推广计划 (Campaign)

V1.1

loading

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

创建推广计划（campaigns/add）

所属权限（scope）：Ads Management

更新推广计划（campaigns/update）

所属权限（scope）：Ads Management

获取推广计划（campaigns/get）

所属权限（scope）：Ads Management, Ads Insights

删除推广计划（campaigns/delete）

所属权限（scope）：Ads Management

创建推广计划
全部接口
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 对应的唯一的广告资源。支持的接口列表参考投放接口错误处理指引章节

请求头名称

描述

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, CAMPAIGN_TYPE_FREETRADE, CAMPAIGN_TYPE_CONTENT_PROMOTION }
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 }

使用说明

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>"
    }
}

可视化调试工具

更新推广计划
全部接口
V1.1
loading

所属权限	Ads Management
请求地址	campaigns/update
请求方法	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
campaign_id*	int64	推广计划 id
campaign_name	string	推广计划名称，字段长度最小 1 个等宽字符，长度最大 60 等宽字符（即字段最大长度为 60 个中文字或全角标点，120 个英文字或半角标点。一个等宽字符等价于一个中文，等价于两个英文。）
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 }

使用说明

CAMPAIGN_TYPE_WECHAT_MOMENTS 已废弃，可切换使用 CAMPAIGN_TYPE_NORMAL。

请求示例


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	int64	推广计划 id

应答示例

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

可视化调试工具

获取推广计划
全部接口
V1.1
loading

所属权限	Ads Management,Ads Insights
请求地址	campaigns/get
请求方法	get

全局参数

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

参数名称	参数类型
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
filtering	struct[]	过滤条件，若此字段不传，或传空则视为无限制条件，详见 [过滤条件] 数组最小长度 1，最大长度 5
field*	string	过滤字段可选值：{ campaign_id, configured_status, campaign_name, campaign_type, promoted_object_type, created_time, last_modified_time, buying_type }
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 } 当 field 取值 buying_type 时，枚举列表：{ EQUALS }
values*	string[]	字段取值，values 数组的个数限制与 operator 的取值相关，详见 [过滤条件] 当 field 取值 configured_status 时，枚举列表：{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND } 当 field 取值 campaign_name 时，字段长度最小 1 字节，长度最大 180 字节当 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_MINI_GAME_QQ, PROMOTED_OBJECT_TYPE_COUPON_WECHAT, PROMOTED_OBJECT_TYPE_APP_PROMOTION, PROMOTED_OBJECT_TYPE_WECHAT_CHANNELS, PROMOTED_OBJECT_TYPE_WECHAT_OFFICIAL_ACCOUNT, PROMOTED_OBJECT_TYPE_MINI_PROGRAM_WECHAT, PROMOTED_OBJECT_TYPE_APP_QUICK_APP } 当 field 取值 created_time 时，字段长度为 10 字节当 field 取值 last_modified_time 时，字段长度为 10 字节当 field 取值 buying_type 时，枚举列表：{ BUYINGTYPE_AUCTION, BUYINGTYPE_CONTRACT, BUYINGTYPE_RESERVED, BUYINGTYPE_FIXED_PRICE }
page	integer	搜索页码，默认值：1 最小值 1，最大值 99999
page_size	integer	一页显示的数据条数，默认值：10。最小值 1，最大值 100
is_deleted	boolean	是否已删除，true：是，false：否可选值：{ true, false }
weixin_official_accounts_upgrade_enabled	boolean	针对微信公众号账户是否使用升级的新调用方式，true：使用升级的新方式，false：不使用，不传则默认值 false ；详细情况请查看公告[Marketing API 微信公众平台账户服务升级] 可选值：{ true, false }

使用说明

当且仅当根据推广计划 id 进行查询时，获取的推广计划列表包含已删除的推广计划。
created_time 和 last_modified_time 的 values 值为时间戳，单位为秒，时区为 GMT+8。

请求示例


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	int64	推广计划 id
campaign_name	string
configured_status	enum	客户设置的状态，[枚举详情]
campaign_type	enum	推广计划类型，[枚举详情]
promoted_object_type	enum	推广目标类型，[枚举详情]
daily_budget	integer	日预算，单位为分
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 次
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_cn": "",
    "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
        }
    }
}

可视化调试工具

删除推广计划
全部接口
V1.1
loading

所属权限	Ads Management
请求地址	campaigns/delete
请求方法	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
campaign_id*	int64	推广计划 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	int64	推广计划 id

应答示例

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

首页

开发文档

最新动态

腾讯广告

推广计划 (Campaign)

V1.1

loading

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

全局参数

特定请求头参数

请求参数

请求示例

场景组合示例

应答字段

应答示例

可视化调试工具

相关阅读

更新推广计划
全部接口
V1.1
loading

全局参数

请求参数

请求示例

应答字段

应答示例

可视化调试工具

相关阅读

获取推广计划
全部接口
V1.1
loading

全局参数

请求参数

请求示例

应答字段

应答示例

可视化调试工具

相关阅读

删除推广计划
全部接口
V1.1
loading

全局参数

请求参数

请求示例

应答字段

应答示例

可视化调试工具

相关阅读

首页

开发文档

最新动态

腾讯广告

推广计划 (Campaign) V1.1 loading

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

全局参数

特定请求头参数

请求参数

请求示例

场景组合示例

应答字段

应答示例

可视化调试工具

相关阅读

更新推广计划 全部接口 V1.1 loading

全局参数

请求参数

请求示例

应答字段

应答示例

可视化调试工具

相关阅读

获取推广计划 全部接口 V1.1 loading

全局参数

请求参数

请求示例

应答字段

应答示例

可视化调试工具

相关阅读

删除推广计划 全部接口 V1.1 loading

全局参数

请求参数

请求示例

应答字段

应答示例

可视化调试工具

相关阅读

推广计划 (Campaign)

V1.1

loading

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

更新推广计划
全部接口
V1.1
loading

获取推广计划
全部接口
V1.1
loading

删除推广计划
全部接口
V1.1
loading