人群报表
全部接口
V1.1
loading
V1.1
loading
所属权限 | Audience Management |
请求地址 | custom_audience_reports/get |
请求方法 | get |
全局参数
全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考。
参数名称 | 参数类型 |
---|---|
access_token | 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节 |
timestamp |
当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。 MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳 MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59 |
nonce | 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性 |
fields | get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回 |
请求参数
标有*的参数为必填项
名称 | 类型 | 描述 |
---|---|---|
account_id*
|
integer | 指定查询的广告主 id |
filtering*
|
struct[] | 过滤条件,详见 [过滤条件] |
field*
|
string | 过滤字段, 可选值:{ account_id, audience_id, audience_platform, adgroup_id, campaign_id, action_type, model_id, audience_predict_task_id }(注:audience_id 和 audience_platform 需要同时填写) |
operator*
|
enum | 当 field 取值 audience_platform 时,枚举列表:{ EQUALS };当 field 取值 account_id,audience_id,adgroup_id,campaign_id,action_type,model_id,audience_predict_task_id 时,枚举列表:{ IN } |
values*
|
string[] | 字段取值,values 数组的个数限制与 operator 的取值相关,当 field 取值 account_id,audience_id,adgroup_id,campaign_id,action_type,model_id,audience_predict_task_id 时,values 数组元素个数限制为 1 个,详见 [过滤条件] 当 field 取值 audience_platform 时, 枚举列表:{ DMP, TDC, TDP } 当 field 取值 action_type 且 operator 取值 IN 时, 枚举列表:{ CLICK, EXPOSURE, ORDER, APP_FINISH_DOWNLOAD, APP_INSTALL, APP_ACTIVATE, REGISTRATION_APP, APP _ONE_DAY_RETENTION, ADD_TO_CART_APP, APP_PURCHASE, APP_APPLY, REGISTRATION_WEB, ADD_TO_CART_WEB, WEB_ONLINE_CONSULT, WEB_MAKE_PHONE_CALL, WEB_RESERVE_PHONE_NUMBER, WEB_RESERVATION, APPLY_WEB, WEB_DELIVER, PURCHASE_WEB, WEB_VIEW_COMMODITY_PAGE } |
date_range*
|
struct | 时间范围,日期格式,{"start_date":"2019-05-06","end_date":"2019-05-06"},时间跨度最多 30 天 |
start_date*
|
string | 开始时间,大于等于 2019-05-06,不能早于 1 年前,且小于 end_date 字段长度为 10 字节 |
end_date*
|
string | 结束时间,小于今天,且大于 start_date 字段长度为 10 字节 |
group_by
|
string[] | 聚合参数,可选值{ account_id,audience_id,adgroup_id,wechat_adgroup_id,campaign_id,wechat_campaign_id,action_type,model_id,audience_predict_task_id } |
请求示例
curl -G 'https://api.e.qq.com/v1.1/custom_audience_reports/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=25610' \
-d 'filtering=[{"field":"adgroup_id","operator":"IN","values":["102000060"]},{"field":"action_type","operator":"IN","values":["CLICK","EXPOSURE"]}]' \
-d 'date_range={"start_date":"2019-05-06","end_date":"2019-05-17"}' \
-d 'group_by=["account_id","audience_id","action_type"]'
应答字段
名称 | 类型 | 描述 |
---|---|---|
list
|
struct[] | 返回数组列表 |
audience_id
|
integer | 人群 id |
account_id
|
integer | 指定查询的广告主 id |
adgroup_id
|
int64 | 广告组 id |
campaign_id
|
int64 | 推广计划 id |
wechat_adgroup_id
|
integer | 广告组 id |
wechat_campaign_id
|
integer | 推广计划 id |
model_id
|
integer | 模型 id |
audience_predict_task_id
|
integer | 人群预测任务 id |
action_type
|
enum | 人群报表行为类型,[枚举详情] |
cost
|
integer | 消耗,单位为分 |
action_count
|
integer | 行为发生次数 |
user_count
|
integer | 行为发生人数 |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"account_id": 25610,
"audience_id": 5600762,
"action_type": "CLICK",
"cost": 85000,
"action_count": 876,
"user_count": 829
},
{
"account_id": 25610,
"audience_id": 5600762,
"action_type": "EXPOSURE",
"cost": 0,
"action_count": 78162,
"user_count": 32161
}
]
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务