Marken auflisten | Listings API

Parameter

Query

Name	Typ	Erforderlich	Beschreibung	Standard
filters	string	optional	JSON-encoded filter object with two fields. `statuses` (array of strings, required inside the object) selects which brand states to return: `ACTIVE` or `ARCHIVED`. `profileName` (string, optional) is a case-insensitive substring match on the brand name. Omit the parameter entirely to return active brands.	—
page	integer	optional	1-based page number. Defaults to 1.	—
size	integer	optional	Rows per page. Defaults to 20.	—

Antworten

200A page of brands plus `pageInfo` for paging.

Response

{  "data": {    "listSocialProfiles": {      "profiles": [        {          "id": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",          "profileName": "Jenny Home",          "archived": false,          "logo": null,          "profileLogo": null,          "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": [],          "connectedChannelCount": 3,          "timezone": {            "label": "(GMT-05:00) Eastern Time",            "tzCode": "America/New_York",            "name": "Eastern Standard Time",            "utc": "-05:00"          },          "contentPreferredLanguage": "en"        },        {          "id": "a90f7c22-5db1-4e83-9f40-2b7c6a1e5d33",          "profileName": "Jenny Home Eastside",          "archived": false,          "logo": null,          "profileLogo": null,          "siteUrl": null,          "countryIso": "US",          "bio": null,          "businessIntent": "general",          "categories": [],          "brandHashtags": [],          "competitorHashtags": [],          "connectedChannelCount": 0,          "timezone": {            "label": "(GMT-06:00) Central Time",            "tzCode": "America/Chicago",            "name": "Central Standard Time",            "utc": "-06:00"          },          "contentPreferredLanguage": "en"        }      ],      "pageInfo": {        "total": 11,        "hasNextPage": true,        "totalEngagementPosts": 0,        "totalPublishedPosts": 0      }    }  }}

401Unauthenticated, missing or invalid API key.

Listet die Marken in Ihrem Konto seitenweise auf. Jede Zeile enthält dasselbe Markenobjekt, das GET /social/brands/{brandId} für eine einzelne Marke zurückgibt. Daher reicht eine Liste normalerweise aus, um eine Markenauswahl ohne eine zweite Anfrage darzustellen.

Anwendungsfall: eine Markenauswahl in Ihrer eigenen Benutzeroberfläche. Führen Sie diesen Aufruf einmal aus, wenn der Benutzer Ihre Veröffentlichungsansicht öffnet, und zeigen Sie profileName und logo pro Zeile an. Eine Marke, deren connectedChannelCount den Wert 0 hat, ist noch mit keinem Social-Media-Konto verbunden und kann nichts veröffentlichen; kennzeichnen Sie sie und leiten Sie den Benutzer zu einem Verbindungslink weiter. Blättern Sie mit page und size durch die Seiten, solange pageInfo.hasNextPage den Wert true hat.

Anwendungsfall: Abgleich Ihrer Datensätze. Durchlaufen Sie jede Nacht alle Seiten und gleichen Sie id mit den Marken-IDs ab, die Sie beim Erstellen gespeichert haben. Eine Marke, die nicht mehr in der standardmäßig zurückgegebenen Liste erscheint, wurde archiviert; übergeben Sie filters={"statuses":["ARCHIVED"]}, um sie anzuzeigen.

Hinweise.

id ist die reine UUID, die an anderer Stelle in der Social API als Pfadplatzhalter brandId und in Anfragekörpern als socialProfileId verwendet wird.
Filter werden als eine einzige JSON-kodierte Zeichenfolge im Abfrageparameter filters übergeben, nicht als separate Parameter. Kodieren Sie diese Zeichenfolge für die Verwendung in einer URL. Wenn Sie filters überhaupt übergeben, muss es statuses enthalten; profileName kann optional zusätzlich enthalten sein.
Die Paginierung erfolgt offsetbasiert (page / size), nicht cursorbasiert wie bei den Endpunkten Locations und Reviews. pageInfo.total ist die Gesamtzahl der übereinstimmenden Marken, nicht die Anzahl auf dieser Seite. pageInfo.totalEngagementPosts und totalPublishedPosts sind Beitragszähler, die auch in der Beitragsliste verwendet werden, und haben hier den Wert 0.
connectedChannelCount zählt nur aktive Verbindungen; ein Kanal, dessen Verbindung getrennt wurde, wird sofort nicht mehr mitgezählt. Um die Kanäle selbst abzurufen, rufen Sie GET /social/brands/{brandId}/connections auf.
timezone.tzCode ist die IANA-Kennung, anhand derer jeder Zeitplan für diese Marke ausgewertet wird; die anderen drei Zeitzonenfelder sind Anzeigebezeichnungen.
Es gibt keine Obergrenze für Marken, mit der Sie einen Abgleich vornehmen müssten. In API-Tarifen ist die Anzahl der Marken unbegrenzt, daher dient die Länge dieser Liste nur zur Information. Begrenzt ist die Anzahl der Verbindungen: Lesen Sie diese aus GET /social/limits aus. Die Archivierung einer Marke nimmt ihre Verbindungen sofort offline, aber ihre Plätze zählen bis zum Ende des Abrechnungszeitraums weiterhin zum Limit maxConnections. Eine Marke, die nicht mehr in dieser Liste erscheint, kann daher bis zur Verlängerung weiterhin Plätze belegen.