Eine Marke abrufen | Listings API

Name	Typ	Erforderlich	Beschreibung
brandId	string	erforderlich	Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

Name

Typ

Erforderlich

Beschreibung

brandId

string

erforderlich

Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

Antworten

200The brand.

Response

{  "data": {    "getSocialProfileDetails": {      "id": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "profileName": "Jenny Home",      "archived": false,      "logo": "https://cdn.listingsapi.com/social/brands/6f2c9a41/logo.png",      "profileLogo": "https://cdn.listingsapi.com/social/brands/6f2c9a41/logo.png",      "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": ["localfurniture"],      "connectedChannelCount": 3,      "timezone": {        "label": "(GMT-05:00) Eastern Time",        "tzCode": "America/New_York",        "name": "Eastern Standard Time",        "utc": "-05:00"      },      "contentPreferredLanguage": "en"    }  }}

401Unauthenticated, missing or invalid API key.

404No brand with that ID on this account (`SY95043`).

Ruft eine einzelne Marke anhand ihrer UUID ab. Die Nutzdaten sind mit einer Zeile aus GET /social/brands identisch. Verwenden Sie diesen Aufruf also, wenn Sie bereits über eine brandId verfügen und die aktuellste Version abrufen möchten, statt die Marken erneut aufzulisten.

Anwendungsfall: Anzeigen des Markenkopfbereichs auf einer Veröffentlichungsseite. Lesen Sie profileName und logo aus, um den Beitragseditor zu beschriften, und timezone.tzCode, um geplante Zeiten in der Zeitzone anzuzeigen, in der die API sie tatsächlich interpretiert. Der Zeitpunkt eines mit scheduleDate + scheduleTime geplanten Beitrags richtet sich nach diesem Feld. Wenn Sie dem Leser etwas anderes anzeigen, kann dies zu Fehlern mit Abweichungen von mehreren Stunden führen.

Anwendungsfall: Vorabprüfung vor der Veröffentlichung. Wenn connectedChannelCount den Wert 0 hat, gibt es kein Ziel für die Veröffentlichung. Leiten Sie den Benutzer zu einem Verbindungslink weiter, statt ihn einen Beitrag verfassen zu lassen, der mit SY95045 abgelehnt wird.

Hinweise.

brandId ist eine einfache UUID. Wenn Sie sie wie eine Standort-ID mit Base64 kodieren, führt dies zu 404.
brandId ist ausschließlich ein Pfad-Token. Derselbe Wert erscheint in Anfrage-Bodys als socialProfileId; die beiden Namen bezeichnen dieselbe ID an unterschiedlichen Positionen.
archived hat bei einer bereits archivierten Marke den Wert true. Bei einer Marke, deren Archivierung lediglich geplant ist, lautet der Wert weiterhin archived: false — siehe Eine Marke archivieren.
timezone.tzCode ist die IANA-Kennung, anhand derer geplante Zeiten interpretiert werden; die anderen drei Zeitzonenfelder dienen als Anzeigebezeichnungen.
Um die einzelnen Verbindungen der Marke — ihre Plattformen und Verbindungs-IDs — abzurufen, rufen Sie GET /social/brands/{brandId}/connections auf.

Parameter

Pfad

Antworten