Bir markayı getirin

Ad	Tür	Zorunlu	Açıklama
brandId	string	zorunlu	Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

Tür

Zorunlu

Açıklama

brandId

string

zorunlu

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

Yanıtlar

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'sine göre tek bir markayı getirir. Döndürülen veri, GET /social/brands içindeki bir satırla aynıdır; bu nedenle elinizde zaten bir brandId varsa ve yeniden listelemek yerine en güncel kopyayı istiyorsanız bunu kullanın.

Kullanım senaryosu: yayınlama ekranında marka başlığını gösterme. Gönderi düzenleyicisini etiketlemek için profileName ve logo alanlarını, planlanan saatleri API'nin gerçekten yorumlayacağı saat diliminde göstermek için de timezone.tzCode alanını okuyun. scheduleDate + scheduleTime ile planlanan bir gönderinin zamanı bu alana göre belirlenir; dolayısıyla okuyucuya başka bir saat dilimi göstermek, saatler düzeyinde sapmalara yol açabilir.

Kullanım senaryosu: yayınlama öncesi kontrol. connectedChannelCount değeri 0 ise yayın yapılabilecek bir yer yoktur. Kullanıcının SY95045 ile reddedilecek bir gönderi hazırlamasına izin vermek yerine onu bir bağlantı kurma bağlantısına yönlendirin.

Notlar.

brandId, düz bir UUID'dir. Bunu bir konum kimliğinde yaptığınız gibi Base64 ile kodlamak, 404 sonucunu üretir.
brandId yalnızca bir yol belirtecidir. Aynı değer, istek gövdelerinde socialProfileId olarak yer alır; bu iki ad, farklı yerlerde kullanılan aynı kimliği ifade eder.
Zaten arşivlenmiş bir marka için archived değeri true olur. Yalnızca arşivlenmesi planlanmış bir marka için değer hâlâ archived: false olarak görünür — bir markayı arşivleyin bölümüne bakın.
timezone.tzCode, planlanan zamanların çözümlenmesinde kullanılan IANA tanımlayıcısıdır; diğer üç saat dilimi alanı, görüntüleme amaçlı etiketlerdir.
Markaya ait bağlantıları tek tek, platformları ve bağlantı kimlikleriyle birlikte almak için GET /social/brands/{brandId}/connections çağrısını yapın.

Parametreler

Yol

Yanıtlar