获取批量异步请求任务列表
所属权限 | ads_management |
请求地址 | batch_async_requests/get |
请求方法 | GET |
全局参数
全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考。
参数名称 | 参数类型 |
---|---|
access_token | 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节 |
timestamp |
当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。 MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳 MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59 |
nonce | 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性 |
请求参数
标有*的参数为必填项
名称 | 类型 | 描述 |
---|---|---|
account_id*
|
integer | 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id |
filtering
|
struct[] | 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件] 数组最小长度 1,最大长度 20 |
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[] | 字段取值 数组最小长度 1,最大长度 100,当 field 取值 task_type 且 operator 取值 EQUALS 时, 数组长度为 1 可选值:{ TASK_TYPE_UPDATE_UNION_POSITION_PACKAGE_NEW, TASK_TYPE_UPDATE_EXCLUDE_UNION_POSITION_PACKAGE_NEW, TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_BID_NEW, TASK_TYPE_DELETE_ADGROUP_NEW, TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_RATE_NEW, TASK_TYPE_TARGETINGS_SHARE_NEW, TASK_TYPE_UPDATE_ADGROUP_CONFIGURED_STATUS_NEW, TASK_TYPE_UPDATE_ADGROUP_DAILY_BUDGET_NEW, TASK_TYPE_UPDATE_ADGROUP_AUTO_ACQUISITION_NEW, TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_ADVANCED_RATE_NEW, TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_ADVANCED_BID_NEW, TASK_TYPE_UPDATE_ADGROUP_ECOM_PKAM_NEW, TASK_TYPE_UPDATE_ADGROUP_DERIVE_CONF_NEW } 当 field 取值 task_type 且 operator 取值 IN 时, 数组最小长度 1,最大长度 200 可选值:{ TASK_TYPE_UPDATE_UNION_POSITION_PACKAGE_NEW, TASK_TYPE_UPDATE_EXCLUDE_UNION_POSITION_PACKAGE_NEW, TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_BID_NEW, TASK_TYPE_DELETE_ADGROUP_NEW, TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_RATE_NEW, TASK_TYPE_TARGETINGS_SHARE_NEW, TASK_TYPE_UPDATE_ADGROUP_CONFIGURED_STATUS_NEW, TASK_TYPE_UPDATE_ADGROUP_DAILY_BUDGET_NEW, TASK_TYPE_UPDATE_ADGROUP_AUTO_ACQUISITION_NEW, TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_ADVANCED_RATE_NEW, TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_ADVANCED_BID_NEW, TASK_TYPE_UPDATE_ADGROUP_ECOM_PKAM_NEW, TASK_TYPE_UPDATE_ADGROUP_DERIVE_CONF_NEW } 当 field 取值 task_name 且 operator 取值 EQUALS 时, 数组长度为 1 字段长度最小 1 字节,长度最大 120 字节 当 field 取值 created_time 时,数组长度为 1 字段长度为 10 字节 当 field 取值 result_status 且 operator 取值 EQUALS 时, 数组长度为 1 可选值:{ 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 时, 数组最小长度 1,最大长度 32 可选值:{ 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 且 operator 取值 EQUALS 时, 数组长度为 1 可选值:{ TASK_STATUS_PENDING, TASK_STATUS_PROCESSING, TASK_STATUS_EXPIRED, TASK_STATUS_COMPLETED, TASK_STATUS_CANCELLED, TASK_STATUS_FAIL, TASK_STATUS_DELETED, TASK_STATUS_DRAFT } 当 field 取值 status 且 operator 取值 IN 时, 数组最小长度 1,最大长度 32 可选值:{ TASK_STATUS_PENDING, TASK_STATUS_PROCESSING, TASK_STATUS_EXPIRED, TASK_STATUS_COMPLETED, TASK_STATUS_CANCELLED, TASK_STATUS_FAIL, TASK_STATUS_DELETED, TASK_STATUS_DRAFT } 字段长度最小 1 字节,长度最大 64 字节 |
page
|
integer | 搜索页码 最小值 1,最大值 99999 默认值:1 |
page_size
|
integer | 一页显示的数据条数 最小值 1,最大值 100 默认值:10 |
使用说明
- 该接口灰度开放,如需使用请线下联系对接渠道运营同事申请。
- 支持 15 日内任务记录的查询。
请求示例
curl -v -G 'https://api.e.qq.com/v3.0/batch_async_requests/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[
{
"values": []
}
]' \
-d 'page=1' \
-d 'page_size=10'
应答字段
名称 | 类型 | 描述 |
---|---|---|
list
|
struct[] | 返回信息列表 |
task_id
|
integer | 任务 id |
task_name
|
string | 任务名称 |
task_type
|
string | 任务类型 |
task_scope
|
enum | 任务操作业务对象范围,[枚举详情] |
status
|
enum | 任务状态,[枚举详情] |
result_status
|
enum | 任务结果状态,[枚举详情] |
created_time
|
integer | |
end_time
|
integer | |
scope_object_id_list
|
integer[] | 任务操作业务对象 id 列表 |
scope_object_id_str_list
|
array | 任务操作业务对象 id 列表 |
page_info
|
struct | 分页配置信息 |
page
|
integer | 搜索页码 默认值:1 |
page_size
|
integer | 一页显示的数据条数 默认值:10 |
total_number
|
integer | 总条数 |
total_page
|
integer | 总页数 |
应答示例
{
"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
}
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务