获取动态商品视频模板

开发环境

GET

/v1.3/dynamic_ad_video_templates/get

应答字段

名称	类型	描述
list	struct[]	返回信息列表
template_id	integer	模板 id
template_name	string	模板名称
template_type	enum	模板类型，[枚举详情]
product_catalog_id	integer	商品库 id
adcreative_template_id	integer	创意规格 id
cover_image_url	string	模板示例图片 URL
intro_video_url	string	模板示例视频 URL
delivery_video_url	string	投放用视频 URL
support_channel	boolean	模板是否支持视频号
coverage	float	覆盖率（百分数）
min_video_duration	float	模板支持的视频最小时长，单位 s
max_video_duration	float	模板支持的视频最大时长，单位 s
video_product_fields	array	模板视频使用到的商品字段列表
image_product_fields	array	模板图片使用到的商品字段列表
extra	struct	模板扩展信息
cover_image_template_id	integer	视频号场景，封面图模板 id
cover_image_template_intro_url	string	视频号场景，封面图模板示例图片 URL
image_template_id	integer	视频号场景，浮层页卡图片模板 id
image_template_intro_url	string	视频号场景，浮层页卡图片模板示例图片 URL
desc	string	视频号场景，商品视频原生文案，1-1000 字，示例 {{product.product_name}}
floating_zone_name	string	视频号场景，浮层卡片上层文案，1-10 字，示例 {{product.product_short_name}}
floating_zone_desc	string	视频号场景，浮层卡片下层文案，1-14 字，示例 {{product.slogan}}
sub_template_list	struct[]	子模板列表
sample_video_url	string	模板示例视频 URL
template_type	enum	模板类型，[枚举详情]
page_info	struct	分页配置信息
page	integer	搜索页码
page_size	integer	一页显示的数据条数
total_number	integer	总条数
total_page	integer	总页数

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET '/v1.3/dynamic_ad_video_templates/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'fields;' \
--data-urlencode 'account_id=20458' \
--data-urlencode 'product_catalog_id=1' \
--data-urlencode 'adcreative_template_id=720' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=10' \
--data-urlencode 'template_id_list=[]' \
--data-urlencode 'product_mode='

响应示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "template_id": 100223274,
                "template_name": "模板名称 111111",
                "template_type": "VIDEO_TEMPLATE_TYPE_TRANSPARENT",
                "product_catalog_id": 22781,
                "adcreative_template_id": 720,
                "cover_image_url": "https://videomaker-30171.sz.gfp.tencent-cloud.com/3a1026df411da6ad8e451cad8fafcbb99ef691ab",
                "intro_video_url": "https://videomaker-30171.sz.gfp.tencent-cloud.com/2f07091636a802735cbf41ea5dc2a5411bb22cca",
                "delivery_video_url": "'",
                "sub_template_list": [
                    {
                        "sample_video_url": "https://videomaker-30171.sz.gfp.tencent-cloud.com/2f07091636a802735cbf41ea5dc2a5411bb22cca",
                        "template_type": "VIDEO_TEMPLATE_TYPE_TRANSPARENT"
                    },
                    {
                        "sample_video_url": "https://videomakertest-30171.sz.gfp.tencent-cloud.com/render_res/135886/video.mp4",
                        "template_type": "VIDEO_TEMPLATE_TYPE_TRANSPARENT"
                    }
                ]
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 20,
            "total_number": 2,
            "total_page": 1
        }
    }
}

请求参数

Header 参数

access_token

string

必需

以Query Parameter方式在请求路径中传递。授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节。

默认值:

<ACCESS_TOKEN>

timestamp

string

必需

以Query Parameter方式在请求路径中传递。当前的时间戳，单位为秒，允许客户端请求最大时间误差为300秒。
MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8，例如当时间戳为1494840119时，表示 2018-05-15 17:21:59

默认值:

nonce

string

必需

以Query Parameter方式在请求路径中传递。随机字串标识，不超过32个字符，由调用方自行生成，需保证全局唯一性。

默认值:

<NONCE>

fields

string

必需

指定返回的字段列表，为选填字段，如不填写，则根据默认值进行返回

Body 参数application/x-www-form-urlencoded

account_id

integer

必需

广告主 id，有操作权限的广告主 id

示例值:

20458

product_catalog_id

integer

必需

商品库 id
最小值 0，最大值 2147483647

示例值:

adcreative_template_id

integer

必需

创意规格 id
最小值 0，最大值 2147483647

示例值:

720

page

integer

可选

搜索页码，默认值：1
最小值 1，最大值 99999

示例值:

page_size

integer

可选

一页显示的数据条数，默认值：10
最小值 1，最大值 100

示例值:

template_id_list

integer

可选

模板 id 列表筛选

示例值:

[]

product_mode

string

必需

标明适用的动态商品广告类型，SINGLE 表示适用于 SDPA，MULTIPLE 表示适用于 MDPA，目前仅支持 MULTIPLE，[枚举详情]
枚举列表：{ SINGLE, MULTIPLE }

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

message_cn

string

必需

data

object

必需

list

array [object {9}]

返回信息列表

必需

page_info

object

分页配置信息

必需

修改于 2023-11-07 03:24:52

获取动态商品图片模板

视频工具任务查询

获取动态商品视频模板

应答字段#

请求参数

返回响应

应答字段