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

创建批量异步请求任务
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 batch_async_requests/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_UPDATE_UNION_POSITION_PACKAGE, TASK_TYPE_UPDATE_EXCLUDE_UNION_POSITION_PACKAGE, TASK_TYPE_UPDATE_TARGETING_ID, TASK_TYPE_UPDATE_BID_STRATEGY, TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_BID, TASK_TYPE_UPDATE_ADGROUP_APP_ANDROID_CHANNEL_PACKAGE_ID, TASK_TYPE_UPDATE_CAMPAIGN_SPEED_MODE, TASK_TYPE_DELETE_CAMPAIGN, TASK_TYPE_DELETE_ADGROUP, TASK_TYPE_DELETE_AD, TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_RATE, TASK_TYPE_UPDATE_ADCREATIVE_DEEP_LINK_URL, TASK_TYPE_TARGETINGS_SHARE, TASK_TYPE_UPDATE_CAMPAIGN_CONFIGURED_STATUS, TASK_TYPE_UPDATE_CAMPAIGN_DAILY_BUDGET, TASK_TYPE_UPDATE_ADGROUP_CONFIGURED_STATUS, TASK_TYPE_UPDATE_ADGROUP_DAILY_BUDGET, TASK_TYPE_UPDATE_AD_CONFIGURED_STATUS, TASK_TYPE_UPDATE_ADGROUP_AUTO_ACQUISITION, TASK_TYPE_UPDATE_ADCREATIVE_LANDING_PAGE, TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_ADVANCED_RATE, TASK_TYPE_REPLY_FINDER_OBJECT_COMMENT, TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_ADVANCED_BID, TASK_TYPE_UPDATE_FINDER_OBJECT_COMMENT_FLAG }
task_spec*
struct 任务所需条件
update_union_position_package_spec
struct[] 批量修改定投优量汇流量包列表信息,当且仅当 task_type = TASK_TYPE_UPDATE_UNION_POSITION_PACKAGE 时,才可且必须使用
数组最小长度 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 时,才可且必须使用
数组最小长度 0,最大长度 100
adgroup_id*
int64 广告组 id
exclude_union_position_package*
integer[] 屏蔽优量汇流量包 id 列表
数组最小长度 1,最大长度 20
update_targeting_id_spec
struct[] 批量修改广告定向包,当且仅当 task_type = TASK_TYPE_UPDATE_TARGETING_ID 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
targeting_id*
int64 定向包 id
update_bid_strategy_spec
struct[] 批量修改广告出价策略,当且仅当 task_type = TASK_TYPE_UPDATE_BID_STRATEGYT 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
bid_strategy*
enum 出价策略,[枚举详情]
枚举列表:{ BID_STRATEGY_AVERAGE_COST, BID_STRATEGY_TARGET_COST, BID_STRATEGY_PRIORITY_LOW_COST }
update_deep_conversion_behavior_bid_spec
struct[] 批量修改广告深度优化行为目标出价,当且仅当 task_type = TASK_TYPE_UPDATE_DEEP_CONVERSION_BEHAVIOR_BID 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
deep_conversion_behavior_bid*
integer 深度优化行为的出价
最小值 10,最大值 500000
update_adgroup_app_android_channel_package_id_spec
struct[] 批量修改广告组安卓应用渠道包 id,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_APP_ANDROID_CHANNEL_PACKAGE_ID 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
app_android_channel_package_id*
string 安卓应用渠道包 id
字段长度最小 0 字节,长度最大 128 字节
update_campaign_speed_mode_spec
struct[] 批量修改推广计划投放速度模式,当且仅当 task_type = TASK_TYPE_UPDATE_CAMPAIGN_SPEED_MODE 时,才可且必须使用
数组最小长度 1,最大长度 100
campaign_id*
int64 推广计划 id
speed_mode*
enum 投放速度模式,[枚举详情]
枚举列表:{ SPEED_MODE_FAST, SPEED_MODE_STANDARD }
delete_campaign_spec
struct[] 批量删除推广计划,当且仅当 task_type = TASK_TYPE_DELETE_CAMPAIGN 时,才可且必须使用
数组最小长度 1,最大长度 100
campaign_id*
int64 推广计划 id
delete_adgroup_spec
struct[] 批量删除广告组,当且仅当 task_type = TASK_TYPE_DELETE_ADGROUP 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
delete_ad_spec
struct[] 批量删除广告,当且仅当 task_type = TASK_TYPE_DELETE_AD 时,才可且必须使用
数组最小长度 1,最大长度 100
ad_id*
int64 广告 id
update_adgroup_deep_conversion_worth_rate_spec
struct[] 批量修改广告组深度优化价值的期望 ROI,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_RATE 时,才可且必须使用
数组最小长度 1,最大长度 100
adgroup_id*
int64 广告组 id
deep_conversion_worth_rate*
float 深度优化价值的期望 ROI
最小值 0.01,最大值 1000,最多保留 2 位小数
update_adcreative_deep_link_url_spec
struct[] 批量修改广告创意应用直达页 URL,当且仅当 task_type = TASK_TYPE_UPDATE_ADCREATIVE_DEEP_LINK_URL 时,才可且必须使用
数组最小长度 1,最大长度 100
adcreative_id*
int64 广告创意 id
deep_link_url*
string 应用直达页 URL
字段长度最小 0 字节,长度最大 2048 字节
targetings_share_spec
struct[] 批量定向包分享结构,当且仅当 task_type = TASK_TYPE_TARGETINGS_SHARE 时,才可且必须使用
数组最小长度 1,最大长度 100
targeting_id*
int64 定向包 id
share_to_account_id*
integer 分享的账户 id
share_type*
enum 分享类型,[枚举详情]
枚举列表:{ SHARE_TYPE_SAME_BUSINESS, SHARE_TYPE_SAME_MDM }
update_campaign_configured_status_spec
struct[] 批量修改推广计划客户设置的状态,当且仅当 task_type = TASK_TYPE_UPDATE_CAMPAIGN_CONFIGURED_STATUS 时,才可且必须使用
数组最小长度 1,最大长度 100
campaign_id*
int64 推广计划 id
configured_status*
enum 客户设置的状态,[枚举详情]
枚举列表:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND }
update_campaign_daily_budget_spec
struct[] 批量修改推广计划日预算,当且仅当 task_type = TASK_TYPE_UPDATE_CAMPAIGN_DAILY_BUDGET 时,才可且必须使用
数组最小长度 1,最大长度 100
campaign_id*
int64 推广计划 id
daily_budget*
integer 日预算,单位为分,设置为 0 表示不设预算(即不限),不传默认 0(即不限,建议必传),

对于微信朋友圈广告(campaign_type = CAMPAIGN_TYPE_WECHAT_MOMENTS):

  • 朋友圈广告日预算必填
  • 日预算要求介于 100,000 – 1,000,000,000 分之间(1,000 元-10,000,000 元,单位为人民币);
  • 修改后的日预算不能低于该广告组今日已消耗金额的 1.5 倍;
  • 每次修改幅度不能低于 5,000 分(50 元,单位为人民币)。

  • 对于非微信朋友圈广告(campaign_type != CAMPAIGN_TYPE_WECHAT_MOMENTS):

  • 日预算需介于 5,000 分-400,000,000 分之间(50 元-4,000,000 元,单位为人民币);
  • 每次修改幅度不能低于该 adgroup 今日已消耗金额加上 5,000 分(50 元,单位为人民币);
  • 每次修改幅度不能低于 5,000 分(50 元,单位为人民币);
  • 每天每广告组最多修改 1,000 次。
  • update_adgroup_configured_status_spec
    struct[] 批量修改广告组客户设置的状态,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_CONFIGURED_STATUS 时,才可且必须使用
    数组最小长度 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 时,才可且必须使用
    数组最小长度 1,最大长度 100
    adgroup_id*
    int64 广告组 id
    daily_budget*
    integer 日预算,单位为分,设置为 0 表示不设预算(即不限),不传默认 0(即不限,建议必传),

    对于微信朋友圈广告(campaign_type = CAMPAIGN_TYPE_WECHAT_MOMENTS):

  • 朋友圈广告日预算必填
  • 日预算要求介于 100,000 – 1,000,000,000 分之间(1,000 元-10,000,000 元,单位为人民币);
  • 修改后的日预算不能低于该广告组今日已消耗金额的 1.5 倍;
  • 每次修改幅度不能低于 5,000 分(50 元,单位为人民币)。

  • 对于非微信朋友圈广告(campaign_type != CAMPAIGN_TYPE_WECHAT_MOMENTS):

  • 日预算需介于 5,000 分-400,000,000 分之间(50 元-4,000,000 元,单位为人民币);
  • 每次修改幅度不能低于该 adgroup 今日已消耗金额加上 5,000 分(50 元,单位为人民币);
  • 每次修改幅度不能低于 5,000 分(50 元,单位为人民币);
  • 每天每广告组最多修改 1,000 次。
  • update_ad_configured_status_spec
    struct[] 批量修改广告客户设置的状态,当且仅当 task_type = TASK_TYPE_UPDATE_AD_CONFIGURED_STATUS 时,才可且必须使用
    数组最小长度 1,最大长度 100
    ad_id*
    int64 广告 id
    configured_status*
    enum 客户设置的状态,[枚举详情]
    枚举列表:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND }
    update_adgroup_auto_acquisition_spec
    struct[] 批量修改广告组一键起量,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_AUTO_ACQUISITION 时,才可且必须使用
    数组最小长度 1,最大长度 100
    adgroup_id*
    int64 广告组 id
    auto_acquisition_enabled*
    boolean 是否开启一键起量,(不传默认 false,建议必传)
    1. 一键起量会在 6 小时内尽量消耗完预算,期间产生的消耗不赔付,但转化计入赔付门槛判断;
    2. 一条广告仅可使用一次该功能,探索中任何原因导致广告暂停播放,都会导致起量中止。
    可选值:{ true, false }
    auto_acquisition_budget
    integer 一键起量探索预算,单位为分,一键起量预算设置后不可修改
    最小值 20000,最大值 10000000
    update_adcreative_landing_page_spec
    struct[] 批量修改广告创意落地页,当且仅当 task_type = TASK_TYPE_UPDATE_ADCREATIVE_LANDING_PAGE 时,才可且必须使用
    数组最小长度 1,最大长度 100
    adcreative_id*
    int64 广告创意 id
    ad_creative*
    struct 广告创意
    page_type*
    enum 落地页类型,[枚举详情]
    枚举列表:{ PAGE_TYPE_MINI_PROGRAM_WECHAT, PAGE_TYPE_MINI_PROGRAM_CANVAS_WECHAT }
    page_spec
    struct 落地页信息
    page_id
    int64 落地页 id
    page_url
    string 落地页 url
    字段长度最小 1 字节,长度最大 1023 字节
    override_canvas_head_option
    enum 创意覆盖原生页选项,[枚举详情]
    枚举列表:{ OPTION_CANVAS_OVERRIDE_CREATIVE, OPTION_CREATIVE_OVERRIDE_CANVAS, OPTION_KEEP_DIFFERENT }
    update_adgroup_deep_conversion_worth_advanced_rate_spec
    struct[] 批量修改广告组深度优化价值的强化 ROI,当且仅当 task_type = TASK_TYPE_UPDATE_ADGROUP_DEEP_CONVERSION_WORTH_ADVANCED_RATE 时,才可且必须使用
    数组最小长度 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 时,才可且必须使用
    数组最小长度 1,最大长度 100
    adgroup_id*
    int64 广告组 id
    deep_conversion_behavior_advanced_bid*
    integer 深度辅助行为的出价
    最小值 10,最大值 500000
    reply_finder_object_comment_spec
    struct[] 批量评论回复,当且仅当 task_type = TASK_TYPE_REPLY_ADCREATIVE_OBJECT_COMMENT 时,才可且必须使用
    数组最小长度 1,最大长度 50
    account_id
    integer 通用的用户 id,包括 user_id 和 account_id
    reply_comment_id*
    string 回复评论 id
    字段长度最小 1 字节,长度最大 1024 字节
    export_id*
    string 视频号动态
    字段长度最小 1 字节,长度最大 2048 字节
    content
    string 评论内容
    字段长度最小 1 字节,长度最大 10240 字节
    adcreative_id*
    int64 广告创意 id
    update_finder_object_comment_flag_spec
    struct[] 批量评论精选,当且仅当 task_type = TASK_TYPE_UPDATE_FINDER_OBJECT_COMMENT_FLAG 时,才可且必须使用
    数组最小长度 1,最大长度 50
    adcreative_id*
    int64 广告创意 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
    delete_finder_object_comment_spec
    struct[] 批量删除评论,当且仅当 task_type = TASK_TYPE_DELETE_FINDER_OBJECT_COMMENT 时,才可且必须使用
    数组最小长度 1,最大长度 50
    account_id
    integer 通用的用户 id,包括 user_id 和 account_id
    adcreative_id*
    int64 广告创意 id
    export_id*
    string 视频号动态
    字段长度最小 1 字节,长度最大 2048 字节
    comment_id*
    string 回复评论 id
    字段长度最小 1 字节,长度最大 1024 字节

    请求示例

    
    curl 'https://api.e.qq.com/v1.1/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
        }
    }

    可视化调试工具