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

广告数据洞察 (Ad Insights)

V1.1

loading


本节将为您介绍广告数据洞察 (Ad Insights) 相关接口。 Marketing API 支持查询帐号层级、推广计划层级、广告组层级等多个维度的日报表和小时报表,同时还支持基于性别、年龄、地域三个定向维度的广告人群分析。关于广告数据洞察更详细的介绍可以参考【广告数据洞察】章节。

特别注意:联盟广告位级别报表(REPORT_LEVEL_UNION_POSITION)目前仅灰度开放。


获取日报表
全部接口
V1.1
loading

所属权限 Ads Insight
请求地址 daily_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
level*
enum 获取报表类型级别,获取报表类型级别,腾讯广告平台广告主仅可使用:{REPORT_LEVEL_ADVERTISER, REPORT_LEVEL_CAMPAIGN, REPORT_LEVEL_ADGROUP, REPORT_LEVEL_AD, REPORT_LEVEL_PROMOTED_OBJECT, REPORT_LEVEL_UNION_POSITION, REPORT_LEVEL_CREATIVE_TEMPLATE, REPORT_LEVEL_EXPAND_TARGETING_ADGROUP, REPORT_LEVEL_MATERIAL_VIDEO, REPORT_LEVEL_MATERIAL_IMAGE, REPORT_LEVEL_PRODUCT_CATELOG},[枚举详情]
枚举列表:{ REPORT_LEVEL_ADVERTISER, REPORT_LEVEL_CAMPAIGN, REPORT_LEVEL_ADGROUP, REPORT_LEVEL_AD, REPORT_LEVEL_PROMOTED_OBJECT, REPORT_LEVEL_UNION_POSITION, REPORT_LEVEL_CREATIVE_TEMPLATE, REPORT_LEVEL_EXPAND_TARGETING_ADGROUP, REPORT_LEVEL_MATERIAL_VIDEO, REPORT_LEVEL_MATERIAL_IMAGE, REPORT_LEVEL_PRODUCT_CATELOG, REPORT_LEVEL_ADVERTISER_WECHAT, REPORT_LEVEL_CAMPAIGN_WECHAT, REPORT_LEVEL_ADGROUP_WECHAT, REPORT_LEVEL_AD_WECHAT }

微信公众账号逻辑

仅可使用:{REPORT_LEVEL_ADVERTISER_WECHAT, REPORT_LEVEL_CAMPAIGN_WECHAT, REPORT_LEVEL_ADGROUP_WECHAT, REPORT_LEVEL_AD_WECHAT}
date_range*
struct 日期范围,最早支持查询 1 年内(365 天)的数据
start_date*
string 开始日期,日期格式:YYYY-MM-DD,且小于等于 end_date
字段长度为 10 字节
end_date*
string 结束日期,日期格式:YYYY-MM-DD,且大于等于 begin_date
字段长度为 10 字节
filtering
struct[] 过滤条件,若此字段不传,或传空则视为无限制条件,若获取联盟广告位信息此字段必填,详见 [过滤条件]
数组最小长度 1,最大长度 5
field*
string 过滤字段,腾讯广告平台广告主:当 level 为 REPORT_LEVEL_CAMPAIGN 时,field 仅可选择 campaign_id; 当 level 为 REPORT_LEVEL_ADGROUP 时,field 可选择 adgroup_id, campaign_id; 当 level 为 REPORT_LEVEL_AD 时,field 仅可选择为 ad_id, adgroup_id, campaign_id ;当 level 为 REPORT_LEVEL_PROMOTED_OBJECT 时,field 可选择 promoted_object_type 和 promoted_object_id;当 level 为 REPORT_LEVEL_UNION_POSITION 时,field 仅可选择为 promoted_object_type , promoted_object_id , union_position_id;当 level 为 REPORT_LEVEL_CREATIVE_TEMPLATE 时,field 仅可选择为 template_id;当 level 为 REPORT_LEVEL_EXPAND_TARGETING_ADGROUP 时,field 仅可选择为 adgroup_id;当 level 为 REPORT_LEVEL_PRODUCT_CATELOG 时,field 必须选择 product_catalog_id
可选值:{ adgroup_id, campaign_id, ad_id, promoted_object_type, promoted_object_id, union_position_id, template_id, bid_type, product_catalog_id }

微信公众账号逻辑

当 level 为 REPORT_LEVEL_CAMPAIGN_WECHAT 时,field 仅可选择 campaign_id; 当 level 为 REPORT_LEVEL_ADGROUP_WECHAT 时,field 可选择 adgroup_id, campaign_id; 当 level 为 REPORT_LEVEL_AD_WECHAT 时,field 仅可选择为 ad_id, adgroup_id, campaign_id
operator*
enum 操作符
当 field 取值 adgroup_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 campaign_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 ad_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 promoted_object_type 时,枚举列表:{ EQUALS, IN }
当 field 取值 promoted_object_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 union_position_id 时,枚举列表:{ EQUALS }
当 field 取值 template_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 bid_type 时,枚举列表:{ EQUALS }
当 field 取值 product_catalog_id 时,枚举列表:{ EQUALS }
values*
string[] 字段取值,values 数组元素的个数限制与 operator 的取值相关,当 level 为 REPORT_LEVEL_UNION_POSITION 时,promoted_object_type , promoted_object_id , union_position_id , template_id, bid_type 的 values 数组元素个数限制为 1 个,详见 [过滤条件]

当 field 取值 promoted_object_type 时,
枚举列表:{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT, PROMOTED_OBJECT_TYPE_QQ_BROWSER_MINI_PROGRAM, PROMOTED_OBJECT_TYPE_LINK, PROMOTED_OBJECT_TYPE_QQ_MESSAGE, PROMOTED_OBJECT_TYPE_QZONE_VIDEO_PAGE, PROMOTED_OBJECT_TYPE_LOCAL_ADS, PROMOTED_OBJECT_TYPE_ARTICLE, PROMOTED_OBJECT_TYPE_LEAD_AD, PROMOTED_OBJECT_TYPE_TENCENT_KE, PROMOTED_OBJECT_TYPE_EXCHANGE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_QZONE_PAGE_ARTICLE, PROMOTED_OBJECT_TYPE_QZONE_PAGE_IFRAMED, PROMOTED_OBJECT_TYPE_QZONE_PAGE, PROMOTED_OBJECT_TYPE_APP_PC, PROMOTED_OBJECT_TYPE_MINI_GAME_WECHAT, PROMOTED_OBJECT_TYPE_MINI_GAME_QQ }

当 field 取值 promoted_object_type 且 operator 取值 IN 时,
枚举列表:{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT, PROMOTED_OBJECT_TYPE_QQ_BROWSER_MINI_PROGRAM, PROMOTED_OBJECT_TYPE_LINK, PROMOTED_OBJECT_TYPE_QQ_MESSAGE, PROMOTED_OBJECT_TYPE_QZONE_VIDEO_PAGE, PROMOTED_OBJECT_TYPE_LOCAL_ADS, PROMOTED_OBJECT_TYPE_ARTICLE, PROMOTED_OBJECT_TYPE_LEAD_AD, PROMOTED_OBJECT_TYPE_TENCENT_KE, PROMOTED_OBJECT_TYPE_EXCHANGE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_QZONE_PAGE_ARTICLE, PROMOTED_OBJECT_TYPE_QZONE_PAGE_IFRAMED, PROMOTED_OBJECT_TYPE_QZONE_PAGE, PROMOTED_OBJECT_TYPE_APP_PC, PROMOTED_OBJECT_TYPE_MINI_GAME_WECHAT, PROMOTED_OBJECT_TYPE_MINI_GAME_QQ }


当 field 取值 bid_type 时,
枚举列表:{ BID_TYPE_CPC, BID_TYPE_CPM }
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, REPORTING_TIME, ACTIVE_TIME }

微信公众账号逻辑

仅支持 REPORTING_TIME
fields
string[] 指定返回的字段列表
数组最小长度 1,最大长度 256
字段长度最小 1 字节,长度最大 64 字节

使用说明

  1. 视频相关指标仅在如下场景可以获取,报表层级为{REPORT_LEVEL_ADGROUP, REPORT_LEVEL_AD, REPORT_LEVEL_CREATIVE_TEMPLATE}。
  2. 涉及视频指标范围:video_outer_play10_count(10%进度播放量),video_outer_play25_count(25%进度播放量),video_outer_play50_count(50%进度播放量),video_outer_play75_count(75%进度播放量),video_outer_play95_count(95%进度播放量),video_outer_play100_count(100%进度播放量),video_outer_play_time_count(平均有效播放时长),video_outer_play_time_avg_rate(平均有效播放进度),video_outer_play_rate(有效播放率),video_outer_play_cost(有效播放成本)。
  3. level 取值 REPORT_LEVEL_PRODUCT_CATELOG 时,group_by 的使用规则如下: 1)按商品信息层级聚合:单选,支持按如下层级聚合,商品 id(product_outer_id),商品系列(product_set_id),品牌 id(brand_id),店铺 id(shop_id),一级类目 id(first_category_id),二级类目 id(second_category_id ),三级类目 id(third_category_id),例如:希望获取商品系列的整账户表现,可指定 group by product_set_id ; 2)按数据层级聚合:单选,支持按如下数据层级聚合,账户(不指定时默认为账户),计划(campaign_id),广告组(adgroup_id),广告(ad_id),例如:希望获取计划层级的商品库报表,可指定 group by campaign id ; 3)按商品信息层级(单选)x 数据层级(单选)聚合进行,例如:希望获取商品*计划粒度的报表数据,可指定 groupby product_outer_id campaign id。
  4. 商品报表仅支持查看指定商品库下,单日花费最高的 10000 条商品的效果数据。

请求示例


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

应答字段

名称 类型 描述
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-05-01",
                "campaign_id": "<CAMPAIGN_ID>",
                "adgroup_id": "<ADGROUP_ID>",
                "ad_id": "<AD_ID>",
                "cost": 1200,
                "image_click": 0,
                "like_or_comment": 0,
                "app_payment_count": 0,
                "app_payment_amount": 0,
                "app_installation": 0,
                "activation": 0,
                "click": 1200,
                "conversion": 0,
                "download": 0,
                "follow": 0,
                "impression": 12000,
                "order_placement": 0,
                "register": 0,
                "reservation": 0,
                "share": 0
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具

相关阅读

获取小时报表
全部接口
V1.1
loading

所属权限 Ads Insight
请求地址 hourly_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
level*
enum 获取报表类型级别,获取报表类型级别,腾讯广告平台广告主仅可使用:{REPORT_LEVEL_ADVERTISER, REPORT_LEVEL_CAMPAIGN, REPORT_LEVEL_ADGROUP, REPORT_LEVEL_AD, REPORT_LEVEL_PROMOTED_OBJECT},[枚举详情]
枚举列表:{ REPORT_LEVEL_ADVERTISER, REPORT_LEVEL_CAMPAIGN, REPORT_LEVEL_ADGROUP, REPORT_LEVEL_AD, REPORT_LEVEL_PROMOTED_OBJECT, REPORT_LEVEL_ADVERTISER_WECHAT, REPORT_LEVEL_CAMPAIGN_WECHAT, REPORT_LEVEL_ADGROUP_WECHAT, REPORT_LEVEL_AD_WECHAT }

微信公众账号逻辑

仅可使用:{REPORT_LEVEL_ADVERTISER_WECHAT, REPORT_LEVEL_CAMPAIGN_WECHAT, REPORT_LEVEL_ADGROUP_WECHAT, REPORT_LEVEL_AD_WECHAT}
date_range*
struct 日期范围,最多支持查询 90 天内的数据查询,支持的最长查询跨度为 1 天

微信公众账号逻辑

最多支持查询 30 天内的数据查询,支持的最长查询跨度为 1 天
start_date*
string 开始日期,日期格式:YYYY-MM-DD,且等于 end_date
字段长度为 10 字节
end_date*
string 结束日期,日期格式:YYYY-MM-DD
字段长度为 10 字节
filtering
struct[] 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件]
数组最小长度 1,最大长度 5
field*
string 过滤字段,腾讯广告平台广告主:当 level 为 REPORT_LEVEL_CAMPAIGN 时,field 仅可选择 campaign_id; 当 level 为 REPORT_LEVEL_ADGROUP 时,field 可选择 adgroup_id, campaign_id; 当 level 为 REPORT_LEVEL_AD 时,field 仅可选择为 ad_id, adgroup_id, campaign_id ;当 level 为 REPORT_LEVEL_PROMOTED_OBJECT 时,field 可选择 promoted_object_type 和 promoted_object_id
可选值:{ adgroup_id, campaign_id, ad_id, promoted_object_type, promoted_object_id }

微信公众账号逻辑

当 level 为 REPORT_LEVEL_CAMPAIGN_WECHAT 时,field 仅可选择 campaign_id; 当 level 为 REPORT_LEVEL_ADGROUP_WECHAT 时,field 可选择 adgroup_id, campaign_id; 当 level 为 REPORT_LEVEL_AD_WECHAT 时,field 仅可选择为 ad_id, adgroup_id, campaign_id
operator*
enum 操作符
当 field 取值 adgroup_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 campaign_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 ad_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 promoted_object_type 时,枚举列表:{ EQUALS, IN }
当 field 取值 promoted_object_id 时,枚举列表:{ EQUALS, IN }
values*
string[] 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件]

当 field 取值 promoted_object_type 时,
枚举列表:{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT, PROMOTED_OBJECT_TYPE_QQ_BROWSER_MINI_PROGRAM, PROMOTED_OBJECT_TYPE_LINK, PROMOTED_OBJECT_TYPE_QQ_MESSAGE, PROMOTED_OBJECT_TYPE_QZONE_VIDEO_PAGE, PROMOTED_OBJECT_TYPE_LOCAL_ADS, PROMOTED_OBJECT_TYPE_ARTICLE, PROMOTED_OBJECT_TYPE_LEAD_AD, PROMOTED_OBJECT_TYPE_TENCENT_KE, PROMOTED_OBJECT_TYPE_EXCHANGE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_QZONE_PAGE_ARTICLE, PROMOTED_OBJECT_TYPE_QZONE_PAGE_IFRAMED, PROMOTED_OBJECT_TYPE_QZONE_PAGE, PROMOTED_OBJECT_TYPE_APP_PC, PROMOTED_OBJECT_TYPE_MINI_GAME_WECHAT, PROMOTED_OBJECT_TYPE_MINI_GAME_QQ }

当 field 取值 promoted_object_type 且 operator 取值 IN 时,
枚举列表:{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT, PROMOTED_OBJECT_TYPE_QQ_BROWSER_MINI_PROGRAM, PROMOTED_OBJECT_TYPE_LINK, PROMOTED_OBJECT_TYPE_QQ_MESSAGE, PROMOTED_OBJECT_TYPE_QZONE_VIDEO_PAGE, PROMOTED_OBJECT_TYPE_LOCAL_ADS, PROMOTED_OBJECT_TYPE_ARTICLE, PROMOTED_OBJECT_TYPE_LEAD_AD, PROMOTED_OBJECT_TYPE_TENCENT_KE, PROMOTED_OBJECT_TYPE_EXCHANGE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_QZONE_PAGE_ARTICLE, PROMOTED_OBJECT_TYPE_QZONE_PAGE_IFRAMED, PROMOTED_OBJECT_TYPE_QZONE_PAGE, PROMOTED_OBJECT_TYPE_APP_PC, PROMOTED_OBJECT_TYPE_MINI_GAME_WECHAT, PROMOTED_OBJECT_TYPE_MINI_GAME_QQ }

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 时间口径,当 level 为 {REPORT_LEVEL_ADVERTISER,REPORT_LEVEL_CAMPAIGN, REPORT_LEVEL_ADGROUP,REPORT_LEVEL_AD} 时支持多时间口径, 其它 level 仅支持 REQUEST_TIME,[枚举详情]
枚举列表:{ REQUEST_TIME, REPORTING_TIME, ACTIVE_TIME }

微信公众账号逻辑

仅支持 REPORTING_TIME
fields
string[] 指定返回的字段列表
数组最小长度 1,最大长度 256
字段长度最小 1 字节,长度最大 64 字节

请求示例


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

应答字段

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

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "hour": 2,
                "campaign_id": "<CAMPAIGN_ID>",
                "adgroup_id": "<ADGROUP_ID>",
                "ad_id": "<AD_ID>",
                "cost": 130,
                "image_click": 0,
                "like_or_comment": 0,
                "activation": 0,
                "app_payment_count": 0,
                "app_payment_amount": 0,
                "app_installation": 0,
                "click": 120,
                "conversion": 0,
                "download": 0,
                "follow": 0,
                "impression": 12000,
                "order_placement": 0,
                "register": 0,
                "reservation": 0,
                "share": 0
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具

相关阅读

获取定向标签报表
全部接口
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
        }
    }
}

可视化调试工具

相关阅读

说明:type=REGION时,返回结果中可能会有3个特殊的region_id,分别是 990000(国外未知)、980000(国内未知)、0(未知,无法确认是国内国外)

获取商品库报表
全部接口
V1.1
loading

所属权限 Ads Insights
请求地址 product_catalogs_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
product_catalog_id*
integer 商品库 id
date_range*
struct 日期范围,最早支持查询 1 年内(365 天)的数据
start_date*
string 开始日期,日期格式:YYYY-MM-DD,且小于等于 end_date
字段长度为 10 字节
end_date*
string 结束日期,日期格式:YYYY-MM-DD,且大于等于 begin_date
字段长度为 10 字节
filtering
struct[] 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件]
数组最小长度 1,最大长度 5
field*
string 过滤字段
可选值:{ first_category_id, second_category_id, third_category_id, brand_id, shop_id, product_outer_id, site_set, template_id }
operator*
enum 操作符
当 field 取值 first_category_id 时,枚举列表:{ EQUALS }
当 field 取值 second_category_id 时,枚举列表:{ EQUALS }
当 field 取值 third_category_id 时,枚举列表:{ EQUALS }
当 field 取值 brand_id 时,枚举列表:{ EQUALS }
当 field 取值 shop_id 时,枚举列表:{ EQUALS }
当 field 取值 product_outer_id 时,枚举列表:{ EQUALS }
当 field 取值 site_set 时,枚举列表:{ EQUALS }
当 field 取值 template_id 时,枚举列表:{ EQUALS }
values*
string[] 字段取值,values 数组元素的个数限制与 operator 的取值相关,详见 [过滤条件]
当 field 取值 product_outer_id 时,
字段长度最小 1 字节,长度最大 255 字节
group_by
string[] 聚合参数,见 [聚合规则]
数组最小长度 1,最大长度 3
可选值:{ date, product_catalog_id, product_outer_id, first_category_id, second_category_id, third_category_id }
order_by
struct[] 排序字段
数组长度为 1
sort_field*
string 排序字段
可选值:{ view_count, valid_click_count, cost, ctr, cpc, thousand_display_price }
sort_type*
enum 排序方式,[枚举详情]
枚举列表:{ ASCENDING, DESCENDING }

请求示例


curl -G 'https://api.e.qq.com/v1.1/product_catalogs_reports/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
-d 'filtering=[]' \
-d 'group_by=[]' \
-d 'order_by=[]' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
date
string 日期,日期格式:YYYY-MM-DD
product_catalog_id
integer 商品库 id
adgroup_id
integer 广告组 id,当获取广告主维度、推广计划维度报表时,该值无意义
product_outer_id
string 商品外部 id
first_category_id
integer 一级类目 id, 当 group_by 中包含有该字段时返回该字段
second_category_id
integer 二级类目 id, 当 group_by 中包含有该字段时返回该字段
third_category_id
integer 三级类目 id, 当 group_by 中包含有该字段时返回该字段
view_count
integer 曝光量-展示指标
valid_click_count
integer 点击量-展示指标
ctr
float 点击率-展示指标
cpc
integer 点击均价-展示指标,单位为“分”
thousand_display_price
integer 千次展现均价-展示指标,单位为“分”
cost
integer 花费-展示指标,单位为“分”
activated_count
integer 激活总量-转化指标(APP 类)-成交前行为,仅在广告主回传对应转化数据后有数据
activated_cost
integer 激活成本-转化指标(APP 类)-成交前行为,单位为“分”
activated_rate
float 下载激活率-转化指标(APP 类)-成交前行为
web_key_page_view_cost
integer 关键页面浏览总量成本-转化指标(网页类)-成交前行为,单位为“分”
web_commodity_page_view_count
integer 商品页浏览量-转化指标(网页类)-成交前行为
web_commodity_page_view_cost
integer 商品页浏览成本-转化指标(网页类)-成交前行为,单位为“分”
web_register_count
integer 注册量-转化指标(网页类)-成交前行为
page_phone_call_direct_count
integer 电话直拨量
own_page_navigation_count
integer 自有网页导航量-转化指标(网页类)-成交前行为
own_page_navigation_cost
integer 自有网页导航成本-转化指标(网页类)-成交前行为,单位为“分”
web_application_count
integer 申请量-转化指标(网页类)-成交前行为
web_application_cost
integer 申请成本-转化指标(网页类)-成交前行为,单位为“分”
web_order_count
integer 下单量-转化指标(网页类)-成交后行为
web_order_rate
float 下单率-转化指标(网页类)-成交后行为
app_order_rate
float 下单率-转化指标(APP 类)
web_order_cost
integer 下单成本-转化指标(网页类)-成交后行为,单位为“分”
web_checkout_amount
integer 付费金额-转化指标(网页类)-成交后行为,单位为“分”,仅在广告主回传对应转化数据后有数据
web_checkout_count
integer 付费行为量-转化指标(网页类)-成交后行为
web_checkout_cost
integer 付费行为成本-转化指标(网页类)-成交后行为,单位为“分”
download_rate
float 下载率-转化指标(APP 类)-成交前行为
download_cost
integer 下载成本-转化指标(APP 类)-成交前行为,单位为“分”
install_cost
integer 安装成本-转化指标(APP 类)-成交前行为,单位为“分”
click_activated_rate
float 点击激活率-转化指标(APP 类)-成交前行为
retention_count
integer 次日留存量-转化指标(APP 类)-成交前行为
retention_rate
float 次日留存率-转化指标(APP 类)-成交前行为
retention_cost
integer 次日留存成本-转化指标(APP 类)-成交前行为,单位为“分”
app_key_page_view_count
integer 关键页面浏览量-转化指标(APP 类)-成交前行为
web_key_page_view_count
integer 关键页面浏览总量-转化指标(网页类)-成交前行为
app_commodity_page_view_count
integer 商品页浏览量-转化指标(APP 类)-成交前行为
app_commodity_page_view_rate
float 商品页浏览率-转化指标(APP 类)-成交前行为
web_commodity_page_view_rate
float 商品页浏览率-转化指标(网页类)-成交前行为
app_commodity_page_view_cost
integer 商品页浏览成本-转化指标(APP 类)-成交前行为,单位为“分”
app_register_count
integer 注册量-转化指标(APP 类)-成交前行为
app_register_cost
integer 注册成本-转化指标(APP 类)-成交前行为,单位为“分”
app_application_count
integer 申请量-转化指标(APP 类)-成交前行为
app_application_cost
integer 申请成本-转化指标(APP 类)-成交前行为,单位为“分”
app_order_count
integer 下单量-转化指标(APP 类)-成交后行为
app_order_cost
integer 下单成本-转化指标(APP 类)-成交后行为,单位为“分”
follow_cost
integer 关注成本-社交互动指标,单位为“分”
forward_cost
integer 转发成本-社交互动指标,单位为“分”
read_cost
integer 阅读成本-社交互动指标,单位为“分”
praise_count
integer 点赞量-社交互动指标
praise_cost
integer 点赞成本-社交互动指标,单位为“分”
comment_count
integer 评论量-社交互动指标
like_or_comment
integer 微信朋友圈赞和评论数,仅微信朋友圈广告有数据
comment_cost
integer 评论成本-社交互动指标,单位为“分”
app_checkout_rate
float 付费率-转化指标(APP 类)
app_register_rate
float 注册率-转化指标(APP 类)
impression
integer 曝光量(待废弃)
click
integer 点击量(待废弃)
download
integer APP 下载量(待废弃)
follow
integer 微信朋友圈关注量,仅微信朋友圈广告有数据(待废弃)
activation
integer APP 激活量(待废弃),仅在广告主回传对应转化数据后有数据
share
integer 微信朋友圈转发量,仅微信朋友圈广告有数据(待废弃)
read
integer 阅读量,仅对推广目标为 QQ 消息的广告有效,表示图文消息被阅读的数量(待废弃)
app_payment_count
integer APP 付费行为次数(待废弃),仅在广告主回传对应转化数据后有数据
reservation
integer 表单预约量(待废弃)
app_installation
integer APP 安装量(待废弃)
app_payment_amount
integer APP 付费总金额,单位为分(待废弃),仅在广告主回传对应转化数据后有数据
app_add_to_car_count
integer 加入购物车量-转化指标(APP 类)-成交前行为
app_add_to_car_cost
integer 加入购物车成本-转化指标(APP 类)-成交前行为,单位为“分”

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "adgroup_id": "<ADGROUP_ID>"
            }
        ]
    }
}

可视化调试工具