获取日报表
开发环境
开发环境
GET
/v1.3/daily_reports/get
请求参数
名称 | 类型 | 描述 |
---|---|---|
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_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_BIDWORD,REPORT_LEVEL_QUERYWORD},[枚举详情] 枚举列表:{ 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_BIDWORD, REPORT_LEVEL_QUERYWORD, 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_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_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;当 level 为 REPORT_LEVEL_BIDWORD 时,field 可选择 bidword_id, adgroup_id, campaign_id;当 level 为 REPORT_LEVEL_QUERYWORD 时,field 可选择 bidword_id; 可选值:{ adgroup_id, campaign_id, project_id, ad_id, promoted_object_type, promoted_object_id, union_position_id, template_id, bid_type, product_catalog_id, material_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 取值 union_position_id 时,枚举列表:{ EQUALS } 当 field 取值 template_id 时,枚举列表:{ EQUALS, IN } 当 field 取值 bid_type 时,枚举列表:{ EQUALS } 当 field 取值 product_catalog_id 时,枚举列表:{ EQUALS } 当 field 取值 material_id 时,枚举列表:{ EQUALS, IN } 当 field 取值 bidword_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_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 } 当 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 } |
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.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。 2.商品报表仅支持查看指定商品库下,单日花费最高的 10000 条商品的效果数据。 3.该接口所有涉及金额的字段,单位为分。 4.腾讯广告投放平台升级全新的指标体系,请及时改造。详细升级情况及新老指标体系映射关系请查看公告[腾讯广告投放端-指标升级指引]。当您使用新的指标调用方式时(即 adq_accounts_upgrade_enabled 传 true),您可以请求新指标体系内指标。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.3/daily_reports/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--data-urlencode 'account_id=<ACCOUNT_ID>' \
--data-urlencode 'level=ADGROUP' \
--data-urlencode 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
--data-urlencode 'filtering=[{"field":"adgroup_id","operator":"EQUALS","values":[111111111]}]' \
--data-urlencode 'group_by=["date"]' \
--data-urlencode 'order_by=[{"sort_field":"impression","sort_type":"ASCENDING"}]' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=10' \
--data-urlencode 'fields=[]' \
--data-urlencode 'operator='
响应示例响应示例
{
"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
}
}
}
请求参数
Header 参数
access_token
string
必需
默认值:
<ACCESS_TOKEN>
timestamp
string
必需
MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8,例如当时间戳为1494840119时,表示 2018-05-15 17:21:59
默认值:
<TIMESTAMP>
nonce
string
必需
默认值:
<NONCE>
Body 参数application/x-www-form-urlencoded
account_id
integer
必需
示例值:
<ACCOUNT_ID>
level
string
必需
枚举列表:{ 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_BIDWORD, REPORT_LEVEL_QUERYWORD, REPORT_LEVEL_ADVERTISER_WECHAT, REPORT_LEVEL_CAMPAIGN_WECHAT, REPORT_LEVEL_ADGROUP_WECHAT, REPORT_LEVEL_AD_WECHAT }
示例值:
ADGROUP
date_range
string
必需
示例值:
{"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}
filtering
string
可选
数组最小长度 1,最大长度 5
示例值:
[{"field":"adgroup_id","operator":"EQUALS","values":[111111111]}]
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
fields
string
可选
可选值:{ adgroup_id, campaign_id, project_id, ad_id, promoted_object_type, promoted_object_id, union_position_id, template_id, bid_type, product_catalog_id, material_id, bidword_id }
示例值:
[]
operator
string
必需
当 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 取值 union_position_id 时,枚举列表:{ EQUALS }
当 field 取值 template_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 bid_type 时,枚举列表:{ EQUALS }
当 field 取值 product_catalog_id 时,枚举列表:{ EQUALS }
当 field 取值 material_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 bidword_id 时,枚举列表:{ EQUALS, IN }
返回响应
修改于 2023-11-07 08:20:14