广告计划列表

获取广告计划列表信息。

请求地址

https://openapi.aiclk.com/openapi/v1/campaign/get

所属权限

ads_read

请求方式

GET

请求参数

字段名	类型	是否必须	描述
account_id	int	是	广告主ID(广告投放平台的userID)
query	string	是	请求参数结构，json格式，具体字段如下

query参数

字段名	类型	是否必须	描述
campaign_id	array	否	计划ID,示例:[11111,22222]，不填时获取该账户下全部计划信息
fields	array	是	需要的返回字段,允许值："campaign_id","campaign_name","configure_status","effective_status","budget","tomorrow_budget","optimization_goal","start_date","end_date","unable_reason","app_marketing_type","created_at"
created_at	object	否	创建时间过滤，start和end字段至少传一个
- start	string	否	创建开始时间, 格式：2020-01-01
- end	string	否	创建结束时间，格式：2020-02-01
updated_at	object	否	修改时间过滤，start和end字段至少传一个
- start	string	否	创建开始时间, 格式：2020-01-01
- end	string	否	创建结束时间，格式：2020-02-01
configure_status	[]string	否	计划状态，开启-ENABLE,暂停-PAUSED,删除-DELETED
page	int	否	页数，默认为1
page_size	int	否	页面大小，默认为10，不大于100

query示例

{
       "fields": [
           "campaign_id",
           "campaign_name",
           "budget"
       ],
       "created_at": {
           "start" : "2020-01-01",
           "end" : "2020-02-01"
       },
       "page": 1,
       "page_size": 10,
       "campaign_id": [
           11111,
           22222
       ]
}

请求示例

curl -X GET \
  'https://openapi.aiclk.com/openapi/v1/campaign/get?account_id=1000002&query={"campaign_id":[1828661,1828662],"page":1,"page_size":10,"fields":["campaign_id","campaign_name","app_marketing_type","configure_status","budget","optimization_goal","start_date","end_date"]}' \
  -H 'Host: openapi.aiclk.com' \
  -H 'OGW_ACCESS_TOKEN: your_access_token'

返回字段释义

字段名	类型	描述
code	int	返回码
message	string	返回信息
data	json	返回值，json格式，包含如下字段
- list	json	返回值，计划数据列表
-- campaign_id	int	广告计划ID
-- campaign_name	string	广告计划名称
-- created_at	string	创建时间
-- app_marketing_type	string	营销目标
-- configure_status	string	计划状态，见<枚举值>
-- effective_status	string	操作状态，开启-ENABLE，暂停-PAUSED
-- budget	int	计划日预算，单位:分
-- tomorrow_budget	int	明日预算，单位:分 值为0代表关闭
-- optimization_goal	string	推广目标，见<枚举值>
-- start_date	string	投放开始日期
-- end_date	string	投放结束日期
-- unable_reason	array	无法投放原因
page_info	json	分页信息
- page	int	页数
- page_size	int	页面大小
- total_number	int	总数

返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "list": [
        {
            "campaign_id": 123235433,
            "campaign_name": "计划名称",
            "configure_status": "ENABLE",
            "budget": 1000022,
            "optimization_goal": "LANDING_PAGE_URL",
            "start_date": "2019-10-22",
            "end_date": "2019-10-22",
            "unable_reason": ["手动暂停，无法投放"]
        },
        {
            "campaign_id": 17238332,
            "campaign_name": "计划名称22",
            "configure_status": "ENABLE",
            "budget": 2000022,
            "optimization_goal": "LANDING_PAGE_URL",
            "start_date": "2019-10-02",
            "end_date": "2019-10-02",
            "unable_reason": ["预算耗尽，请及时更新"]
        }
        ],
        "page_info":{ 
            "page": 1, 
            "page_size": 10, 
            "total_number": 2
        } 
    }
}