广告投放报表
需要携带 Token,详情看 Token
说明: 数据会在当天过后 5 小时左右可以生成。如拉取零时区 8 月 1 日的数据,可以在零时区 8 月 2 日 5 点左右拉取。
请求地址
https://scaler.taurusx.com/openapi/performance_data
请求方法
GET
请求参数
字段 | 是否必填 | 类型 | 说明 | 默认值 | 例子 |
---|---|---|---|---|---|
timezone | 选填 | string | 数据对应的时区 | +0 | +0 |
report_type | 选填 | string | 报表统计的类型,event|request,event 基于事件时间,request 基于统计时间 | event | event |
start_time | 必填 | string | 请求数据的开始时间,格式为**"yyyy-MM-dd" **。支持最近一周的查询。 | —— | "2023-04-23" |
end_time | 必填 | string | 请求数据的结束时间,格式为**"yyyy-MM-dd" **。支持最近一周的查询。 | —— | "2023-04-24" |
dimension_option | 必填 | string | 可选的字段名: "Campaign" , "Adgroup", ,"Creative" , "AdType" , "Country" . 多个字段用,分隔.dimension_option=> "Campaign" , 按 Campaign ID 细分数据;dimension_option=> "Adgroup" , 按 Adgroup ID 细分数据; dimension_option=> "Creative" , 按 Creative ID, 细分数据; dimension_option=> "AdType" , 按 Ad Type 细分数据; dimension_option=> "Country" ,按 国家细分数据(两位国家码); | —— | Campaign,Country |
响应结果
名称 | 父节点 | 类型 | 描述 |
---|---|---|---|
code | int | 200 表示成功,其他表示失败 | |
data | json | 结果列表 | |
data_list | data | array<json> | |
date | data_list | string | 日期 |
campaign_id | data_list | string | Campaign ID |
campaign_name | data_list | string | Campaign Name |
adgroup_id | data_list | string | Adgroup ID |
adgroup_name | data_list | string | Adgroup Name |
creative_id | data_list | string | Creative ID |
creative_name | data_list | string | Creative Name |
ad_type | data_list | string | 素材类型: image,nativeImg,video,videoEndCard,html,videoHtml |
country | data_list | string | 国家 两位国家码 |
impressions | data_list | number | 展示数量 |
clicks | data_list | number | 点击数量 |
conversions | data_list | number | 转化数量 |
cost | data_list | number | 消耗,单位美元 |
- 成功响应报文
JSON
{
"code": 200,
"data": {
"data_list": [
{
"date": "2023-10-20",
"campaign_id": 100115,
"campaign_name": "Test name",
"adgroup_id": 1000228,
"adgroup_name": "Test name",
"creative_id": 10001116,
"creative_name": "Test name",
"ad_type": "image",
"country": "BR",
"clicks": 118.0,
"conversions": 0.0,
"cost": 0.293090625116,
"impressions": 298.0
},
{
"date": "2023-10-21",
"campaign_id": 100115,
"campaign_name": "Test name",
"adgroup_id": 1000228,
"adgroup_name": "Test name",
"creative_id": 10001117,
"creative_name": "Test name",
"ad_type": "video",
"country": "BR",
"clicks": 104.0,
"conversions": 0.0,
"cost": 0.08020019578,
"impressions": 214.0
},
]
}
}
{
"code": 200,
"data": {
"data_list": [
{
"date": "2023-10-20",
"campaign_id": 100115,
"campaign_name": "Test name",
"adgroup_id": 1000228,
"adgroup_name": "Test name",
"creative_id": 10001116,
"creative_name": "Test name",
"ad_type": "image",
"country": "BR",
"clicks": 118.0,
"conversions": 0.0,
"cost": 0.293090625116,
"impressions": 298.0
},
{
"date": "2023-10-21",
"campaign_id": 100115,
"campaign_name": "Test name",
"adgroup_id": 1000228,
"adgroup_name": "Test name",
"creative_id": 10001117,
"creative_name": "Test name",
"ad_type": "video",
"country": "BR",
"clicks": 104.0,
"conversions": 0.0,
"cost": 0.08020019578,
"impressions": 214.0
},
]
}
}