跳转至

分省份报表接口

接口

获取分省份数据报表展现、点击、消费金额等

请求地址

https://openapi.aiclk.com/openapi/v1/report/province

所属权限

ads_read

请求方式

GET

请求参数

请求参数字段:

字段名 类型 必须 描述
account_id number 查询的广告账户ID(广告投放平台的userID)
query string(json object) 查询参数结构体,具体结构如下

query格式:

字段名 类型 必须 描述
start_date string 开始日期,格式YYYY-MM-DD,时间跨度不超过7天
end_date string 结束日期,格式YYYY-MM-DD,时间跨度不超过7天
filtering object 过滤字段,允许值:"campaign_id","adgroup_id","creative_id"

query例子

{
    "start_date": "2019-10-14", 
    "end_date": "2019-10-14", 
    "filtering": {
        "campaign_id": 121242,
        "adgroup_id": 234233,
        "creative_id": 333454
    }
}

请求示例

curl -X GET \
  'https://openapi.aiclk.com/openapi/v1/report/province?account_id=1000004&query={"start_date":"2019-11-07","end_date":"2019-11-08","filtering":{"campaign_id":100008}}' \
  -H 'OGW_ACCESS_TOKEN: your_access_token'

返回字段

字段名 类型 描述
code int 返回码
message string 返回信息
data json 返回值,json格式,包含如下字段
- province string 省份名称,如:北京、上海
- impression int 展现
- click int 点击
- cost int 消费现金,单位:分

返回格式:

{
    "code": 200,
    "data": [
        {
            "click": 34,
            "cost": 486,
            "impression": 55,
            "province": "湖北"
        },
        {
            "click": 454,
            "cost": 44,
            "impression": 2,
            "province": "上海"
        },
        {
            "click": 34,
            "cost": 104,
            "impression": 115,
            "province": "山西"
        }
    ],
    "message": "success"
}