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

获取商品库报表(待废弃)
全部接口
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 }

使用说明

  1. 新的商品报表请通过 daily_reports/get 和 async_reports/get 接口获取,该接口即将废弃。

请求示例


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

可视化调试工具