Locale

Locale é a configuração de idioma que um Space oferece. Cada Locale tem um código de idioma (code, por exemplo ko-KR), a indicação de ser ou não o Locale padrão do Space (default), a indicação de ser ou não opcional no preenchimento de campos obrigatórios (optional) e o Locale a consultar quando não há valor (fallbackCode). A CDA (Content Delivery API) entrega esta lista apenas para leitura. Criar ou alterar um Locale é responsabilidade da CMA Locale.

Ao consultar um Content ou um Media, o valor do parâmetro de consulta locale é exatamente o code deste Locale. Para saber que códigos pode usar, leia primeiro com este endpoint a lista de Locale que o Space oferece e use o code que ela contém.

Estrutura do recurso

A seguir está a forma como a CDA entrega um Locale do Space de demonstração ("Korean (South Korea)"). Junto com sys (propriedades de sistema), tem optional, a propriedade de corpo do 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
}

Chaves principais:

• sys.code: o código de idioma deste Locale. Coloque este valor no parâmetro locale da consulta de Content e Media.
• sys.default: indica se este Locale é o Locale padrão do Space. Um Space tem um único Locale padrão, e só nesse Locale default é true.
• sys.name: o nome legível por pessoas (por exemplo "Korean (South Korea)"). No parâmetro de consulta usa-se o code, não este nome.
• optional: indica se este Locale pode ficar vazio ao preencher um campo obrigatório (required). Os dois Locale do exemplo acima têm ambos optional igual a false.
• fallbackCode: o code de outro Locale a consultar quando não há valor (opcional). Só aparece na resposta quando está definido. No exemplo acima não está definido, por isso a chave não aparece.

Propriedades de sistema (sys) e corpo

space, createdBy e updatedBy entram no formato Refer ({ "sys": { "id", "type": "Refer", "targetType" } }).

Como Locale não é um instantâneo de publicação, mas sim um recurso de configuração do Space, revision, status e publish que existem no sys de Content não são incluídos.

Propriedades de corpo:

Notas de comportamento

O Locale com default igual a true tem de ser obrigatoriamente preenchido ao criar um Content e, na consulta de Content e Media, indica-se locale com esse code para receber o valor nesse idioma. Quando fallbackCode está definido, se o Locale pedido não tiver valor, passa-se para o Locale apontado por fallbackCode para procurar o valor (se esse Locale também tiver fallbackCode, a cadeia continua). Um Locale sem fallbackCode fica null quando não há valor. As regras de Locale padrão, fallback e preenchimento obrigatório são tratadas em Multilíngue (conceito).

API

A URL base dos endpoints abaixo é https://cda.weegloo.com/v1 e é necessário um token Bearer que autentique na CDA no cabeçalho Authorization. Como a lista de Locale é a própria configuração de idioma, ao contrário da consulta de Content e Media, não aceita o parâmetro de consulta locale.

Documentos relacionados

• Visão geral da CDA: a CDA no seu todo e o comportamento comum de entrega.
• CDA Content: definir o idioma a receber com locale e obter Content.
• Multilíngue (conceito): regras de Locale padrão, fallback e preenchimento obrigatório.