简介
海报合成模板功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于海报合成模板的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.5.0。
API | 操作描述 |
查询海报合成模板接口 | |
查询海报合成模板列表接口 | |
删除模板 | |
解析保存 PSD 文件模板 |
查询海报模板
功能说明
查询海报合成模板接口
使用示例
function describePosterProductionTemplate() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const TemplateId = "xxx";const key = `posterproduction/template/${TemplateId}` // TemplateId:{TemplateId};const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}describePosterProductionTemplate()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | posterproduction/template/{TemplateId} | String | 是 |
回调函数说明
function(err, data) { ... }
相关链接
API 文档
功能指南
批量拉取海报模板
功能说明
查询海报合成模板列表接口
使用示例
function describePosterProductionTemplateList() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `posterproduction/template`;const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Query: {// 模板分类ID,支持传入多个,以,符号分割字符串;是否必传:否categoryIds: "",// Official(系统预设模板),Custom(自定义模板),All(所有模板),默认值: Custom;是否必传:否type: "Custom",},},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}describePosterProductionTemplateList()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:posterproduction/template | String | 是 |
Query | 请求参数 | Object | 否 |
Query 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
pageNumber | 第几页,默认值:1 | Number | 否 |
pageSize | 每页个数,默认值:10 | Number | 否 |
categoryIds | 模板分类 ID,支持传入多个,以,符号分割字符串 | String | 否 |
type | Official(系统预设模板),Custom(自定义模板),All(所有模板),默认值: Custom | String | 否 |
回调函数说明
function(err, data) { ... }
相关链接
API 文档
功能指南
删除模板接口
功能说明
删除模板
使用示例
function deletePosterProductionTemplate() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const TemplateId = "xxx";const key = `posterproduction/template/${TemplateId}`; // TemplateId:{TemplateId};const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'DELETE', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}deletePosterProductionTemplate()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:DELETE | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | posterproduction/template/{TemplateId} | String | 是 |
回调函数说明
function(err, data) { ... }
相关链接
API 文档
功能指南
上传文件解析模板接口
功能说明
解析保存 PSD 文件模板
使用示例
function uploadPosterProductionTemplate() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `posterproduction/template`;const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = COS.util.json2xml({Request: {// 输入参数;是否必传:否Input: {// COS 桶中 PSD 文件,大小限制100M;是否必传:是Object: "test.psd",},// 模板名称;是否必传:是Name: "test",// 模板分类 ID,支持传入多个,以 , 符号分割字符串;是否必传:否CategoryIds: "",}});cos.request({Method: 'POST', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Body: body, // 请求体参数,必须ContentType: 'application/xml', // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}uploadPosterProductionTemplate()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:POST | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:posterproduction/template | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Object | 是 |
回调函数说明
function(err, data) { ... }
参数名称 | 参数描述 | 类型 |
err | Object | |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
data | 请求成功时返回的对象,如果请求发生错误,则为空 | Object |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
- Response | Object |
相关链接
API 文档
功能指南