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

获取广告创意预览
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 adcreative_template_previews/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
adgroup_id
integer 广告组 id
ad_id_list
integer[] 广告 id 列表,如[2001,2002,2003,2004],此字段起过滤作用,预览时只保留这些 ad 的预览结果
数组最小长度 0,最大长度 20
最小值 0,最大值 9200000000000000000
adgroup
struct 广告组信息,adgroup 与 ad_list 需同时提供,若提供了 adgroup_id,则会忽略 adgroup 和 ad_list 字段
campaign_type*
enum 推广计划类型,[枚举详情]
枚举列表:{ CAMPAIGN_TYPE_NORMAL, CAMPAIGN_TYPE_WECHAT_MOMENTS }
billing_event*
enum 计费类型,[枚举详情]
枚举列表:{ BILLINGEVENT_CLICK, BILLINGEVENT_APP_DOWNLOAD, BILLINGEVENT_IMPRESSION }
scene_spec
struct 场景定向
mobile_union
enum[] 优量汇行业定投流量包,当且仅当投放优量汇流量时可以使用(待废弃,请使用优量汇行业精选流量包,但不能和 mobile_union_industry 同时使用时),[枚举详情]
数组最小长度 1,最大长度 9
枚举列表:{ MOBILE_UNION_IN_WECHAT, MOBILE_UNION_FEEDS, MOBILE_UNION_REWARDED_VIDEO, MOBILE_UNION_QA_COMMUNITY, MOBILE_UNION_SHORT_VIDEO, MOBILE_UNION_REWARDED_MEDIA, MOBILE_UNION_SMB_CUSTOMIZATION, MOBILE_UNION_GAME_ADVERTISER_PECULIAR, MOBILE_UNION_READ_ADVERTISER }
exclude_mobile_union
enum[] 优量汇行业屏蔽流量包,当且仅当投放优量汇流量时可以使用(待废弃,请使用优量汇行业精选流量包,但不能和 mobile_union_industry 同时使用时),[枚举详情]
数组最小长度 1,最大长度 8
枚举列表:{ MOBILE_UNION_IN_WECHAT, MOBILE_UNION_FEEDS, MOBILE_UNION_REWARDED_VIDEO, MOBILE_UNION_SPLASH, MOBILE_UNION_QA_COMMUNITY, MOBILE_UNION_SHORT_VIDEO, MOBILE_UNION_REWARDED_MEDIA, MOBILE_UNION_GAME_ADVERTISER_EXCLUDE, MOBILE_UNION_LIGHT_GAME_ADVERTISER_EXCLUDE, MOBILE_UNION_READ_ADVERTISER_EXCLUDE }
mobile_union_industry
enum[] 优量汇行业精选流量包,当且仅当投放优量汇流量时可以使用,[枚举详情]
数组最小长度 1,最大长度 8
枚举列表:{ MOBILE_UNION_GAME_ADVERTISER, MOBILE_UNION_LIGHT_GAME_ADVERTISER, MOBILE_UNION_READ_ADVERTISER, MOBILE_UNION_EDUCATION_ADVERTISER, MOBILE_UNION_LONGTAIL_ADVERTISER, MOBILE_UNION_FINANCE_ADVERTISER, MOBILE_UNION_TOURISM_ADVERTISER, MOBILE_UNION_EC_ADVERTISER }
union_position_package
integer[] 定投优量汇流量包列表,一个广告最多可选择 20 个定投流量包,且该广告所有流量包关联的广告位数量不得超过 500 个
数组最小长度 1,最大长度 20
exclude_union_position_package
integer[] 屏蔽优量汇流量包列表,一个广告最多可选择 20 个屏蔽流量包,且该广告所有流量包关联的广告位数量不得超过 500 个
数组最小长度 1,最大长度 20
tencent_news
enum[] 腾讯新闻流量场景定向,当且仅当投放腾讯新闻流量时可以使用,功能灰度开放,[枚举详情]
数组最小长度 1,最大长度 3
枚举列表:{ TENCENT_NEWS_APP, TENCENT_NEWS_WECHAT, TENCENT_NEWS_QQ }
display_scene
enum[] 广告展示场景,当且仅当投放优量汇流量时可以使用,[枚举详情]
数组最小长度 0,最大长度 32
枚举列表:{ DISPLAY_SCENE_BANNER, DISPLAY_SCENE_INLINE, DISPLAY_SCENE_SPLASH, DISPLAY_SCENE_NATIVE, DISPLAY_SCENE_REWARDED_VIDEO }
promoted_object_type
enum 推广目标类型,[枚举详情]
枚举列表:{ 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_QQ_BROWSER_MINI_PROGRAM, 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_ANDROID:Android 应用
PROMOTED_OBJECT_TYPE_APP_IOS:IOS 应用
PROMOTED_OBJECT_TYPE_ECOMMERCE:电商推广
PROMOTED_OBJECT_TYPE_MINI_GAME_WECHAT:微信小游戏推广目标
PROMOTED_OBJECT_TYPE_LINK_WECHAT:微信品牌页
PROMOTED_OBJECT_TYPE_LEAD_AD:销售线索
promoted_object_id
string 推广目标 id,详见 [查询推广目标 id]
字段长度最小 0 字节,长度最大 128 字节
ad_list
struct[] 广告数据列表
数组最小长度 1,最大长度 20
ad_name*
string 广告名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 1 字节,长度最大 180 字节
adcreative*
struct 广告创意
adcreative_name*
string 广告创意名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 1 字节,长度最大 180 字节
adcreative_template_id*
integer 创意形式 id,具体请咨询您的运营接口人,也可通过创意形式查询工具进行查询
adcreative_elements*
struct 创意元素,不同 adcreative_template_id 要求的元素不尽相同,其中部分创意形式的文案元素支持换行能力,使用“\n ”表示换行,占 0.5 个等宽字符,建议行数不超过 6 行,具体情况可通过 [创意规格查询工具] 进行查询
site_set*
enum[] 投放版位集合,当前单版位或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO+SITE_SET_MOBILE_UNION+SITE_SET_MOBILE_INNER+SITE_SET_KANDIAN+SITE_SET_QQ_MUSIC_GAME 的组合,[枚举详情]
数组最小长度 1,最大长度 32
枚举列表:{ SITE_SET_QZONE, SITE_SET_QQCLIENT, SITE_SET_MUSIC, SITE_SET_MOBILE_UNION, SITE_SET_QQCOM, SITE_SET_WECHAT, SITE_SET_MOBILE_INNER, SITE_SET_TENCENT_NEWS, SITE_SET_TENCENT_VIDEO, SITE_SET_TENCENT_KUAIBAO, SITE_SET_MOBILE_MYAPP, SITE_SET_PCQQ, SITE_SET_KANDIAN, SITE_SET_QQ_MUSIC_GAME, SITE_SET_MOMENTS, SITE_SET_KUAISHOU, SITE_SET_MINI_GAME_WECHAT, SITE_SET_MINI_GAME_QQ, SITE_SET_MOBILE_GAME, SITE_SET_MOBILE_YYB }

微信公众账号逻辑

仅支持 SITE_SET_WECHAT, SITE_SET_MINI_GAME_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_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_APP_ANDROID:Android 应用
PROMOTED_OBJECT_TYPE_APP_IOS:IOS 应用
PROMOTED_OBJECT_TYPE_ECOMMERCE:电商推广
PROMOTED_OBJECT_TYPE_LINK_WECHAT:微信品牌页
PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT:本地广告(微信推广)
PROMOTED_OBJECT_TYPE_LEAD_AD:销售线索
promoted_object_id
string 推广目标 id,详见 [查询推广目标 id]
字段长度最小 0 字节,长度最大 128 字节
page_type
enum 落地页类型,[枚举详情]
枚举列表:{ PAGE_TYPE_DEFAULT, PAGE_TYPE_TSA_APP, PAGE_TYPE_TSA_WEB_NONE_ECOMMERCE, PAGE_TYPE_FENGYE_ECOMMERCE, PAGE_TYPE_CANVAS, PAGE_TYPE_MINI_PROGRAM, PAGE_TYPE_CANVAS_WECHAT, PAGE_TYPE_MINI_PROGRAM_WECHAT, PAGE_TYPE_UNSUPPORTED, PAGE_TYPE_MINI_GAME_WECHAT, PAGE_TYPE_MINI_PROGRAM_QQ, PAGE_TYPE_MINI_GAME_QQ, PAGE_TYPE_MINI_PROGRAM_CANVAS_WECHAT, PAGE_TYPE_MOMENTS_SIMPLE_NATIVE_WECHAT, PAGE_TYPE_FULL_SCREEN_WECHAT, PAGE_TYPE_YUEBAO_QUICKAPP, PAGE_TYPE_YUEBAO_OFFICIAL_ACCOUNT_ARTICLE }
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 }
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 字节
universal_link_url
string 通用链接页 URL
字段长度最小 0 字节,长度最大 2048 字节

微信公众账号逻辑

不支持设置,仅能传空字符串
profile_id
integer 朋友圈头像昵称跳转页 id
created_time
integer 创建时间(时间戳)
最小值 0,最大值 9999999999
last_modified_time
integer 最后修改时间(时间戳)
最小值 0,最大值 9999999999
share_content_spec
struct 分享信息
share_title*
string 分享标题
字段长度最小 1 字节,长度最大 10240 字节
share_description*
string 分享描述
字段长度最小 1 字节,长度最大 10240 字节
dynamic_adcreative_spec
struct 动态商品广告属性,当创意为动态商品广告创意时,该字段必填
product_catalog_id*
integer 商品库 id
product_mode*
enum 动态商品广告类型,目前只支持单商品动态商品广告,多商品动态商品广告敬请期待,[枚举详情]
枚举列表:{ SINGLE }
product_source*
string 动态商品广告所使用的商品信息,可以填入商品系列 id 或者商品 id
字段长度最小 1 字节,长度最大 128 字节
is_deleted
boolean 是否已删除,true:是,false:否
可选值:{ true, false }
is_dynamic_creative
boolean 是否是动态创意广告自动生成的,true:是,false:否
可选值:{ true, false }
multi_share_optimization_enabled
boolean 创意元素自动优化排序,仅对部分规格生效,详情请通过开发者官网素材查询工具或者 adcreative_templates/get 接口查询
可选值:{ true, false }
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 }
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 }
feeds_interaction_enabled
boolean 是否支持赞转评
可选值:{ true, false }

微信公众账号逻辑

非微信流量功能,不支持设置,仅支持传入 false

使用说明

  1. 创意预览场景分为:a)对已创建的广告的预览; b)对创建/编辑中的广告的预览。
  2. 针对已创建的广告,可以提供 adgroup_id 和 ad_id_list 来获取预览地址,此时,adgroup_id 必填,ad_id_list 选填。
  3. 针对正在创建/编辑的广告,可以提供 adgroup 和 ad_list 来获取预览地址,此时,adgroup 和 ad_list 都必须提供。
  4. 若 adgroup_id、adgroup、ad_list 都提供,则会使用 adgroup_id 获取预览地址,adgroup、ad_list 字段会被忽略。
  5. 不能 adgroup_id、adgroup、ad_list 都不提供,否则无法预览。

请求示例


curl 'https://api.e.qq.com/v1.1/adcreative_template_previews/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'adgroup_id=<ADGROUP_ID>' \
-d 'ad_id_list=[]' \
-d 'adgroup={
    "scene_spec": {
        "mobile_union": [],
        "exclude_mobile_union": [],
        "mobile_union_industry": [],
        "union_position_package": [],
        "exclude_union_position_package": [],
        "tencent_news": [],
        "display_scene": []
    }
}' \
-d 'ad_list=[
    {
        "adcreative": {
            "adcreative_name": "广告创意",
            "adcreative_template_id": "<ADCREATIVE_TEMPLATE_ID>",
            "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": []
                },
                "myapp_landing_page_info": [],
                "end_page": []
            },
            "site_set": [],
            "page_spec": {
                "mini_program_spec": [],
                "mini_game_spec": []
            },
            "created_time": 1491019858,
            "last_modified_time": 1491098468,
            "share_content_spec": [],
            "dynamic_adcreative_spec": [],
            "is_deleted": false,
            "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": []
            },
            "category": [],
            "label": [],
            "video_end_page": []
        }
    }
]' 
					

应答字段

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

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "preview_url": "https://tools.e.qq.com/venus/at-glance/view?ticket=8c028652a90a250c780dff807bb7866b&_wv=16777249"
    }
}

可视化调试工具