جلب علامة تجارية

الاسم	النوع	مطلوب	الوصف
brandId	string	مطلوب	Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

الاسم

النوع

مطلوب

الوصف

brandId

string

مطلوب

Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

الاستجابات

200The brand.

Response

{  "data": {    "getSocialProfileDetails": {      "id": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "profileName": "Jenny Home",      "archived": false,      "logo": "https://cdn.listingsapi.com/social/brands/6f2c9a41/logo.png",      "profileLogo": "https://cdn.listingsapi.com/social/brands/6f2c9a41/logo.png",      "siteUrl": "https://jennyhome.example",      "countryIso": "US",      "bio": "Handmade furniture for real homes.",      "businessIntent": "A family-run home furnishings store selling handmade furniture and textiles.",      "categories": ["Furniture Store", "Home Goods"],      "brandHashtags": ["jennyhome", "handmadefurniture"],      "competitorHashtags": ["localfurniture"],      "connectedChannelCount": 3,      "timezone": {        "label": "(GMT-05:00) Eastern Time",        "tzCode": "America/New_York",        "name": "Eastern Standard Time",        "utc": "-05:00"      },      "contentPreferredLanguage": "en"    }  }}

401Unauthenticated, missing or invalid API key.

404No brand with that ID on this account (`SY95043`).

يجلب علامة تجارية واحدة باستخدام UUID الخاص بها. تطابق البيانات المُرجعة صفًا واحدًا من GET /social/brands، لذا استخدمه عندما يكون لديك بالفعل brandId وتريد أحدث نسخة بدلًا من جلب القائمة مجددًا.

حالة استخدام: عرض ترويسة العلامة التجارية على شاشة النشر. اقرأ profileName وlogo لتسمية محرر المنشورات، واقرأ timezone.tzCode لعرض الأوقات المجدولة بالمنطقة الزمنية التي ستفسرها واجهة API وفقًا لها فعليًا. يُحدَّد توقيت المنشور المجدول باستخدام scheduleDate + scheduleTime وفقًا لـهذا الحقل، لذا فإن عرض أي منطقة زمنية أخرى للقارئ قد يؤدي إلى أخطاء بفارق ساعات.

حالة استخدام: التحقق المسبق قبل النشر. إذا كانت قيمة connectedChannelCount هي 0، فلا توجد وجهة للنشر. وجّه المستخدم إلى رابط اتصال بدلًا من السماح له بكتابة منشور سيُرفض مع SY95045.

ملاحظات.

brandId هو UUID بصيغته العادية. يؤدي ترميزه باستخدام Base64، كما تفعل مع معرّف موقع، إلى 404.
brandId هو رمز في المسار فقط. تظهر القيمة نفسها في أجسام الطلبات باسم socialProfileId؛ ويشير الاسمان إلى المعرّف نفسه في موضعين مختلفين.
تكون قيمة archived هي true للعلامة التجارية التي أُرشفت بالفعل. أما العلامة التجارية المجدولة للأرشفة فقط، فتظل قيمتها archived: false — انظر أرشفة علامة تجارية.
timezone.tzCode هو معرّف IANA الذي تُحدَّد الأوقات المجدولة وفقًا له؛ أما حقول المنطقة الزمنية الثلاثة الأخرى فهي تسميات للعرض.
للحصول على الاتصالات الفردية للعلامة التجارية — ومنصاتها ومعرّفات الاتصال الخاصة بها — استدعِ GET /social/brands/{brandId}/connections.

المعلمات

المسار

الاستجابات