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

创建广告
全部接口
V1.1
loading

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

请求参数

参数仅适用于微信公众平台,暂不支持腾讯广告平台。
标有*的参数为必填项

名称 类型 描述
adgroup*
struct 广告组结构
adgroup_name*
string 广告组名称,同一帐号下的广告组名称不允许重复。字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 1 字节,长度最大 180 字节
begin_date*
string 开始投放日期,日期格式:YYYY-MM-DD,且日期小于等于 end_date。附近推场景下最早投放时间为 T+2,比如当前时间是 1 号,则起始时间最早为 3 号。
字段长度为 10 字节
targeting
struct 定向详细设置,存放所有定向条件,附近推场景年龄、性别定向必填
age
struct[] 年龄定向(仅支持单年龄段,范围为 14~66,66 代表的是 66 岁及 66 岁以上,如 18~66 代表大于等于 18 岁)
数组长度为 1
min*
integer 年龄最小值限制,其中 15、16、17 不可用
最小值 14,最大值 66
max*
integer 年龄最大值限制
最小值 14,最大值 66
gender
enum[] 性别定向(仅单选),[枚举详情]
数组长度为 1
枚举列表:{ MALE, FEMALE }
poi_list
string[] 微信门店 poi list,附近推场景下必填
数组最大长度 100
字段长度最小 0 字节,长度最大 1024 字节
package_level
enum 套餐级别,附近推场景下必填,[枚举详情]
枚举列表:{ PACKAGE_LEVEL_2000, PACKAGE_LEVEL_5000, PACKAGE_LEVEL_9000 }
cold_start_audience
integer[] 冷启动人群包列表
数组最大长度 10
campaign*
struct 计划结构
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
campaign_name*
string 推广计划名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 1 字节,长度最大 180 字节
adcreative*
struct 广告创意结构
adcreative_name*
string 广告创意名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 1 字节,长度最大 180 字节
adcreative_elements*
struct 创意元素
title
string 广告文案
字段长度最小 1 字节,长度最大 10240 字节
description
string 广告描述。附近推场景必填。
字段长度最小 1 字节,长度最大 10240 字节
image_list
string[] 图片墙,图片 id 通过 [images 模块] 上传图片获得。附近推场景只支持最大数组为 1,图片墙
数组最小长度 1,最大长度 12
字段长度最小 1 字节,长度最大 192 字节
page_type*
enum 落地页类型,[枚举详情]
枚举列表:{ PAGE_TYPE_MINI_PROGRAM_WECHAT, PAGE_TYPE_MINI_PROGRAM_CANVAS_WECHAT }
page_spec
struct 落地页信息,根据不同 promoted_object_type 和 page_type,要求的 page_spec 信息不同
mini_program_spec
struct 小程序落地页,mini_program_id 和 mini_program_path 要同时填写
mini_program_id*
string 小程序 id
字段长度最小 1 字节,长度最大 384 字节
mini_program_path*
string 小程序路径
字段长度最小 1 字节,长度最大 2048 字节
button_tips
string 按钮文案信息,只有当落地页为微信小程序原生页时才能填写,并且必填,60 个字
字段长度最小 1 字节,长度最大 120 字节
coupon_title
string 优惠信息,只有当落地页为微信小程序原生页时才能填写,并且必填,10 个字
字段长度最小 1 字节,长度最大 20 字节
ad*
struct 广告组结构
ad_name*
string 广告名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。),同一帐号下的广告名称不允许重复
字段长度最小 1 字节,长度最大 180 字节

请求示例


curl 'https://api.e.qq.com/v1.1/local/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'adgroup={
    "adgroup_name": "推广广告",
    "targeting": {
        "age": [],
        "gender": []
    },
    "poi_list": [],
    "cold_start_audience": []
}' \
-d 'campaign={
    "account_id": "<ACCOUNT_ID>"
}' \
-d 'adcreative={
    "adcreative_name": "广告创意",
    "adcreative_elements": {
        "image_list": []
    },
    "page_spec": {
        "mini_program_spec": []
    }
}' \
-d 'ad=[]' 
					

应答字段

名称 类型 描述
adgroup_id
integer 广告组 id

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "adgroup_id": "<ADGROUP_ID>"
    }
}

可视化调试工具