Tag
最終更新: 2026年6月22日
Tag は Content や Media を分類するための短いラベルです。アパレルのショッピングモールを例にすると、「ベストセラー」「新商品」のようなラベルが Tag です。同じ Tag を複数の Content・Media に付けておくと、後からそのラベルでまとめて取得したり絞り込んだりできます。
Tag 自体は名前(name)のみを持つラベルであり、公開の概念がない設定リソースです。実際に何かに付与するのは Tag を直接編集することではなく、Content・Media の metadata.tags にこの Tag の Refer を入れることで行います(下記 Content・Media にタグを付ける を参照)。CMA において Tag は Space の下位リソースであり、パスは /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 オブジェクトに格納します。space、createdBy、updatedBy は Refer 形式({ "sys": { "id", "type": "Refer", "targetType" } })で入ります。
| 属性 | 型 | 説明 |
|---|---|---|
id | string | リソースの一意な識別子。 |
type | string | リソースの種類。Tag は常に "Tag"。 |
space | Refer<Space> | この Tag が属する Space。 |
createdBy | Refer<User> | 作成したユーザー。 |
createdAt | string (date-time) | 作成日時。 |
updatedBy | Refer<User> | 最後に編集したユーザー。 |
updatedAt | string (date-time) | 最終編集日時。 |
version | integer (≥1) | リソースのバージョン。編集するたびに 1 ずつ上がります。 |
本文属性:
| 属性 | 型 | 説明 |
|---|---|---|
name | string (1~16) | Tag の名前。作成・編集時に指定します。 |
Tag は公開の概念がない設定リソースです。そのため Content・Media とは異なり sys に publish・archive・status がなく、version のみを持ちます。version は Tag を編集するたびに上がります。
Content・Media にタグを付ける
Tag を付けるには 2 つのステップを踏みます。
- Tag を作成します(下記 Tag 作成 エンドポイント)。レスポンスの
sys.idを控えておきます。 - Content・Media を作成または編集する際、その本文の
metadata.tags配列にこの Tag のReferを入れます。
metadata.tags に入れる Refer の形式は以下のとおりです。id には手順 1 で受け取った Tag の sys.id を入れます。
"metadata": {
"tags": [
{ "sys": { "id": "3trmXRM3RqbgSnifyg7OShPt8M8Nwh", "type": "Refer", "targetType": "Tag" } }
]
}複数の Tag を付けるには、この Refer オブジェクトを配列に複数入れます。タグを外すには該当項目を配列から除き、Content・Media を再度編集します。Content・Media の本文データを作成する詳しい方法は Content・Media のドキュメントを参照してください。
API
以下のすべてのエンドポイントの基準 URL は https://cma.weegloo.com/v1 であり、Authorization ヘッダーに CMA を認証する Bearer トークンが必要です。編集・部分編集には、楽観的並行性制御のために X-Weegloo-Version ヘッダー(現在のリソースの sys.version)も一緒に送る必要があります。作成と削除にはこのヘッダーはありません。
