Weegloo Docs - Locale

Locale 是 Space 所支持的语言设置。每个 Locale 都拥有语言代码（code，例如 ko-KR）、是否为 Space 的默认 Locale（default）、在填写必填字段时是否可选（optional），以及当值为空时改为查找的 Locale（fallbackCode）。CDA（Content Delivery API）以只读方式传递该列表。创建或修改 Locale 的操作属于 CMA Locale 的范畴。

查询 Content 或 Media 时传入的 locale 查询参数值，正是该 Locale 的 code。若想知道可以填入哪些代码，请先通过此端点读取 Space 所支持的 Locale 列表，并使用其中包含的 code。

资源结构

下面是 CDA 传递的演示 Space 中一条 Locale（"Korean (South Korea)"）的形态。它在 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，只有该 Locale 的 default 为 true。
sys.name：供人阅读的名称（例如 "Korean (South Korea)"）。查询参数中使用的是 code，而非该名称。
optional：在填写必填（required）字段时，是否可以将此 Locale 留空。上例中的两个 Locale 的 optional 均为 false。
fallbackCode：当值为空时改为查找的另一个 Locale 的 code（可选）。仅在设置后才会出现在响应中。上例未设置，因此看不到该键。

系统属性 (sys) 与正文

space、createdBy、updatedBy 以 Refer 形态（{ "sys": { "id", "type": "Refer", "targetType" } }）填入。

属性	类型	说明
`id`	string	资源唯一标识符。
`type`	string	资源种类。Locale 始终为 `"Locale"`。
`space`	Refer<Space>	此 Locale 所属的 Space。
`name`	string	供人阅读的名称（例如 `"Korean (South Korea)"`）。
`code`	string	语言代码（例如 `ko-KR`）。成为 Content、Media 查询的 `locale` 值。
`default`	boolean	是否为 Space 的默认 Locale。一个 Space 中仅有一个为 `true`。
`createdBy`	Refer<User>	创建者。
`createdAt`	string (date-time)	创建时间。
`updatedBy`	Refer<User>	最后修改的用户。
`updatedAt`	string (date-time)	最后修改时间。
`version`	integer	当前版本。每次修改时递增。

Locale 不是发布快照，而是 Space 的设置资源，因此 Content 的 sys 中所含的 revision、status、publish 不会出现在其中。

正文属性：

属性	类型	说明
`optional`	boolean	在填写必填（`required`）字段时，是否可以将此 Locale 留空。默认 Locale 通常为 `false`（必须填写）。
`fallbackCode`	string	当值为空时改为查找的 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 查询参数。

CDA 概览：CDA 整体与通用传递行为。
CDA Content：通过 locale 指定接收语言来传递 Content。
多语言（概念）：默认 Locale、fallback、必填规则。

资源结构

系统属性 (sys) 与正文

行为备注

API

查询 Locale 列表

相关文档