创建批量异步请求任务

所属权限 ads_management
请求地址 batch_async_requests/add
请求方法 POST
Content-Type application/json

全局参数

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

参数名称 参数类型
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
task_name*
string 任务名称
字段长度最小 1 字节,长度最大 120 字节
task_type*
string 枚举列表:{ 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_spec*
struct 任务所需条件
update_union_position_package_spec
struct[] 批量修改定投优量汇流量包列表信息,当且仅当 task_type = TASK_TYPE_UPDATE_UNION_POSITION_PACKAGE_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
union_position_package
integer[] 定投优量汇流量包 id 列表
数组最小长度 0,最大长度 20
update_exclude_union_position_package_spec
struct[] 批量修改广告组屏蔽优量汇流量包列表信息,当且仅当 task_type = TASK_TYPE_UPDATE_EXCLUDE_UNION_POSITION_PACKAGE_NEW 时,才可且必须使用
数组最小长度 0,最大长度 100
adgroup_id*
int64 广告组 id
exclude_union_position_package
integer[] 屏蔽优量汇流量包 id 列表
数组最小长度 0,最大长度 20
update_deep_conversion_behavior_bid_spec
struct[] ,当且仅当 task_type = TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_BID_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
deep_conversion_behavior_bid*
integer 深度优化行为的出价
最小值 0,最大值 1000000
delete_adgroup_spec
struct[] 批量删除广告组,当且仅当 task_type = TASK_TYPE_DELETE_ADGROUP_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
update_adgroup_deep_conversion_worth_rate_spec
struct[] 批量修改广告组深度优化价值的期望 ROI,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_RATE_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
deep_conversion_worth_rate*
float 深度优化价值的期望 ROI
最小值 0.001,最大值 1000,最多保留 3 位小数
targetings_share_spec
struct[] 批量定向包分享结构,当且仅当 task_type = TASK_TYPE_TARGETINGS_SHARE_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
targeting_id*
int64 定向包 id
share_to_account_id*
integer 分享的账户 id
share_type*
enum 分享类型,[枚举详情]
可选值:{ SHARE_TYPE_SAME_BUSINESS, SHARE_TYPE_SAME_MDM }
update_adgroup_configured_status_spec
struct[] 批量修改广告组客户设置的状态,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_CONFIGURED_STATUS_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
configured_status*
enum 客户设置的状态,[枚举详情]
可选值:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND }
update_adgroup_daily_budget_spec
struct[] 批量修改广告组日预算,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_DAILY_BUDGET_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
daily_budget*
integer 广告组日预算
update_adgroup_auto_acquisition_spec
struct[] 批量修改广告组一键起量,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_AUTO_ACQUISITION_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
auto_acquisition_enabled*
boolean 是否开启一键起量
可选值:{ true, false }
auto_acquisition_budget
integer 一键起量探索预算
最小值 20000,最大值 10000000
update_adgroup_deep_conversion_worth_advanced_rate_spec
struct[] 批量修改广告组深度优化价值的强化 ROI,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_ADVANCED_RATE_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
deep_conversion_worth_advanced_rate*
float 深度优化价值的强化 ROI
最小值 0.001,最大值 1000,最多保留 3 位小数
update_deep_conversion_behavior_advanced_bid_spec
struct[] ,当且仅当 task_type = TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_ADVANCED_BID_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
deep_conversion_behavior_advanced_bid*
integer 深度辅助行为的出价
最小值 0,最大值 1000000
reply_finder_object_comment_spec
struct[] 批量评论回复,当且仅当 task_type = TASK_TYPE_REPLY_FINDER_OBJECT_COMMENT_NEW 时,才可且必须使用
数组最小长度 1,最大长度 50
account_id*
integer 通用的用户 id,包括 user_id 和 account_id
reply_comment_id*
string 回复评论 id
字段长度最小 1 字节,长度最大 1024 字节
content*
string 评论内容
字段长度最小 1 字节,长度最大 10240 字节
finder_ad_object_id*
integer 广告动态 id
delete_finder_object_comment_spec
struct[] 批量删除评论,当且仅当 task_type = TASK_TYPE_DELETE_FINDER_OBJECT_COMMENT_NEW 时,才可且必须使用
数组最小长度 1,最大长度 50
account_id*
integer 通用的用户 id,包括 user_id 和 account_id
finder_ad_object_id*
integer 广告动态 id
comment_id*
string 回复评论 id
字段长度最小 1 字节,长度最大 1024 字节
update_finder_object_comment_flag_spec
struct[] 批量评论精选,当且仅当 task_type = TASK_TYPE_UPDATE_FINDER_OBJECT_COMMENT_FLAG_NEW 时,才可且必须使用
数组最小长度 1,最大长度 50
finder_ad_object_id*
integer 广告动态 id
op_type*
enum 设置视频号评论精选操作类型 URL,[枚举详情]
可选值:{ SET_OBJECT_COMMENT_FLAG_OP_TYPE_OPEN, SET_OBJECT_COMMENT_FLAG_OP_TYPE_CLOSE }
account_id*
integer 通用的用户 id,包括 user_id 和 account_id
comment_id
string 评论 id
字段长度最小 1 字节,长度最大 1024 字节
comment_level
integer
最小值 1,最大值 2
update_adgroup_time_spec
struct[] 批量修改广告组投放时间,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_TIME_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
account_id
integer 通用的用户 id,包括 user_id 和 account_id
time_series
string 投放时间段
字段长度为 336 字节
first_day_begin_time
string 首日开始投放时间
字段长度最小 0 字节,长度最大 8 字节
update_adgroup_date_spec
struct[] 批量修改广告组投放日期,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_DATE_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
begin_date*
string 开始投放日期
字段长度为 10 字节
end_date*
string 结束投放日期
字段长度最小 0 字节,长度最大 10 字节
account_id
integer 通用的用户 id,包括 user_id 和 account_id
update_adgroup_bid_amount_spec
struct[] 批量修改广告组出价,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_BID_AMOUNT_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
bid_amount*
integer 广告出价
account_id
integer 通用的用户 id,包括 user_id 和 account_id
is_potential
boolean 是否是潜力广告
可选值:{ true, false }
report_potential_data
string 潜力广告改价上报的信息
字段长度最小 2 字节,长度最大 1000 字节
update_adgroup_bind_rta_policy_spec
struct[] 批量修改广告组绑定的 rta 策略,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_BIND_RTA_POLICY_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
origin_rta_policy_uuid*
string 源 rta 策略
字段长度最小 0 字节,长度最大 1024 字节
target_rta_policy_uuid*
string 目标 rta 策略
字段长度最小 0 字节,长度最大 1024 字节
account_id
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
update_adcreative_object_comment_flag_spec
struct[] 批量评论管理,当且仅当 task_type = TASK_TYPE_UPDATE_ADCREATIVE_OBJECT_COMMENT_FLAG_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
finder_ad_object_id*
integer 广告动态 id
op_type*
enum 设置视频号评论管理操作类型 URL,[枚举详情]
可选值:{ SET_OBJECT_COMMENT_FLAG_OP_TYPE_OPEN, SET_OBJECT_COMMENT_FLAG_OP_TYPE_CLOSE }
account_id
integer 通用的用户 id,包括 user_id 和 account_id
update_dynamic_creative_configured_status_spec
struct[] 批量修改广告创意客户设置的状态,当且仅当 task_type = TASK_TYPE_UPDATE_DYNAMIC_CREATIVE_CONFIGURED_STATUS_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
dynamic_creative_id*
integer 广告创意 id
configured_status*
enum 客户设置的状态,[枚举详情]
可选值:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND }
delete_dynamic_creative_spec
struct[] 批量删除广告创意,当且仅当 task_type = TASK_TYPE_DELETE_DYNAMIC_CREATIVE_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
dynamic_creative_id*
integer 广告创意 id
process_user_page_object_spec
struct[] 批量沉淀动态,当且仅当 task_type = TASK_TYPE_PROCESS_USER_PAGE_OBJECT_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
account_id
integer 通用的用户 id,包括 user_id 和 account_id
ad_export_id*
string 视频号动态 id
字段长度最小 0 字节,长度最大 1024 字节
create_scheduled_update_adgroup_daily_budget_spec
struct[] 批量预设置广告组次日预算,当且仅当 task_type = TASK_TYPE_CREATE_SCHEDULED_UPDATE_ADGROUP_DAILY_BUDGET_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
daily_budget*
integer 广告组日预算
account_id
integer 通用的用户 id,包括 user_id 和 account_id
delete_scheduled_task_spec
struct[] 批量删除预设置任务,当且仅当 task_type = TASK_TYPE_DELETE_SCHEDULED_TASK_NEW 时,才可且必须使用
数组最小长度 1,最大长度 100
task_id*
integer 预设置任务 id
account_id
integer 通用的用户 id,包括 user_id 和 account_id
update_adgroup_targeting_task_spec
struct[] 批量修改定向任务,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_TARGETING 时,才可且必须使用
数组最小长度 1,最大长度 50
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
adgroup_id*
int64 广告组 id
need_upgrade_targeting
enum[] 支持批量更新的定向信息类型,[枚举详情]
数组最小长度 0,最大长度 10
可选值:{ GEO_LOCATION, CUSTOM_AUDIENCE, EXCLUDED_CUSTOM_AUDIENCE }
geo_location
struct 地理位置定向,"regions"、"business_districts"、"custom_locations" 不能同时为空。
location_types*
enum[] 地点类型,[枚举详情],选择限制:
  • 对于微信流量,仅能选择"LIVE_IN"(常住);
  • 使用商圈(business_district)以及自定义地理位置(custom_locations)时,仅可选 "VISITED_IN"(去过),"LIVE_IN"(常住);
  • 如:["LIVE_IN", "VISITED_IN"]

    数组最小长度 1,最大长度 5
    可选值:{ RECENTLY_IN, VISITED_IN, LIVE_IN, TRAVEL_IN, CAA_RECENTLY_IN, LIVE_AND_RECENTLY, INTELLIGENCE }
    regions
    integer[] 省市区县列表,可通过 [targeting_tags/get] 接口获取
    数组最小长度 0,最大长度 1000
    business_districts
    integer[] 商圈 id 列表,可通过 [targeting_tags/get] 接口获取
    数组最小长度 0,最大长度 400
    custom_locations
    struct[] 自定义地理位置列表,使用火星系坐标。
    数组最小长度 1,最大长度 400
    longitude*
    float64 经度,单位度
    最小值-180,最大值 180,最多保留 6 位小数
    latitude*
    float64 纬度,单位度
    最小值-90,最大值 90,最多保留 6 位小数
    radius*
    integer 半径,单位米
    最小值 200,最大值 25000
    geo_location_auto_audience
    boolean 是否使用地域优选
    可选值:{ true, false }
    custom_audience
    integer[] 定向用户群,通过 [创建人群接口] 创建的人群 id,custom_audience 和 excluded_custom_audience 个数之和不能超过 50 个
    数组最小长度 1,最大长度 200
    excluded_custom_audience
    integer[] 排除用户群,通过 [创建人群接口] 创建的人群 id,custom_audience 和 excluded_custom_audience 个数之和不能超过 50 个
    数组最小长度 1,最大长度 200
    update_adgroup_ecom_pkam_spec
    struct[] 批量修改广告组一键起量,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_ECOM_PKAM_NEW 时,才可且必须使用
    数组最小长度 1,最大长度 100
    adgroup_id*
    int64 广告组 id
    ecom_pkam_switch*
    enum 是否开启一方跑量,[枚举详情]
    可选值:{ ECOM_PKAM_SWITCH_CLOSE, ECOM_PKAM_SWITCH_OPEN }
    update_adgroup_derive_conf_spec
    struct[] ,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_DERIVE_CONF_NEW 时,才可且必须使用
    数组最小长度 1,最大长度 100
    adgroup_id*
    int64 广告组 id
    auto_derived_creative_enabled*
    boolean 是否开启自动衍生视频创意,该功能灰度开放中。

    开启后,根据广告主的投放数据以及上传的素材, 通过策略选择效果最佳的视频模板、音乐, 并复制已有创意元素, 程序化生成视频创意。

    derive_template_conf
    struct 定义衍生模版配置
    template_conf_list*
    struct[] 衍生配置列表
    数组最大长度 10
    template_list*
    integer[] 创意衍生自定义模版列表
    数组最小长度 0,最大长度 256
    adcreative_template_id*
    integer 创意衍生使用的原规格 id
    account_id
    integer 通用的用户 id,包括 user_id 和 account_id

    使用说明

    1. 该接口灰度开放,如需使用请线下联系对接渠道运营同事申请。

    请求示例

    
    curl 'https://api.e.qq.com/v3.0/batch_async_requests/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -H 'Content-Type: application/json' \
    -d '{
        "account_id": "<ACCOUNT_ID>",
        "task_name": "batch_async_request_task",
        "task_type": "TASK_TYPE_UPDATE_TARGETING_ID",
        "task_spec": {
            "update_targeting_id": [
                {
                    "adgroup_id": 1,
                    "targeting_id": 1
                }
            ]
        }
    }'
    					

    应答字段

    名称 类型 描述
    task_id
    integer 任务 id

    应答示例

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

    可视化调试工具