拉取广告列表
开发环境
开发环境
POST
/v1.3/local/get
请求参数
名称 | 类型 | 描述 |
---|---|---|
account_id* | integer | 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id |
date_range* | struct | 日期范围,最多支持查询 180 天内的数据查询,支持的最长查询跨度为 1 天 |
start_date* | string | 开始日期,日期格式:YYYY-MM-DD,且小于等于 end_date 字段长度为 10 字节 |
end_date* | string | 结束日期,日期格式:YYYY-MM-DD 字段长度为 10 字节 |
filtering | struct[] | 过滤条件,若此字段不传,或传空则视为无限制条件; 数组最小长度 1,最大长度 5 |
field* | string | 过滤字段 可选值:{ adgroup_id, calc_status, created_time, local_business_mode } |
operator* | enum | 操作符 当 field 取值 adgroup_id 时,枚举列表:{ EQUALS, IN } 当 field 取值 calc_status 时,枚举列表:{ EQUALS } 当 field 取值 created_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER } |
values* | string[] | 字段取值,values 数组元素的个数限制与 operator 的取值相关 当 field 取值 calc_status 时, 枚举列表:{ CALCULATE_STATUS_PENDING, CALCULATE_STATUS_DENIED, CALCULATE_STATUS_FROZEN, CALCULATE_STATUS_SUSPEND, CALCULATE_STATUS_READY, CALCULATE_STATUS_ACTIVE, CALCULATE_STATUS_STOP, CALCULATE_STATUS_NOT_READY_IMG, CALCULATE_STATUS_ACTIVE_ACC_FROZEN, CALCULATE_STATUS_ACTIVE_ACC_LIMIT, CALCULATE_STATUS_ACTIVE_CAM_LIMIT, CALCULATE_STATUS_ACTIVE_CAM_PAUSED, CALCULATE_STATUS_PART_READY, CALCULATE_STATUS_PART_ACTIVE, CALCULATE_STATUS_LOCAL_WEPAY_PENDING } 当 field 取值 created_time 时, 字段长度为 10 字节 |
level* | enum | 报表类型,[枚举详情] 枚举列表:{ REPORT_LEVEL_ADVERTISER_WECHAT, REPORT_LEVEL_ADGROUP_WECHAT } |
page* | integer | 页码 |
page_size* | integer | 每页数量 |
使用说明 1.拉取广告数据和报表数据列表。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1.3/local/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--data-urlencode 'account_id=<ACCOUNT_ID>' \
--data-urlencode 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
--data-urlencode 'filtering=[]' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=10'
响应示例响应示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"campaign": {
"campaign_id": "<CAMPAIGN_ID>"
},
"adgroup": {
"adgroup_id": 123456789,
"adgroup_name": "推广广告",
"targeting": {
"age": [],
"gender": [],
"education": []
},
"metric_detail": [],
"reject_message": "Reject message example",
"poi_list": [],
"cold_start_audience": []
},
"adcreative": {
"adcreative_id": "<ADCREATIVE_ID>",
"adcreative_name": "广告创意",
"adcreative_template_id": "<ADCREATIVE_TEMPLATE_ID>",
"adcreative_elements": {
"image_list": []
},
"page_spec": {
"mini_program_spec": [],
"alita_page_spec": []
}
},
"account_metric": []
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_page": 1
}
}
}
请求参数
Header 参数
access_token
string
必需
默认值:
<ACCESS_TOKEN>
timestamp
string
必需
MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8,例如当时间戳为1494840119时,表示 2018-05-15 17:21:59
默认值:
<TIMESTAMP>
nonce
string
必需
默认值:
<NONCE>
Body 参数application/x-www-form-urlencoded
account_id
integer
必需
示例值:
<ACCOUNT_ID>
date_range
string
必需
示例值:
{"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}
filtering
string
可选
数组最小长度 1,最大长度 5
示例值:
[]
page
integer
页码
示例值:
1
page_size
string
每页数量
示例值:
10
返回响应
修改于 2023-11-08 08:05:28