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

获取日报表
全部接口
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, material_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 }
当 field 取值 material_id 时,枚举列表:{ EQUALS, IN }
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
        }
    }
}

可视化调试工具

相关阅读