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

获取创意规格信息
全部接口
V1.1
loading

所属权限 Ads Management,Ads Insight
请求地址 adcreative_templates/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,最大长度 3
field*
string 过滤字段
可选值:{ adcreative_template_id, is_dynamic_creative, site_set, promoted_object_type, dynamic_ability_type }
operator*
enum 操作符
当 field 取值 adcreative_template_id 时,枚举列表:{ EQUALS }
当 field 取值 site_set 时,枚举列表:{ EQUALS }
当 field 取值 promoted_object_type 时,枚举列表:{ EQUALS }
当 field 取值 is_dynamic_creative 时,枚举列表:{ EQUALS }
当 field 取值 dynamic_ability_type 时,枚举列表:{ EQUALS }
values*
string[] 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件]
当 field 取值 site_set 时,
枚举列表:{ 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 }

当 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 取值 dynamic_ability_type 时,
枚举列表:{ DYNAMIC_TYPE_SINGLE_PRODUCT_AD, DYNAMIC_TYPE_MULTIPLE_PRODUCT_AD, DYNAMIC_TYPE_DYNAMIC_CREATIVE }
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10
最小值 1,最大值 100

使用说明

  1. 标准化规格并无 adcreative_template_name(创意形式名称),adcreative_template_size(创意形式尺寸)及 adcreative_template_description(创意形式描述)字段。

请求示例


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

应答字段

名称 类型 描述
list
struct[] 创意形式列表
adcreative_template_id
integer 创意形式 id
adcreative_template_name
string 创意形式名称(待废弃)
adcreative_template_description
string 创意形式描述(待废弃)
adcreative_template_size
string 创意形式尺寸(待废弃)
adcreative_template_style
string 创意形式类型
adcreative_template_appellation
string 创意形式名称
site_set
enum 投放版位,[枚举详情]
promoted_object_type
enum 推广目标类型,[枚举详情]
adcreative_sample_image_list
struct[] 创意规格示意图数组
name
string 示例图名称
thumb
string 示例缩略图链接,部分标准化创意形式并无此信息
image
string 示例图链接
ad_attributes
struct[] 广告属性信息
name
string 广告创意接口要求的 adcreative_elements 结构中的元素字段名,如 image、title 等
element_type
enum 创意元素类型,[枚举详情]
field_type
enum 创意元素传参类型,[枚举详情]
required
boolean 创意元素是否必填,true 或 false
description
string 该创意元素的描述,如图片、广告文案等
parent_name
string 创意元素父节点名称,为父节点的 name 字段
enum_property
struct 广告创意元素枚举值特性
default
string 创意元素枚举默认值
enumeration
struct[] 创意元素枚举可选值数组
value
string 创意元素枚举可选值
description
string 创意元素枚举可选值描述
array_property
struct 广告创意元素数组特性
min_number
integer 广告创意元素数组个数最小值
max_number
integer 广告创意元素数组个数最大值
struct_property
struct 广告创意元素结构体特性
element_mutual_exclusive
boolean 结构体中元素是否互斥,true: 是,仅能使用结构体中的一个元素字段; false: 否
restriction
struct 广告创意元素需满足的限制条件
text_restriction
struct 文本需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_TEXT 时返回
min_length
integer 最小长度,文本类型适用
max_length
integer 最大长度,文本类型适用
text_pattern
string text 的正则表达式
image_restriction
struct 图片需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_IMAGE_ARRAY 或 ELEMENT_TYPE_IMAGE 时返回
width
integer 宽度,单位 px,图片适用
height
integer 高度,单位 px,图片适用
file_size
integer 支持的文件大小最大值,单位 KB,1KB=1024B, 图片、视频适用
file_format
enum[] 支持的图片文件格式数组,[枚举详情]
url_restriction
struct 链接需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_URL 时返回
url_pattern
string url 的正则表达式
video_restriction
struct 视频需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_VIDEO 时返回
width
integer 宽度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
height
integer 高度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
min_width
integer 最小宽度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
min_height
integer 最小高度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
ratio_width
integer 宽比例,视频比例=ratio_width:ratio_height,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
ratio_height
integer 高比例,视频比例=ratio_width:ratio_height,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
file_size
integer 支持的文件大小最大值,单位 KB,1KB=1024B, 图片、视频适用
file_format
enum[] 支持的流媒体文件格式数组,[枚举详情]
min_duration
integer 最小时长,单位秒,视频适用
max_duration
integer 最大时长,单位秒,视频适用
number_restriction
struct 数值型需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_INTEGER 时返回
min
integer 最小长度,文本类型适用
max
integer 最大长度,文本类型适用
adcreative_attributes
struct[] 广告创意属性信息
name
string 广告创意接口要求的 adcreative_elements 结构中的元素字段名,如 image、title 等
element_type
enum 创意元素类型,[枚举详情]
field_type
enum 创意元素传参类型,[枚举详情]
required
boolean 创意元素是否必填,true 或 false
description
string 该创意元素的描述,如图片、广告文案等
parent_name
string 创意元素父节点名称,为父节点的 name 字段
enum_property
struct 广告创意元素枚举值特性
default
string 创意元素枚举默认值
enumeration
struct[] 创意元素枚举可选值数组
value
string 创意元素枚举可选值
description
string 创意元素枚举可选值描述
array_property
struct 广告创意元素数组特性
min_number
integer 广告创意元素数组个数最小值
max_number
integer 广告创意元素数组个数最大值
struct_property
struct 广告创意元素结构体特性
element_mutual_exclusive
boolean 结构体中元素是否互斥,true: 是,仅能使用结构体中的一个元素字段; false: 否
restriction
struct 广告创意元素需满足的限制条件
text_restriction
struct 文本需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_TEXT 时返回
min_length
integer 最小长度,文本类型适用
max_length
integer 最大长度,文本类型适用
text_pattern
string text 的正则表达式
image_restriction
struct 图片需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_IMAGE_ARRAY 或 ELEMENT_TYPE_IMAGE 时返回
width
integer 宽度,单位 px,图片适用
height
integer 高度,单位 px,图片适用
file_size
integer 支持的文件大小最大值,单位 KB,1KB=1024B, 图片、视频适用
file_format
enum[] 支持的图片文件格式数组,[枚举详情]
url_restriction
struct 链接需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_URL 时返回
url_pattern
string url 的正则表达式
video_restriction
struct 视频需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_VIDEO 时返回
width
integer 宽度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
height
integer 高度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
min_width
integer 最小宽度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
min_height
integer 最小高度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
ratio_width
integer 宽比例,视频比例=ratio_width:ratio_height,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
ratio_height
integer 高比例,视频比例=ratio_width:ratio_height,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
file_size
integer 支持的文件大小最大值,单位 KB,1KB=1024B, 图片、视频适用
file_format
enum[] 支持的流媒体文件格式数组,[枚举详情]
min_duration
integer 最小时长,单位秒,视频适用
max_duration
integer 最大时长,单位秒,视频适用
number_restriction
struct 数值型需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_INTEGER 时返回
min
integer 最小长度,文本类型适用
max
integer 最大长度,文本类型适用
adcreative_elements
struct[] 广告创意元素列表
name
string 广告创意接口要求的 adcreative_elements 结构中的元素字段名,如 image、title 等
element_type
enum 创意元素类型,[枚举详情]
field_type
enum 创意元素传参类型,[枚举详情]
required
boolean 创意元素是否必填,true 或 false
description
string 该创意元素的描述,如图片、广告文案等
parent_name
string 创意元素父节点名称,为父节点的 name 字段
enum_property
struct 广告创意元素枚举值特性
default
string 创意元素枚举默认值
enumeration
struct[] 创意元素枚举可选值数组
value
string 创意元素枚举可选值
description
string 创意元素枚举可选值描述
array_property
struct 广告创意元素数组特性
min_number
integer 广告创意元素数组个数最小值
max_number
integer 广告创意元素数组个数最大值
struct_property
struct 广告创意元素结构体特性
element_mutual_exclusive
boolean 结构体中元素是否互斥,true: 是,仅能使用结构体中的一个元素字段; false: 否
restriction
struct 广告创意元素需满足的限制条件
text_restriction
struct 文本需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_TEXT 时返回
min_length
integer 最小长度,文本类型适用
max_length
integer 最大长度,文本类型适用
text_pattern
string text 的正则表达式
image_restriction
struct 图片需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_IMAGE_ARRAY 或 ELEMENT_TYPE_IMAGE 时返回
width
integer 宽度,单位 px,图片适用
height
integer 高度,单位 px,图片适用
file_size
integer 支持的文件大小最大值,单位 KB,1KB=1024B, 图片、视频适用
file_format
enum[] 支持的图片文件格式数组,[枚举详情]
url_restriction
struct 链接需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_URL 时返回
url_pattern
string url 的正则表达式
video_restriction
struct 视频需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_VIDEO 时返回
width
integer 宽度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
height
integer 高度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
min_width
integer 最小宽度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
min_height
integer 最小高度,单位 px,视频适用,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
ratio_width
integer 宽比例,视频比例=ratio_width:ratio_height,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
ratio_height
integer 高比例,视频比例=ratio_width:ratio_height,ratio_width、ratio_height、min_width、min_height 与 width、height 不同时返回
file_size
integer 支持的文件大小最大值,单位 KB,1KB=1024B, 图片、视频适用
file_format
enum[] 支持的流媒体文件格式数组,[枚举详情]
min_duration
integer 最小时长,单位秒,视频适用
max_duration
integer 最大时长,单位秒,视频适用
number_restriction
struct 数值型需满足的限制条件,仅当 element_type 是 ELEMENT_TYPE_INTEGER 时返回
min
integer 最小长度,文本类型适用
max
integer 最大长度,文本类型适用
support_page_type
enum[] 支持的落地页类型,[枚举详情]
support_billing_spec_list
struct[] 支持的计费信息
billing_event
enum 计费方式,[枚举详情]
min_price
integer 最低出价,单位分
max_price
integer 最高出价,单位分
support_dynamic_ability_spec_list
struct 动态广告支持情况
dynamic_ability_type
enum[] 动态广告投放能力类型,[枚举详情]
product_item_display_quantity
enum[] 在该规格位置上单个广告上的创意可展示商品数量,[枚举详情]
support_bid_mode_list
enum[] 支持的出价方式,[枚举详情]
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "promoted_object_type": "PROMOTED_OBJECT_TYPE_LINK",
                "adcreative_template_id": 69,
                "ad_attributes": [
                    {
                        "enum_property": [],
                        "array_property": [],
                        "struct_property": [],
                        "name": "impression_tracking_url",
                        "element_type": "ELEMENT_TYPE_URL",
                        "field_type": "FIELD_TYPE_STRING",
                        "required": false,
                        "description": "请输入曝光监测 URL(可选)",
                        "parent_name": "",
                        "restriction": {
                            "url_restriction": {
                                "url_pattern": "^https?:\\/\\/([a-zA-Z0-9\\-]+\\.)+([a-zA-Z]{2,5})([\\/\\?#][a-zA-Z0-9`~!@#%&_=;\\$\\^\\*\\(\\)\\-\\+\\{\\}\\[\\]\\:\\,\\.\\?\\/\\|]*)?$"
                            }
                        }
                    },
                    {
                        "enum_property": [],
                        "array_property": [],
                        "struct_property": [],
                        "name": "click_tracking_url",
                        "element_type": "ELEMENT_TYPE_URL",
                        "field_type": "FIELD_TYPE_STRING",
                        "required": false,
                        "description": "请输入点击监测 URL(可选)",
                        "parent_name": "",
                        "restriction": {
                            "url_restriction": {
                                "url_pattern": "^https?:\\/\\/([a-zA-Z0-9\\-]+\\.)+([a-zA-Z]{2,5})([\\/\\?#][a-zA-Z0-9`~!@#%&_=;\\$\\^\\*\\(\\)\\-\\+\\{\\}\\[\\]\\:\\,\\.\\?\\/\\|]*)?$"
                            }
                        }
                    }
                ],
                "adcreative_elements": [
                    {
                        "enum_property": [],
                        "array_property": [],
                        "struct_property": [],
                        "name": "image",
                        "element_type": "ELEMENT_TYPE_IMAGE",
                        "field_type": "FIELD_TYPE_STRING",
                        "required": true,
                        "description": "图片",
                        "parent_name": "",
                        "restriction": {
                            "image_restriction": {
                                "width": 72,
                                "height": 72,
                                "file_size": 30,
                                "file_format": [
                                    "IMAGE_TYPE_JPG",
                                    "IMAGE_TYPE_PNG"
                                ]
                            }
                        }
                    },
                    {
                        "enum_property": [],
                        "array_property": [],
                        "struct_property": [],
                        "name": "title",
                        "element_type": "ELEMENT_TYPE_TEXT",
                        "field_type": "FIELD_TYPE_STRING",
                        "required": true,
                        "description": "广告文案",
                        "parent_name": "",
                        "restriction": {
                            "text_restriction": {
                                "min_length": 1,
                                "max_length": 14
                            }
                        }
                    },
                    {
                        "enum_property": [],
                        "array_property": [],
                        "struct_property": [],
                        "name": "description",
                        "element_type": "ELEMENT_TYPE_TEXT",
                        "field_type": "FIELD_TYPE_STRING",
                        "required": true,
                        "description": "广告描述",
                        "parent_name": "",
                        "restriction": {
                            "text_restriction": {
                                "min_length": 1,
                                "max_length": 14
                            }
                        }
                    },
                    {
                        "enum_property": [],
                        "array_property": [],
                        "struct_property": [],
                        "name": "phone",
                        "element_type": "ELEMENT_TYPE_TEXT",
                        "field_type": "FIELD_TYPE_STRING",
                        "required": false,
                        "description": "请输入电话号码(可选)",
                        "parent_name": "",
                        "restriction": []
                    }
                ],
                "adcreative_sample_image_list": [
                    {
                        "name": "移动 Banner 广告位",
                        "image": "http://qzonestyle.gtimg.cn/gdt_ui_proj/dist/gdt/imgbox/lm_bannner_72x72.png"
                    }
                ],
                "adcreative_template_name": "移动 Banner",
                "adcreative_template_description": "Banner 广告位",
                "adcreative_template_size": "72 × 72",
                "adcreative_template_style": "单图(文)",
                "site_set": "SITE_SET_MOBILE_INNER",
                "adcreative_attributes": [
                    {
                        "enum_property": [],
                        "array_property": [],
                        "struct_property": [],
                        "name": "deep_link_url",
                        "element_type": "ELEMENT_TYPE_URL",
                        "field_type": "FIELD_TYPE_STRING",
                        "required": false,
                        "description": "应用直达(可选)",
                        "parent_name": "",
                        "restriction": {
                            "url_restriction": {
                                "url_pattern": "^((?!https?)([a-zA-Z0-9_\\-\\.])+):\\/\\/([a-zA-Z0-9_\\-\\?]+\\.?)+([a-zA-Z0-9`~!@#%&_=;\\$\\^\\*\\(\\)\\-\\+\\{\\}\\[\\]\\:\\,\\.\\?\\/\\|\\u4e00-\\u9fa5]*)?$"
                            }
                        }
                    }
                ],
                "support_billing_spec_list": [
                    {
                        "billing_event": "BILLINGEVENT_CLICK",
                        "min_price": 10,
                        "max_price": 10000
                    }
                ]
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具