GET/api/v4/social/brands/{brandId}/connections

عرض اتصالات علامة تجارية

يعيد حسابات التواصل الاجتماعي المتصلة بعلامة تجارية، مع المنصة واسم العرض وحالة الأرشفة لكل منها.

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

المعلمات

المسار

الاسمالنوعمطلوبالوصف
brandIdstringمطلوبBrand UUID whose connections should be listed.

الاستجابات

200The brand's connections.
Response
{  "data": {    "listConnectedChannelWithSocialProfile": {      "socialConnected": [        {          "id": "b81d5b3c-4a90-4f6a-9c11-71e0dd2fa4a7",          "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",          "vendorProfileId": null,          "platform": "INSTAGRAM",          "displayName": "Jenny Home",          "userName": "jennyhome",          "userImage": "https://cdn.listingsapi.com/social/channels/b81d5b3c/avatar.jpg",          "archived": false,          "archivedAt": null,          "listingConnectedAccountId": null,          "referenceId": "17841400000000001"        },        {          "id": "2d4e6f80-1c33-4b7a-8e05-9a1b2c3d4e5f",          "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",          "vendorProfileId": null,          "platform": "FACEBOOK",          "displayName": "Jenny Home & Co.",          "userName": "jennyhomeco",          "userImage": "https://cdn.listingsapi.com/social/channels/2d4e6f80/avatar.jpg",          "archived": false,          "archivedAt": null,          "listingConnectedAccountId": "cf12de77-2211-4a09-b7c1-0a6f3b2e91aa",          "referenceId": "102938475601234"        }      ],      "profileCount": 1,      "channelCount": 2    }  }}
401Unauthenticated, missing or invalid API key.
404No brand with that ID on this account (`SY95043`).

يسرد حسابات التواصل الاجتماعي المرتبطة بعلامة تجارية واحدة. يمثّل id في كل صف معرّف الاتصال: وهو القيمة التي تمرّرها في connectedChannelIds عندما تريد توجيه منشور إلى قنوات محددة، والقيمة التي تقبلها عملية قطع الاتصال، وكذلك socialConnectedChannelId الذي تتطلبه الإحصاءات.

حالة استخدام: عرض أداة اختيار القنوات. قبل عرض محرّر المنشورات، اقرأ هذه القائمة وقدّم مفتاح تبديل لكل صف، مع تسميته باستخدام displayName وplatform. لا توجد وجهة للنشر لعلامة تجارية تكون مصفوفة socialConnected لديها فارغة؛ لذا وجّه المستخدم إلى رابط اتصال بدلاً من ذلك.

حالة استخدام: التأكد من إنشاء الاتصال. بعد عودة المستخدم من مسار الاتصال المستضاف مع status=success، استعلم دورياً من نقطة النهاية هذه حتى يظهر الصف الذي تطابق فيه قيمة id قيمة connectedAccountId في عنوان URL للعودة. تُنشأ الاتصالات بصورة غير متزامنة، لذا انتظر بضع ثوانٍ وأعِد المحاولة مرتين قبل عرض خطأ.

ملاحظات.

  • تكون قيمة platform واحدة من FACEBOOK أو INSTAGRAM أو TWITTER (X) أو LINKEDIN أو PINTEREST.
  • يمثّل id معرّف UUID للاتصال، وهو القيمة التي تتطلبها كل نقطة نهاية في Social تقبل اتصالاً. أما referenceId فهو معرّف الحساب الخاص بالمنصة نفسها — مثل معرّف صفحة Facebook أو معرّف حساب أعمال Instagram — وهو مفيد للمطابقة مع السجلات التي تحتفظ بها خارج ListingsAPI، لكنه لا يُقبل أبداً كقيمة إدخال هنا.
  • يشير archived: true مع طابع زمني في archivedAt إلى أن الاتصال لم يعد موجوداً، إما لأن شخصاً ما قطع الاتصال، أو لأن العلامة التجارية أُرشفت، أو لأن المنصة ألغت الرمز المميز. يفشل المنشور الذي يستهدف قناة مؤرشفة مع SY95045.
  • لا تُعيَّن قيمة listingConnectedAccountId إلا عندما يكون الحساب نفسه مرتبطاً أيضاً في جانب Listings؛ وتكون قيمته null للاتصال الخاص بـ Social فقط.
  • يُستخدم اتصال واحد فقط لكل منصة لكل علامة تجارية لأغراض النشر. يؤدي ربط المنصة نفسها مرة أخرى بالعلامة التجارية نفسها إلى استبدال القناة السابقة بدلاً من إضافة قناة ثانية.
  • للاطلاع على استخدام الاتصالات على مستوى حسابك بأكمله مقارنةً بالحد الأقصى المسموح لك، بدلاً من قنوات علامة تجارية واحدة، استدعِ GET /social/limits.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \  -H "Authorization: API $LISTINGSAPI_KEY"