动态商品图片 (Dynamic Ad Image)
V1.1
loading
本节将为您介绍动态商品图片 (Dynamic Ad Image) 相关接口。主要用于DPA广告投放。
- 根据DPA模板生成图片(dynamic_ad_images/add)
所属权限(scope):Ads Management
- 获取DPA模板生成的图片(dynamic_ad_images/get)
所属权限(scope):Ads Management
创建用于广告投放的动态广告图片
全部接口
V1.1
loading
所属权限
Ads Management
请求地址
dynamic_ad_images/add
请求方法
post
全局参数
全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考。
参数名称
参数类型
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
product_catalog_id*
integer
商品目录 id
最小值 0,最大值 2147483647
product_mode*
enum
标明适用的动态商品广告类型,SINGLE 表示适用于 SDPA,MULTIPLE 表示适用于 MDPA,[枚举详情]
枚举列表:{ SINGLE, MULTIPLE }
product_source*
string
product_mode 为 SINGLE 时,需传入商品 id ; product_mode 为 MULTIPLE 时,需传入商品系列 id
字段长度最小 1 字节,长度最大 128 字节
dynamic_ad_template_size*
enum
模板使用尺寸,[枚举详情]
枚举列表:{ SIZE_1280_720, SIZE_1080_1920, SIZE_1000_560, SIZE_960_540, SIZE_960_334, SIZE_960_274, SIZE_900_500, SIZE_800_800, SIZE_800_640, SIZE_800_450, SIZE_720_1280, SIZE_640_316, SIZE_640_960, SIZE_640_800, SIZE_640_360, SIZE_640_1136, SIZE_582_166, SIZE_498_280, SIZE_480_360, SIZE_480_320, SIZE_480_270, SIZE_465_230, SIZE_354_222, SIZE_240_180, SIZE_230_152, SIZE_147_147, SIZE_540_276 }
dynamic_ad_template_id*
integer
动态商品模板 id
最小值 0,最大值 2147483647
image_matting_enabled
boolean
是否使用“商品抠图”功能,默认值为 false
可选值:{ true, false }
请求示例
curl 'https://api.e.qq.com/v1.1/dynamic_ad_images/add?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=123' \
-d 'product_catalog_id=1' \
-d 'product_mode=MULTIPLE' \
-d 'product_source=123' \
-d 'dynamic_ad_template_size=SIZE_1280_720' \
-d 'dynamic_ad_template_id=123456'
应答字段
名称
类型
描述
image_id
int64
图片 id
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"image_id": "<IMAGE_ID>"
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务
获取动态广告图片信息
全部接口
V1.1
loading
所属权限
Ads Management
请求地址
dynamic_ad_images/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,最大长度 4
field*
string
过滤字段
可选值:{ image_signature, image_id, image_width, image_height, created_time, last_modified_time }
operator*
enum
操作符
当 field 取值 image_signature 时,枚举列表:{ EQUALS, CONTAINS }
当 field 取值 image_id 时,枚举列表:{ EQUALS, CONTAINS, IN }
当 field 取值 image_width 时,枚举列表:{ EQUALS }
当 field 取值 image_height 时,枚举列表:{ 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 取值 image_signature 时,
字段长度最小 1 字节,长度最大 32 字节
当 field 取值 image_id 且 operator 取值 IN 时,
字段长度最小 1 字节,长度最大 48 字节
当 field 取值 image_id 时,
字段长度最小 1 字节,长度最大 48 字节
当 field 取值 image_width 时,
最小值 0,最大值 2000
当 field 取值 image_height 时,
最小值 0,最大值 2000
当 field 取值 created_time 时,
字段长度为 10 字节
当 field 取值 last_modified_time 时,
字段长度为 10 字节
page
integer
搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer
一页显示的数据条数,默认值:10
最小值 1,最大值 100
请求示例
curl -G 'https://api.e.qq.com/v1.1/dynamic_ad_images/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=123' \
-d 'page=1' \
-d 'page_size=10'
应答字段
名称
类型
描述
list
struct[]
返回信息列表
image_id
int64
图片 id
dynamic_ad_template_id
integer
动态商品模板 id
width
integer
图片宽度,单位 px
height
integer
图片高度,单位 px
sample_image_url
string
预览地址
page_info
struct
分页配置信息
page
integer
搜索页码
page_size
integer
一页显示的数据条数
total_number
integer
总条数
total_page
integer
总页数
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"image_id": "<IMAGE_ID>",
"dynamic_ad_template_id": 123456,
"width": 360,
"height": 640
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务
本节将为您介绍动态商品图片 (Dynamic Ad Image) 相关接口。主要用于DPA广告投放。
- 根据DPA模板生成图片(dynamic_ad_images/add)
- 获取DPA模板生成的图片(dynamic_ad_images/get)
所属权限(scope):Ads Management
所属权限(scope):Ads Management
创建用于广告投放的动态广告图片
全部接口
V1.1
loading
所属权限 | Ads Management |
请求地址 | dynamic_ad_images/add |
请求方法 | post |
全局参数
全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考。
参数名称 | 参数类型 |
---|---|
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 |
product_catalog_id*
|
integer | 商品目录 id 最小值 0,最大值 2147483647 |
product_mode*
|
enum | 标明适用的动态商品广告类型,SINGLE 表示适用于 SDPA,MULTIPLE 表示适用于 MDPA,[枚举详情] 枚举列表:{ SINGLE, MULTIPLE } |
product_source*
|
string | product_mode 为 SINGLE 时,需传入商品 id ; product_mode 为 MULTIPLE 时,需传入商品系列 id 字段长度最小 1 字节,长度最大 128 字节 |
dynamic_ad_template_size*
|
enum | 模板使用尺寸,[枚举详情] 枚举列表:{ SIZE_1280_720, SIZE_1080_1920, SIZE_1000_560, SIZE_960_540, SIZE_960_334, SIZE_960_274, SIZE_900_500, SIZE_800_800, SIZE_800_640, SIZE_800_450, SIZE_720_1280, SIZE_640_316, SIZE_640_960, SIZE_640_800, SIZE_640_360, SIZE_640_1136, SIZE_582_166, SIZE_498_280, SIZE_480_360, SIZE_480_320, SIZE_480_270, SIZE_465_230, SIZE_354_222, SIZE_240_180, SIZE_230_152, SIZE_147_147, SIZE_540_276 } |
dynamic_ad_template_id*
|
integer | 动态商品模板 id 最小值 0,最大值 2147483647 |
image_matting_enabled
|
boolean | 是否使用“商品抠图”功能,默认值为 false 可选值:{ true, false } |
请求示例
curl 'https://api.e.qq.com/v1.1/dynamic_ad_images/add?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=123' \
-d 'product_catalog_id=1' \
-d 'product_mode=MULTIPLE' \
-d 'product_source=123' \
-d 'dynamic_ad_template_size=SIZE_1280_720' \
-d 'dynamic_ad_template_id=123456'
应答字段
名称 | 类型 | 描述 |
---|---|---|
image_id
|
int64 | 图片 id |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"image_id": "<IMAGE_ID>"
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务
获取动态广告图片信息
全部接口
V1.1
loading
所属权限 | Ads Management |
请求地址 | dynamic_ad_images/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,最大长度 4 |
field*
|
string | 过滤字段 可选值:{ image_signature, image_id, image_width, image_height, created_time, last_modified_time } |
operator*
|
enum | 操作符 当 field 取值 image_signature 时,枚举列表:{ EQUALS, CONTAINS } 当 field 取值 image_id 时,枚举列表:{ EQUALS, CONTAINS, IN } 当 field 取值 image_width 时,枚举列表:{ EQUALS } 当 field 取值 image_height 时,枚举列表:{ 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 取值 image_signature 时, 字段长度最小 1 字节,长度最大 32 字节 当 field 取值 image_id 且 operator 取值 IN 时, 字段长度最小 1 字节,长度最大 48 字节 当 field 取值 image_id 时, 字段长度最小 1 字节,长度最大 48 字节 当 field 取值 image_width 时, 最小值 0,最大值 2000 当 field 取值 image_height 时, 最小值 0,最大值 2000 当 field 取值 created_time 时, 字段长度为 10 字节 当 field 取值 last_modified_time 时, 字段长度为 10 字节 |
page
|
integer | 搜索页码,默认值:1 最小值 1,最大值 99999 |
page_size
|
integer | 一页显示的数据条数,默认值:10 最小值 1,最大值 100 |
请求示例
curl -G 'https://api.e.qq.com/v1.1/dynamic_ad_images/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=123' \
-d 'page=1' \
-d 'page_size=10'
应答字段
名称 | 类型 | 描述 |
---|---|---|
list
|
struct[] | 返回信息列表 |
image_id
|
int64 | 图片 id |
dynamic_ad_template_id
|
integer | 动态商品模板 id |
width
|
integer | 图片宽度,单位 px |
height
|
integer | 图片高度,单位 px |
sample_image_url
|
string | 预览地址 |
page_info
|
struct | 分页配置信息 |
page
|
integer | 搜索页码 |
page_size
|
integer | 一页显示的数据条数 |
total_number
|
integer | 总条数 |
total_page
|
integer | 总页数 |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"image_id": "<IMAGE_ID>",
"dynamic_ad_template_id": 123456,
"width": 360,
"height": 640
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务