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 都是連線 ID:當您希望將貼文發布至特定管道時,這就是您在 connectedChannelIds 中傳入的值,也是中斷連線接受的值,以及洞察資料端點所需的 socialConnectedChannelId。

使用案例:顯示管道選擇器。 顯示貼文編輯器之前,請讀取此清單,並為每筆資料提供一個切換開關,以 displayName 和 platform 作為標籤。若品牌的 socialConnected 陣列為空,就沒有可發布的管道;請改為將使用者導向連線連結。

使用案例:確認連線已建立。 使用者完成託管連線流程並帶著 status=success 返回後,請輪詢此端點,直到出現 id 與返回 URL 上的 connectedAccountId 相符的資料為止。連線會以非同步方式建立,因此請等待幾秒並重試幾次,再顯示錯誤。

注意事項。

  • platform 為 FACEBOOK、INSTAGRAM、TWITTER(X)、LINKEDIN、PINTEREST 其中之一。
  • id 是連線的 UUID,也是所有接受連線作為輸入的 Social 端點所需的值。referenceId 是平台本身的帳號識別碼,例如 Facebook 粉絲專頁 ID 或 Instagram 商業帳號 ID,可用來比對您在 ListingsAPI 以外持有的記錄,但此處一律不接受它作為輸入。
  • archived: true 若帶有 archivedAt 時間戳記,就表示該連線已不存在,原因可能是有人將其中斷連線、品牌已封存,或平台已撤銷權杖。以已封存管道為發布目標的貼文會失敗,並傳回 SY95045。
  • 只有在同一帳號也已在 Listings 端連結時,才會設定 listingConnectedAccountId;若連線僅用於 Social,則其值為 null。
  • 每個品牌在每個平台上只會使用一個連線來發布內容。在同一品牌上再次連結相同平台,會取代先前的管道,而不是新增第二個管道。
  • 若要查看整個帳戶的連線用量與上限的比較,而非單一品牌的管道,請呼叫 GET /social/limits。
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \  -H "Authorization: API $LISTINGSAPI_KEY"