联盟广告位报表接口

请求参数

标有*的参数为必填项

名称	类型	描述
account_id*	integer	广告主帐号 id，有操作权限的帐号 id，不支持代理商 id
filtering	struct	过滤字段结构，promoted_object_type,promoted_object_id,union_position_id
promoted_object_type	enum[]	推广目标类型列表，推广目标类型个数不大于 1 个, 如：["PROMOTED_OBJECT_TYPE_APP_ANDROID"] 最多 1 个，[枚举详情] 数组长度为 1 枚举列表：{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_LINK, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_LEAD_AD }
promoted_object_id	string[]	推广目标 id 列表，推广目标 id 个数不大于 100 个, 如：["51213","51214","51215"] 最多 100 个数组最小长度 1，最大长度 100 字段长度最小 1 字节，长度最大 128 字节
union_position_id	integer[]	广告位 id 列表，广告位个数不大于 20 个, 如：["51213","51214","51215"] 最多 20 个数组最小长度 1，最大长度 20
date_range*	struct	日期范围
start_date*	string	开始日期，日期格式：YYYY-MM-DD，且小于等于 end_date 字段长度为 10 字节
end_date*	string	结束日期，日期格式：YYYY-MM-DD，且大于等于 start_date 字段长度为 10 字节
group_by	string[]	聚合参数，例：["date"]，group by 取值仅限于 union_position_id,date,industry_parent_id,placement_type 这些字段数组最小长度 1，最大长度 5 字段长度最大 255 字节
order_by	struct[]	排序参数数组最小长度 0，最大长度 12
sort_field*	string	排序字段，需为 fields 字段中指定返回字段的子集，字段类型为数值类的指标均支持排序字段长度最小 3 字节，长度最大 255 字节
sort_type*	enum	排序方式，[枚举详情] 枚举列表：{ ASCENDING, DESCENDING }
page	integer	搜索页码，默认值：1 最小值 1，最大值 99999
page_size	integer	一页显示的数据条数，默认值：10 最小值 1，最大值 100
fields*	string[]	指定返回的字段列表数组最小长度 1，最大长度 512 字段长度最小 1 字节，长度最大 64 字节
async	integer	是否创建异步报表任务，1：是，0：否最小值 0，最大值 1

使用说明
1.
本接口支持联盟广告位报表数据的获取。
2.
group_by 的使用规则如下：
1）为保证接口响应时间，建议查询时间跨度不超过 7 天
2）group by 中指定的字段，才会在 list 中返回
3）group by 中指定 placement_type 时，list 返回中会附加 placement_name 字段
4）group by 中指定 industry_parent_id 时，list 返回中会附加 industry_parent_name 字段。
3.
async 参数表示创建异步报表，指定为 1 时，返回异步任务 id，可通过 [异步报表任务]获取任务数据。
4.
每账号（account_id）限制最多 5 分钟创建 1 个异步报表任务。
5.
该接口所有涉及金额的字段，单位为分。

curl --location --request POST '/v1.3/report/ad_union' \ --header 'access_token;' \ --header 'timestamp;' \ --header 'nonce;' \ --data-urlencode 'account_id=<ACCOUNT_ID>' \ --data-urlencode 'filtering={ "promoted_object_type": [], "promoted_object_id": [], "union_position_id": [] }' \ --data-urlencode 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \ --data-urlencode 'group_by=[]' \ --data-urlencode 'order_by=[]' \ --data-urlencode 'page=1' \ --data-urlencode 'page_size=10' \ --data-urlencode 'fields=[]'

{ "code": 0, "message": "", "message_cn": "", "data": { "list": [], "page_info": { "page": 1, "page_size": 10, "total_number": 1, "total_page": 1 } } }

联盟广告位报表接口

请求参数#

请求参数

返回响应

请求参数