动态商品模板(Dynamic Ad Template)
V1.1
loading
本节将为您介绍动态商品模板(Dynamic Ad Template)相关接口。
- 获取动态商品广告模板(dynamic_ad_templates/get)
所属权限(scope):Ads Management
获取动态模板信息(待废弃)
全部接口
V1.1
loading
所属权限
请求地址
dynamic_ad_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
product_catalog_id*
integer
商品目录 id
dynamic_ad_template_type
enum
动态商品模板类型,DYNAMIC_AD_IMAGE_TEMPLATE 类型只支持 PRIVATE_TEMPLATE,DYNAMIC_AD_VIDEO_TEMPLATE 类型只支持 PUBLIC_TEMPLATE,[枚举详情]
枚举列表:{ DYNAMIC_AD_IMAGE_TEMPLATE, DYNAMIC_AD_VIDEO_TEMPLATE }
dynamic_ad_template_ownership_type
enum
动态商品模板所属类型,[枚举详情]
枚举列表:{ PRIVATE_TEMPLATE, PUBLIC_TEMPLATE, SELF_OWNED_TEMPLATE, GRANTED_TEMPLATE }
dynamic_ad_template_width*
integer
动态商品模板宽度,单位 px
最小值 1,最大值 2000
dynamic_ad_template_height*
integer
动态商品模板高度,单位 px
最小值 1,最大值 2000
filtering
struct[]
过滤条件,若此字段不传,或传空则视为无限制条件
数组长度为 1
field*
string
过滤字段
可选值:{ product_item_display_quantity }
operator*
enum
操作符
当 field 取值 product_item_display_quantity 时,枚举列表:{ EQUALS }
values*
string[]
字段取值,values 数组的个数限制与 operator 的取值相关
当 field 取值 product_item_display_quantity 时,
枚举列表:{ SINGLE, MULTIPLE }
page
integer
搜索页码,获取指定页数据,大于等于 1,小于等于实际总页数,若不传则视为 1
最小值 1,最大值 99999
page_size
integer
一页获取的数据条数,1-100,默认为 10
最小值 1,最大值 100
使用说明
- 因业务发展需要,后续获取 DPA 图片模板优先使用新接口 [获取动态商品图片模板],其余保持不变。
请求示例
curl -G 'https://api.e.qq.com/v1.1/dynamic_ad_templates/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'product_catalog_id=1' \
-d 'dynamic_ad_template_width=1000' \
-d 'dynamic_ad_template_height=560' \
-d 'filtering=[{"field":"product_item_quantity","operator":"EQUALS","value":1}]' \
-d 'page=1' \
-d 'page_size=10'
应答字段
名称
类型
描述
list
struct[]
返回信息列表
dynamic_ad_template_id
integer
动态商品模板 id
dynamic_ad_template_name
string
动态商品模板名称
dynamic_ad_template_type
enum
动态商品模板类型,DYNAMIC_AD_IMAGE_TEMPLATE 类型只支持 PRIVATE_TEMPLATE,DYNAMIC_AD_VIDEO_TEMPLATE 类型只支持 PUBLIC_TEMPLATE,[枚举详情]
product_item_display_quantity
enum
模板上的商品数量,[枚举详情]
dynamic_ad_template_width
integer
动态商品模板宽度,单位 px
dynamic_ad_template_height
integer
动态商品模板高度,单位 px
image_url
string
动态商品模板示例图链接
video_url
string
动态商品视频模板预览链接(仅视频模板类型时返回该项)
page_info
struct
分页配置信息
page
integer
搜索页码,获取指定页数据,大于等于 1,小于等于实际总页数,若不传则视为 1
page_size
integer
一页获取的数据条数,1-100
total_number
integer
总条数
total_page
integer
总页数
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"dynamic_ad_template_id": 123,
"dynamic_ad_template_name": "模板名称",
"dynamic_ad_template_width": 1000,
"dynamic_ad_template_height": 560,
"image_url": "http://example.org/example.jpg"
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务
loading
本节将为您介绍动态商品模板(Dynamic Ad Template)相关接口。
- 获取动态商品广告模板(dynamic_ad_templates/get)
所属权限(scope):Ads Management
获取动态模板信息(待废弃)
全部接口
V1.1
loading
V1.1
loading
所属权限 | |
请求地址 | dynamic_ad_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 |
product_catalog_id*
|
integer | 商品目录 id |
dynamic_ad_template_type
|
enum | 动态商品模板类型,DYNAMIC_AD_IMAGE_TEMPLATE 类型只支持 PRIVATE_TEMPLATE,DYNAMIC_AD_VIDEO_TEMPLATE 类型只支持 PUBLIC_TEMPLATE,[枚举详情] 枚举列表:{ DYNAMIC_AD_IMAGE_TEMPLATE, DYNAMIC_AD_VIDEO_TEMPLATE } |
dynamic_ad_template_ownership_type
|
enum | 动态商品模板所属类型,[枚举详情] 枚举列表:{ PRIVATE_TEMPLATE, PUBLIC_TEMPLATE, SELF_OWNED_TEMPLATE, GRANTED_TEMPLATE } |
dynamic_ad_template_width*
|
integer | 动态商品模板宽度,单位 px 最小值 1,最大值 2000 |
dynamic_ad_template_height*
|
integer | 动态商品模板高度,单位 px 最小值 1,最大值 2000 |
filtering
|
struct[] | 过滤条件,若此字段不传,或传空则视为无限制条件 数组长度为 1 |
field*
|
string | 过滤字段 可选值:{ product_item_display_quantity } |
operator*
|
enum | 操作符 当 field 取值 product_item_display_quantity 时,枚举列表:{ EQUALS } |
values*
|
string[] | 字段取值,values 数组的个数限制与 operator 的取值相关 当 field 取值 product_item_display_quantity 时, 枚举列表:{ SINGLE, MULTIPLE } |
page
|
integer | 搜索页码,获取指定页数据,大于等于 1,小于等于实际总页数,若不传则视为 1 最小值 1,最大值 99999 |
page_size
|
integer | 一页获取的数据条数,1-100,默认为 10 最小值 1,最大值 100 |
使用说明
- 因业务发展需要,后续获取 DPA 图片模板优先使用新接口 [获取动态商品图片模板],其余保持不变。
请求示例
curl -G 'https://api.e.qq.com/v1.1/dynamic_ad_templates/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'product_catalog_id=1' \
-d 'dynamic_ad_template_width=1000' \
-d 'dynamic_ad_template_height=560' \
-d 'filtering=[{"field":"product_item_quantity","operator":"EQUALS","value":1}]' \
-d 'page=1' \
-d 'page_size=10'
应答字段
名称 | 类型 | 描述 |
---|---|---|
list
|
struct[] | 返回信息列表 |
dynamic_ad_template_id
|
integer | 动态商品模板 id |
dynamic_ad_template_name
|
string | 动态商品模板名称 |
dynamic_ad_template_type
|
enum | 动态商品模板类型,DYNAMIC_AD_IMAGE_TEMPLATE 类型只支持 PRIVATE_TEMPLATE,DYNAMIC_AD_VIDEO_TEMPLATE 类型只支持 PUBLIC_TEMPLATE,[枚举详情] |
product_item_display_quantity
|
enum | 模板上的商品数量,[枚举详情] |
dynamic_ad_template_width
|
integer | 动态商品模板宽度,单位 px |
dynamic_ad_template_height
|
integer | 动态商品模板高度,单位 px |
image_url
|
string | 动态商品模板示例图链接 |
video_url
|
string | 动态商品视频模板预览链接(仅视频模板类型时返回该项) |
page_info
|
struct | 分页配置信息 |
page
|
integer | 搜索页码,获取指定页数据,大于等于 1,小于等于实际总页数,若不传则视为 1 |
page_size
|
integer | 一页获取的数据条数,1-100 |
total_number
|
integer | 总条数 |
total_page
|
integer | 总页数 |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"dynamic_ad_template_id": 123,
"dynamic_ad_template_name": "模板名称",
"dynamic_ad_template_width": 1000,
"dynamic_ad_template_height": 560,
"image_url": "http://example.org/example.jpg"
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务