ブランドの接続一覧を取得する

名前	型	必須	説明
brandId	string	必須	Brand UUID whose connections should be listed.

名前

型

必須

説明

brandId

string

必須

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

1つのブランドに紐づくソーシャルアカウントの一覧を取得します。各行のidは接続IDです。これは、特定のチャネルに投稿する際にconnectedChannelIdsに渡す値であり、disconnectが受け取る値であり、insightsが必要とするsocialConnectedChannelIdでもあります。

ユースケース：チャネル選択UIの表示。 投稿作成画面を表示する前にこの一覧を取得し、行ごとに、displayNameとplatformをラベルにした切り替えスイッチを表示します。socialConnected配列が空のブランドには投稿先がないため、ユーザーを接続リンクに誘導します。

ユースケース：接続が作成されたことの確認。 ユーザーがホスト型の接続フローからstatus=successを伴って戻ったら、idが戻り先URLのconnectedAccountIdと一致する行が現れるまで、このエンドポイントをポーリングします。接続は非同期で作成されるため、エラーを表示する前に数秒待ち、2回ほど再試行してください。

注意事項。

platformは、FACEBOOK、INSTAGRAM、TWITTER（X）、LINKEDIN、PINTERESTのいずれかです。
idは接続のUUIDであり、接続を受け取るすべてのSocialエンドポイントが必要とする値です。referenceIdは、FacebookページIDやInstagramビジネスアカウントIDなど、プラットフォーム固有のアカウント識別子であり、ListingsAPIの外部で保持しているレコードとの照合に役立ちますが、ここでは入力として一切受け付けられません。
archivedAtのタイムスタンプを伴うarchived: trueは、誰かが接続を解除した、ブランドがアーカイブされた、またはプラットフォームがトークンを失効させたことにより、その接続が失われたことを意味します。アーカイブされたチャネルを対象とする投稿は、SY95045で失敗します。
listingConnectedAccountIdは、同じアカウントがListings側でもリンクされている場合にのみ設定されます。Socialのみの接続ではnullになります。
投稿には、ブランドごとに各プラットフォームで1つの接続のみが使用されます。同じブランドで同じプラットフォームに再度接続すると、2つ目のチャネルが追加されるのではなく、以前のチャネルが置き換えられます。
1つのブランドのチャネルではなく、アカウント全体の接続使用量を上限と比較して確認するには、GET /social/limitsを呼び出します。

ブランドの接続一覧を取得する

パラメーター

パス

レスポンス