获取创意规格详情

所属权限 ads_management,ads_insights
请求地址 creative_template/get
请求方法 GET

全局参数

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

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性

请求参数

标有*的参数为必填项

名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
marketing_goal*
enum 营销目的类型,[枚举详情]
可选值:{ MARKETING_GOAL_UNKNOWN, MARKETING_GOAL_USER_GROWTH, MARKETING_GOAL_PRODUCT_SALES, MARKETING_GOAL_LEAD_RETENTION, MARKETING_GOAL_BRAND_PROMOTION, MARKETING_GOAL_INCREASE_FANS_INTERACTION }
marketing_sub_goal
enum 二级营销目的类型,[枚举详情]
可选值:{ MARKETING_SUB_GOAL_UNKNOWN, MARKETING_SUB_GOAL_NEW_GAME_RESERVE, MARKETING_SUB_GOAL_NEW_GAME_TEST, MARKETING_SUB_GOAL_NEW_GAME_LAUNCH, MARKETING_SUB_GOAL_PLATEAU_PHASE_LAUNCH, MARKETING_SUB_GOAL_MINI_GAME_NEW_CUSTOMER_GROWTH, MARKETING_SUB_GOAL_MINI_GAME_RETURN_CUSTOMER_ENGAGEMENT, MARKETING_SUB_GOAL_APP_ACQUISITION, MARKETING_SUB_GOAL_APP_ACTIVATION, MARKETING_SUB_GOAL_NOT_INSTALL_USER, MARKETING_SUB_GOAL_PRE_INSTALL_USER, MARKETING_SUB_GOAL_UNLOADED_USER, MARKETING_SUB_GOAL_SHORT_INACTIVE_USER, MARKETING_SUB_GOAL_LONG_INACTIVE_USER }
marketing_target_type*
enum 推广产品类型,[枚举详情]
可选值:{ MARKETING_TARGET_TYPE_APP_ANDROID, MARKETING_TARGET_TYPE_APP_IOS, MARKETING_TARGET_TYPE_WECHAT_OFFICIAL_ACCOUNT, MARKETING_TARGET_TYPE_PRODUCT, MARKETING_TARGET_TYPE_TRAFFIC, MARKETING_TARGET_TYPE_LOCAL_STORE, MARKETING_TARGET_TYPE_WECHAT_MINI_GAME, MARKETING_TARGET_TYPE_CONSUMER_PRODUCT, MARKETING_TARGET_TYPE_WECHAT_CHANNELS, MARKETING_TARGET_TYPE_WECHAT_CHANNELS_LIVE, MARKETING_TARGET_TYPE_WECHAT_CHANNELS_LIVE_RESERVATION, MARKETING_TARGET_TYPE_MINI_PROGRAM_WECHAT, MARKETING_TARGET_TYPE_APP_QUICK_APP, MARKETING_TARGET_TYPE_CONSUME_MEDICAL, MARKETING_TARGET_TYPE_COMPREHENSIVE_HOUSEKEEPING, MARKETING_TARGET_TYPE_FICTION, MARKETING_TARGET_TYPE_SHORT_DRAMA, MARKETING_TARGET_TYPE_AUDIOVISUAL_ENTERTAINMENT, MARKETING_TARGET_TYPE_BEAUTY_AND_PERSONAL_CARE, MARKETING_TARGET_TYPE_WEDDING_AND_PORTRAIT_PHOTOGRAPHY, MARKETING_TARGET_TYPE_FRANCHISE_BRAND, MARKETING_TARGET_TYPE_ENTERPRISE_SERVICES, MARKETING_TARGET_TYPE_EXHIBITION_BOOTH_DESIGN, MARKETING_TARGET_TYPE_INSURANCE, MARKETING_TARGET_TYPE_BANK, MARKETING_TARGET_TYPE_CREDIT, MARKETING_TARGET_TYPE_INVESTMENT_CONSULTING, MARKETING_TARGET_TYPE_REAL_ESTATE, MARKETING_TARGET_TYPE_TELECOMMUNICATIONS_OPERATOR, MARKETING_TARGET_TYPE_TOURIST_ATTRACTIONS_TICKETS, MARKETING_TARGET_TYPE_RENOVATION_SERVICES, MARKETING_TARGET_TYPE_FURNITURE_AND_BUILDING_MATERIALS, MARKETING_TARGET_TYPE_EXHIBITION_SALES, MARKETING_TARGET_TYPE_MEDICINE_INDUSTRY_COMMERCIAL, MARKETING_TARGET_TYPE_FINANCE, MARKETING_TARGET_TYPE_LOCAL_STORE_PACKAGE, MARKETING_TARGET_TYPE_CATERING_AND_LEISURE, MARKETING_TARGET_TYPE_CHAIN_RESTAURANT, MARKETING_TARGET_TYPE_COMMODITY_SET, MARKETING_TARGET_TYPE_TOURIST_TRAVEL_ROUTE, MARKETING_TARGET_TYPE_TOURIST_CRUISE_LINE, MARKETING_TARGET_TYPE_TOURIST_HOTEL_SERVICE, MARKETING_TARGET_TYPE_TOURIST_AIRLINE_TICKETS, MARKETING_TARGET_TYPE_LOCAL_STORE_COMBINE_WITH_PRODUCT, MARKETING_TARGET_TYPE_ACTIVITY, MARKETING_TARGET_TYPE_STORE, MARKETING_TARGET_TYPE_MINI_GAME_QQ, MARKETING_TARGET_TYPE_PC_GAME, MARKETING_TARGET_TYPE_WECHAT_WORK, MARKETING_TARGET_TYPE_LIVE_STREAM_ROOM, MARKETING_TARGET_TYPE_PERSONAL_STORE, MARKETING_TARGET_TYPE_PLATFORM_CHANNEL, MARKETING_TARGET_TYPE_TWO_WHEEL_VEHICLE, MARKETING_TARGET_TYPE_GOVERNMENT_AFFAIRS, MARKETING_TARGET_TYPE_CAR_ECOLOGY }
marketing_carrier_type*
enum 营销载体类型,[枚举详情]
可选值:{ MARKETING_CARRIER_TYPE_UNKNOWN, MARKETING_CARRIER_TYPE_APP_ANDROID, MARKETING_CARRIER_TYPE_APP_IOS, MARKETING_CARRIER_TYPE_WECHAT_OFFICIAL_ACCOUNT, MARKETING_CARRIER_TYPE_JUMP_PAGE, MARKETING_CARRIER_TYPE_WECHAT_MINI_GAME, MARKETING_CARRIER_TYPE_WECHAT_CHANNELS_LIVE, MARKETING_CARRIER_TYPE_WECHAT_CHANNELS, MARKETING_CARRIER_TYPE_WECHAT_CHANNELS_LIVE_RESERVATION, MARKETING_CARRIER_TYPE_MINI_PROGRAM_WECHAT, MARKETING_CARRIER_TYPE_APP_QUICK_APP, MARKETING_CARRIER_TYPE_PC_GAME, MARKETING_CARRIER_TYPE_QQ_MINI_GAME }
automatic_site_enabled
boolean 是否开启自动版位功能,暂不包含 SITE_SET_WECHAT,此字段与 site_set 字段至少需要写入一个。该功能目前灰度中。
可选值:{ true, false }
site_set
enum[] 投放站点集合,当前单站点或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO 的组合,[枚举详情]
数组最小长度 1,最大长度 32
可选值:{ SITE_SET_MOBILE_UNION, SITE_SET_WECHAT, SITE_SET_TENCENT_NEWS, SITE_SET_TENCENT_VIDEO, SITE_SET_MOBILE_YYB, SITE_SET_PCQQ, SITE_SET_KANDIAN, SITE_SET_QQ_MUSIC_GAME, SITE_SET_MOMENTS, SITE_SET_CHANNELS, SITE_SET_WECHAT_SEARCH, SITE_SET_WECHAT_PLUGIN, SITE_SET_QBSEARCH, SITE_SET_SEARCH_SCENE }
delivery_mode*
enum 投放模式,[枚举详情]
可选值:{ DELIVERY_MODE_COMPONENT, DELIVERY_MODE_CUSTOMIZE }
dynamic_creative_type
enum 动态创意类型,[枚举详情]
可选值:{ DYNAMIC_CREATIVE_TYPE_COMMON, DYNAMIC_CREATIVE_TYPE_PROGRAM }
creative_template_id
integer 创意规格 id,具体请咨询您的运营接口人,也可通过 [ [创意规格查询工具] ] 进行查询

请求示例


curl -v -G 'https://api.e.qq.com/v3.0/creative_template/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'site_set=[]' 
					

应答字段

名称 类型 描述
list
struct[] 创意规格列表
creative_template_id
integer 创意规格 id,具体请咨询您的运营接口人,也可通过 [ [创意规格查询工具] ] 进行查询
creative_template_style
string 创意形式类型
creative_template_appellation
string 创意形式名称
creative_sample_image
string 创意规格示意图链接
site_set
enum[] 投放站点集合,当前单站点或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO 的组合,[枚举详情]
creative_components
struct[] 创意组件列表
name
string 元素字段名,创意接口要求的 creative_components 结构中的元素字段名,如 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 创意元素枚举可选值描述
category
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 最大长度,文本类型适用
link_name_text_restrictions
struct[] 支持的出价方式
min_length
integer 最小长度,文本类型适用
max_length
integer 最大长度,文本类型适用
text_pattern
string text 的正则表达式
link_name_text_template
string 文字链模板文案
path
string 元素路径名称,创意接口要求的 creative_components 结构中的元素路径
unsupport_siteset_detail_spec
struct[] 不支持播放的版位信息列表
site_set
enum[] 投放站点集合,当前单站点或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO 的组合,[枚举详情]
support_dynamic_ability_spec_list
struct 动态广告支持情况
dynamic_ability_type
enum[] 动态广告投放能力类型,[枚举详情]
product_item_display_quantity
enum[] 在该规格位置上单个广告上的创意可展示商品数量,[枚举详情]

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "site_set": [],
                "creative_components": [
                    {
                        "enum_property": {
                            "enumeration": []
                        },
                        "array_property": [],
                        "struct_property": [],
                        "restriction": {
                            "text_restriction": [],
                            "image_restriction": {
                                "file_format": []
                            },
                            "url_restriction": [],
                            "video_restriction": {
                                "file_format": []
                            },
                            "number_restriction": [],
                            "link_name_text_restrictions": []
                        }
                    }
                ],
                "unsupport_siteset_detail_spec": [
                    {
                        "site_set": []
                    }
                ],
                "support_dynamic_ability_spec_list": {
                    "dynamic_ability_type": [],
                    "product_item_display_quantity": []
                }
            }
        ]
    }
}

可视化调试工具