ブランドの取得 | Listings API

名前	型	必須	説明
brandId	string	必須	Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

名前

型

必須

説明

brandId

string

必須

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

レスポンス

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

UUIDを指定して単一のブランドを取得します。ペイロードはGET /social/brandsの1行と同一なので、すでにbrandIdを持っていて最新の情報を取得したい場合は、一覧を再取得する代わりにこちらを使用します。

ユースケース：公開画面でのブランドヘッダーの表示。 profileNameとlogoを読み取って投稿作成画面のラベルに使用し、timezone.tzCodeを読み取って、APIが実際に解釈するタイムゾーンで予約時刻を表示します。scheduleDate + scheduleTimeで予約した投稿の時刻は、このフィールドに基づいて決まるため、それ以外のタイムゾーンで表示すると、時刻が数時間ずれる原因になります。

ユースケース：公開前の事前確認。 connectedChannelCountが0の場合、公開先がありません。SY95045で拒否される投稿をユーザーに作成させるのではなく、接続リンクに誘導します。

注意事項。

brandIdは通常のUUIDです。拠点IDと同じようにBase64エンコードすると、404が発生します。
brandIdはパストークンとしてのみ使用します。リクエストボディでは、同じ値がsocialProfileIdとして現れます。この2つの名前は、異なる位置で使われる同じIDを表します。
すでにアーカイブされたブランドでは、archivedはtrueです。アーカイブが予約されているだけのブランドでは、引き続きarchived: falseとなります。ブランドのアーカイブを参照してください。
timezone.tzCodeはスケジュールの時刻を確定する際の基準となるIANA識別子であり、ほかの3つのタイムゾーンフィールドは表示用のラベルです。
ブランドの個々の接続について、プラットフォームと接続IDを取得するには、GET /social/brands/{brandId}/connectionsを呼び出します。

パラメーター

パス

レスポンス