入门与指南专题介绍帐号管理营销资产广告管理数据洞察人群管理数据接入接口清单
授权认证 帐号管理 营销资产 广告管理 数据洞察 辅助工具 用户行为数据 用户人群数据 用户标签数据 用户属性数据
附录

推广计划 (Campaign)

V1.1

loading


本节将为您介绍推广计划 (Campaign) 相关接口。推广计划通常是一系列共享相同营销主题和预算的广告集合。关于推广计划更详细的介绍可以参考【推广计划】章节。


创建推广计划

campaigns/add

POST

*为必填项
名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
campaign_name*
string 推广计划名称(字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 1 字节,长度最大 180 字节
campaign_type*
enum 推广计划类型,[枚举详情]
枚举列表:{ CAMPAIGN_TYPE_NORMAL, CAMPAIGN_TYPE_WECHAT_MOMENTS }
promoted_object_type*
enum 推广目标类型,[枚举详情]
枚举列表:{ 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_QQ_BROWSER_MINI_PROGRAM, 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_JD }
daily_budget
integer 日消耗限额,单位为分,

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

  • 日预算要求介于 100,000 – 1,000,000,000 分之间(1,000 元-10,000,000 元,单位为人民币);
  • 修改后的日预算不能低于该计划今日已消耗金额的 1.5 倍;
  • 每次修改幅度不能低于 5000 分(50 元,单位为人民币)。
  • 对于非微信朋友圈广告(campaign_type != CAMPAIGN_TYPE_WECHAT_MOMENTS):

  • 日预算需介于 5,000 分-400,000,000 分之间(50 元-4,000,000 元,单位为人民币);
  • 每次修改幅度不能低于该计划今日已消耗金额加上 5,000 分(50 元,单位为人民币);
  • 每次修改幅度不能低于 5,000 分(50 元,单位为人民币);
  • 每天每计划最多修改 1,000 次;
  • configured_status
    enum 客户设置的状态,[枚举详情]
    枚举列表:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND }
    speed_mode
    enum 投放速度模式,默认值为标准投放,[枚举详情]
    枚举列表:{ SPEED_MODE_FAST, SPEED_MODE_STANDARD }
    
    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
    integer 推广计划 id
    {
        "code": 0,
        "message": "",
        "message_ch": "",
        "data": {
            "campaign_id": "<CAMPAIGN_ID>"
        }
    }


    更新推广计划

    campaigns/update

    POST

    *为必填项
    名称 类型 描述
    account_id*
    integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
    campaign_id*
    integer 推广计划 id
    campaign_name
    string 推广计划名称(字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
    字段长度最小 1 字节,长度最大 180 字节
    daily_budget
    integer 日消耗限额,单位为分,

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

  • 日预算要求介于 100,000 – 1,000,000,000 分之间(1,000 元-10,000,000 元,单位为人民币);
  • 修改后的日预算不能低于该计划今日已消耗金额的 1.5 倍;
  • 每次修改幅度不能低于 5000 分(50 元,单位为人民币)。
  • 对于非微信朋友圈广告(campaign_type != CAMPAIGN_TYPE_WECHAT_MOMENTS):

  • 日预算需介于 5,000 分-400,000,000 分之间(50 元-4,000,000 元,单位为人民币);
  • 每次修改幅度不能低于该计划今日已消耗金额加上 5,000 分(50 元,单位为人民币);
  • 每次修改幅度不能低于 5,000 分(50 元,单位为人民币);
  • 每天每计划最多修改 1,000 次;
  • configured_status
    enum 客户设置的状态,[枚举详情]
    枚举列表:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND }
    speed_mode
    enum 投放速度模式,默认值为标准投放,[枚举详情]
    枚举列表:{ SPEED_MODE_FAST, SPEED_MODE_STANDARD }
    
    curl 'https://api.e.qq.com/v1.1/campaigns/update?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -d 'account_id=<ACCOUNT_ID>' \
    -d 'campaign_id=<CAMPAIGN_ID>' \
    -d 'campaign_name=五一节大促推广计划' \
    -d 'daily_budget=50000' \
    -d 'configured_status=AD_STATUS_SUSPEND' \
    -d 'speed_mode=SPEED_MODE_STANDARD' 
    					
    名称 类型 描述
    campaign_id
    integer 推广计划 id
    {
        "code": 0,
        "message": "",
        "message_ch": "",
        "data": {
            "campaign_id": "<CAMPAIGN_ID>"
        }
    }


    获取推广计划

    campaigns/get

    GET

    *为必填项
    名称 类型 描述
    account_id*
    integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
    filtering
    struct[] 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件]
    数组最小长度 1,最大长度 5
    field*
    string 过滤字段
    可选值:{ campaign_id, configured_status, campaign_name, campaign_type, promoted_object_type, created_time, last_modified_time }
    operator*
    enum 操作符
    当 field 取值 campaign_id 时,枚举列表:{ EQUALS, IN }
    当 field 取值 configured_status 时,枚举列表:{ EQUALS }
    当 field 取值 campaign_name 时,枚举列表:{ EQUALS, CONTAINS }
    当 field 取值 campaign_type 时,枚举列表:{ EQUALS }
    当 field 取值 promoted_object_type 时,枚举列表:{ EQUALS }
    当 field 取值 created_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
    当 field 取值 last_modified_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
    values*
    string[] 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件]

    当 field 取值 configured_status 时,
    枚举列表:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND }

    当 field 取值 campaign_name 时,
    字段长度最小 1 字节,长度最大 120 字节

    当 field 取值 campaign_type 时,
    枚举列表:{ CAMPAIGN_TYPE_SEARCH, CAMPAIGN_TYPE_NORMAL, CAMPAIGN_TYPE_WECHAT_OFFICIAL_ACCOUNTS, CAMPAIGN_TYPE_WECHAT_MOMENTS }

    当 field 取值 promoted_object_type 时,
    枚举列表:{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT, PROMOTED_OBJECT_TYPE_QQ_BROWSER_MINI_PROGRAM, PROMOTED_OBJECT_TYPE_LINK, PROMOTED_OBJECT_TYPE_QQ_MESSAGE, PROMOTED_OBJECT_TYPE_QZONE_VIDEO_PAGE, PROMOTED_OBJECT_TYPE_LOCAL_ADS, PROMOTED_OBJECT_TYPE_ARTICLE, PROMOTED_OBJECT_TYPE_LEAD_AD, PROMOTED_OBJECT_TYPE_TENCENT_KE, PROMOTED_OBJECT_TYPE_EXCHANGE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_QZONE_PAGE_ARTICLE, PROMOTED_OBJECT_TYPE_QZONE_PAGE_IFRAMED, PROMOTED_OBJECT_TYPE_QZONE_PAGE, PROMOTED_OBJECT_TYPE_APP_PC, PROMOTED_OBJECT_TYPE_MINI_GAME_WECHAT, PROMOTED_OBJECT_TYPE_JD }

    当 field 取值 created_time 时,
    字段长度为 10 字节

    当 field 取值 last_modified_time 时,
    字段长度为 10 字节
    page
    integer 搜索页码,默认值:1
    最小值 1,最大值 99999
    page_size
    integer 一页显示的数据条数,默认值:10
    最小值 1,最大值 100
    is_deleted
    boolean 是否已删除,true:是,false:否
    可选值:{ true, false }
    • is_deleted 参数不传时默认为 false,只返回未删除记录。
    • is_deleted 参数为 true 时,需要同时在 filtering 传参数 last_modified_time。
    • 当根据推广计划 id 进行查询且 is_deleted 参数不传或为 false 时,获取的推广计划列表包含已删除的推广计划。
    
    curl -G 'https://api.e.qq.com/v1.1/campaigns/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -d 'account_id=<ACCOUNT_ID>' \
    -d 'filtering=[{"field":"configured_status","operator":"EQUALS","values":["AD_STATUS_SUSPEND"]}]' \
    -d 'page=1' \
    -d 'page_size=10' \
    -d 'is_deleted=false' 
    					
    名称 类型 描述
    list
    struct[] 返回信息列表
    campaign_id
    integer 推广计划 id
    campaign_name
    string 推广计划名称(字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
    configured_status
    enum 客户设置的状态,[枚举详情]
    campaign_type
    enum 推广计划类型,[枚举详情]
    promoted_object_type
    enum 推广目标类型,[枚举详情]
    daily_budget
    integer 日消耗限额,单位为分
    budget_reach_date
    integer 日限额到达日期,值为最近一次触达日限额的日期,如无触达记录则为空,如:20170501,表示最近一次到达日限额的日期是 5 月 1 日,若今天是 5 月 1 日,则表示今天已经到达日限额
    created_time
    integer 创建时间(时间戳)
    last_modified_time
    integer 最后修改时间(时间戳)
    speed_mode
    enum 投放速度模式
    is_deleted
    boolean 是否已删除,true:是,false:否
    page_info
    struct 分页配置信息
    page
    integer 搜索页码
    page_size
    integer 一页显示的数据条数
    total_number
    integer 总条数
    total_page
    integer 总页数
    {
        "code": 0,
        "message": "",
        "message_ch": "",
        "data": {
            "list": [
                {
                    "campaign_id": "<CAMPAIGN_ID>",
                    "campaign_name": "五一节大促推广计划",
                    "configured_status": "AD_STATUS_SUSPEND",
                    "campaign_type": "CAMPAIGN_TYPE_NORMAL",
                    "promoted_object_type": "PROMOTED_OBJECT_TYPE_APP_IOS",
                    "daily_budget": 50000,
                    "budget_reach_date": 20170501,
                    "created_time": 1491019858,
                    "last_modified_time": 1491098468,
                    "speed_mode": "SPEED_MODE_STANDARD",
                    "is_deleted": false
                }
            ],
            "page_info": {
                "page": 1,
                "page_size": 10,
                "total_number": 1,
                "total_page": 1
            }
        }
    }


    删除推广计划

    campaigns/delete

    POST

    *为必填项
    名称 类型 描述
    account_id*
    integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
    campaign_id*
    integer 推广计划 id
    • 仅支持删除暂停状态的推广计划。
    • 推广计划删除操作,除了删除推广计划本身之外,也会同时删除推广计划下的所有广告组,且此操作不可逆,请谨慎调用。
    • 如果 campaign 下 adgroup 数太多,删除时可能超时失败,可以重试。
    
    curl 'https://api.e.qq.com/v1.1/campaigns/delete?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -d 'account_id=<ACCOUNT_ID>' \
    -d 'campaign_id=<CAMPAIGN_ID>' 
    					
    名称 类型 描述
    campaign_id
    integer 推广计划 id
    {
        "code": 0,
        "message": "",
        "message_ch": "",
        "data": {
            "campaign_id": "<CAMPAIGN_ID>"
        }
    }