更新广告
开发环境
开发环境
POST
/v1.3/local/update
请求参数
名称 | 类型 | 描述 |
---|---|---|
account_id* | integer | 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id |
adgroup_id* | int64 | 广告组 id |
adgroup | struct | 广告组结构 |
adgroup_name | string | 广告组名称,同一帐号下的广告组名称不允许重复。字段长度最小 1 个等宽字符,最大 60 等宽字符(一个等宽字符等价于一个中文,或两个英文。) 字段长度最小 1 字节,长度最大 180 字节 |
begin_date | string | 开始投放日期,日期格式:YYYY-MM-DD,且小于等于 end_date。只有审核驳回的广告才能修改时间,最早投放日期为 T+2,比如当前日期是 1 号,则起始日期最早为 3 号。 字段长度为 10 字节 |
configured_status | enum | 客户设置的状态,[枚举详情] 枚举列表:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND } |
targeting | struct | 广告定向,年龄、性别必填,年龄需设置上下限,性别为空时表示全选 |
age* | struct[] | 年龄定向(仅支持单年龄段,范围为 14~66,66 代表的是 66 岁及 66 岁以上) 数组长度为 1 |
min* | integer | 年龄下限,其中 15、16、17 不可用 最小值 14,最大值 66 |
max* | integer | 年龄上限 最小值 14,最大值 66 |
gender | enum[] | 性别定向(仅单选),[枚举详情] 数组长度为 1 枚举列表:{ MALE, FEMALE } |
education | enum[] | 用户学历,[枚举详情] 数组最小长度 1,最大长度 100 枚举列表:{ DOCTOR, MASTER, BACHELOR, SENIOR, JUNIOR, PRIMARY, JUNIOR_COLLEGE } |
poi_list | string[] | 微信门店 poi list 数组最大长度 10 字段长度最小 0 字节,长度最大 1024 字节 |
poi_radius | integer | 最大投放半径范围,单位为米 最小值 3000,最大值 20000 |
campaign | struct | 计划结构 |
campaign_name | string | 推广计划名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(一个等宽字符等价于一个中文,或等于两个英文。) 字段长度最小 1 字节,长度最大 180 字节 |
adcreative | struct | 广告创意结构 |
adcreative_name | string | 创意名称,长度最小 1 个等宽字符,最大 60 等宽字符(一个等宽字符等价于一个中文,或等价于两个英文。) 字段长度最小 1 字节,长度最大 180 字节 |
adcreative_elements | struct | 创意元素 |
title* | string | 广告标题,默认规格 1707 需要 10 个汉字以内,如果使用 311 规格需要在 30 个字以内,广告标题 字段长度最小 1 字节,长度最大 32 字节 |
description | string | 广告描述,30 个汉字以内,使用 1707 规格描述字段必填,使用 311 规格描述字段不用填 字段长度最小 1 字节,长度最大 10240 字节 |
image_list | string[] | 广告图片,图片规格 1707 规格对应:800450,311 规格对应 800800。数组元素是图片 id,可通过 [images 模块] 上传图片获得。目前只能设置一张图片 字段长度最小 1 字节,长度最大 192 字节 |
page_spec | struct | 落地页信息,不同 page_type 填写的信息不同。page_type 为 PAGE_TYPE_MINI_PROGRAM_WECHAT 时需填写 mini_program_spec,page_type 为 PAGE_TYPE_MINI_PROGRAM_CANVAS_WECHAT 时需填写 alita_page_spec |
mini_program_spec | struct | 小程序落地页,mini_program_id 和 mini_program_path 要同时填写 |
mini_program_id* | string | 小程序原始 id,格式类似 gh_xxxxx 字段长度最小 1 字节,长度最大 384 字节 |
mini_program_path* | string | 小程序路径 字段长度最小 1 字节,长度最大 2048 字节 |
alita_page_spec | struct | 微信小程序原生页 |
button_tips* | string | 优惠描述,包括使用规则,不超过 60 个字 字段长度最小 1 字节,长度最大 120 字节 |
coupon_title* | string | 优惠标题,不超过 10 个字 字段长度最小 1 字节,长度最大 32 字节 |
begin_date* | string | 开始日期,日期格式:YYYY-MM-DD,且小于等于 end_date 字段长度为 10 字节 |
end_date* | string | 结束日期,日期格式:YYYY-MM-DD 字段长度为 10 字节 |
profile_id | integer | profile 页自定义昵称头像,可通过 [profile 模块] 上传头像昵称获得。目前一个账户最多 5 个 |
profile_type | enum | 头像类型,使用自定义类型需要传 profile id,通过该字段实现类型的切换,[枚举详情] 枚举列表:{ LOCAL_PROFILE_TYPE_DEFAULT, LOCAL_PROFILE_TYPE_CUSTOMIZED |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1.3/local/update' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--data-urlencode 'account_id=<ACCOUNT_ID>' \
--data-urlencode 'adgroup_id=123456789' \
--data-urlencode 'adgroup={
"adgroup_name": "推广广告",
"targeting": {
"age": [],
"gender": [],
"education": []
},
"poi_list": []
}' \
--data-urlencode 'campaign=[]' \
--data-urlencode 'adcreative={
"adcreative_name": "广告创意",
"adcreative_elements": {
"image_list": []
},
"page_spec": {
"mini_program_spec": [],
"alita_page_spec": []
}
}'
响应示例响应示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"adgroup_id": 123456789
}
}
请求参数
Header 参数
access_token
string
必需
默认值:
<ACCESS_TOKEN>
timestamp
string
必需
MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8,例如当时间戳为1494840119时,表示 2018-05-15 17:21:59
默认值:
<TIMESTAMP>
nonce
string
必需
默认值:
<NONCE>
Body 参数application/x-www-form-urlencoded
account_id
integer
必需
示例值:
<ACCOUNT_ID>
adgroup_id
integer
广告组 id
示例值:
123456789
adgroup
string
广告组结构
示例值:
{
"adgroup_name": "推广广告",
"targeting": {
"age": [],
"gender": [],
"education": []
},
"poi_list": []
}
campaign
string
计划结构
示例值:
[]
adcreative
string
广告创意结构
示例值:
{
"adcreative_name": "广告创意",
"adcreative_elements": {
"image_list": []
},
"page_spec": {
"mini_program_spec": [],
"alita_page_spec": []
}
}
返回响应
修改于 2023-11-08 08:05:30