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

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

所属权限 Ads Management,Ads Insights
请求地址 adcreatives/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 过滤字段
可选值:{ adcreative_id, adcreative_name, campaign_id, promoted_object_type, adcreative_template_id, created_time, last_modified_time }

微信公众账号逻辑

不能支持:campaign_id,create_time,adcreative_name,
能支持:adcreative_id,last_modified_time
当使用 last_modified_time 作为过滤条件时,operator 仅支持 GREATER_EQUALS
operator*
enum 操作符
当 field 取值 adcreative_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 adcreative_name 时,枚举列表:{ EQUALS, CONTAINS }
当 field 取值 campaign_id 时,枚举列表:{ EQUALS }
当 field 取值 promoted_object_type 时,枚举列表:{ EQUALS }
当 field 取值 adcreative_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 取值 adcreative_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_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 }

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

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

微信公众账号逻辑

当 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_LOCAL_ADS_WECHAT,PROMOTED_OBJECT_TYPE_LEAD_AD}
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10。最小值 1,最大值 100
is_deleted
boolean 是否已删除,true:是,false:否
可选值:{ true, false }
link_page_type_compatible
boolean 是否返回旧结构文字链数据
可选值:{ true, false }

使用说明

  1. is_deleted 参数不传时默认为 false,只返回未删除记录。
  2. is_deleted 参数为 true 时,需要同时在 filtering 传参数 last_modified_time。
  3. 当根据广告创意 id 进行查询且 is_deleted 参数不传或为 false 时,获取的广告创意列表包含已删除的广告创意。

请求示例


curl -G 'https://api.e.qq.com/v1.1/adcreatives/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[{"field":"adcreative_name","operator":"EQUALS","values":["广告创意"]}]' \
-d 'page=1' \
-d 'page_size=10' \
-d 'is_deleted=false' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
campaign_id
integer 推广计划 id
adcreative_id
integer 广告创意 id
adcreative_name
string 广告创意名称
adcreative_template_id
integer 创意形式 id,具体请咨询您的运营接口人,也可通过创意形式查询工具进行查询
adcreative_elements
struct 创意元素,不同 adcreative_template_id 要求的元素不尽相同,其中部分创意形式的文案元素支持换行能力,使用“\n ”表示换行,占 0.5 个等宽字符,建议行数不超过 6 行,具体情况可通过 [创意规格查询工具] 进行查询
page_type
enum 落地页类型,[枚举详情]
page_spec
struct 落地页信息,根据不同 promoted_object_type 和 page_type,要求的 page_spec 信息不同
page_id
integer 落地页 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_game_spec
struct 小游戏落地页信息
mini_game_tracking_parameter
string 小游戏监控参数,需以英文字符?开头,如:?channel=xxxx,字段长度最小 1 个等宽字符,长度最大 250 个等宽字符(即字段最大长度为 250 个中文字或全角标点,500 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
override_canvas_head_option
enum 原生推广页顶部素材和广告创意素材之间的替换关系,(仅在朋友圈广告使用原生推广页情况下有效),[枚举详情]
link_page_type
enum 文字链跳转类型类型,[枚举详情]
link_name_type
enum 链接名称类型,[枚举详情]
link_page_spec
struct 文字链跳转信息,根据不同 promoted_object_type 和 page_type、link_page_type,要求的 link_page_spec 信息不同
page_id
integer 落地页 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_game_spec
struct 小游戏落地页信息
mini_game_tracking_parameter
string 小游戏监控参数,需以英文字符?开头,如:?channel=xxxx,字段长度最小 1 个等宽字符,长度最大 250 个等宽字符(即字段最大长度为 250 个中文字或全角标点,500 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
conversion_data_type
enum 数据展示数据类型,[枚举详情]
conversion_target_type
enum 数据展示转化数据量类型,仅投朋友圈流量且 conversion_data_type 为 CONVERSION_DATA_ADMETRIC 时可设置,[枚举详情]
qq_mini_game_tracking_query_string
string 为 QQ 小游戏落地页地址增加独立的监控参数,可选填,为 QQ 小游戏落地页地址增加独立的监控参数
deep_link_url
string 应用直达页 URL,微信朋友圈卡片广告创意形式需要填写 deeplink_ios_appid 或 deeplink_anroid_appid 以支持双端都能应用直达,应用直达页 URL
android_deep_link_app_id
string 安卓应用直达 AppId
ios_deep_link_app_id
string IOS 应用直达 AppId
universal_link_url
string 通用链接页 URL

微信公众账号逻辑

不支持设置,仅能传空字符串
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 的组合,[枚举详情]

微信公众账号逻辑

仅支持 SITE_SET_WECHAT, SITE_SET_MINI_GAME_WECHAT
automatic_site_enabled
boolean 是否开启自动版位功能(暂不包含 SITE_SET_WECHAT 和 SITE_SET_MOMENTS),此字段与 site_set 字段至少需要写入一个。此字段目前灰度开放中。
promoted_object_type
enum 推广目标类型,[枚举详情]

微信公众账号逻辑

支持读取的推广目标类型:
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]
profile_id
integer 朋友圈头像昵称跳转页 id
created_time
integer 创建时间(时间戳)
last_modified_time
integer 最后修改时间(时间戳)
share_content_spec
struct 分享信息
share_title
string 分享标题
share_description
string 分享描述
dynamic_adcreative_spec
struct 动态商品广告属性,当创意为动态商品广告创意时,该字段必填
product_catalog_id
integer 商品库 id
product_mode
enum 动态商品广告类型,目前只支持单商品动态商品广告,多商品动态商品广告敬请期待,[枚举详情]
product_source
string 动态商品广告所使用的商品信息,可以填入商品系列 id 或者商品 id
is_deleted
boolean 是否已删除,true:是,false:否
is_dynamic_creative
boolean 是否是动态创意广告自动生成的,true:是,false:否
multi_share_optimization_enabled
boolean 创意元素自动优化排序,仅对部分规格生效,详情请通过开发者官网素材查询工具或者 adcreative_templates/get 接口查询
component_id
integer 附加创意组件 id
online_enabled
boolean 是否开启“创意修改、广告不下线”功能
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
category
integer[] 创意分类,灰度开放中,请填写符合您推广产品的行业分类,随意选择(如游戏产品选择了金融分类)可能会导致您的广告效果收到影响。
label
string[] 创意标签,灰度开放中,请填写推广产品属于该行业分类下哪个细分服务,或者创意上描述的产品特点,标签描述越详细全面将越有助于点击率和转化率的预估。
union_market_switch
boolean 联盟下载器开关
playable_page_material_id
string 互动推广页落地页 id,(待废弃,请改为使用 video_end_page 进行设置)
video_end_page
struct 视频播放结束页,(当前仅支持互动推广页)
end_page_id
string 视频播放结束页 id
end_page_type
enum 视频播放结束页类型,[枚举详情]
feeds_video_comment_switch
boolean 视频广告评论开关
webview_url
string 简易原生页嵌入 Webview url。(该字段灰度开放中)
floating_zone
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_show_app_property_switch
boolean 显示已下载人数及评分开关,显示已下载人数及评分开关(仅限应用下载类广告)
marketing_pendant_image_id
string 素材图片 id,通过 [images 模块] 上传图片后获得,仅在规格支持时传入,详见规格详情
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "campaign_id": "<CAMPAIGN_ID>",
                "adcreative_id": "<ADCREATIVE_ID>",
                "adcreative_name": "广告创意",
                "adcreative_template_id": "<ADCREATIVE_TEMPLATE_ID>",
                "adcreative_elements": {
                    "image": "123456"
                },
                "page_type": "PAGE_TYPE_DEFAULT",
                "page_spec": {
                    "page_url": "https://www.example.com"
                },
                "link_page_spec": {
                    "mini_program_spec": [],
                    "mini_game_spec": []
                },
                "site_set": [
                    "SITE_SET_WECHAT"
                ],
                "promoted_object_type": "PROMOTED_OBJECT_TYPE_LINK_WECHAT",
                "created_time": 1491019858,
                "last_modified_time": 1491098468,
                "share_content_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": [],
                "floating_zone": []
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具

相关阅读