获取 GMV Max 推广系列可用的认证身份
您可使用本接口获取与某个 TikTok Shop 绑定的认证身份列表,以及这些认证身份是否可用于 GMV Max 推广系列。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/gmv_max/identity/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。<br>可以通过[获取访问令牌](1738373164380162.html)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 |
| 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。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/gmv_max/identity/get/?advertiser_id={{advertiser_id}}&store_id={{store_id}}&store_authorized_bc_id={{store_authorized_bc_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| 返回数据。 |
#| identity_list | object[] |与该 TikTok Shop 绑定的认证身份列表。 |
##| identity_id | string | 认证身份 ID。|
##| identity_type | string | 认证身份类型。 <br><br>枚举值: <ul><li>`AUTH_CODE`:授权用户。当您使用授权码访问 TikTok 账户或 TikTok 帖子时,系统将创建此类型的认证身份。</li><li>`TT_USER`:TikTok 用户。当您绑定 TikTok For Business 账户与 TikTok 企业号,或将 TikTok For Business 账户与普通 TikTok 账户绑定后,将 TikTok 账户升级为企业号时,系统将创建此类型的认证身份。</li><li>`BC_AUTH_TT`:添加到商务中心的 TikTok 用户。当您将 TikTok 账号添加到商务中心,并从 TikTok 账号主获得访问批准后,系统将创建此类型的认证身份。 </li><li>`TTS_TT`:TikTok Shop 关联的 TikTok 用户。当您为 TikTok Shop 设置官方 TikTok 账号后,系统将创建此类型的认证身份。</li></ul> |
##|identity_authorized_bc_id | string | 仅当 `identity_type` 为 `BC_AUTH_TT` 时返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的商务中心的 ID。 |
##| identity_authorized_shop_id | string |仅为部分 `BC_AUTH_TT` 认证身份返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
##| store_id | string | 仅当 `identity_type` 为 `TTS_TT` 时返回本字段。<br><br>与 TikTok Shop 关联的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
##| profile_image | string | 与该认证身份绑定的 TikTok 账号的主页头像临时 URL。 <br><br>有效期:约 48 小时。过期时间包含在 `x-expires` 参数后的 URL 中,格式为以秒为单位的 Epoch/Unix 时间戳。<br><br>URL 过期后,您需要调用[/gmv_max/identity/get/](1822001101474882.html) 获取新的 URL。|
##| display_name | string | 与该认证身份绑定的 TikTok 账号的展示名称。 |
##| user_name | string | 与该认证身份绑定的 TikTok 账号的用户名。 |
##| is_running_custom_shop_ads | boolean | 该认证身份是否被处于启用状态的视频购物广告,商品购物广告或 直 播购物广告占用。<br><br>支持的值:`true`,`false`。|
##| product_gmv_max_available | boolean | 该认证身份是否可用于商品 GMV Max 推广系列。<br><br>支持的值:`true`,`false`。 |
##| live_gmv_max_available | boolean | 该认证身份是否可用于直播 GMV Max 推广系列。 <br><br>支持的值:`true`,`false`。|
##| unavailable_reason | string | 仅当 `live_gmv_max_available` 为 `false` 时返回本字段。<br><br>该认证身份不可用于直播 GMV Max 推广系列的原因。<br><br>枚举值: <ul><li>`OCCUPIED`:该认证身份已被一个处于启用状态的直播 GMV Max 推广系列占用。</li><li>`UNAUTHORIZED`:该认证身份无在直播 GMV Max 推广系列中使用的授权。</li></ul>|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"identity_list": [
{
"display_name": "{{display_name}}",
"identity_authorized_bc_id": "{{identity_authorized_bc_id}}",
"identity_id": "{{identity_id}}",
"identity_type": "BC_AUTH_TT",
"is_running_custom_shop_ads": false,
"live_gmv_max_available": false,
"product_gmv_max_available": true,
"profile_image": "{{profile_image}}",
"unavailable_reason": "OCCUPIED",
"user_name": "{{user_name}}"
},
{
"display_name": "{{display_name}}",
"identity_authorized_bc_id": "{{identity_authorized_bc_id}}",
"identity_id": "{{identity_id}}",
"identity_type": "BC_AUTH_TT",
"is_running_custom_shop_ads": false,
"live_gmv_max_available": false,
"product_gmv_max_available": true,
"profile_image": "{{profile_image}}",
"unavailable_reason": "UNAUTHORIZED",
"user_name": "{{user_name}}"
},
{
"display_name": "{{display_name}}",
"identity_authorized_bc_id": "{{identity_authorized_bc_id}}",
"identity_id": "{{identity_id}}",
"identity_type": "BC_AUTH_TT",
"is_running_custom_shop_ads": false,
"live_gmv_max_available": false,
"product_gmv_max_available": true,
"profile_image": "{{profile_image}}",
"unavailable_reason": "OCCUPIED",
"user_name": "{{user_name}}"
},
{
"display_name": "{{display_name}}",
"identity_authorized_bc_id": "{{identity_authorized_bc_id}}",
"identity_id": "{{identity_id}}",
"identity_type": "BC_AUTH_TT",
"is_running_custom_shop_ads": false,
"live_gmv_max_available": true,
"product_gmv_max_available": true,
"profile_image": "{{profile_image}}",
"user_name": "{{user_name}}"
},
{
"display_name": "{{display_name}}",
"identity_authorized_bc_id": "{{identity_authorized_bc_id}}",
"identity_id": "{{identity_id}}",
"identity_type": "BC_AUTH_TT",
"is_running_custom_shop_ads": false,
"live_gmv_max_available": false,
"product_gmv_max_available": true,
"profile_image": "{{profile_image}}",
"unavailable_reason": "OCCUPIED",
"user_name": "{{user_name}}"
},
{
"identity_id": "{{identity_id}}",
"identity_type": "TTS_TT",
"is_running_custom_shop_ads": false,
"live_gmv_max_available": false,
"product_gmv_max_available": false,
"store_id": "{{store_id}}",
"unavailable_reason": "UNAUTHORIZED"
},
{
"display_name": "{{display_name}}",
"identity_id": "{{identity_id}}",
"identity_type": "TT_USER",
"is_running_custom_shop_ads": false,
"live_gmv_max_available": false,
"product_gmv_max_available": false,
"profile_image": "{{profile_image}}",
"unavailable_reason": "UNAUTHORIZED",
"user_name": "{{user_name}}"
}
]
}
}
(/code)