接口文档SDK业务专题开发者工具

异步任务(Async Task)

V1.1

loading

本节将为您介绍异步任务(Async Task)相关接口, 关于异步任务更详细的介绍可以参考【异步任务】章节。

所属权限(scope): Ads Insight

所属权限(scope):Ads Insight

所属权限(scope):Ads Insight


创建异步任务
全部接口
V1.1
loading

所属权限 Ads Insight
请求地址 async_tasks/add
请求方法 post

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性
fields get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回

请求参数

参数仅适用于腾讯广告平台及微信公众平台。其中,标有的内容表示,该参数在微信公众平台使用时,描述不同。标有*的参数为必填项

名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
task_name*
string 同一帐号名下不允许重复
字段长度最小 1 字节,长度最大 120 字节
task_type*
enum 任务类型(部分任务待废弃)具体请参考,[枚举详情]
枚举列表:{ TASK_TYPE_AD_HOURLY_REPORT, TASK_TYPE_WECHAT_MOMENTS_ADGROUP_HOURLY_REPORT, TASK_TYPE_WECHAT_ADGROUP_HOURLY_REPORT, TASK_TYPE_WECHAT_ADGROUP_DAILY_REPORT, TASK_TYPE_WECHAT_AD_HOURLY_REPORT, TASK_TYPE_WECHAT_AD_DAILY_REPORT, TASK_TYPE_WECHAT_ADVERTISING_DATA, TASK_TYPE_WECHAT_POI_HOURLY_REPORT, TASK_TYPE_CREATE_ANDROID_CHANNEL_PACKAGE, TASK_TYPE_UPDATE_ANDROID_CHANNEL_PACKAGE, TASK_TYPE_CREATE_ANDROID_UNION_CHANNEL_PACKAGE, TASK_TYPE_UPDATE_ANDROID_UNION_CHANNEL_PACKAGE, TASK_TYPE_UNION_POSITION_REPORT, TASK_TYPE_UPDATE_ANDROID_UNION_CHANNEL_PACKAGE_BY_URL }
task_spec
struct 任务所需条件
report_task_spec
struct 报表任务所需条件,当 task_type 为 TASK_TYPE_REPORT_AGENCY_ADVERTISER_HOURLY 时,report_task_spec 必填
level*
string 报表类型级别
可选值:{ CAMPAIGN, ADGROUP }
date*
string 日期,日期格式:YYYY-MM-DD
字段长度为 10 字节
task_type_ad_hourly_report_spec
struct 广告小时报表查询条件,当且仅当 task_type = TASK_TYPE_AD_HOURLY_REPORT 时,才可且必须使用
date*
string 日期,格式 YYYY-MM-DD,只支持最近 30 天内的数据
字段长度为 10 字节
task_type_wechat_moments_adgroup_hourly_report_spec
struct 微信朋友圈广告组小时报表查询条件,当且仅当 task_type = TASK_TYPE_WECHAT_MOMENTS_ADGROUP_HOURLY_REPORT 时,才可且必须使用
date*
string 日期,格式 YYYY-MM-DD,只支持最近 30 天内的数据
字段长度为 10 字节
task_type_wechat_adgroup_hourly_report_spec
struct 广告组小时报表查询条件,微信广告组小时报表查询条件,当且仅当 task_type = TASK_TYPE_WECHAT_ADGROUP_HOURLY_REPORT 时,才可且必须使用
date*
string 日期,格式 YYYY-MM-DD,仅支持获取近一个月内的数据
字段长度为 10 字节
hour_range
struct 查询的具体时段范围,begin_hour 小于等于 end_hour,最长时间跨度不超过 2 小时
begin_hour*
integer 小时(0-23)
最小值 0,最大值 23
end_hour*
integer 小时(0-23)
最小值 0,最大值 23
task_type_wechat_adgroup_daily_report_spec
struct 广告组天报表查询条件,当且仅当 task_type = TASK_TYPE_WECHAT_ADGROUP_DAILY_REPORT 时,才可且必须使用
date*
string 日期,格式 YYYY-MM-DD,只支持最近 1 年内的数据
字段长度为 10 字节
task_type_wechat_ad_hourly_report_spec
struct 广告小时报表查询条件,微信广告小时报表查询条件,当且仅当 task_type = TASK_TYPE_WECHAT_AD_HOURLY_REPORT 时,才可且必须使用
date*
string 日期,格式 YYYY-MM-DD,仅支持获取近一个月内的数据
字段长度为 10 字节
task_type_wechat_ad_daily_report_spec
struct 广告组天报表查询条件,当且仅当 task_type = TASK_TYPE_WECHAT_AD_DAILY_REPORT 时,才可且必须使用
date*
string 日期,格式 YYYY-MM-DD,只支持最近 1 年内的数据
字段长度为 10 字节
task_type_wechat_advertising_data_spec
struct 获取微信数据任务查询条件,当且仅当 task_type = TASK_TYPE_WECHAT_ADVERTISING_DATA 时,才可且必须使用
last_modified_time_range*
struct 广告组信息最后更新时间范围,一次最多允许获取 7 天的数据,最远可获取 2018.01.01 的数据
begin_time*
integer 开始时间戳
最小值 0,最大值 9999999999
end_time*
integer 结束时间戳
最小值 0,最大值 9999999999
fields*
string[] 指定返回的字段列表
数组最小长度 1,最大长度 256
字段长度最小 1 字节,长度最大 64 字节
task_type_wechat_poi_hourly_report_spec
struct 微信门店小时报表查询条件,当 task_type = TASK_TYPE_WECHAT_POI_HOURLY_REPORT 时,可填且必填
date*
string 日期,格式 YYYY-MM-DD,只支持最近 30 天内的数据
字段长度为 10 字节
task_type_create_android_channel_package_spec
struct 创建应用宝渠道包接口任务所需条件,当且仅当 task_type = TASK_TYPE_CREATE_ANDROID_CHANNEL_PACKAGE 时,才可且必须使用
myapp_auth_key*
string 应用宝用户唯一标识
字段长度最小 1 字节,长度最大 64 字节
android_app_id*
integer 应用宝 APP id
android_channel_package_spec*
struct[] 渠道包信息
数组最小长度 1,最大长度 100
package_name*
string 渠道包名称
字段长度最小 1 字节,长度最大 1024 字节
download_url*
string 渠道包下载地址
字段长度最小 1 字节,长度最大 10240 字节
task_type_update_android_channel_package_spec
struct 更新应用宝渠道包接口任务所需条件,当且仅当 task_type = TASK_TYPE_UPDATE_ANDROID_CHANNEL_PACKAGE 时,才可且必须使用
myapp_auth_key*
string 应用宝用户唯一标识
字段长度最小 1 字节,长度最大 64 字节
android_app_id*
integer 应用宝 APP id
android_channel_package_spec*
struct[] 渠道包信息
数组最小长度 1,最大长度 100
channel_package_id*
string 渠道包 id
字段长度最小 1 字节,长度最大 64 字节
download_url*
string 渠道包下载地址
字段长度最小 1 字节,长度最大 10240 字节
task_type_create_android_union_channel_package_spec
struct 创建广告渠道包接口任务所需条件,当且仅当 task_type = TASK_TYPE_CREATE_ANDROID_UNION_CHANNEL_PACKAGE 时,才可且必须使用
android_union_app_id*
integer 广告包 APP id
android_union_channel_package_spec*
struct[] 渠道包信息
数组最小长度 1,最大长度 100
package_name*
string 渠道包名称
字段长度最小 1 字节,长度最大 1024 字节
download_url*
string 渠道包下载地址
字段长度最小 1 字节,长度最大 10240 字节
task_type_update_android_union_channel_package_spec
struct 更新广告渠道包接口任务所需条件,当且仅当 task_type = TASK_TYPE_UPDATE_ANDROID_UNION_CHANNEL_PACKAGE 时,才可且必须使用
android_union_app_id*
integer 广告包 APP id
android_union_channel_package_spec*
struct[] 渠道包信息
数组最小长度 1,最大长度 100
channel_package_id*
integer 渠道包 id
package_name
string 渠道包名称
字段长度最小 1 字节,长度最大 1024 字节
download_url*
string 渠道包下载地址
字段长度最小 1 字节,长度最大 10240 字节
task_type_union_position_report_spec
struct 优量汇广告位报表查询条件,当且仅当 task_type = TASK_TYPE_UNION_POSITION_REPORT 时,才可且必须使用
date*
string 日期,格式 YYYY-MM-DD
字段长度为 10 字节

使用说明

  1. 该接口灰度开放,如需使用请线下联系对接渠道运营同事申请。
  2. 只能由代理商账户创建的任务有:TASK_TYPE_WECHAT_ADGROUP_HOURLY_REPORT,TASK_TYPE_WECHAT_ADGROUP_DAILY_REPORT,TASK_TYPE_WECHAT_ADVERTISING_DATA。

请求示例


curl 'https://api.e.qq.com/v1.1/async_tasks/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'task_name=test task name' \
-d 'task_type=TASK_TYPE_AGENCY_AD_HOURLY_REPORT' \
-d 'task_spec={"task_type_agency_ad_hourly_report_spec":{"date":"2018-08-28"}}' 
					

应答字段

名称 类型 描述
task_id
integer 任务 id

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "task_id": 1024
    }
}

可视化调试工具

相关阅读

  • 异步任务限制每个账号(account_id)最多允许每5分钟创建1次
  • 任务 TASK_TYPE_WECHAT_MOMENTS_ADGROUP_HOURLY_REPORT 仅支持QQ账号授权获取的token拉取通过API投放的朋友圈广告报表
  • 任务 TASK_TYPE_WECHAT_ADGROUP_HOURLY_REPORT 和 TASK_TYPE_WECHAT_ADGROUP_DAILY_REPORT 仅支持微信公众平台广告主授权获取的token拉取微信公众平台投放广告的报表,account_id只能为服务商id

获取异步任务
全部接口
V1.1
loading

所属权限 Ads Insight
请求地址 async_tasks/get
请求方法 get

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性
fields get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回

请求参数

参数仅适用于腾讯广告平台及微信公众平台。其中,标有的内容表示,该参数在微信公众平台使用时,描述不同。标有*的参数为必填项

名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
filtering
struct[] 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件]
数组最小长度 1,最大长度 2
field*
string 过滤字段
可选值:{ task_id, task_name }
operator*
enum 操作符
当 field 取值 task_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 task_name 时,枚举列表:{ EQUALS, CONTAINS }
values*
string[] 字段取值

当 field 取值 task_name 时,
字段长度最小 1 字节,长度最大 120 字节
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10
最小值 1,最大值 100

使用说明

  1. 异步任务获取接口支持 7 日内任务记录的查询,单生成任务文件下载有效期为 24 小时。

请求示例


curl -G 'https://api.e.qq.com/v1.1/async_tasks/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[{"field":"task_id","operator":"EQUALS","values":["1024"]}]' \
-d 'page=1' \
-d 'page_size=10' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
task_id
integer 任务 id
task_name
string 同一帐号名下不允许重复
task_type
enum 任务类型(部分任务待废弃)具体请参考,[枚举详情]
status
enum 任务状态,[枚举详情]
created_time
integer 任务创建时间戳(Unix 时间戳,单位为秒),大于等于 0
result
struct 任务结果
code
integer 返回码,正常返回 0,异常返回大于 0
message
string 返回消息
data
struct 任务结果
file_info_list
struct[] 文件返回结果列表
file_id
integer 文件 id
md5
string 文件 md5
channel_package_info_list
struct[] 应用宝渠道包任务处理信息,仅支持当 task_type=TASK_TYPE_CREATE_ANDROID_CHANNEL_PACKAGE,TASK_TYPE_UPDATE_ANDROID_CHANNEL_PACKAGE 数据返回
android_app_id
integer 应用宝 APP id,大于等于 0
package_name
string 渠道包名称
status
enum 渠道包任务处理状态,[枚举详情]
error_code
enum 渠道包任务错误码,[枚举详情]
created_time
integer 任务创建时间戳(Unix 时间戳,单位为秒),大于等于 0
last_modified_time
integer 最后修改时间(时间戳)
union_channel_package_info_list
struct[] 广告渠道包任务处理信息,仅支持当 task_type=TASK_TYPE_CREATE_ANDROID_UNION_CHANNEL_PACKAGE,TASK_TYPE_UPDATE_ANDROID_UNION_CHANNEL_PACKAGE 数据返回
android_union_app_id
integer 广告包 APP id,大于等于 0
package_name
string 渠道包名称
status
enum 渠道包任务处理状态,[枚举详情]
created_time
integer 任务创建时间戳(Unix 时间戳,单位为秒),大于等于 0
last_modified_time
integer 最后修改时间(时间戳)
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "task_id": 1024,
                "task_name": "test task name",
                "task_type": "TASK_TYPE_AGENCY_AD_HOURLY_REPORT",
                "status": "TASK_STATUS_COMPLETED",
                "created_time": 1403243242,
                "result": {
                    "code": 0,
                    "message": "",
                    "data": {
                        "file_info_list": [
                            {
                                "file_id": 5,
                                "md5": "79054025255fb1a26e4bc422aef54eb4"
                            }
                        ]
                    }
                }
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具

相关阅读

  • 异步任务获取接口支持7日内任务记录的查询
  • 所生成任务文件下载有效期为24小时

获取文件接口
全部接口
V1.1
loading

所属权限 Ads Insight
请求地址 https://dl.e.qq.com/v1.1/async_task_files/get
请求方法 get

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性
fields get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回

请求参数

参数仅适用于腾讯广告平台及微信公众平台。其中,标有的内容表示,该参数在微信公众平台使用时,描述不同。标有*的参数为必填项

名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
task_id*
integer 任务 id
file_id*
integer 文件 id

使用说明

  1. 建议先下载整个文件,然后再解析。一边下载一边解析可能会因为处理时间较长而导致超时。

请求示例


curl -G 'https://dl.e.qq.com/v1.1/async_task_files/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'task_id=1024' \
-d 'file_id=<FILE_ID>' 
					

应答字段

应答示例

重定向到异步任务文件下载地址

相关阅读

  • 获取异步任务文件接口的域名为 dl.e.qq.com
  • 获取任务文件对应的数据字段说明,可参考【异步任务】章节