获取受众应用记录
您可以使用本接口获取自定义受众的最新应用记录。请注意,本接口仅返回应用操作(action_mode = Apply)的记录。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/apply/log/
方法 GET
Header
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string|广告主 ID。|
|custom_audience_ids{必填} |string[]|自定义受众ID列表。<br><p><span style="color:darkred"><b>注意</b></span><br>广告主必须是`custom_audience_ids`的拥有者,否则将会报错。您可以使用[/dmp/custom_audience/list/](https://ads.tiktok.com/marketing_api/docs?id=1739940506015746)和 [/dmp/custom_audience/get/](https://ads.tiktok.com/marketing_api/docs?id=1739940507792385)返回的`is_creator`字段查看该广告主是否为该受众的拥有者。
|page|number|当前页数,默认值: 1。
|page_size|number|分页大小,默认值: 10。
|timezone|string|返回值的时区。获取枚举值,请参考[附录-时区信息](https://ads.tiktok.com/marketing_api/docs?id=1737586324313089)。<br>若不传,则使用UTC时区。
示例
(code)
curl --location -g --request GET 'https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/apply/log?advertiser_id="123"&custom_audience_ids=["123"]' \
--header 'Access-Token: 123' \
--data-raw ''
(/code)
返回
|字段|类型|描述|
|---|---|---|
|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|返回数据。|
#|advertiser_id|string|广告主ID。
#|list|list|应用数据的数组。
##|audience_id|string|受众ID。
##|adgroup_id|string|广告组ID。
##|adgroup_name|string|广告组名称。
##|usage_mode|string|该受众在广告组中的使用方式。枚举值:`Include`,`Exclude`.
##|editor|string|操作者。
##|action_timestamp|string|操作发生的时间。格式:"YYYY-MM-DD HH:MM:SS"。
#|page_info |object |分页信息。
##|page |number | 当前页码。
##|page_size |number |分页大小。
##|total_number |number | 总结果数。
##|total_page |number |总页数。
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "123",
"data": {
"advertiser_id": "123",
"page_info": {
"total_number": 8,
"page_size": 10,
"page": 1,
"total_page": 1
},
"list": [
{
"audience_id": "123",
"adgroup_name": "123",
"action_timestamp": "2022-06-15 11:31:00",
"editor": "123",
"usage_mode": "Include",
"adgroup_id": "123"
},
{
"audience_id": "123",
"adgroup_name": "123",
"action_timestamp": "2023-01-23 22:49:06",
"editor": "123",
"usage_mode": "Exclude",
"adgroup_id": "123"
}
]
}
}
(/code);