GET/api/v4/locations/{locationId}/voice-assistants

جلب إدراجات النشاط التجاري لموقع لدى المساعدات الصوتية

يُرجع حالة مزامنة إدراجات النشاط التجاري لدى المساعدات الصوتية لموقع عبر Google Assistant وAlexa وSiri وCortana وBixby.

يتطلب مفتاح API. راجع المصادقة لمعرفة تنسيق الترويسة وتدوير المفاتيح.

المعلمات

المسار

الاسمالنوعمطلوبالوصف
locationIdstringمطلوبLocation ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`).

الاستجابات

200Array of voice assistant listings with per-assistant sync status.
Response
{  "data": {    "voiceAssistantsForLocation": [      {        "databaseId": "104468723",        "voiceIdentifier": "GOOGLE_ASSISTANT",        "name": "Google Assistant",        "connectedAccountId": null,        "syncStatus": "REQUIRING_ACTION",        "actionRequired": true,        "syncIssue": null,        "errors": []      },      {        "databaseId": "104468711",        "voiceIdentifier": "SIRI",        "name": "Siri",        "connectedAccountId": null,        "syncStatus": "IN_PROGRESS",        "actionRequired": false,        "syncIssue": null,        "errors": []      },      {        "databaseId": "104468714",        "voiceIdentifier": "ALEXA",        "name": "Alexa",        "connectedAccountId": null,        "syncStatus": "IN_PROGRESS",        "actionRequired": false,        "syncIssue": null,        "errors": []      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

يُرجع حالة إدراجات النشاط التجاري لدى المساعدات الصوتية لموقع واحد. تزامن Listings API بيانات الموقع مع Google Assistant وAmazon Alexa وApple Siri وMicrosoft Cortana وSamsung Bixby ليظهر النشاط التجاري في نتائج البحث الصوتي. يقبل مقطع المسار locationId معرّف العقدة بترميز base64 من أي استجابة خاصة بموقع، أو معرّف قاعدة البيانات الرقمي الخام، ويشير كلاهما إلى الموقع نفسه.

حالة الاستخدام: عرض إدراجات الأنشطة التجارية لدى المساعدات الصوتية التي «تتطلب إجراءً» في لوحة التحكم. اعرض عنصر واجهة يوضح جاهزية كل موقع للبحث الصوتي من خلال المرور على عناصر المصفوفة ووضع علامة على كل عنصر تكون فيه قيمة actionRequired هي true أو تكون قيمة syncIssue غير null. في المثال أعلاه، يحتاج Google Assistant وBixby إلى معالجة. السبب الأكثر شيوعًا لحاجة Google Assistant إلى معالجة هو عدم وجود اتصال بـ Google، لأن نتائجه تأتي من الاتصال بـ Google Business Profile. اربط هذه الصفوف بـ ربط Google ليتمكن العميل من ربط الحساب. تأتي نتائج Siri من إدراج النشاط التجاري الخاص بالموقع على Apple Maps.

قيم حالة المزامنة: IN_PROGRESS (جارٍ الإرسال)، وREQUIRING_ACTION (يلزم إدخال من العميل قبل أن تتمكن Listings API من المزامنة)، وLIVE (منشور)، وNOT_SUBMITTED. errors عبارة عن مصفوفة من سلاسل نصية للأخطاء من جانب منصة النشر؛ ويربط connectedAccountId المساعد بالحساب المتصل الذي تجري المزامنة عبره عندما ينطبق ذلك (مثل Google Assistant عبر الاتصال بـ Google).

تُحتسب الطلبات إلى نقطة النهاية هذه ضمن حد معدل الطلبات لحسابك. إذا كنت تستعلم دوريًا عن حالة المساعدات الصوتية عبر مواقع عديدة، فاستعرض المواقع صفحةً بصفحة باستخدام نقطة النهاية قائمة المواقع وباعد بين الاستدعاءات؛ إذ تتضمن استجابة 429 ترويسة Retry-After تُعلمك بموعد استئناف الطلبات.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/voice-assistants' \  -H "Authorization: API $LISTINGSAPI_KEY"