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

获取广告创意预览(待废弃)
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 adcreative_template_preview/get
请求方法 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
preview_spec*
struct 预览信息
adcreative_template_id*
integer 创意形式 id,具体请咨询您的运营接口人,也可通过创意形式查询工具进行查询
site_set*
enum[] 投放版位集合,仅支持微信版位,[枚举详情]
数组长度为 1
枚举列表:{ SITE_SET_WECHAT }
promoted_object_type*
enum 推广目标类型,[枚举详情]
枚举列表:{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT, PROMOTED_OBJECT_TYPE_LEAD_AD }
adcreative_elements*
struct 创意元素,不同 adcreative_template_id 要求的元素不尽相同,其中部分创意形式的文案元素支持换行能力,使用“\n ”表示换行,占 0.5 个等宽字符,建议行数不超过 6 行,具体情况可通过 [创意规格查询工具] 进行查询
promoted_object_id
string 推广目标 id,详见 [推广目标类型],iOS 推广、Android 推广、微信本地推广时必填
字段长度最小 0 字节,长度最大 128 字节
page_type*
enum 落地页类型,微信版位仅支持 PAGE_TYPE_DEFAULT 和 PAGE_TYPE_CANVAS_WECHAT,[枚举详情]
枚举列表:{ PAGE_TYPE_DEFAULT, PAGE_TYPE_CANVAS_WECHAT }
page_spec
struct 落地页信息,根据不同 promoted_object_type 和 page_type,要求的 page_spec 信息不同
page_id
int64 落地页 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_program_paths
string[] 小程序落地页 path 列表
数组最小长度 1,最大长度 255
字段长度最小 1 字节,长度最大 2048 字节
mini_program_openlink_option
enum 小程序蹊径落地页开关选项,当投放版位含优量汇时、落地页使用「微信小程序」落地页时,支持使用「蹊径落地页」,默认开启,[枚举详情]
枚举列表:{ MINI_PROGRAM_OPEN_LINK_OPTION_UNKNOWN, MINI_PROGRAM_OPEN_LINK_OPTION_ON, MINI_PROGRAM_OPEN_LINK_OPTION_OFF }
mini_game_spec
struct 小游戏落地页信息
mini_game_tracking_parameter
string 小游戏监控参数,需以英文字符?开头,如:?channel=xxxx,字段长度最小 1 个等宽字符,长度最大 250 个等宽字符(即字段最大长度为 250 个中文字或全角标点,500 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 0 字节,长度最大 750 字节
mini_game_openlink
string openlink 地址字段,当投放版位含优量汇时、推广目标是微信小游戏推广目标时,支持填写「微信小游戏落地页的 openlink 地址」(白名单灰度中),什么是 opelink 可参考[微信开放文档]
字段长度最小 0 字节,长度最大 2048 字节
mini_game_openlink_page_spec
struct 小游戏蹊径落地页,当投放版位含优量汇时、推广目标是微信小游戏推广目标时,落地页使用「微信小游戏」落地页时,支持使用「蹊径落地页」(白名单灰度中);注意不能同时和「 mini_game_openlink 」同时使用,否则会被蹊径落地页链接覆盖。
landing_page_type*
enum openlink 落地页页面类型,不大于 1024 个英文字符或数字,[枚举详情]
枚举列表:{ LANDING_PAGE_TYPE_XJ_WEBSITE_H5 }
landing_page_id*
integer 落地页 id
mini_game_openlink_switch
boolean 小游戏蹊径落地页开关,当投放版位含优量汇时、推广目标是微信小游戏推广目标时,落地页使用「微信小游戏」落地页时,支持使用「蹊径落地页」(白名单灰度中)
可选值:{ true, false }
override_canvas_head_option
enum 原生推广页顶部素材和广告创意素材之间的替换关系,(仅在朋友圈广告使用原生推广页情况下有效),[枚举详情]
枚举列表:{ OPTION_CANVAS_OVERRIDE_CREATIVE, OPTION_CREATIVE_OVERRIDE_CANVAS, OPTION_KEEP_DIFFERENT }
dynamic_product_spec
struct 动态多商品广告落地页信息,仅支持 MDPA 广告使用动态落地页(见 dynamic_adcreative_spec.landing_page_url_type) 时填写
page_url
string 动态落地页 url
字段长度最小 1 字节,长度最大 1023 字节
mini_program_paths
string[] 动态多商品广告小程序落地页 path 列表
数组最小长度 1,最大长度 6
字段长度最小 1 字节,长度最大 2048 字节

使用说明

  1. 仅支持微信版位的创意预览,且本次预览的规格如下:
    朋友圈:263, 310, 311, 641, 642, 643, 644, 645, 646, 647, 648, 649, 450, 452, 588, 589, 618
    公众号:133, 567, 484, 608, 677。

请求示例


curl 'https://api.e.qq.com/v1.1/adcreative_template_preview/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'preview_spec={"adcreative_template_id":608,"site_set":["SITE_SET_WECHAT"],"promoted_object_type":"PROMOTED_OBJECT_TYPE_ECOMMERCE","adcreative_elements":{"image":"1662230","mini_program_id":"gh_6ee8536f381b","mini_program_path":"pages/detail/detail?id=1112&share=true"},"page_type":"PAGE_TYPE_DEFAULT","page_spec":{"page_url":"https://www.example.com"}}' 
					

应答字段

名称 类型 描述
preview_url
string 预览地址,有效时长为 1h

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "preview_url": "https://mp.weixin.qq.com/promotion/res/htmledition/mobile/html/pos_type_wx_application.html?preview_key=1548751945de63d"
    }
}

可视化调试工具