创建异步任务
开发环境
开发环境
POST
/v1.3/async_tasks/add
请求参数
名称 | 类型 | 描述 |
---|---|---|
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_TYPE_MASSIVE_KEYWORD_RECOMMEND, TASK_TYPE_SEARCH_DOWNLOAD_ALL } |
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 } |
task_type_massive_keyword_recommend_spec | struct | 海量拓词任务,当且仅当 task_type = TASK_TYPE_MASSIVE_KEYWORD_RECOMMEND 时, 才可且必须使用 |
massive_keyword_recommend_data_info* | struct | 拓词参数 |
seed_words* | string[] | 种子词列表 数组最小长度 1,最大长度 1000 字段长度最小 1 字节,长度最大 60 字节 |
is_filter_purchased_words* | enum | 是否过滤已购买词,[枚举详情] 枚举列表:{ FILTER_DISABLED, FILTER_ENABLED } |
site_sets* | enum[] | 流量类型,[枚举详情] 数组长度为 1 枚举列表:{ SITE_SET_WECHAT_SEARCH, SITE_SET_QBSEARCH } |
exclude_words | string[] | 不包含词列表 数组最小长度 0,最大长度 100 字段长度最小 1 字节,长度最大 60 字节 |
contains_non_regional_words | enum | 是否包含非地域词,[枚举详情] 枚举列表:{ CONTAINS_REGION_ENABLED, CONTAINS_REGION_DISABLED } |
word_province | integer[] | 地域词省份编码,具体值参照附录中的 [地域信息] 数组最小长度 0,最大长度 35 |
word_city | integer[] | 地域词市编码,具体值参照附录中的 [地域信息] 数组最小长度 0,最大长度 500 |
task_type_search_download_all_spec | struct | 搜索整账户下载数据查询条件,当且仅当 task_type = TASK_TYPE_SEARCH_DOWNLOAD_ALL 时,才可且必须使用 |
campaign_ids | integer[] | 推广计划 id,数量不超过 100 个 数组最小长度 0,最大长度 100 |
adcleaner_update_adgroup_configured_status_spec | struct | 广告清理工具设置广告,当且仅当 task_type = TASK_TYPE_ADCLEANER_UPDATE_ADGROUP_CONFIGURED_STATUS 时,才可且必须使用 |
adclean_data* | struct | 更新数据 |
is_select_all | string | 是否选择全部数据 字段长度最小 0 字节,长度最大 256 字节 |
clean_data* | struct[] | 待清理广告数据 数组最小长度 0,最大长度 100 |
adgroup_id* | int64 | 广告组 id |
configured_status* | enum | 客户设置的状态,[枚举详情] 枚举列表:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND } |
account_id | integer | 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id |
query_info | string | 查询清理广告信息 字段长度最小 1 字节,长度最大 2024 字节 |
clean_mode* | enum | 清理模式,[枚举详情] 枚举列表:{ SYSTEM_CLEAN_LIGHT_MODE, SYSTEM_CLEAN_MODERATE_MODE, SYSTEM_CLEAN_SERIOUS_MODE, CUSTOM_CLEAN_MODE } |
adcleaner_delete_adgroup_spec | struct | 广告清理工具删除广告,当且仅当 task_type = TASK_TYPE_ADCLEANER_DELETE_ADGROUP 时,才可且必须使用 |
adclean_data* | struct | 删除数据 |
is_select_all | string | 是否选择全部数据 字段长度最小 0 字节,长度最大 256 字节 |
clean_data* | struct[] | 待清理广告数据 数组最小长度 0,最大长度 100 |
adgroup_id* | int64 | 广告组 id |
account_id | integer | 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id |
query_info | string | 查询清理广告信息 字段长度最小 1 字节,长度最大 2024 字节 |
clean_mode* | enum | 清理模式,[枚举详情] 枚举列表:{ SYSTEM_CLEAN_LIGHT_MODE, SYSTEM_CLEAN_MODERATE_MODE, SYSTEM_CLEAN_SERIOUS_MODE, CUSTOM_CLEAN_MODE } |
weixin_official_accounts_upgrade_enabled | boolean | 针对微信公众号账户是否使用升级的新调用方式,true:使用升级的新方式,false:不使用,不传则默认值 false ;详细情况请查看公告[Marketing API 微信公众平台账户服务升级] 可选值:{ true, false } |
使用说明 1.该接口灰度开放,如需使用请线下联系对接渠道运营同事申请。 2.只能由代理商账户创建的任务有:TASK_TYPE_WECHAT_ADGROUP_HOURLY_REPORT,TASK_TYPE_WECHAT_ADGROUP_DAILY_REPORT,TASK_TYPE_WECHAT_ADVERTISING_DATA。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1.3/async_tasks/add' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--data-urlencode 'account_id=<ACCOUNT_ID>' \
--data-urlencode 'task_name=test task name' \
--data-urlencode 'task_type=TASK_TYPE_AGENCY_AD_HOURLY_REPORT' \
--data-urlencode 'task_spec={"task_type_agency_ad_hourly_report_spec":{"date":"2018-08-28"}}'
响应示例响应示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"task_id": 1024
}
}
请求参数
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>
task_name
string
必需
字段长度最小 1 字节,长度最大 120 字节
示例值:
test task name
task_type
string
必需
枚举列表:{ 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_TYPE_MASSIVE_KEYWORD_RECOMMEND, TASK_TYPE_SEARCH_DOWNLOAD_ALL }
示例值:
TASK_TYPE_AGENCY_AD_HOURLY_REPORT
task_spec
string
任务所需条件
示例值:
{"task_type_agency_ad_hourly_report_spec":{"date":"2018-08-28"}}
返回响应
修改于 2023-11-09 02:35:00