获取广告账号的 TikTok Shop 专属授权状态
您可以使用本接口检查某个广告账号针对某个 TikTok Shop 是否获取了创建 GMV Max 推广系列的专属授权。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/gmv_max/exclusive_authorization/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。<br>可以通过[获取访问令牌](1738373164380162.html)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| store_id {必填} | string | TikTok Shop ID。<br><br> 若想获取可用于 GMV Max 推广系列的 TikTok Shop,可使用 [/gmv_max/store/list/](1822001044479041.html) 并确认返回的 `is_gmv_max_available` 为 `true`。 |
| store_authorized_bc_id {必填} | string |有权限访问该 TikTok Shop(`store_id`)的商务中心的 ID。 |
| advertiser_id {必填} | string | 用于查询 GMV Max 专属授权状态的广告账户 ID。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/gmv_max/exclusive_authorization/get/?store_id={{store_id}}&store_authorized_bc_id={{store_authorized_bc_id}}&advertiser_id={{advertiser_id}}' \
--header 'Access-Token:{{Access-Token}}'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number| 返回码。完整返回码列表及描述,参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string| 返回信息。更多信息参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string| 请求的日志 ID,唯一标识一个请求。 |
|data |object| 返回数据。 |
#| store_id | string | TikTok Shop 的 ID。|
#| advertiser_id | string | 广告账户的 ID。|
#| authorization_status | string | 该广告账户使用此 TikTok Shop 创建 GMV Max 推广系列的专属授权状态。<br><br>枚举值:<ul><li>`EFFECTIVE`:该广告账号目前拥有 GMV Max 专属授权。</li><li>`INEFFECTIVE`:该广告账号拥有过 GMV Max 专属授权,但专属授权已取消。</li><li>`UNAUTHORIZED`:该广告账号尚未拥有 GMV Max 专属授权。</li></ul>|
#| advertiser_name | string | 广告账户的名称。<br><br><p><span style="color:darkred"><b>注意</b></span>:`authorization_status` 为 `UNAUTHORIZED` 时,不返回本字段。 |
#| advertiser_status | string | 广告账户的状态。 <br><br>枚举值:<ul><li>`STATUS_ENABLE`:审核通过。</li><li>`STATUS_CONFIRM_FAIL`:未通过审核。</li><li>`STATUS_PENDING_CONFIRM`:正在审核。</li><li>`STATUS_LIMIT`:暂时停用。</li><li>`STATUS_CONTRACT_PENDING`:合同未生效。</li><li>`STATUS_DISABLE`:永久停用。</li><li>`STATUS_PENDING_CONFIRM_MODIFY`:修改待审核。</li><li>`STATUS_PENDING_VERIFIED`待验证。</li><li>`STATUS_SELF_SERVICE_UNAUDITED`:自助开户待验证资质。</li><li> `STATUS_WAIT_FOR_BPM_AUDIT`:CRM 系统待审核。</li><li>`STATUS_CONFIRM_FAIL_END`:CRM 系统未通过审核。 </li><li>`STATUS_CONFIRM_MODIFY_FAIL`:修改未通过审核。 </li></ul><br><p><span style="color:darkred"><b>注意</b></span>:`authorization_status` 为 `UNAUTHORIZED` 时,不返回本字段。|
#| identity_id | string |仅当 TikTok Shop 设置了官方 TikTok 账号时返回本字段。 <br><br> 与 TikTok Shop 的官方 TikTok 账号绑定的认证身份 ID。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"advertiser_id": "{{advertiser_id}}",
"advertiser_name": "{{advertiser_name}}",
"advertiser_status": "STATUS_ENABLE",
"authorization_status": "EFFECTIVE",
"identity_id": "{{identity_id}}",
"store_id": "{{store_id}}"
}
}
(/code)