Tag

最后更新:2026年6月22日

Tag 是用于对 ContentMedia 进行分类的简短标签。以服装电商为例,"畅销商品"、"新品" 这样的标签就是 Tag。把同一个 Tag 标注到多个 ContentMedia 上后,之后就能按该标签将它们归集起来查询或筛选。

Tag 本身是只有名称(name)的标签,是没有发布概念的配置型资源。实际把它标注到某个对象上时,并不是直接修改 Tag,而是把这个 TagRefer 放入 ContentMediametadata.tags(参见下方 为内容和媒体添加标签)。在 CMA 中,TagSpace 的下级资源,其路径以 /spaces/{spaceId}/tags 为基准。

资源结构

下面是 Tag "畅销商品" 的单条查询响应。它包含 sys(系统属性)和正文属性 name

{
  "sys": {
    "id": "3trmXRM3RqbgSnifyg7OShPt8M8Nwh",
    "type": "Tag",
    "space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
    "createdBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "createdAt": "2026-06-16T01:46:07.426Z",
    "updatedBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "updatedAt": "2026-06-16T01:46:07.426Z",
    "version": 1
  },
  "name": "畅销商品"
}

主要键:

  • sys.idTag 的唯一标识符。它会填入单条查询、修改、删除路径中的 {tagId},并且在用 metadata.tags 添加标签时作为 Refer 的目标 id 使用。
  • nameTag 的名称(1-16 个字符)。它就是在内容分类中显示的标签本身。

系统属性 (sys)

每个 Tag 都把通用系统属性放在 sys 对象中。spacecreatedByupdatedByRefer 形态({ "sys": { "id", "type": "Refer", "targetType" } })填入。

属性类型说明
idstring资源唯一标识符。
typestring资源种类。Tag 始终为 "Tag"
spaceRefer<Space>Tag 所属的 Space
createdByRefer<User>创建该资源的用户。
createdAtstring (date-time)创建时间。
updatedByRefer<User>最后修改该资源的用户。
updatedAtstring (date-time)最后修改时间。
versioninteger (≥1)资源版本。每次修改时加 1。

正文属性:

属性类型说明
namestring (1-16)Tag 名称。创建和修改时指定。

Tag 是没有发布概念的配置型资源。因此与 ContentMedia 不同,它的 sys 中没有 publisharchivestatus,只有 versionversion 会在每次修改 Tag 时递增。

为内容和媒体添加标签

要添加 Tag,需要经过两个步骤。

  1. 创建 Tag(下方 创建 Tag 端点)。保留响应中的 sys.id
  2. 在创建或修改 ContentMedia 时,把该 TagRefer 放入其正文的 metadata.tags 数组。

放入 metadata.tagsRefer 形态如下。id 处填入步骤 1 中得到的 Tagsys.id

"metadata": {
  "tags": [
    { "sys": { "id": "3trmXRM3RqbgSnifyg7OShPt8M8Nwh", "type": "Refer", "targetType": "Tag" } }
  ]
}

要添加多个 Tag,就把这个 Refer 对象多放几个到数组中。要移除标签,就把对应的项从数组中去掉,再重新修改 ContentMedia。关于编写 ContentMedia 正文数据的详细方法,请参见 ContentMedia 文档。

API

下面所有端点的基准 URL 均为 https://cma.weegloo.com/v1,并且 Authorization 头中需要用于认证 CMA 的 Bearer 令牌。修改和部分修改时,为了乐观并发控制,还须一并发送 X-Weegloo-Version 头(当前资源的 sys.version)。创建和删除没有这个头。

  • Content:用 metadata.tags 添加 Tag 的正文数据。
  • Media:用 metadata.tags 添加 Tag 的文件资源。