获取批量异步请求任务列表
开发环境
开发环境
GET
/v1.3/batch_async_requests/get
请求参数
名称 | 类型 | 描述 |
---|---|---|
account_id* | integer | 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id |
filtering | struct[] | 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件] 数组最小长度 1,最大长度 10 |
field* | string | 过滤字段 可选值:{ task_id, task_type, task_name, created_time, result_status, status } |
operator* | enum | 操作符 当 field 取值 task_id 时,枚举列表:{ EQUALS, IN } 当 field 取值 task_type 时,枚举列表:{ EQUALS, IN } 当 field 取值 task_name 时,枚举列表:{ EQUALS, CONTAINS } 当 field 取值 created_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER } 当 field 取值 result_status 时,枚举列表:{ EQUALS, IN } 当 field 取值 status 时,枚举列表:{ EQUALS, IN } |
values* | string[] | 字段取值 当 field 取值 task_type 时, 枚举列表:{ TASK_TYPE_UPDATE_UNION_POSITION_PACKAGE, TASK_TYPE_UPDATE_EXCLUDE_UNION_POSITION_PACKAGE, TASK_TYPE_UPDATE_TARGETING_ID, TASK_TYPE_UPDATE_BID_STRATEGY, TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_BID, TASK_TYPE_UPDATE_ADGROUP_APP_ANDROID_CHANNEL_PACKAGE_ID, TASK_TYPE_UPDATE_CAMPAIGN_SPEED_MODE, TASK_TYPE_DELETE_CAMPAIGN, TASK_TYPE_DELETE_ADGROUP, TASK_TYPE_DELETE_AD, TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_RATE, TASK_TYPE_UPDATE_ADCREATIVE_DEEP_LINK_URL, TASK_TYPE_TARGETINGS_SHARE, TASK_TYPE_UPDATE_CAMPAIGN_CONFIGURED_STATUS, TASK_TYPE_UPDATE_CAMPAIGN_DAILY_BUDGET, TASK_TYPE_UPDATE_ADGROUP_CONFIGURED_STATUS, TASK_TYPE_UPDATE_ADGROUP_DAILY_BUDGET, TASK_TYPE_UPDATE_AD_CONFIGURED_STATUS, TASK_TYPE_UPDATE_ADGROUP_AUTO_ACQUISITION, TASK_TYPE_UPDATE_ADCREATIVE_LANDING_PAGE, TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_ADVANCED_RATE, TASK_TYPE_REPLY_FINDER_OBJECT_COMMENT, TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_ADVANCED_BID, TASK_TYPE_UPDATE_FINDER_OBJECT_COMMENT_FLAG } 当 field 取值 task_type 且 operator 取值 IN 时, 枚举列表:{ TASK_TYPE_UPDATE_UNION_POSITION_PACKAGE, TASK_TYPE_UPDATE_EXCLUDE_UNION_POSITION_PACKAGE, TASK_TYPE_UPDATE_TARGETING_ID, TASK_TYPE_UPDATE_BID_STRATEGY, TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_BID, TASK_TYPE_UPDATE_ADGROUP_APP_ANDROID_CHANNEL_PACKAGE_ID, TASK_TYPE_UPDATE_CAMPAIGN_SPEED_MODE, TASK_TYPE_DELETE_CAMPAIGN, TASK_TYPE_DELETE_ADGROUP, TASK_TYPE_DELETE_AD, TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_RATE, TASK_TYPE_UPDATE_ADCREATIVE_DEEP_LINK_URL, TASK_TYPE_TARGETINGS_SHARE, TASK_TYPE_UPDATE_CAMPAIGN_CONFIGURED_STATUS, TASK_TYPE_UPDATE_CAMPAIGN_DAILY_BUDGET, TASK_TYPE_UPDATE_ADGROUP_CONFIGURED_STATUS, TASK_TYPE_UPDATE_ADGROUP_DAILY_BUDGET, TASK_TYPE_UPDATE_AD_CONFIGURED_STATUS, TASK_TYPE_UPDATE_ADGROUP_AUTO_ACQUISITION, TASK_TYPE_UPDATE_ADCREATIVE_LANDING_PAGE, TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_ADVANCED_RATE, TASK_TYPE_REPLY_FINDER_OBJECT_COMMENT, TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_ADVANCED_BID, TASK_TYPE_UPDATE_FINDER_OBJECT_COMMENT_FLAG } 当 field 取值 task_name 时, 字段长度最小 1 字节,长度最大 120 字节 当 field 取值 created_time 时, 字段长度为 10 字节 当 field 取值 result_status 时, 枚举列表:{ TASK_RESULT_STATUS_UNKNOWN, TASK_RESULT_STATUS_PENDING, TASK_RESULT_STATUS_PROCESSING, TASK_RESULT_STATUS_SUCCESS, TASK_RESULT_STATUS_FAIL, TASK_RESULT_STATUS_PARTIAL_FAIL, TASK_RESULT_STATUS_SYSTEM_ERROR, TASK_RESULT_STATUS_DELETED } 当 field 取值 result_status 且 operator 取值 IN 时, 枚举列表:{ TASK_RESULT_STATUS_UNKNOWN, TASK_RESULT_STATUS_PENDING, TASK_RESULT_STATUS_PROCESSING, TASK_RESULT_STATUS_SUCCESS, TASK_RESULT_STATUS_FAIL, TASK_RESULT_STATUS_PARTIAL_FAIL, TASK_RESULT_STATUS_SYSTEM_ERROR, TASK_RESULT_STATUS_DELETED } 当 field 取值 status 时, 枚举列表:{ TASK_STATUS_PENDING, TASK_STATUS_PROCESSING, TASK_STATUS_EXPIRED, TASK_STATUS_COMPLETED, TASK_STATUS_FAIL, TASK_STATUS_DELETED } 当 field 取值 status 且 operator 取值 IN 时, 枚举列表:{ TASK_STATUS_PENDING, TASK_STATUS_PROCESSING, TASK_STATUS_EXPIRED, TASK_STATUS_COMPLETED, TASK_STATUS_FAIL, TASK_STATUS_DELETED } |
page | integer | 搜索页码,默认值:1 最小值 1,最大值 99999 |
page_size | integer | 一页显示的数据条数,默认值:10 最小值 1,最大值 100 |
使用说明 1.支持 15 日内任务记录的查询。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.3/batch_async_requests/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'fields;' \
--data-urlencode 'account_id=<ACCOUNT_ID>' \
--data-urlencode 'filtering=[]' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=10'
响应示例响应示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"task_id": 1,
"task_name": "batch_async_request_task",
"task_type": "TASK_TYPE_UPDATE_TARGETING_ID",
"task_scope": "TASK_SCOPE_ADGROUP",
"status": "TASK_STATUS_COMPLETED",
"result_status": "TASK_RESULT_STATUS_SUCCESS",
"created_time": 1597239107,
"end_time": 1597239167,
"scope_object_id_list": [
1
],
"scope_object_id_str_list": []
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"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>
fields
string
必需
Body 参数application/x-www-form-urlencoded
account_id
integer
必需
示例值:
<ACCOUNT_ID>
filtering
string
必需
数组最小长度 1,最大长度 10
示例值:
[]
page
integer
可选
最小值 1,最大值 99999
示例值:
1
page_size
integer
可选
最小值 1,最大值 100
示例值:
10
返回响应
修改于 2023-11-07 02:56:10