/api/v4/locations/{locationId}/reviews/settingsعرض مصادر التقييمات لموقع
يعرض مصادر التقييمات التي أُعدّت لموقع واحد، مع عناوين URL الخاصة باتصالها.
المعلمات
المسار
| الاسم | النوع | مطلوب | الوصف |
|---|---|---|---|
| locationId | string | مطلوب | Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID. |
الاستجابات
200Review-source sites and their configured URLs for the location.
{ "data": { "interactionsSetting": { "siteSettings": [ { "name": "maps.google.com", "url": null }, { "name": "facebook.com", "url": null }, { "name": "yelp.com", "url": null } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
يعرض إعدادات مصادر التقييمات لموقع واحد. يمثّل كل عنصر في siteSettings منصة تدعمها خطة الحساب. إذا كانت قيمة url غير null، فهذا يعني أن المنصة متصلة وأن Listings API يجلب التقييمات من عنوان URL ذاك؛ أما إذا كانت قيمة url هي null (كما هو موضح أعلاه للموقع الفعلي Jenny Home، الذي لم تُربط به أي مصادر خارجية بعد)، فالمنصة متاحة لكنها لم تُعدّ بعد.
حالة استخدام: معرفة المصادر التي لا تزال بحاجة إلى عنوان URL
اجلب هذه القائمة وصفِّها بحسب url: null لإنشاء قائمة بالمنصات التي لا يزال على مالك الموقع ربطها. تُربط مصادر التقييمات تلقائيًا بمجرد ربط الملفين التعريفيين للموقع على Google وFacebook، لذا اربط هذين الحسابين لتعبئة عناوين URL الناقصة:
{ "name": "yelp.com", "url": "https://www.yelp.com/biz/your-listing" }بعد التعديل، تظهر المنصة نفسها في الاستجابة وقد عُبِّئ الحقل url الخاص بها بدلًا من أن تكون قيمته null.
حالة استخدام: تدقيق المصادر المتصلة عبر مجموعة من المواقع
مرّ على مواقعك (من سرد جميع المواقع) واستدعِ نقطة النهاية هذه لكل موقع لإعداد تقرير عن تغطية مصادر التقييمات. نظرًا إلى أن كل موقع يتطلب طلبًا واحدًا، التزم بحد معدل الطلبات للحساب، ووزّع الاستدعاءات على فترات، وعند تلقي 429، أعد المحاولة بعد المدة المحددة في ترويسة Retry-After بدلًا من إرسال الطلبات بكثافة.
يظهر Google وFacebook تلقائيًا على أنهما متصلان عند ربطهما عبر OAuth، ولا يمكن استبدال إعداداتهما عبر نقطة نهاية التعديل. استخدم عرض مصادر التقييمات لحساب، الذي يشمل الحساب بأكمله، للاطلاع على المجموعة الكاملة من المنصات التي يمكن أن تدعمها الخطة.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/reviews/settings' \ -H "Authorization: API $LISTINGSAPI_KEY"