Tag

最終更新: 2026年6月22日

TagContentMedia を分類するための短いラベルです。アパレルのショッピングモールを例にすると、「ベストセラー」「新商品」のようなラベルが Tag です。同じ Tag を複数の ContentMedia に付けておくと、後からそのラベルでまとめて取得したり絞り込んだりできます。

Tag 自体は名前(name)のみを持つラベルであり、公開の概念がない設定リソースです。実際に何かに付与するのは Tag を直接編集することではなく、ContentMediametadata.tags にこの TagRefer を入れることで行います(下記 Content・Media にタグを付ける を参照)。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.id: Tag の一意な識別子です。単一取得・編集・削除パスの {tagId} に入り、metadata.tags でタグを付ける際の Refer の対象 id としても使います。
  • name: Tag の名前です(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 とは異なり syspublisharchivestatus がなく、version のみを持ちます。versionTag を編集するたびに上がります。

Content・Media にタグを付ける

Tag を付けるには 2 つのステップを踏みます。

  1. Tag を作成します(下記 Tag 作成 エンドポイント)。レスポンスの sys.id を控えておきます。
  2. ContentMedia を作成または編集する際、その本文の metadata.tags 配列にこの TagRefer を入れます。

metadata.tags に入れる Refer の形式は以下のとおりです。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 を付けるファイルリソース。