接口文档SDK业务专题开发者工具

获取定向标签报表
全部接口
V1.1
loading

所属权限 Ads Insights
请求地址 targeting_tag_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,有操作权限的帐号 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 }

微信公众账号逻辑

微信公众平台广告主仅可使用:{CITY,PROVINCE,AGE_GENDER,INTEREST}
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 }

微信公众账号逻辑

枚举列表:{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 }

微信公众账号逻辑

仅支持 REPORTING_TIME

使用说明

  1. 当 age(年龄)返回为 13 的时候,表示 13 岁及以下的人群,当 age(年龄)返回为 66 的时候,表示 66 岁及以上的人群。
  2. 微信广告主不支持 order_by、group_by、time_line。

请求示例


curl -G 'https://api.e.qq.com/v1.1/targeting_tag_reports/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'type=GENDER' \
-d 'level=CAMPAIGN' \
-d 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
-d 'filtering=[{"field":"campaign_id","operator":"EQUALS","values":[456792]}]' \
-d 'group_by=["date"]' \
-d 'order_by=[{"sort_field":"impression","sort_type":"ASCENDING"}]' \
-d 'page=1' \
-d 'page_size=10' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数

应答示例

{
    "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
        }
    }
}

可视化调试工具

相关阅读