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

Verbindungen einer Marke auflisten

Gibt die mit einer Marke verbundenen Social-Media-Konten zurück, jeweils mit Plattform, Anzeigename und Archivierungsstatus.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Pfad

NameTypErforderlichBeschreibung
brandIdstringerforderlichBrand UUID whose connections should be listed.

Antworten

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

Listet die mit einer Marke verknüpften Social-Media-Konten auf. Der Wert id jeder Zeile ist die Verbindungs-ID: der Wert, den Sie in connectedChannelIds übergeben, wenn ein Beitrag auf bestimmten Kanälen veröffentlicht werden soll, den disconnect entgegennimmt und den insights als socialConnectedChannelId benötigt.

Anwendungsfall: Kanalauswahl anzeigen. Rufen Sie diese Liste ab, bevor Sie einen Beitragseditor anzeigen, und bieten Sie für jede Zeile einen Schalter an, der mit displayName und platform beschriftet ist. Eine Marke mit einem leeren socialConnected-Array hat keinen Kanal zum Veröffentlichen; leiten Sie den Benutzer stattdessen zu einem Verbindungslink weiter.

Anwendungsfall: Bestätigen, dass eine Verbindung hergestellt wurde. Nachdem der Benutzer mit status=success aus dem gehosteten Verbindungsablauf zurückkehrt, fragen Sie diesen Endpunkt wiederholt ab, bis die Zeile erscheint, deren id mit dem connectedAccountId in der Rückkehr-URL übereinstimmt. Verbindungen werden asynchron angelegt. Warten Sie daher einige Sekunden und versuchen Sie es ein paar Mal erneut, bevor Sie einen Fehler anzeigen.

Hinweise.

  • platform hat einen der folgenden Werte: FACEBOOK, INSTAGRAM, TWITTER (X), LINKEDIN, PINTEREST.
  • id ist die UUID der Verbindung und der Wert, den jeder Social-Endpunkt erwartet, der eine Verbindung entgegennimmt. referenceId ist die eigene Kontokennung der Plattform — eine Facebook-Seiten-ID oder eine Instagram-Business-Konto-ID — und eignet sich zum Abgleich mit Datensätzen, die Sie außerhalb von ListingsAPI verwalten, wird hier jedoch niemals als Eingabe akzeptiert.
  • archived: true mit einem archivedAt-Zeitstempel bedeutet, dass die Verbindung nicht mehr besteht, entweder weil jemand sie getrennt hat, weil die Marke archiviert wurde oder weil die Plattform das Token widerrufen hat. Ein Beitrag, der auf einen archivierten Kanal abzielt, schlägt mit SY95045 fehl.
  • listingConnectedAccountId wird nur gesetzt, wenn dasselbe Konto auch auf der Listings-Seite verknüpft ist; bei einer reinen Social-Verbindung ist der Wert null.
  • Pro Plattform und Marke wird nur eine Verbindung zum Veröffentlichen verwendet. Wenn Sie dieselbe Plattform erneut mit derselben Marke verbinden, wird der bisherige Kanal ersetzt, statt ein zweiter hinzugefügt.
  • Um die kontoweite Nutzung Ihrer Verbindungen im Verhältnis zu Ihrem Limit statt der Kanäle einer einzelnen Marke anzuzeigen, rufen Sie GET /social/limits auf.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \  -H "Authorization: API $LISTINGSAPI_KEY"