/api/v4/connected-accounts/trigger-matchesبدء مطابقة المواقع
يجلب الملفات التجارية على Google وFacebook للحسابات المتصلة ويطابقها مع مواقعك في Listings API.
المعلمات
النص الأساسي
| الاسم | النوع | مطلوب | الوصف |
|---|---|---|---|
| input | object | مطلوب | Wrapper object. The entire request body must be nested under `input`. |
| input.connectedAccountIds | array of strings | مطلوب | UUIDs of the connected accounts to trigger matches for. Taken from `GET /connected-accounts`. |
مثال على الطلب
نص جاهز للصق. استبدل المعرّفات والقيم النموذجية بقيمك.
{ "input": { "connectedAccountIds": [ "4f712c17-4f95-42dd-90f4-97171a2e67b5" ] }}الاستجابات
200Request accepted. `success` is `true` when the fetch-and-match job was queued for every account; accounts that could not be queued are returned in `failedIds` and `success` is `false`.
{ "data": { "connectedAccountsTriggerMatches": { "failedIds": null, "success": true } }}400Bad request, the body was not wrapped in `input` (error message: `Variable "$input" of required type "ConnectedAccountsTriggerMatchesInput!" was not provided`).
401Unauthenticated, missing or invalid API key.
يبدأ المهمة غير المتزامنة التي تسترد كل ملف تجاري على Google Business Profile وFacebook يمكن للحسابات المتصلة المحددة الوصول إليه، وتطابق هذه الملفات مع مواقعك في Listings API. تعني الاستجابة success: true أن المهمة أُضيفت إلى قائمة الانتظار، وتجري عملية المطابقة نفسها في الخلفية.
بنية الطلب. يجب تغليف جسم الطلب بكائن input يحتوي على connectedAccountIds، وهي مصفوفة الحسابات المتصلة المطلوب إجراء المطابقة لها. يُرفض إرسال جسم طلب مسطح وغير مغلف بحالة HTTP 400. احصل على معرّفات الحسابات من GET /connected-accounts. عندما يتعذر إضافة حساب واحد أو أكثر إلى قائمة الانتظار، تُعاد معرّفات تلك الحسابات في failedIds وتكون قيمة success هي false.
حالة استخدام: تحديث الاقتراحات بعد ربط حساب جديد. فور إكمال العميل خطوات الربط بـ Google، استدعِ trigger-matches باستخدام connectedAccountId الخاص بذلك الحساب. يؤدي ذلك إلى توفير اقتراحات مطابقة المواقع، بحيث تتمكن واجهة إعداد العملاء لديك من عرض "عثرنا على N من إدراجات أنشطتك التجارية" دون أن ينتظر العميل مزامنة مجدولة.
حالة استخدام: إعادة تشغيل المطابقة بعد إضافة مواقع. عندما تنشئ دفعة من المواقع الجديدة في Listings API لحساب متصل موجود، ابدأ عملية مطابقة جديدة لربط المواقع الجديدة بإدراجات الأنشطة التجارية الموجودة لها على Google/Facebook.
نظرًا إلى أن العمل يجري بصورة غير متزامنة، فلا تعتبر 200 دلالة على "اكتمال المطابقة". استعلم دوريًا من نقطة نهاية تفاصيل الحساب المتصل وانتظر حتى تصل قيمة requestMatchesStatus إلى MATCH_COMPLETED، ثم اقرأ النتائج من نقطة النهاية connection-suggestions قبل استدعاء confirm-matches أو connect-listing.
تضيف نقطة النهاية هذه إلى قائمة الانتظار عملية جلب فعلية من Google/Facebook. بُنية الطلب ونموذج الاستجابة أعلاه موثَّقان استنادًا إلى مواصفات API؛ ولا يُنفَّذ الاستدعاء على بيانات بيئة الإنتاج.
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/trigger-matches' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "connectedAccountIds": [ "4f712c17-4f95-42dd-90f4-97171a2e67b5" ] } }'