获取已保存受众详情
您可以使用本接口获取与某个广告账户绑定的已保存受众详情。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/dmp/saved_audience/list/
方法 GET
Header
| 字段 {30%}| 类型{15%} | 描述{55%} |
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
| 字段 {30%}| 类型{15%} | 描述{55%} |
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 |
| saved_audience_ids | string[] | 已保存受众 ID 列表。<br><br>最大数量：100。<br><br>若想创建已保存受众并获取已保存受众 ID，可使用 [/dmp/saved_audience/create/](1780154541898754.html)。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/dmp/saved_audience/list/?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 | 返回数据。 |
#| saved_audiences | object[] | 已保存受众列表。 |
##| saved_audience_id | string | 已保存受众ID。 |
##| saved_audience_name | string | 已保存受众名称。 |
##| location_ids | string[] | 您想要定向的地域ID列表。 |
##| gender | string | 定向受众性别。<br>枚举值: `GENDER_FEMALE`, `GENDER_MALE`, `GENDER_UNLIMITED`。 |
##| age_groups | string[] | 定向受众年龄。 <br>枚举值：[详见枚举值-受众年龄区间](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。 |
##| languages | string[] | 受众语言。 |
##| audience_ids | string[] | 受众ID列表。 |
##| excluded_audience_ids | string[] | 要排除的受众ID列表。 |
##| interest_category_ids | string[] | 兴趣分类。 |
##| interest_keyword_ids | string[] | 用于定向的兴趣关键词ID列表。 |
##| actions | object[] | 行为分类ID列表。 |
###| action_category_ids | string[] | 您想要定向的行为分类ID列表。 |
###| action_scene | string | 行为场景。枚举值：`VIDEO_RELATED`(视频行为)，`CREATOR_RELATED`（创作者互动行为），`HASHTAG_RELATED`（视频标签相关）。 |
###| action_period | number | 选择n天内发生的行为。<br>枚举值: `0`，`7`，`15`。如果`action_scene`为`CREATOR_RELATED`或`HASHTAG_RELATED`，不论您传入何值，系统将默认使用`0`。`0`表示不设置行为发生的明确时间范围。 |
###| video_user_actions | string[] | 视频相关行为。<ul><li>若`action_scene`为`VIDEO_RELATED`（视频类行为），枚举值为：`WATCHED_TO_END`(看完)，`LIKED`（点赞），`COMMENTED`（评论），`SHARED`（分享)。</li><li>若`action_scene`为`CREATOR_RELATED`（创作者互动行为），枚举值为：`FOLLOWING`（关注），`VIEW_HOMEPAGE`（浏览主页）。</li><li>若`action_scene`为`HASHTAG_RELATED`（标签相关行为），枚举值为： `VIEW_HASHTAG`（浏览标签）。</li></ul> |
##| operating_systems | string[] | 受众操作系统。 枚举值：`ANDROID`， `IOS`。只允许传入一个值。|
##| min_android_version | string | 受众最低Android版本。枚举值：详见[枚举值-最低Android版本](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。 |
##| min_ios_version | string | 受众最低iOS版本。<br>枚举值：详见[枚举值-最低iOS版本](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。 |
##| device_model_ids | string[] | 设备机型ID列表。 |
##| network_types | string[] | 网络类型。默认值：`unlimited`。 详见[枚举值-网络类型](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。 |
##| carrier_ids | string[] | 运营商 ID列表。 |
##| device_price_ranges | number[] | 设备价格区间（10000代表1000+）。<br>该数字必须是50的倍数。 <br><span style="color:darkred"><b>重要提示</b></span>：最终的实际上限将在您设定的上限基础上增加50，您可以在TikTok广告管理平台的广告组设置中看到实际上限。例如，如果您设置的价格区间是[0, 250]，实际区间则为[0, 300]。 |
#|page_info |object| 分页信息。 |
##|page |number| 当前页数。 |
##|page_size |number| 分页大小。 |
##|total_number |number| 总结果数。 |
##|total_page |number| 总页数。 |
示例
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"saved_audiences": [
{
"interest_keyword_ids": [
"{{interest_keyword_id}}"
],
"age_groups": [
"{{age_group}}"
],
"actions": [
{
"action_period": 0,
"action_category_ids": [
"2"
],
"video_user_actions": [
"FOLLOWING"
],
"action_scene": "CREATOR_RELATED"
}
],
"languages": [
"en"
],
"location_ids": [
"6252001",
"2077456"
],
"interest_category_ids": [
"14",
"16"
],
"network_types": [
"WIFI"
],
"saved_audience_name": "{{saved_audience_name}}",
"operating_systems": [
"ANDROID"
],
"device_model_ids": [],
"excluded_audience_ids": [
"{{excluded_audience_ids}}",
"{{excluded_audience_ids}}"
],
"saved_audience_id": "{{saved_audience_id}}",
"audience_ids": [
"{{audience_ids}}",
"{{audience_ids}}"
],
"device_price_ranges": [
0,
50,
100,
150,
200,
250,
300,
350,
400,
450,
500,
550,
600,
650,
700,
750,
800,
850,
900,
950,
1000
],
"carrier_ids": [
"{{carrier_id}}"
],
"gender": "GENDER_FEMALE",
"min_ios_version": "NONE",
"min_android_version": "10.0"
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_page": 1,
"total_number": 1
}
}
}
(/code)