获取定向标签报表
开发环境
开发环境
GET
/v1.3/targeting_tag_reports/get
请求参数
名称 | 类型 | 描述 |
---|---|---|
account_id* | integer | 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id |
type* | string | 接口类型,腾讯广告平台广告主仅可使用:{GENDER,AGE,REGION,CITY,REGION_RECENTLY_IN,CITY_RECENTLY_IN,REGION_VISITED_IN,REGION_LIVE_IN,REGION_TRAVEL_IN,CITY_VISITED_IN,CITY_LIVE_IN,CITY_TRAVEL_IN,BEHAVIOR_INTEREST_INTENTION,CUSTOM_AUDIENCE} 可选值:{ GENDER, AGE, REGION, CITY, REGION_RECENTLY_IN, CITY_RECENTLY_IN, REGION_VISITED_IN, REGION_LIVE_IN, REGION_TRAVEL_IN, CITY_VISITED_IN, CITY_LIVE_IN, CITY_TRAVEL_IN, INTEREST, AGE_GENDER, PROVINCE, BEHAVIOR_INTEREST_INTENTION, CUSTOM_AUDIENCE } |
level* | string | 获取定向标签报表类型级别,AD 仅在 type 取值为 {BEHAVIOR_INTEREST_INTENTION,CUSTOM_AUDIENCE} 时可用, PROMOTED_OBJECT 仅在 type 取值为 CUSTOM_AUDIENCE 时可用 可选值:{ ADVERTISER, CAMPAIGN, ADGROUP, AD, PROMOTED_OBJECT } |
date_range* | struct | 日期范围,最早支持查询 1 年内(365 天)的数据 |
start_date* | string | 开始日期,日期格式:YYYY-MM-DD,且小于等于 end_date 字段长度为 10 字节 |
end_date* | string | 结束日期,日期格式:YYYY-MM-DD,且大于等于 begin_date 字段长度为 10 字节 |
pos_type | enum | 微信广告位,腾讯广告平台广告主不可用, 微信公众账号广告主必填,[枚举详情] 枚举列表:{ POSITION_TYPE_WECHAT_MOMENTS, POSITION_TYPE_WECHAT_OTHERS } |
filtering | struct[] | 过滤条件,若此字段不传,或传空则视为无限制条件,当 level 为 CAMPAIGN,ADGROUP 或 AD 时,该字段必填,详见 [过滤条件] 数组最小长度 1,最大长度 2 |
field* | string | 过滤字段,当 level 为 CAMPAIGN 时,field 仅可选择 campaign_id; 当 level 为 ADGROUP 时,field 仅可选择 adgroup_id; 当 level 为 AD 时,field 仅可选择 ad_id; 当 type 为 AGE_GENDER 时,field 可选择 gender; 当 type 为 INTEREST 时,field 可选择 interest; 可选值:{ campaign_id, adgroup_id, ad_id, gender, interest } |
operator* | enum | 操作符 当 field 取值 adgroup_id 时,枚举列表:{ EQUALS, IN } 当 field 取值 campaign_id 时,枚举列表:{ EQUALS, IN } 当 field 取值 ad_id 时,枚举列表:{ EQUALS, IN } 当 field 取值 gender 时,枚举列表:{ EQUALS } 当 field 取值 interest 时,枚举列表:{ EQUALS } |
values* | string[] | 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件] 当 field 取值 gender 时, 枚举列表:{ MALE, FEMALE, ALL, NOT_SEPARATE } 当 field 取值 interest 时, 枚举列表:{ FIRST, SECOND, THIRD, FOURTH, KEYWORD } |
group_by | string[] | 聚合参数,见 [聚合规则] 数组最小长度 1,最大长度 4 字段长度最大 255 字节 |
order_by | struct[] | 排序字段 数组长度为 1 |
sort_field* | string | 排序字段,排序字段,需为 fields 字段中指定返回字段的子集,字段类型为数值类的指标均支持排序 |
sort_type* | enum | 排序方式,[枚举详情] 枚举列表:{ ASCENDING, DESCENDING } |
page | integer | 搜索页码,默认值:1 最小值 1,最大值 99999 |
page_size | integer | 一页显示的数据条数,默认值:10 最小值 1,最大值 1000 |
time_line | enum | 时间口径,腾讯广告账户仅支持 REQUEST_TIME,[枚举详情] 枚举列表:{ REQUEST_TIME, REPORTING_TIME, ACTIVE_TIME } |
weixin_official_accounts_upgrade_enabled | boolean | 针对微信公众号账户是否使用升级的新调用方式,true:使用升级的新方式,false:不使用,不传则默认值 false ;详细情况请查看公告[Marketing API 微信公众平台账户服务升级] 可选值:{ true, false } |
adq_accounts_upgrade_enabled | boolean | 针对腾讯广告平台广告账户是否使用升级的新调用方式,true:使用升级的新方式,可以调用新指标体系; false:不使用,仅能调用旧指标体系,不传则默认值 false ; 可选值:{ true, false } |
使用说明 1.当 age(年龄)返回为 13 的时候,表示 13 岁及以下的人群,当 age(年龄)返回为 65 的时候,表示 65 岁及以上的人群。 2.微信广告主不支持 order_by、group_by、time_line。 3.该接口所有涉及金额的字段,单位为分。 4.腾讯广告投放平台升级全新的指标体系,请及时改造。详细升级情况及新老指标体系映射关系请查看公告[腾讯广告投放端-指标升级指引]。当您使用新的指标调用方式时(即 adq_accounts_upgrade_enabled 传 true),您可以请求新指标体系内指标。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.3/targeting_tag_reports/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'fields;' \
--data-urlencode 'account_id=<ACCOUNT_ID>' \
--data-urlencode 'type=GENDER' \
--data-urlencode 'level=CAMPAIGN' \
--data-urlencode 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
--data-urlencode 'filtering=[{"field":"campaign_id","operator":"EQUALS","values":[456792]}]' \
--data-urlencode 'group_by=["date"]' \
--data-urlencode 'order_by=[{"sort_field":"impression","sort_type":"ASCENDING"}]' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=10'
响应示例响应示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"date": "2017-04-25",
"gender": "FEMALE",
"cost": 1200,
"activation": 0,
"click": 1200,
"conversion": 0,
"download": 0,
"impression": 12000,
"register": 0,
"reservation": 0
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}
请求参数
Header 参数
access_token
string
必需
默认值:
<ACCESS_TOKEN>
timestamp
string
必需
MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8,例如当时间戳为1494840119时,表示 2018-05-15 17:21:59
默认值:
<TIMESTAMP>
nonce
string
必需
默认值:
<NONCE>
fields
string
必需
Body 参数application/x-www-form-urlencoded
account_id
integer
必需
示例值:
<ACCOUNT_ID>
type
string
必需
可选值:{ GENDER, AGE, REGION, CITY, REGION_RECENTLY_IN, CITY_RECENTLY_IN, REGION_VISITED_IN, REGION_LIVE_IN, REGION_TRAVEL_IN, CITY_VISITED_IN, CITY_LIVE_IN, CITY_TRAVEL_IN, INTEREST, AGE_GENDER, PROVINCE, BEHAVIOR_INTEREST_INTENTION, CUSTOM_AUDIENCE }
示例值:
GENDER
level
string
必需
可选值:{ ADVERTISER, CAMPAIGN, ADGROUP, AD, PROMOTED_OBJECT }
示例值:
CAMPAIGN
date_range
string
必需
示例值:
{"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}
filtering
string
可选
数组最小长度 1,最大长度 2
示例值:
[{"field":"campaign_id","operator":"EQUALS","values":[456792]}]
group_by
string
可选
数组最小长度 1,最大长度 4
字段长度最大 255 字节
示例值:
["date"]
order_by
string
可选
数组长度为 1
示例值:
[{"sort_field":"impression","sort_type":"ASCENDING"}]
page
integer
可选
最小值 1,最大值 99999
示例值:
1
page_size
integer
可选
最小值 1,最大值 1000
示例值:
10
返回响应
修改于 2023-11-07 08:20:17