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

创建异步任务
全部接口
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_TYPE_REVIEW_ELEMENT_PREREVIEW_RESULT }
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 字节
task_type_review_element_prereview_result_spec
 struct 获取元素的预审结果条件，当且仅当 task_type = TASK_TYPE_REVIEW_ELEMENT_PREREVIEW_RESULT 时，才可且必须使用
adgroup_id
 int64 广告组 id
elements*
 struct[] 元素信息的列表
数组最小长度 1，最大长度 5
element_type*
 enum 元素类型，[枚举详情]
枚举列表：{ IMAGE, VIDEO, TXT, DEST_URL }
element_content*
 string 元素内容：1）当元素类型为“图片”时，取值为：image_id 图片 id 2）当元素类型为“视频”时，取值为：video_id 视频 id 3）当元素类型为“文本”时，取值为：文本内容 4）当元素类型为”落地页“时，取值为：落地页的 URL
字段长度最小 0 字节，长度最大 256 字节
element_key
 enum 元素 key，[枚举详情]
枚举列表：{ IMG, TXT, CORPORATE_NAME, CORPORATE_IMG, BRAND_CORPORATE_NAME, BRAND_CORPORATE_IMG, BRAND_CORPORATE_DESC, BUTTON_TXT, BUTTON_URL, VIDEO_POPUP_BUTTON_TXT, VIDEO_POPUP_BUTTON_URL, DESC, URL, LEFT_BOTTOM_TXT, BOTTOM_TXT, GIF, VIDEO, LEFT_UPPER_TXT, SHARE_DESC, SHARE_IMG }
supplement
 struct[] 补充信息，若此字段不传，或传空则视为无补充信息
数组最小长度 1，最大长度 50
field*
 string 过滤字段, 可选值：{ adcreative_template_id,mini_program_id,deep_link_url,site_set,campaign_id,is_dynamic_creative }
operator*
 enum 操作符
当 field 取值 adcreative_template_id 时，枚举列表：{ EQUALS }
当 field 取值 mini_program_id 时，枚举列表：{ EQUALS }
当 field 取值 deep_link_url 时，枚举列表：{ EQUALS }
当 field 取值 site_set 时，枚举列表：{ EQUALS, IN }
当 field 取值 campaign_id 时，枚举列表：{ EQUALS }
当 field 取值 is_dynamic_creative 时，枚举列表：{ EQUALS }
values*
 string[] 字段取值
当 field 取值 mini_program_id 时，
字段长度最小 1 字节，长度最大 400 字节

当 field 取值 deep_link_url 时，
字段长度最小 1 字节，长度最大 1000 字节

当 field 取值 site_set 时，
枚举列表：{ SITE_SET_QZONE, SITE_SET_QQCLIENT, SITE_SET_MUSIC, SITE_SET_MOBILE_UNION, SITE_SET_KUAISHOU, SITE_SET_QQCOM, SITE_SET_WECHAT, SITE_SET_MOBILE_MYAPP, SITE_SET_MOBILE_INNER, SITE_SET_TENCENT_NEWS, SITE_SET_TENCENT_VIDEO, SITE_SET_TENCENT_KUAIBAO, SITE_SET_MOBILE_YYB, SITE_SET_PENGYOU, SITE_SET_TUAN, SITE_SET_MEISHI, SITE_SET_PIAO, SITE_SET_MAIL, SITE_SET_PC_UNION, SITE_SET_YINGYONGBAO_PC, SITE_SET_PAIPAISEARCH, SITE_SET_QQSHOP, SITE_SET_PAIPAIDAOGOU, SITE_SET_QZONESEARCH, SITE_SET_WEBUNION_DELETED, SITE_SET_EXPRESSPORTAL, SITE_SET_WEIBO, SITE_SET_WANGGOU, SITE_SET_MOBILE_UNION_DELETED, SITE_SET_THIRDPARTY, SITE_SET_JD_WAICAI, SITE_SET_PCQQ, SITE_SET_KANDIAN, SITE_SET_QQ_MUSIC_GAME, SITE_SET_MOMENTS, SITE_SET_MINI_GAME_WECHAT, SITE_SET_MINI_GAME_QQ, SITE_SET_MOBILE_GAME, SITE_SET_QQSHOPPING }

当 field 取值 site_set 且 operator 取值 IN 时，
枚举列表：{ SITE_SET_QZONE, SITE_SET_QQCLIENT, SITE_SET_MUSIC, SITE_SET_MOBILE_UNION, SITE_SET_KUAISHOU, SITE_SET_QQCOM, SITE_SET_WECHAT, SITE_SET_MOBILE_MYAPP, SITE_SET_MOBILE_INNER, SITE_SET_TENCENT_NEWS, SITE_SET_TENCENT_VIDEO, SITE_SET_TENCENT_KUAIBAO, SITE_SET_MOBILE_YYB, SITE_SET_PENGYOU, SITE_SET_TUAN, SITE_SET_MEISHI, SITE_SET_PIAO, SITE_SET_MAIL, SITE_SET_PC_UNION, SITE_SET_YINGYONGBAO_PC, SITE_SET_PAIPAISEARCH, SITE_SET_QQSHOP, SITE_SET_PAIPAIDAOGOU, SITE_SET_QZONESEARCH, SITE_SET_WEBUNION_DELETED, SITE_SET_EXPRESSPORTAL, SITE_SET_WEIBO, SITE_SET_WANGGOU, SITE_SET_MOBILE_UNION_DELETED, SITE_SET_THIRDPARTY, SITE_SET_JD_WAICAI, SITE_SET_PCQQ, SITE_SET_KANDIAN, SITE_SET_QQ_MUSIC_GAME, SITE_SET_MOMENTS, SITE_SET_MINI_GAME_WECHAT, SITE_SET_MINI_GAME_QQ, SITE_SET_MOBILE_GAME, SITE_SET_QQSHOPPING }

当 field 取值 is_dynamic_creative 时，
枚举列表：{ DYNAMIC_CREATIVE, NOT_DYNAMIC_CREATIVE }

使用说明

  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
    }
}

可视化调试工具

相关阅读

广告报表异步任务

广告资源

广告技术

开发文档

辅助工具

帮助支持

手机浏览开发者官网

Copyright © 1998 - Tencent Inc. All Rights Reserved.