Locale

最終更新: 2026年6月22日

Locale は Space がサポートする言語設定です。各 Locale は、言語コード（code、例: ko-KR）、その Locale が Space の既定 Locale かどうか（default）、必須フィールドの入力において任意かどうか（optional）、値がないときに代わりに参照する Locale（fallbackCode）を持ちます。CDA（Content Delivery API）はこの一覧を読み取り専用で配信します。Locale の作成や変更は CMA Locale の管轄です。

Content や Media を取得するときに渡す locale クエリパラメータの値が、まさにこの Locale の code です。どのコードを指定できるかを知るには、まずこのエンドポイントで Space がサポートする Locale 一覧を読み取り、そこに含まれる code を使用します。

リソース構造

以下は、デモ Space の Locale 1 件（"Korean (South Korea)"）を CDA が配信する形です。sys（システム属性）とともに、Locale の本文属性である optional を持ちます。

{
  "sys": {
    "id": "3trmXRM3RqbgSnifyg7OGfZoXmkOU8",
    "type": "Locale",
    "space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
    "name": "Korean (South Korea)",
    "default": false,
    "code": "ko-KR",
    "createdBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "createdAt": "2026-06-15T15:14:11.710Z",
    "updatedAt": "2026-06-17T10:43:32.034Z",
    "updatedBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "version": 3
  },
  "optional": false
}

主なキー:

  • sys.code: この Locale の言語コードです。Content・Media 取得の locale パラメータにこの値を指定します。
  • sys.default: この Locale が Space の既定 Locale かどうかです。Space には既定 Locale が 1 つあり、その Locale でのみ default が true になります。
  • sys.name: 人が読むための名前です（例: "Korean (South Korea)"）。取得パラメータにはこの名前ではなく code を使います。
  • optional: 必須（required）フィールドを入力する際、この Locale を空のままにできるかどうかです。上記の例の 2 つの Locale はいずれも optional が false です。
  • fallbackCode: 値がないときに代わりに参照する別の Locale の code です（オプション）。設定したときだけ応答に現れます。上記の例では設定されていないため、キーが表示されません。

システム属性 (sys) と本文

space・createdBy・updatedBy は Refer 形（{ "sys": { "id", "type": "Refer", "targetType" } }）で入ります。

属性型説明
idstringリソース固有の識別子。
typestringリソースの種類。Locale は常に "Locale"。
spaceRefer<Space>この Locale が属する Space。
namestring人が読むための名前（例: "Korean (South Korea)"）。
codestring言語コード（例: ko-KR）。Content・Media 取得の locale 値になります。
defaultbooleanSpace の既定 Locale かどうか。Space で 1 つだけ true。
createdByRefer<User>作成したユーザー。
createdAtstring (date-time)作成時刻。
updatedByRefer<User>最後に更新したユーザー。
updatedAtstring (date-time)最後の更新時刻。
versioninteger現在のバージョン。更新するたびに増えます。

Locale は発行スナップショットではなく Space の設定リソースであるため、Content の sys にある revision・status・publish は含まれません。

本文属性:

属性型説明
optionalboolean必須（required）フィールドを入力する際、この Locale を空のままにできるかどうか。既定 Locale は通常 false（必ず入力）。
fallbackCodestring値がないときに代わりに参照する Locale の code（オプション、チェーン可能）。設定しなければキー自体が応答にありません。

動作メモ

default が true の Locale は Content 作成時に必ず入力する必要があり、Content・Media 取得では locale をその code に指定してその言語の値を受け取ります。fallbackCode が設定されていると、要求した Locale に値がないときに fallbackCode が指す Locale に切り替えて値を探します（その Locale にも fallbackCode があれば続いていくチェーンになります）。fallbackCode がない Locale は、値がないとそのまま null になります。既定 Locale・fallback・必須入力のルールは 多言語対応 (概念) で扱います。

API

以下のエンドポイントの基準 URL は https://cda.weegloo.com/v1 で、Authorization ヘッダーに CDA を認証する Bearer トークンが必要です。Locale 一覧は言語設定そのものであるため、Content・Media 取得とは異なり locale クエリパラメータを受け取りません。