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

创建推广计划
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 campaigns/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 中的字段。如不填写,则根据默认值进行返回

特定请求头参数

该接口支持一些特定请求头的参数,该参数支持放入请求的请求头中,注意不是请求体中。

请求头名称 描述
X-Request-Id 资源请求的唯一 id,该请求头参数用于保证接口重试的幂等性,即当请求参数是 A 时,X-Request-Id 为 B 时,即使重复请求,API 侧永远不会新建一个全新的广告资源,避免重试的时候重复创建。如果在创建时重复传入相同的请求参数和 X-Request-Id,那么会返回该 X-Request-Id 对应的唯一的广告资源。支持的接口列表参考投放接口错误处理指引章节

请求参数

标有*的参数为必填项

名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
campaign_name*
string 推广计划名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
campaign_type*
enum 推广计划类型,[枚举详情]
枚举列表:{ CAMPAIGN_TYPE_NORMAL, CAMPAIGN_TYPE_WECHAT_MOMENTS, CAMPAIGN_TYPE_SEARCH }
promoted_object_type*
enum 推广目标类型,[枚举详情]
当 campaign_type 取值 CAMPAIGN_TYPE_WECHAT_MOMENTS 时,枚举列表:{ PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_LEAD_AD, PROMOTED_OBJECT_TYPE_MINI_GAME_WECHAT }

当 campaign_type 取值 CAMPAIGN_TYPE_NORMAL 时,枚举列表:{PROMOTED_OBJECT_TYPE_LINK, PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT, PROMOTED_OBJECT_TYPE_QQ_MESSAGE, PROMOTED_OBJECT_TYPE_LEAD_AD, PROMOTED_OBJECT_TYPE_MINI_GAME_WECHAT, PROMOTED_OBJECT_TYPE_MINI_GAME_QQ, PROMOTED_OBJECT_TYPE_APP_QUICK_APP}

daily_budget
integer 推广计划日预算,单位为分,设置为 0 表示不设预算(即不限),

日预算要求介于 5,000 分– 4,000,000,000 分之间(50 元-40,000,000 元,单位为人民币)


当推广计划下有微信朋友圈广告(campaign_type=CAMPAIGN_TYPE_WECHAT_MOMENTS 或 site_set=SITE_SET_MOMENTS):

  • 下调日预算不能低于该推广计划今日已消耗金额的 1.5 倍
  • 每次修改幅度不能低于 5000 分(50 元,单位为人民币)

  • 当推广计划下为非微信朋友圈广告(campaign_type!=CAMPAIGN_TYPE_WECHAT_MOMENTS 且 site_set!=SITE_SET_MOMENTS):

  • 修改后的日预算不能低于该推广计划今日已消耗金额加上 5,000 分(50 元,单位为人民币)
  • 每次修改幅度不能低于 5,000 分(50 元,单位为人民币)
  • total_budget
    integer 推广计划总预算,单位为分,设置为 0 表示不设预算(即不限),
    总预算需介于 5,000 分-4,000,000,000 分之间(50 元-40,000,000 元,单位为人民币);
    修改后的总预算不能低于该计划累计总消耗金额加上今日已消耗金额的 0.5 倍,且不能低于当前计划累计总消耗金额加上 50,000 分(500 元,单位为人民币);
    每次修改幅度不能低于 5,000 分(50 元,单位为人民币);
    允许从不限预算(0)修改为指定预算,以及从指定总预算修改为不限预算(0);
    每天每计划最多修改 1,000 次
    最小值 0,最大值 4000000000
    configured_status
    enum 客户设置的状态,[枚举详情]
    枚举列表:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND }
    speed_mode
    enum 投放速度模式,默认值为标准投放,[枚举详情]
    枚举列表:{ SPEED_MODE_FAST, SPEED_MODE_STANDARD }

    使用说明

    1. CAMPAIGN_TYPE_WECHAT_MOMENTS 已废弃,可切换使用 CAMPAIGN_TYPE_NORMAL。

    请求示例

    
    curl 'https://api.e.qq.com/v1.1/campaigns/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -d 'account_id=<ACCOUNT_ID>' \
    -d 'campaign_name=五一节大促推广计划' \
    -d 'campaign_type=CAMPAIGN_TYPE_NORMAL' \
    -d 'promoted_object_type=PROMOTED_OBJECT_TYPE_APP_IOS' \
    -d 'daily_budget=50000' \
    -d 'configured_status=AD_STATUS_SUSPEND' \
    -d 'speed_mode=SPEED_MODE_STANDARD' 
    					

    场景组合示例

    枚举值会自动根据已选条件变化,只展示有示例数据的枚举值

    应答字段

    名称 类型 描述
    campaign_id
    int64 推广计划 id

    应答示例

    {
        "code": 0,
        "message": "",
        "message_cn": "",
        "data": {
            "campaign_id": "<CAMPAIGN_ID>"
        }
    }

    可视化调试工具

    相关阅读