Locale
Última actualización: 22 de junio de 2026
Locale es la configuración de idiomas que admite un Space. Cada Locale tiene un código de idioma (code, por ejemplo ko-KR), si es el Locale predeterminado del Space (default), si es opcional al rellenar campos obligatorios (optional) y el Locale que se consulta en su lugar cuando no hay valor (fallbackCode). La CDA (Content Delivery API) entrega esta lista en modo de solo lectura. Crear o modificar un Locale corresponde a CMA Locale.
Al consultar un Content o un Media, el valor del parámetro de consulta locale que se pasa es precisamente el code de este Locale. Para saber qué código se puede indicar, primero se lee la lista de Locale que admite el Space mediante este endpoint y se usa el code que contiene.
Estructura del recurso
A continuación se muestra cómo la CDA entrega un Locale del Space de demostración ("Korean (South Korea)"). Junto con sys (propiedades de sistema), tiene optional, que es la propiedad de cuerpo del Locale.
{
"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
}Claves principales:
sys.code: el código de idioma de este Locale. Este valor se indica en el parámetrolocalede las consultas de Content y Media.sys.default: si este Locale es el Locale predeterminado del Space. Un Space tiene un único Locale predeterminado, y solo en ese Localedefaultestrue.sys.name: el nombre legible por personas (por ejemplo,"Korean (South Korea)"). En los parámetros de consulta se usa elcode, no este nombre.optional: si este Locale se puede dejar vacío al rellenar campos obligatorios (required). Los dos Locale del ejemplo anterior tienen ambosoptionalenfalse.fallbackCode: elcodede otro Locale que se consulta en su lugar cuando no hay valor (opcional). Solo aparece en la respuesta cuando se ha configurado. En el ejemplo anterior no está configurado, por lo que la clave no se muestra.
Propiedades de sistema (sys) y cuerpo
space, createdBy y updatedBy se incluyen con forma Refer ({ "sys": { "id", "type": "Refer", "targetType" } }).
| Propiedad | Tipo | Descripción |
|---|---|---|
id | string | Identificador único del recurso. |
type | string | Tipo de recurso. Para Locale siempre es "Locale". |
space | Refer<Space> | El Space al que pertenece este Locale. |
name | string | Nombre legible por personas (por ejemplo, "Korean (South Korea)"). |
code | string | Código de idioma (por ejemplo, ko-KR). Es el valor locale de las consultas de Content y Media. |
default | boolean | Si es el Locale predeterminado del Space. Solo uno es true en el Space. |
createdBy | Refer<User> | Usuario que lo creó. |
createdAt | string (date-time) | Momento de creación. |
updatedBy | Refer<User> | Usuario que lo modificó por última vez. |
updatedAt | string (date-time) | Momento de la última modificación. |
version | integer | Versión actual. Aumenta cada vez que se modifica. |
Como Locale no es una instantánea de publicación sino un recurso de configuración del Space, no incluye revision, status ni publish, que sí están en el sys de Content.
Propiedades de cuerpo:
| Propiedad | Tipo | Descripción |
|---|---|---|
optional | boolean | Si este Locale se puede dejar vacío al rellenar campos obligatorios (required). El Locale predeterminado suele ser false (debe rellenarse). |
fallbackCode | string | El code del Locale que se consulta en su lugar cuando no hay valor (opcional, encadenable). Si no se configura, la clave en sí no aparece en la respuesta. |
Notas de comportamiento
Un Locale con default en true debe rellenarse obligatoriamente al crear un Content, y en las consultas de Content y Media se indica locale con su code para recibir los valores de ese idioma. Si fallbackCode está configurado, cuando el Locale solicitado no tiene valor se pasa al Locale al que apunta fallbackCode para buscar el valor (si ese Locale también tiene fallbackCode, la cadena continúa). Un Locale sin fallbackCode queda como null cuando no hay valor. Las reglas sobre el Locale predeterminado, el fallback y el relleno obligatorio se tratan en Multilingüe (concepto).
API
La URL base de los siguientes endpoints es https://cda.weegloo.com/v1, y se requiere un token Bearer que autentique la CDA en la cabecera Authorization. Como la lista de Locale es la propia configuración de idiomas, a diferencia de las consultas de Content y Media, no acepta el parámetro de consulta locale.
Documentos relacionados
- Introducción a la CDA: la CDA completa y el comportamiento común de entrega.
- CDA Content: recibir Content eligiendo el idioma de entrega con locale.
- Multilingüe (concepto): reglas sobre el Locale predeterminado, el fallback y el relleno obligatorio.
