列出品牌 | Listings API

参数

查询

名称	类型	必填	描述	默认值
filters	string	可选	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	可选	1-based page number. Defaults to 1.	—
size	integer	可选	Rows per page. Defaults to 20.	—

响应

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.

分页列出您账户下的品牌。每一行都与 GET /social/brands/{brandId} 返回的单个品牌对象相同，因此通常只需此列表即可显示品牌选择器，无需再次请求。

使用场景：在您自己的 UI 中提供品牌选择器。 当用户打开您的发布界面时，调用此端点一次，并在每一行中显示 profileName 和 logo。如果某个品牌的 connectedChannelCount 为 0，则该品牌尚未关联任何社交账号，无法发布；请为其添加标记，并引导用户前往连接链接。当 pageInfo.hasNextPage 为 true 时，使用 page 和 size 继续分页。

使用场景：核对您的记录。 每晚遍历所有页面，并将 id 与您在创建时存储的品牌 ID 比对。从默认列表中消失的品牌已被归档；传入 filters={"statuses":["ARCHIVED"]} 即可查看该品牌。

注意事项。

id 是普通 UUID，在 Social API 的其他端点中用作路径参数 brandId，在请求体中用作 socialProfileId。
筛选条件以一个 JSON 编码的字符串通过 filters 查询参数传递，而不是通过多个独立参数传递。请对该字符串做 URL 编码。只要发送了 filters，其中就必须包含 statuses；也可以同时包含可选的 profileName。
分页基于偏移量（page / size），并非像 Locations 和 Reviews 端点那样基于游标。pageInfo.total 是匹配品牌的总数，而不是当前页的品牌数量。pageInfo.totalEngagementPosts 和 totalPublishedPosts 是与帖子列表共用的帖子计数器，在此处均为 0。
connectedChannelCount 仅统计活跃连接；渠道断开连接后会立即从计数中移除。要获取渠道本身的信息，请调用 GET /social/brands/{brandId}/connections。
timezone.tzCode 是 IANA 标识符，该品牌的所有定时安排都依据此标识符解析；其他 3 个时区字段是用于显示的标签。
品牌数量没有上限，无需据此核对。 API 套餐不限制品牌数量，因此此列表的长度仅供参考。有数量上限的是连接数：请从 GET /social/limits 读取该数值。归档品牌会立即使其连接离线，但连接名额在计费周期结束前仍计入 maxConnections，因此已从此列表中移除的品牌可能仍会占用名额，直到续订时才释放。