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

更新广告创意
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 adcreatives/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
adcreative_id*
integer 广告创意 id
adcreative_name
string 广告创意名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 1 字节,长度最大 180 字节
adcreative_elements
struct 创意元素,不同 adcreative_template_id 要求的元素不尽相同,其中部分创意形式的文案元素支持换行能力,使用“\n ”表示换行,占 0.5 个等宽字符,建议行数不超过 6 行,具体情况可通过 [创意规格查询工具] 进行查询
page_type
enum 落地页类型,[枚举详情]
枚举列表:{ PAGE_TYPE_DEFAULT, PAGE_TYPE_TSA_APP, PAGE_TYPE_TSA_WEB_NONE_ECOMMERCE, PAGE_TYPE_CANVAS_WECHAT, PAGE_TYPE_MINI_PROGRAM_WECHAT, PAGE_TYPE_FENGYE_ECOMMERCE, PAGE_TYPE_MINI_GAME_WECHAT, PAGE_TYPE_MINI_PROGRAM_QQ, PAGE_TYPE_MINI_PROGRAM_CANVAS_WECHAT, PAGE_TYPE_MINI_GAME_QQ, PAGE_TYPE_ARTICAL_WECHAT, PAGE_TYPE_MOMENTS_SIMPLE_NATIVE_WECHAT, PAGE_TYPE_FULL_SCREEN_WECHAT, PAGE_TYPE_YUEBAO_QUICKAPP, PAGE_TYPE_YUEBAO_OFFICIAL_ACCOUNT_ARTICLE }

微信公众账号逻辑

1.当使用原生推广页创建广告时,原生推广页中的应用 id\渠道包 id 信息需与广告组层级填写的应用 id、渠道包 id 一致,否则报错
2.若渠道包不填写则表示使用主线包
3.小游戏推广目标落地页填写:page_type:PAGE_TYPE_MINI_GAME_WECHAT
page_spec:mini_game_spec{mini_game_tracking_parameter:小游戏监控链接}
page_spec
struct 落地页信息,根据不同 promoted_object_type 和 page_type,要求的 page_spec 信息不同
page_id
integer 落地页 id
page_url
string 落地页 url
字段长度最小 1 字节,长度最大 1023 字节
mini_program_spec
struct 小程序落地页,mini_program_id 和 mini_program_path 要同时填写
mini_program_id*
string 小程序 id
字段长度最小 1 字节,长度最大 384 字节
mini_program_path*
string 小程序路径
字段长度最小 1 字节,长度最大 2048 字节
mini_game_spec
struct 小游戏落地页信息
mini_game_tracking_parameter
string 小游戏监控参数,需以英文字符?开头,如:?channel=xxxx,字段长度最小 1 个等宽字符,长度最大 250 个等宽字符(即字段最大长度为 250 个中文字或全角标点,500 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 0 字节,长度最大 750 字节
override_canvas_head_option
enum 原生推广页顶部素材和广告创意素材之间的替换关系,(仅在朋友圈广告使用原生推广页情况下有效),[枚举详情]
枚举列表:{ OPTION_CANVAS_OVERRIDE_CREATIVE, OPTION_CREATIVE_OVERRIDE_CANVAS, OPTION_KEEP_DIFFERENT }
link_page_type
enum 文字链跳转类型类型,[枚举详情]
枚举列表:{ LINK_PAGE_TYPE_NOT_USED, LINK_PAGE_TYPE_DEFAULT, LINK_PAGE_TYPE_CANVAS_WECHAT, LINK_PAGE_TYPE_ARTICAL_WECHAT, LINK_PAGE_TYPE_MINI_PROGRAM_WECHAT, LINK_PAGE_TYPE_MINI_GAME_WECHAT, LINK_PAGE_TYPE_FENGYE_ECOMMERCE }
link_name_type
enum 链接名称类型,[枚举详情]
枚举列表:{ VIEW_DETAILS, GET_COUPONS, MAKE_AN_APPOINTMENT, BUY_NOW, GO_SHOPPING, ENTER_MINI_PROGRAM, ENTER_MINI_GAME, APPLY_NOW, BOOK_NOW, RESERVATION_BUY, CONSULT_NOW, BOOK_DRIVE, ENTER_OFFICIAL_ACCOUNTS, PLAY_NOW, OPEN_MINI_GAME, DOWNLOAD_APP, DOWNLOAD_GAME, GET_SAMPLES, GET_IT_NOW, BUY_ASAP, DOWNLOAD_NOW, VIEW_APPS, MORE_INFO, GET_VOUCHERS, FOLLOW_OFFICIAL_ACCOUNT, READ_NOVELS, WATCH_LIVE, RESERVE_NOW }
link_page_spec
struct 文字链跳转信息,根据不同 promoted_object_type 和 page_type、link_page_type,要求的 link_page_spec 信息不同
page_id
integer 落地页 id
page_url
string 落地页 url
字段长度最小 1 字节,长度最大 1023 字节
mini_program_spec
struct 小程序落地页,mini_program_id 和 mini_program_path 要同时填写
mini_program_id*
string 小程序 id
字段长度最小 1 字节,长度最大 384 字节
mini_program_path*
string 小程序路径
字段长度最小 1 字节,长度最大 2048 字节
mini_game_spec
struct 小游戏落地页信息
mini_game_tracking_parameter
string 小游戏监控参数,需以英文字符?开头,如:?channel=xxxx,字段长度最小 1 个等宽字符,长度最大 250 个等宽字符(即字段最大长度为 250 个中文字或全角标点,500 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 0 字节,长度最大 750 字节
conversion_data_type
enum 数据展示数据类型,[枚举详情]
枚举列表:{ CONVERSION_DATA_DEFAULT, CONVERSION_DATA_FRIEND_PLAY, CONVERSION_DATA_APP_DOWNLOAD, CONVERSION_DATA_ONSHOP, CONVERSION_DATA_ADMETRIC }
conversion_target_type
enum 数据展示转化数据量类型,仅投朋友圈流量且 conversion_data_type 为 CONVERSION_DATA_ADMETRIC 时可设置,[枚举详情]
枚举列表:{ CONVERSION_TARGET_DEFAULT, CONVERSION_TARGET_GET, CONVERSION_TARGET_RESERVE, CONVERSION_TARGET_BOOK, CONVERSION_TARGET_BUY, CONVERSION_TARGET_APPLY, CONVERSION_TARGET_CONSULT, CONVERSION_TARGET_DOWNLOAD, CONVERSION_TARGET_PLAYING }
qq_mini_game_tracking_query_string
string 为 QQ 小游戏落地页地址增加独立的监控参数,可选填,为 QQ 小游戏落地页地址增加独立的监控参数
字段长度最小 0 字节,长度最大 2048 字节
deep_link_url
string 应用直达页 URL,微信朋友圈卡片广告创意形式需要填写 deeplink_ios_appid 或 deeplink_anroid_appid 以支持双端都能应用直达,应用直达页 URL
字段长度最小 0 字节,长度最大 2048 字节
android_deep_link_app_id
string 安卓应用直达 AppId
字段长度最小 0 字节,长度最大 128 字节
ios_deep_link_app_id
string IOS 应用直达 AppId
字段长度最小 0 字节,长度最大 128 字节
universal_link_url
string 通用链接页 URL
字段长度最小 0 字节,长度最大 2048 字节

微信公众账号逻辑

不支持设置,仅能传空字符串
share_content_spec
struct 分享信息,仅在部分朋友圈创意形式下设置有效,具体可通过创意形式查询工具或 adcreative_templates/get 接口进行查询,若该字段不为空,则表示投放简版原生推广页(点击图片后会跳转至系统自动生成的简版原生推广页)
share_title*
string 分享标题
字段长度最小 1 字节,长度最大 10240 字节
share_description*
string 分享描述
字段长度最小 1 字节,长度最大 10240 字节
multi_share_optimization_enabled
boolean 创意元素自动优化排序,仅对部分规格生效,详情请通过开发者官网素材查询工具或者 adcreative_templates/get 接口查询
可选值:{ true, false }
profile_id
integer 朋友圈头像昵称跳转页 id
component_id
integer 附加创意组件 id
最小值 1,最大值 4294967295
online_enabled
boolean 是否开启“创意修改、广告不下线”功能,默认均为 false(不开启创意修改、原广告不下线功能)当且仅当广告创意的状态为审核通过,且 site_set !=SITE_SET_WECHAT 时,可将此字段设置为 true, 可选值:{ true, false },true:是,false:否
可选值:{ true, false }
revised_adcreative_spec
struct 修改后的创意内容,当且仅当 online_enabled = true 时,此字段允许写入
revised_adcreative_elements
struct 修改后的创意元素,填写要求同 adcreative_elements,当且仅当 online_enabled = true 时,此字段允许写入,创意元素
revised_page_spec
struct 修改后的落地页,填写要求同 page_spec,当且仅当 online_enabled = true 时,此字段允许写入,根据不同 promoted_object_type 和 page_type,要求的 page_spec 信息不同
page_id
integer 落地页 id
page_url
string 落地页 url
字段长度最小 1 字节,长度最大 1023 字节
category
integer[] 创意分类,灰度开放中,请填写符合您推广产品的行业分类,随意选择(如游戏产品选择了金融分类)可能会导致您的广告效果收到影响。
数组最小长度 0,最大长度 5
label
string[] 创意标签,灰度开放中,请填写推广产品属于该行业分类下哪个细分服务,或者创意上描述的产品特点,标签描述越详细全面将越有助于点击率和转化率的预估。
数组最小长度 0,最大长度 20
字段长度最小 1 字节,长度最大 30 字节
union_market_switch
boolean 联盟下载器开关
可选值:{ true, false }
playable_page_material_id
string 互动推广页落地页 id,(待废弃,请改为使用 video_end_page 进行设置)
字段长度最小 1 字节,长度最大 20 字节
video_end_page
struct 视频播放结束页,(当前仅支持互动推广页)
end_page_id*
string 视频播放结束页 id
字段长度最小 1 字节,长度最大 20 字节
end_page_type*
enum 视频播放结束页类型,[枚举详情]
枚举列表:{ VIDEO_END_PAGE_TYPE_PLAY_H5 }
feeds_video_comment_switch
boolean 视频广告评论开关
可选值:{ true, false }
webview_url
string 简易原生页嵌入 Webview url。(该字段灰度开放中)
字段长度最小 0 字节,长度最大 1023 字节
floating_zone
struct 浮层卡片创意内容
floating_zone_switch*
boolean 浮层卡片开关
可选值:{ true, false }
floating_zone_image_id
string 尺寸:512*512,大小:不超过 50 KB,格式:*.jpg|*.jpeg|*.png ;
floating_zone_name
string 文案一,字段长度最小 1 个等宽字符,长度最大 8 等宽字符(即字段最大长度为 8 个中文字或全角标点,16 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
floating_zone_desc
string 文案二,字段长度最小 0 个等宽字符,长度最大 6 等宽字符(即字段最大长度为 6 个中文字或全角标点,12 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
floating_zone_button_text
string 按钮文案,字段长度最小 0 个等宽字符,长度最大 4 等宽字符(即字段最大长度为 4 个中文字或全角标点,8 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
floating_zone_show_app_property_switch
boolean 显示已下载人数及评分开关,显示已下载人数及评分开关(仅限应用下载类广告)
可选值:{ true, false }
marketing_pendant_image_id
string 素材图片 id,通过 [images 模块] 上传图片后获得,仅在规格支持时传入,详见规格详情
字段长度最小 1 字节,长度最大 64 字节

使用说明

  1. 修改广告创意(修改 adcreative_name 除外),将会导致引用它的所有广告进行待审核状态。
  2. 对于朋友圈广告(campaign_type=CAMPAIGN_TYPE_WECHAT_MOMENTS),一旦广告审核通过且当前时间大于广告投放起始时间,则不允许修改 adcreative_name 外的字段。
  3. DPA 广告功能灰度开放,如有接入需求,请联系对接渠道运营同事线下进行申请。

请求示例


curl 'https://api.e.qq.com/v1.1/adcreatives/update?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'adcreative_id=<ADCREATIVE_ID>' \
-d 'adcreative_name=广告创意' \
-d 'adcreative_elements={"image":"123456"}' \
-d 'page_type=PAGE_TYPE_DEFAULT' \
-d 'page_spec={"page_url":"https://www.example.com"}' \
-d 'link_page_spec={
    "mini_program_spec": [],
    "mini_game_spec": []
}' \
-d 'share_content_spec=[]' \
-d 'revised_adcreative_spec={
    "revised_adcreative_elements": {
        "corporate": [],
        "image_list": [],
        "element_story": [],
        "label": [],
        "product_tags": [],
        "short_video_struct": [],
        "long_video_struct": [],
        "banner_content": [],
        "card_content": [],
        "video_popup_button": [],
        "brand": [],
        "labelled_img": {
            "label": []
        },
        "end_page": []
    },
    "revised_page_spec": []
}' \
-d 'category=[]' \
-d 'label=[]' \
-d 'video_end_page=[]' \
-d 'floating_zone=[]' 
					

应答字段

名称 类型 描述
adcreative_id
integer 广告创意 id

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "adcreative_id": "<ADCREATIVE_ID>"
    }
}

可视化调试工具

相关阅读