获取成员列表
商务中心的管理员用户可以使用本接口获取商务中心下的成员列表及信息。
如果您需要获取某个成员的资产信息,可以使用/bc/asset/get/接口。您需要传入user_id或user_email。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/bc/member/get/| /v1.3/bc/member/get/|
|请求参数类型|bc_id: number |bc_id: string |
|返回参数类型|user_id: number |user_id`: string |
## 请求
**地址**
https://business-api.tiktok.com/open_api/v1.3/bc/member/get/
**方法** GET
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权access_token,可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。 |
参数
|字段|类型|描述|
|---|---|---|
|bc_id {必填}|string| 商务中心id|
|page |number|当前页数|
|page_size |number|分页大小。最大值:20。|
|filtering |object| 筛选条件 |
#|keyword |string| 关键词|
#| user_role | string | 用户在商务中心的基础角色。枚举值:<ul><li>`ADMIN`:管理员可以管理商务中心的成员和资产。<li>`STANDARD`:标准成员只能处理分配给他们的广告账户。 |
#| relation_status | string | 用户与商务中心的关系状态,显示用户是否已加入商务中心。枚举值:<ul><li>`BOUND`: 管理资产的申请已获拥有者批准。</li><li>`PENDING`: 管理资产的申请正在等待拥有者批准。</li><li>`REJECTED`: 管理资产的申请已被拥有者拒绝。</li></ul>|
示例
(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "bc_id=BC_ID" \
--data-urlencode "page=PAGE" \
--data-urlencode "page_size=PAGE_SIZE" \
--data-urlencode "filtering={\"keyword\": \"KEYWORD\", \"user_role\": \"USER_ROLE\", \"relation_status\": \"RELATION_STATUS\"}" \
https://business-api.tiktok.com/open_api/v1.3/bc/member/get/
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097) |
|message |string|返回信息,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097) |
|data |object|返回数据。 |
#|list|object[]|成员信息。|
##| user_id | string |用户 ID。 |
##| user_name | string | 用户名称。 |
##| user_role | string | 用户在商务中心中的角色。 |
##| relation_status | string | 用户在商务中心的状态。|
##| user_email | string |成员邮箱地址。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>为保护成员的个人信息安全,部分邮箱地址将默认进行脱敏处理。例如,邮箱地址`user@example.com` 将处理为 `u**r@example.com`。不过,您可申请白名单,从而获取所有成员的完整邮箱地址。</li><li>获取商务中心所有成员的完整邮箱地址目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。</li></ul>|
##| ext_user_role | object | 用户在商务中心除基本角色外的扩展角色。|
###| finance_role | string | 用户财务角色。枚举值:`MANAGER`, `ANALYST`。 |
#|page_info|object| 分页信息。 |
##|page|number| 当前页数。 |
##|page_size|number| 分页大小。 |
##|total_number|number| 总数。 |
##|total_page|number| 总页数。 |
|request_id |string|请求的日志id,唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"list": [
{
"user_id": null,
"ext_user_role": {
"finance_role": null
},
"relation_status": "BOUND",
"user_name": null,
"user_role": "ADMIN",
"user_email": "{{user_email}}"
},
{
"user_id": null,
"ext_user_role": {
"finance_role": null
},
"relation_status": "PENDING",
"user_name": null,
"user_role": "STANDARD",
"user_email": "{{user_email}}"
}
],
"page_info": {
"total_number": 2,
"page": 1,
"page_size": 20,
"total_page": 1
}
}
}
(/code)