/api/v4/connected-accounts/disconnect-listingفصل إدراج نشاط تجاري عن موقع
يفصل إدراج النشاط التجاري المتصل على منصة النشر عن موقع واحد في Listings API.
المعلمات
النص الأساسي
| الاسم | النوع | مطلوب | الوصف |
|---|---|---|---|
| input | object | مطلوب | Wrapper object. The entire request body must be nested under `input`. |
| input.locationId | string | مطلوب | Base64-encoded Relay ID of the one location to disconnect. |
| input.site | string | اختياري | Publisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`. |
| input.providerId | string | اختياري | The publisher's own account identifier, as an alternative to `site`. Required unless you send `site`. |
مثال على الطلب
نص جاهز للصق. استبدل المعرّفات والقيم النموذجية بقيمك.
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "GOOGLE" }}الاستجابات
200Listing disconnected.
{ "data": { "disconnectConnectedAccountsLocations": { "clientMutationId": null, "success": true, "errors": null } }}401Unauthenticated, missing or invalid API key.
يزيل الرابط بين موقع في Listings API وإدراج النشاط التجاري على منصة النشر (Google Business Profile أو Facebook Page أو Apple Business Connect) المتصل به حاليًا. بعد الفصل، تتوقف Listings API عن إرسال التحديثات إلى إدراج النشاط التجاري هذا. يبقى الموقع نفسه في حسابك، ويُقطع فقط رابط إدراج النشاط التجاري.
بنية الطلب. يجب تغليف جسم الطلب في كائن input يحتوي على locationId واحد، بالإضافة إلى أحد الخيارين: site (GOOGLE أو FACEBOOK أو APPLE) أو providerId لتحديد الاتصال المراد قطعه. لا تدعم نقطة النهاية هذه العمليات المجمّعة: يُسمح بموقع واحد لكل استدعاء، لذا استخدم حلقة تكرار إذا احتجت إلى فصل عدة مواقع.
إذا لم تُرسل أيًا من site وproviderId، فستُرجع نقطة النهاية SY10056 ("Site is not valid for the location disconnection"، أي أن منصة النشر غير صالحة لفصل الموقع). إذا لم يكن للموقع اتصال نشط بمنصة النشر تلك، فستُرجع نقطة النهاية SY10057 ("Location is not connected for the site"، أي أن الموقع غير متصل بمنصة النشر) بدلًا من الإبلاغ عن نجاح دون إجراء أي تغيير، لذا تعني success: true أن رابطًا أُزيل فعلًا.
حالة استخدام: إعادة ربط موقع بحساب مختلف. عندما ينقل عميل متجرًا من حساب Google إلى آخر، افصل أولًا إدراج النشاط التجاري الحالي للموقع هنا باستخدام site: "GOOGLE"، ثم استخدم trigger-matches وconnect-listing على الحساب المتصل الجديد لربط الموقع بإدراج النشاط التجاري الصحيح.
حالة استخدام: إنهاء الخدمة دون حذف. عندما ينتقل عميل إلى خطة أدنى ولا يعود يرغب في أن تدير Listings API حضوره على Google/Facebook، لكنه يريد الاحتفاظ بسجل الموقع وبياناته المستضافة لدى Listings API، افصل إدراج النشاط التجاري بدلًا من أرشفة الموقع. يؤدي ذلك إلى إيقاف المزامنة الصادرة مع الاحتفاظ بالموقع لاستخدامه مع منصات نشر أخرى.
تغيّر نقطة النهاية هذه اتصالًا فعليًا وترسل التغيير إلى منصة النشر. الطلب والاستجابة النموذجيان أعلاه مثالان توضيحيان.
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/disconnect-listing' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "GOOGLE" } }'