Mendapatkan merek

Nama	Tipe	Wajib	Deskripsi
brandId	string	wajib	Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

Nama

Tipe

Wajib

Deskripsi

brandId

string

wajib

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

Respons

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`).

Mengambil satu merek berdasarkan UUID-nya. Payload-nya identik dengan satu baris dari GET /social/brands, jadi gunakan ini saat Anda sudah memiliki brandId dan menginginkan salinan terbaru alih-alih mengambil daftar lagi.

Kasus penggunaan: menampilkan header merek pada layar publikasi. Baca profileName dan logo untuk memberi label pada editor postingan, serta timezone.tzCode untuk menampilkan waktu terjadwal dalam zona waktu yang benar-benar akan digunakan API untuk menafsirkan waktu tersebut. Waktu postingan yang dijadwalkan dengan scheduleDate + scheduleTime ditentukan berdasarkan field ini, sehingga menampilkan informasi lain kepada pembaca dapat menyebabkan kesalahan selisih jam.

Kasus penggunaan: pemeriksaan awal sebelum publikasi. Jika connectedChannelCount bernilai 0, tidak ada tujuan untuk memublikasikan postingan. Arahkan pengguna ke tautan koneksi alih-alih membiarkan mereka menyusun postingan yang akan ditolak dengan SY95045.

Catatan.

brandId adalah UUID biasa. Mengodekannya dengan Base64, seperti yang Anda lakukan untuk ID lokasi, akan menghasilkan 404.
brandId hanya merupakan token path. Nilai yang sama muncul dalam body permintaan sebagai socialProfileId; kedua nama tersebut merujuk pada ID yang sama di posisi yang berbeda.
archived bernilai true untuk merek yang sudah diarsipkan. Merek yang baru dijadwalkan untuk diarsipkan masih bernilai archived: false — lihat mengarsipkan merek.
timezone.tzCode adalah pengenal IANA yang digunakan sebagai acuan untuk menentukan waktu dalam jadwal; tiga field zona waktu lainnya merupakan label tampilan.
Untuk mendapatkan setiap koneksi pada merek tersebut — platform dan ID koneksinya — panggil GET /social/brands/{brandId}/connections.

Parameter

Path

Respons