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

Bir markanın bağlantılarını listeleyin

Bir markaya bağlı sosyal medya hesaplarını, her birinin platformu, görünen adı ve arşivlenme durumuyla birlikte döndürür.

API anahtarı gerektirir. Başlık biçimi ve anahtar yenileme için Kimlik doğrulama bölümüne bakın.

Parametreler

Yol

AdTürZorunluAçıklama
brandIdstringzorunluBrand UUID whose connections should be listed.

Yanıtlar

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

Tek bir markaya bağlı sosyal medya hesaplarını listeler. Her satırdaki id, bağlantı kimliğidir: bir gönderinin belirli kanallarda yayımlanmasını istediğinizde connectedChannelIds içinde ilettiğiniz, bağlantıyı kesme işleminin aldığı ve istatistikler işleminin gerektirdiği socialConnectedChannelId olarak kullanılan değerdir.

Kullanım senaryosu: kanal seçiciyi görüntüleme. Gönderi oluşturma arayüzünü göstermeden önce bu listeyi okuyun ve her satır için displayName ve platform ile etiketlenmiş bir açma/kapatma düğmesi sunun. socialConnected dizisi boş olan bir markanın yayın yapabileceği bir kanal yoktur; bu durumda kullanıcıyı bir bağlantı kurma bağlantısına yönlendirin.

Kullanım senaryosu: bağlantının oluşturulduğunu doğrulama. Kullanıcı, barındırılan bağlantı kurma akışından status=success ile döndükten sonra, id değeri dönüş URL'sindeki connectedAccountId ile eşleşen satır görünene kadar bu uç noktayı düzenli aralıklarla sorgulayın. Bağlantılar eşzamansız olarak oluşturulur; bu nedenle hata göstermeden önce birkaç saniye bekleyin ve birkaç kez yeniden deneyin.

Notlar.

  • platform, FACEBOOK, INSTAGRAM, TWITTER (X), LINKEDIN, PINTEREST değerlerinden biridir.
  • id, bağlantının UUID'sidir ve bağlantı kabul eden tüm Social uç noktalarının beklediği değerdir. referenceId, platformun kendi hesap tanımlayıcısıdır — bir Facebook Sayfa Kimliği veya Instagram işletme hesabı kimliği — ve ListingsAPI dışında tuttuğunuz kayıtlarla eşleştirme yapmak için yararlıdır, ancak burada hiçbir zaman girdi olarak kabul edilmez.
  • archivedAt zaman damgasıyla birlikte archived: true, birinin bağlantıyı kesmesi, markanın arşivlenmesi veya platformun belirteci iptal etmesi nedeniyle bağlantının artık mevcut olmadığı anlamına gelir. Arşivlenmiş bir kanalı hedefleyen gönderi, SY95045 ile başarısız olur.
  • listingConnectedAccountId yalnızca aynı hesap Listings tarafında da bağlıysa ayarlanır; yalnızca Social tarafında bulunan bir bağlantı için değeri null olur.
  • Yayın yapmak için her markada platform başına yalnızca bir bağlantı kullanılır. Aynı platformu aynı markaya yeniden bağlamak, ikinci bir kanal eklemek yerine önceki kanalın yerini alır.
  • Tek bir markanın kanalları yerine hesabınızın tamamındaki bağlantı kullanımını üst sınırınıza göre görmek için GET /social/limits çağrısını yapın.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \  -H "Authorization: API $LISTINGSAPI_KEY"