广告投放报表

需要携带 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 基于统计时间eventevent
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

响应结果

名称父节点类型描述
codeint200 表示成功,其他表示失败
datajson结果列表
data_listdataarray<json>
datedata_liststring日期
campaign_iddata_liststringCampaign ID
campaign_namedata_liststringCampaign Name
adgroup_iddata_liststringAdgroup ID
adgroup_namedata_liststringAdgroup Name
creative_iddata_liststringCreative ID
creative_namedata_liststringCreative Name
ad_typedata_liststring素材类型: image,nativeImg,video,videoEndCard,html,videoHtml
countrydata_liststring国家 两位国家码
impressionsdata_listnumber展示数量
clicksdata_listnumber点击数量
conversionsdata_listnumber转化数量
costdata_listnumber消耗,单位美元
  • 成功响应报文
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
            },
        ]
    }
}