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

获取动态广告创意列表
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 dynamic_creatives/get
请求方法 get

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
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
filtering
struct[] 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件]
数组最小长度 1,最大长度 5
field*
string 过滤字段
可选值:{ dynamic_creative_id, dynamic_creative_name, created_time, last_modified_time, enable_breakthrough_siteset }
operator*
enum 操作符
当 field 取值 dynamic_creative_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 dynamic_creative_name 时,枚举列表:{ EQUALS, CONTAINS }
当 field 取值 promoted_object_type 时,枚举列表:{ EQUALS }
当 field 取值 dynamic_creative_template_id 时,枚举列表:{ EQUALS }
当 field 取值 created_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
当 field 取值 last_modified_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
values*
string[] 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件]

当 field 取值 dynamic_creative_name 时,
字段长度最小 1 字节,长度最大 180 字节

当 field 取值 promoted_object_type 时,
枚举列表:{ 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_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_WECHAT_CHANNELS, PROMOTED_OBJECT_TYPE_WECHAT_OFFICIAL_ACCOUNT, PROMOTED_OBJECT_TYPE_MINI_PROGRAM_WECHAT, PROMOTED_OBJECT_TYPE_APP_QUICK_APP }

当 field 取值 created_time 时,
字段长度为 10 字节

当 field 取值 last_modified_time 时,
字段长度为 10 字节
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10。最小值 1,最大值 100

使用说明

  1. 当且仅当根据广告创意 id 进行查询时,获取的广告创意列表包含已删除的广告创意。

请求示例


curl -G 'https://api.e.qq.com/v1.1/dynamic_creatives/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[]' \
-d 'page=1' \
-d 'page_size=10' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
dynamic_creative_id
integer 广告创意 id
outer_adcreative_id
integer 外部广告素材 id,小于 2^63
dynamic_creative_name
string 广告创意名称(字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
dynamic_creative_template_id
integer 创意规格 id,具体请咨询您的运营接口人,也可通过 [创意规格查询工具] 进行查询,dynamic_creative_type 为 DYNAMIC_CREATIVE_TYPE_PROGRAM 时不传该参数
dynamic_creative_elements
struct 创意元素
image
string 图片 id,通过 [images 模块] 上传图片后获得,图片 id
image2
string 素材图片 2 的 id,通过 [images 模块] 上传图片后获得,素材图片 2 的 id
image3
string 素材图片 3 的 id,通过 [images 模块] 上传图片后获得,素材图片 3 的 id
title
string 广告文案
description
string 广告描述
corporate
struct 商标
corporate_name
string 商标名称
corporate_img
string 商标图片 id,通过 [images 模块] 上传图片后获得,商标图片 id
video
string 视频 id,通过 [videos 模块] 上传视频后获得,视频 id
image_options
string[] 图片墙,图片 id 通过 [images 模块] 上传图片获得,图片墙
image_list_options
array[] 注意,该结构为二维数组,外层数组中的每个元素为 imgae_list,内层数组中的元素为 image,示例:image_list_options:[[image1_1, image1_2],[image2_1, image2_2]],图片墙
title_options
string[] 广告文案
description_options
string[] 广告描述
video_options
string[] 视频
short_video_struct_options
struct[] 视频
short_video1
integer 视频 id,通过 [videos 模块] 上传视频后获得
short_video2
integer 视频 id,通过 [videos 模块] 上传视频后获得
deep_link_type
string 应用直达点击方式
link_name_type
enum 链接名称类型,若不填写,则默认显示【查看详情】,[枚举详情]
image_list
string[] 图片墙,图片 id 通过 [images 模块] 上传图片获得,图片墙
element_story
struct[] 集装箱创意组合,具体请咨询你的运营接口人,集装箱创意组合
image
string 图片 id,通过 [images 模块] 上传图片后获得,图片 id
image2
string 素材图片 2 的 id,通过 [images 模块] 上传图片后获得,素材图片 2 的 id
description
string 广告描述
url
string 跳转链接
title
string 广告文案
url
string 跳转链接
button_text
string 跳转按钮文字
bottom_text
string 左下辅助文字
activity_type
string 页卡类型
countdown_begin
integer 倒计时开始时间戳,unix 时间戳,单位秒
countdown_expiring_timestamp
integer 倒计时截止时间戳,unix 时间戳,单位秒
countdown_price
string 倒计时价格
countdown_time_type
enum 倒计时时间类型 0:距离活动开始 1:距离活动结束,[枚举详情]
mini_program_id
string 小程序 id
mini_program_path
string 小程序路径
label
struct[] 标签数组
content
string 标签内容
type
enum 创意标签类型,[枚举详情]
product_tags
enum[] product_tags,[枚举详情]
logo_description
string 素材标题,仅在规格支持时传入,详见规格详情
logo
string 标签广告 logo 图片 id,通过 [images 模块] 上传图片后获得,仅在规格支持时传入,详见规格详情
left_button
string 左侧按钮文字
right_button
string 右侧按钮文字
left_bottom_txt
string 左下角描述
animation_effect
string 动画效果
phone
string 电话号码
canvas
string 原生广告
caption
string 消息标题
myapp_page_id
string 应用宝应用详情页 id
logo_page
struct logo 页
image
string 图片 id,通过 [images 模块] 上传图片后获得,图片 id
video_popup_url
string 视频浮层页链接
video_popup_button
struct 视频浮层按钮信息
video_popup_button_text
string 视频浮层按钮文案
video_popup_button_url
string 视频浮层按钮链接
video_popup_button_text
string 视频浮层按钮文案
video_popup_button_url
string 视频浮层按钮链接
button_url
string 按钮链接
brand
struct 品牌形象结构,品牌形象元素,支持 brand_img,brand_name,brand_description
brand_img
string 广告主头像图片 id,通过 [images 模块] 上传图片后获得,仅在规格支持时传入,详见规格详情
brand_name
string 广告主名称
brand_description
string 广告文案
myapp_landing_page_info
struct 落地页
myapp_page_id
string 应用宝应用详情页 id
url
string 跳转链接
long_video1
string 长视频 960*720
long_video2
string 长视频 960*540
short_video_struct
struct 短视频结构,短视频结构,支持 short_video1,short_video2
short_video1
integer 视频 id,通过 [videos 模块] 上传视频后获得
short_video2
integer 视频 id,通过 [videos 模块] 上传视频后获得
qzone_video_page_id
string 视频说说 id
qq
string 公众空间 QQ 号
left_canvas
string Canvas
right_canvas
string Canvas
sun_text
string 晴天文案
cloud_text
string 多云文案
overcast_text
string 阴天文案
rain_text
string 雨文案
snow_text
string 雪文案
fog_text
string 雾文案
sand_text
string 沙尘文案
haze_text
string 霾文案
labelled_img
struct 标签图片
image
string 图片 id,通过 [images 模块] 上传图片后获得,图片 id
label
struct[] 标签数组
coordinate_x
integer 标签坐标
coordinate_y
integer 标签坐标
direction
string 标签方向
content
string 标签内容
landing_page_url
string 落地页 url
share_img
string 图片 id,通过 [images 模块] 上传图片后获得,图片 id
long_video_struct
struct 完整视频结构,完整视频结构,支持 long_video1,long_video2
long_video1
integer 视频 id,通过 [videos 模块] 上传视频后获得
long_video2
integer 视频 id,通过 [videos 模块] 上传视频后获得
banner_content
struct banner 素材内容
image
string 图片 id,通过 [images 模块] 上传图片后获得,图片 id
title
string 广告文案
url
string 跳转链接
card_content
struct 卡片素材内容
image
string 图片 id,通过 [images 模块] 上传图片后获得,图片 id
description
string 广告描述
url
string 跳转链接
head_line
string 消息标题
shop_image_struct
struct 卖点图
shop_image_switch
boolean 卖点图开关
dynamic_shop_image_switch
boolean 卖点图轮播开关
shop_image_id
string 卖点图片 id
shop_image_title
string 卖点图标题
shop_image_description
string 卖点图文案
chosen_button
struct 选择按钮
chosen_button_text1
string 左侧按钮文字
chosen_button_landing_page1
struct 跳转落地页信息
page_spec
struct 落地页信息,根据不同 promoted_object_type 和 page_type,要求的 page_spec 信息不同
page_id
int64 落地页 id
page_url
string 落地页 url
mini_program_spec
struct 小程序落地页,mini_program_id 和 mini_program_path 要同时填写
mini_program_id
string 小程序 id
mini_program_path
string 小程序路径
mini_program_paths
string[] 小程序落地页 path 列表
mini_game_spec
struct 小游戏落地页信息
mini_game_tracking_parameter
string 小游戏监控参数,需以英文字符?开头,如:?channel=xxxx,字段长度最小 1 个等宽字符,长度最大 250 个等宽字符(即字段最大长度为 250 个中文字或全角标点,500 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
mini_game_openlink
string openlink 地址字段,当投放版位含优量汇时、推广目标是微信小游戏推广目标时,支持填写「微信小游戏落地页的 openlink 地址」(白名单灰度中),什么是 opelink 可参考[微信开放文档]
mini_game_openlink_page_spec
struct 小游戏蹊径落地页,当投放版位含优量汇时、推广目标是微信小游戏推广目标时,落地页使用「微信小游戏」落地页时,支持使用「蹊径落地页」(白名单灰度中);注意不能同时和「 mini_game_openlink 」同时使用,否则会被蹊径落地页链接覆盖。
landing_page_type
enum openlink 落地页页面类型,不大于 1024 个英文字符或数字,[枚举详情]
landing_page_id
integer 落地页 id
override_canvas_head_option
enum 原生推广页顶部素材和广告创意素材之间的替换关系,(仅在朋友圈广告使用原生推广页情况下有效),[枚举详情]
dynamic_product_spec
struct 动态多商品广告落地页信息,仅支持 MDPA 广告使用动态落地页(见 dynamic_adcreative_spec.landing_page_url_type) 时填写
page_url
string 动态落地页 url
mini_program_paths
string[] 动态多商品广告小程序落地页 path 列表
page_type
enum 落地页类型,[枚举详情]
link_name_type
enum 链接名称类型,[枚举详情]
landing_page_platform
enum 落地页制作平台,[枚举详情]
landing_page_info
struct 品牌形象
landing_page_type
enum 落地页页面类型,不大于 1024 个英文字符或数字,[枚举详情]
chosen_button_text2
string 右侧按钮文字
chosen_button_landing_page2
struct 跳转落地页信息
page_spec
struct 落地页信息,根据不同 promoted_object_type 和 page_type,要求的 page_spec 信息不同
page_id
int64 落地页 id
page_url
string 落地页 url
mini_program_spec
struct 小程序落地页,mini_program_id 和 mini_program_path 要同时填写
mini_program_id
string 小程序 id
mini_program_path
string 小程序路径
mini_program_paths
string[] 小程序落地页 path 列表
mini_game_spec
struct 小游戏落地页信息
mini_game_tracking_parameter
string 小游戏监控参数,需以英文字符?开头,如:?channel=xxxx,字段长度最小 1 个等宽字符,长度最大 250 个等宽字符(即字段最大长度为 250 个中文字或全角标点,500 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
mini_game_openlink
string openlink 地址字段,当投放版位含优量汇时、推广目标是微信小游戏推广目标时,支持填写「微信小游戏落地页的 openlink 地址」(白名单灰度中),什么是 opelink 可参考[微信开放文档]
mini_game_openlink_page_spec
struct 小游戏蹊径落地页,当投放版位含优量汇时、推广目标是微信小游戏推广目标时,落地页使用「微信小游戏」落地页时,支持使用「蹊径落地页」(白名单灰度中);注意不能同时和「 mini_game_openlink 」同时使用,否则会被蹊径落地页链接覆盖。
landing_page_type
enum openlink 落地页页面类型,不大于 1024 个英文字符或数字,[枚举详情]
landing_page_id
integer 落地页 id
override_canvas_head_option
enum 原生推广页顶部素材和广告创意素材之间的替换关系,(仅在朋友圈广告使用原生推广页情况下有效),[枚举详情]
dynamic_product_spec
struct 动态多商品广告落地页信息,仅支持 MDPA 广告使用动态落地页(见 dynamic_adcreative_spec.landing_page_url_type) 时填写
page_url
string 动态落地页 url
mini_program_paths
string[] 动态多商品广告小程序落地页 path 列表
page_type
enum 落地页类型,[枚举详情]
link_name_type
enum 链接名称类型,[枚举详情]
landing_page_platform
enum 落地页制作平台,[枚举详情]
landing_page_info
struct 品牌形象
landing_page_type
enum 落地页页面类型,不大于 1024 个英文字符或数字,[枚举详情]
living_desc_struct
struct 轮播文案
living_desc_struct_switch
boolean 轮播组件开关
living_desc_list
string[] 轮播文案
floating_zone_struct
struct 浮层卡片创意内容
floating_zone_switch
boolean 浮层卡片开关
floating_zone_image_id
string 卡片图片
floating_zone_name
string
floating_zone_desc
string
floating_zone_button_text
string
floating_zone_type
enum 浮层卡片类型,[枚举详情]
floating_zone_single_image_id
string 卡片单图
canvas_share_image
string 图片 URL
wegame_info_spec
struct 小游戏结束页能力
wegame_info_switch
boolean 小游戏结束页开关
page_type
enum 落地页类型,[枚举详情]
page_spec
struct 落地页信息,根据不同 promoted_object_type 和 page_type,要求的 page_spec 信息不同
page_id
int64 落地页 id
page_url
string 落地页 url
deep_link_url
string 应用直达页 URL
automatic_site_enabled
boolean 是否开启自动版位功能(暂不包含 SITE_SET_WECHAT 和 SITE_SET_MOMENTS),此字段与 site_set 字段至少需要写入一个。
site_set
enum[] 投放版位集合,当前单版位或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO+SITE_SET_MOBILE_UNION+SITE_SET_KANDIAN+SITE_SET_QQ_MUSIC_GAME 的组合,[枚举详情]
promoted_object_type
enum 推广目标类型,[枚举详情]
promoted_object_id
string 推广目标 id,详见 [查询推广目标 id]
profile_id
integer 朋友圈头像昵称跳转页 id,仅微信朋友圈广告(site_set=SITE_SET_MOMENTS)的创意形式支持
created_time
integer 创建时间(时间戳)
last_modified_time
integer 最后修改时间(时间戳)
dynamic_adcreative_spec
struct 动态商品广告属性,当创意为动态商品广告创意时,该字段必填
product_catalog_id
integer 商品库 id
product_mode
enum 动态商品广告(DPA)类型,支持单商品动态商品广告(SDPA)和多商品动态商品广告(MDPA),[枚举详情]
product_source
string 动态商品广告所使用的商品信息,可以填入商品系列 id 或者商品 id
is_deleted
boolean 是否已删除,true:是,false:否
campaign_type
enum 推广计划类型,[枚举详情]
impression_tracking_url
string 曝光监控地址,监控地址主域只允许白名单内的域名,详见 [第三方监控]
click_tracking_url
string 监控链接,监控地址主域只允许白名单内的域名,详见 [第三方监控]
feeds_video_comment_switch
boolean 视频广告评论开关
union_market_switch
boolean 联盟下载器开关
video_end_page
struct 视频播放结束页,(当前仅支持互动推广页)
end_page_id
string 视频播放结束页 id
end_page_type
enum 视频播放结束页类型,[枚举详情]
barrage_list
struct[] 弹幕列表
id
integer 弹幕 id
text
string 弹幕文案,1~12 个字
dynamic_creative_group_used
enum 动态创意分组,使用方法详见[动态创意广告]
默认为不使用组合,功能灰度开放中,如需使用可联系您的客户运营,[枚举详情]
app_gift_pack_code
struct 礼包码,微信朋友圈广告创意形式需要填写,礼包码
code
string 礼包码,微信朋友圈广告创意形式需要填写,礼包码
tips
string 礼包码提示,微信朋友圈广告创意形式需要填写,礼包码提示
enable_breakthrough_siteset
boolean 是否支持版位突破,广告版位选择“微信朋友圈”,当广告有机会获得更多曝光与转化时,将可能投放到微信公众号与小程序版位,若不传值默认为 true
creative_template_version_type
enum 数据版本类型 0:历史数据 1:旧版本 2:新版本,[枚举详情]
union_market_spec
struct 厂商下载信息,厂商下载信息,仅可在跳转厂商应用商店(union_market_switch)值为 true 时使用。
union_market_jump_type
enum 厂商直达链接跳转类型,[枚举详情]
creative_template_category
string 创意形式类型
program_creative_info
struct 动态创意(升级版)信息,dynamic_creative_type 为 DYNAMIC_CREATIVE_TYPE_PROGRAM 时必填
material_derive_id
integer 衍生 id,
[programmed 模块] 创建模板预览获得得该 id 并在参数中传入
bid_mode
enum 出价方式,
1. bid_mode 为 billing_event 升级字段,不可同时输入,升级后直接写入 bid_mode 字段即可;
2. 当投放智能出价广告,可写入 BID_MODE_OCPC/BID_MODE_OCPM。此时,optimization_goal 优化目标字段必填;
3. 当投放非智能出价广告,可写入 BID_MODE_CPC/BID_MODE_CPM/BID_MODE_CPA。此时,optimization_goal 优化目标字段不可填;
4. 针对非微信流量,BID_MODE_CPC 可编辑修改为 BID_MODE_OCPC,BID_MODE_CPM 可编辑修改为 BID_MODE_OCPM,其他修改不可操作。针对微信流量,bid_mode 字段不可修改;
5. 可通过 adcreative_templates/get 接口查询不同情况下支持的出价方式;,[枚举详情]
dynamic_creative_type
enum 动态创意类型,[枚举详情]
head_click_type
enum 头像点击跳转信息,[枚举详情]
head_click_spec
struct 头像点击跳转信息,头像点击跳转信息,目前支持跳转搜一搜品牌专区,白名单开放中,如果需要使用请联系您的运营经理
brand_app_id
string 搜一搜品牌形象 app id
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "dynamic_creative_id": 123,
                "dynamic_creative_name": "test",
                "dynamic_creative_template_id": 471,
                "dynamic_creative_elements": {
                    "corporate": {
                        "corporate_name": "DC 规格"
                    },
                    "image_options": [
                        "141201:db1c272f4daf9a8261db5bd49ab88632",
                        "141201:dfdbedd1a4870a21e392ee8569f663ff"
                    ],
                    "title_options": [
                        "1111111111111111testetetetsttest11",
                        "1111111111111111testtestett2"
                    ]
                },
                "page_type": "PAGE_TYPE_DEFAULT",
                "page_spec": {
                    "page_url": "https://www.example.com"
                },
                "deep_link_url": "http://www.example.com",
                "site_set": [
                    "SITE_SET_TENCENT_NEWS"
                ],
                "promoted_object_type": "PROMOTED_OBJECT_TYPE_APP_IOS",
                "promoted_object_id": "1044283059",
                "created_time": 1491019858,
                "last_modified_time": 1491098468,
                "dynamic_adcreative_spec": [],
                "is_deleted": false,
                "campaign_type": "CAMPAIGN_TYPE_NORMAL",
                "impression_tracking_url": "http://www.example.com",
                "click_tracking_url": "http://www.example.com",
                "video_end_page": [],
                "barrage_list": [],
                "app_gift_pack_code": {
                    "code": 0
                },
                "union_market_spec": [],
                "program_creative_info": [],
                "head_click_spec": []
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具