获取品牌模板数据集

开发环境

GET

/rest/v1/brand-templates/{brandTemplateId}/dataset

检查您是否可以自动填充品牌模板以及可以自动填充哪些信息。

此 API 目前以预览版形式提供。请注意以下事项：

可能会有未公布的重大变化。

对预览 API 的任何重大更改都不会产生新的API 版本。

使用预览 API 的公共集成将不会通过审核流程，并且无法向所有 Canva 用户提供。

获取品牌模板的数据集定义。如果品牌模板包含自动填充数据字段，此 API 将返回一个对象，其中包含数据字段名称及其接受的数据类型。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/rest/v1/brand-templates//dataset' \
--header 'Authorization: Bearer {token}'

响应示例

{
  "dataset": {
    "cute_pet_image_of_the_day": {
      "type": "image"
    },
    "cute_pet_witty_pet_says": {
      "type": "text"
    }
  }
}

请求参数

Path 参数

brandTemplateId

string

品牌模板ID。

必需

Header 参数

Authorization

string

必需

示例值:

Bearer {token}

🟢200成功

application/json

Body

dataset

object

必需

品牌模板的数据集定义。数据集定义包含可用于创建设计自动填充作业 API的数据输入。

cute_pet_image_of_the_day

object

必需

cute_pet_witty_pet_says

object

必需

修改于 2024-06-26 09:29:41