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

获取模板列表接口
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 programmed_template/get
请求方法 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
material_derive_id*
integer 预览 id
material_group_id*
integer 素材组 id
material_derive_preview_id*
integer 素材预览 id
template_id_list
array 模板 id 列表列表,数组长度为[0,100]
数组最小长度 0,最大长度 100
key_word
string 搜索名称
字段长度最小 0 字节,长度最大 1024 字节
sort_by
struct[] 排序列表,数组长度为[0,100]
数组最小长度 0,最大长度 100
field
enum 排序条件字段,最新上传:derive_on_first_time,消耗:template_stat.cost,点击率:template_stat.click_rate,使用量:template_stat.use_cnt,[枚举详情]
枚举列表:{ derive_on_first_time, template_stat.cost, template_stat.click_rate, template_stat.use_cnt }
desc
enum 默认降序:DESC,升序:ASC,[枚举详情]
枚举列表:{ DESC, ASC }
page_info
struct 排序
page
integer 页码,最小为 1
rows
integer 页大小
total
integer 总数

使用说明

  1. 使用该接口获取模板列表信息,会依据目前服务器繁忙程度,对接口调用进行限流,当超过限制访问频率后,提交任务会返回失败。

请求示例


curl 'https://api.e.qq.com/v1.1/programmed_template/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'material_derive_id=2449' \
-d 'material_group_id=11651' \
-d 'material_derive_preview_id=4281' \
-d 'template_id_list=[]' \
-d 'sort_by=[]' \
-d 'page_info={"page":1,"rows":20,"total":1}' 
					

应答字段

名称 类型 描述
template_infos
struct[] 排序列表,数组长度为[0,100]
id
integer 模板 id
type
integer 模版类型,2:视频模版,1:图片模版
name
string 模板名称
image_url
string 图片 url
video_url
string 视频 url
width
integer
height
integer
duration
float 视频时长
use_cnt
integer 使用量
cost
integer 消耗
click_rate
float 点击率
conversion_rate
float 转化率
conversion_cost
float 转化成本
page_info
struct 排序
page
integer 页码,最小为 1
rows
integer 页大小
total
integer 总数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "template_infos": [
            {
                "id": 100231348,
                "type": 1,
                "name": "test1234",
                "image_url": "http://p.qpic.cn/gdt_venus",
                "video_url": "",
                "width": 800,
                "height": 800,
                "duration": 0,
                "use_cnt": 0,
                "cost": 0,
                "click_rate": 0,
                "conversion_rate": 0,
                "conversion_cost": 0
            }
        ],
        "page_info": {
            "page": 1,
            "rows": 20,
            "total": 1
        }
    }
}

可视化调试工具