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

获取小时报表
全部接口
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_PROJECT,REPORT_LEVEL_ADGROUP, REPORT_LEVEL_AD, REPORT_LEVEL_PROMOTED_OBJECT,REPORT_LEVEL_BIDWORD}，[枚举详情]
枚举列表：{ REPORT_LEVEL_ADVERTISER, REPORT_LEVEL_CAMPAIGN, REPORT_LEVEL_ADGROUP, REPORT_LEVEL_AD, REPORT_LEVEL_PROMOTED_OBJECT, REPORT_LEVEL_BIDWORD, REPORT_LEVEL_ADVERTISER_WECHAT, REPORT_LEVEL_CAMPAIGN_WECHAT, REPORT_LEVEL_ADGROUP_WECHAT, REPORT_LEVEL_AD_WECHAT }
date_range*
 struct 日期范围，最多支持查询 90 天内的数据查询，支持的最长查询跨度为 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_PROJECT 时，field 仅可选择 project_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_BIDWORD 时，field 可选择 bidword_id, adgroup_id, campaign_id
可选值：{ adgroup_id, campaign_id, project_id, ad_id, promoted_object_type, promoted_object_id, bidword_id }
operator*
 enum 操作符
当 field 取值 adgroup_id 时，枚举列表：{ EQUALS, IN }
当 field 取值 campaign_id 时，枚举列表：{ EQUALS, IN }
当 field 取值 project_id 时，枚举列表：{ EQUALS, IN }
当 field 取值 ad_id 时，枚举列表：{ EQUALS, IN }
当 field 取值 promoted_object_type 时，枚举列表：{ EQUALS, IN }
当 field 取值 promoted_object_id 时，枚举列表：{ EQUALS, IN }
当 field 取值 bidword_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_ARTICLE, PROMOTED_OBJECT_TYPE_LEAD_AD, PROMOTED_OBJECT_TYPE_TENCENT_KE, 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, PROMOTED_OBJECT_TYPE_WECHAT_OFFICIAL_ACCOUNT, PROMOTED_OBJECT_TYPE_APP_QUICK_APP, PROMOTED_OBJECT_TYPE_WECHAT_ARTICLE, PROMOTED_OBJECT_TYPE_WECHAT_PAY_COUPON }

当 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_ARTICLE, PROMOTED_OBJECT_TYPE_LEAD_AD, PROMOTED_OBJECT_TYPE_TENCENT_KE, 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, PROMOTED_OBJECT_TYPE_WECHAT_OFFICIAL_ACCOUNT, PROMOTED_OBJECT_TYPE_APP_QUICK_APP, PROMOTED_OBJECT_TYPE_WECHAT_ARTICLE, PROMOTED_OBJECT_TYPE_WECHAT_PAY_COUPON }
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,REPORT_LEVEL_BIDWORD} 时支持多时间口径, 其它 level 仅支持 REQUEST_TIME，[枚举详情]
枚举列表：{ REQUEST_TIME, REPORTING_TIME, ACTIVE_TIME }
fields
 string[] 指定返回的字段列表
数组最小长度 1，最大长度 512
字段长度最小 1 字节，长度最大 64 字节
weixin_official_accounts_upgrade_enabled
 boolean 针对微信公众号账户是否使用升级的新调用方式，true：使用升级的新方式，false：不使用，不传则默认值 false ；详细情况请查看公告[Marketing API 微信公众平台账户服务升级]
可选值：{ true, false }
adq_accounts_upgrade_enabled
 boolean 针对腾讯广告平台广告账户是否使用升级的新调用方式，true：使用升级的新方式，可以调用新指标体系； false：不使用，仅能调用旧指标体系，不传则默认值 false ；
可选值：{ true, false }

使用说明

  1. 该接口所有涉及金额的字段，单位为分。
  2. 腾讯广告投放平台升级全新的指标体系，请及时改造。详细升级情况及新老指标体系映射关系请查看公告[腾讯广告投放端-指标升级指引]。当您使用新的指标调用方式时（即 adq_accounts_upgrade_enabled 传 true），您可以请求新指标体系内指标。
  3. 报表数据量限制：page * pageSize 小于等于 20000, 超过 20000 条数据，请使用创建异步报表任务接口。

请求示例


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=["hour"]' \
-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
        }
    }
}

可视化调试工具

相关阅读

广告报表小时报表

广告资源

广告技术

开发文档

辅助工具

帮助支持

手机浏览开发者官网

Copyright © 1998 - Tencent Inc. All Rights Reserved.