Locale

Dernière mise à jour : 22 juin 2026

La Locale est la configuration de langue prise en charge par un Space. Chaque Locale possède un code de langue (code, par exemple ko-KR), un indicateur précisant s'il s'agit de la Locale par défaut du Space (default), un indicateur précisant si elle est facultative lors du remplissage des champs obligatoires (optional), et la Locale à consulter à la place lorsqu'une valeur est absente (fallbackCode). La CDA (Content Delivery API) délivre cette liste en lecture seule. La création ou la modification d'une Locale relève de CMA Locale.

Lorsque vous interrogez un Content ou un Media, la valeur du paramètre de requête locale que vous transmettez correspond précisément au code de cette Locale. Pour savoir quels codes vous pouvez fournir, lisez d'abord la liste des Locale prises en charge par le Space via cet endpoint, puis utilisez le code qui y figure.

Structure de la ressource

Voici la forme sous laquelle la CDA délivre une Locale du Space de démonstration (« Korean (South Korea) »). Outre sys (propriétés système), elle possède optional, la propriété de contenu de la 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
}

Clés principales :

  • sys.code : le code de langue de cette Locale. C'est cette valeur que vous placez dans le paramètre locale lors de l'interrogation d'un Content ou d'un Media.
  • sys.default : indique si cette Locale est la Locale par défaut du Space. Un Space possède une seule Locale par défaut, et default vaut true uniquement pour cette Locale.
  • sys.name : le nom lisible par un humain (par exemple "Korean (South Korea)"). Dans les paramètres d'interrogation, vous utilisez le code et non ce nom.
  • optional : indique si cette Locale peut être laissée vide lors du remplissage des champs obligatoires (required). Dans l'exemple ci-dessus, les deux Locale ont toutes deux optional à false.
  • fallbackCode : le code d'une autre Locale à consulter à la place lorsqu'une valeur est absente (facultatif). Il n'apparaît dans la réponse que s'il est défini. Il n'est pas défini dans l'exemple ci-dessus, c'est pourquoi la clé n'apparaît pas.

Propriétés système (sys) et contenu

space, createdBy et updatedBy se présentent sous la forme Refer ({ "sys": { "id", "type": "Refer", "targetType" } }).

PropriétéTypeDescription
idstringIdentifiant unique de la ressource.
typestringType de ressource. Pour une Locale, toujours "Locale".
spaceRefer<Space>Le Space auquel appartient cette Locale.
namestringNom lisible par un humain (par exemple "Korean (South Korea)").
codestringCode de langue (par exemple ko-KR). Devient la valeur locale lors de l'interrogation d'un Content ou d'un Media.
defaultbooleanIndique si c'est la Locale par défaut du Space. Un seul true par Space.
createdByRefer<User>Utilisateur qui a créé la ressource.
createdAtstring (date-time)Date et heure de création.
updatedByRefer<User>Dernier utilisateur ayant modifié la ressource.
updatedAtstring (date-time)Date et heure de la dernière modification.
versionintegerVersion actuelle. Incrémentée à chaque modification.

Comme la Locale n'est pas un instantané de publication mais une ressource de configuration du Space, les revision, status et publish présents dans le sys d'un Content n'y figurent pas.

Propriétés de contenu :

PropriétéTypeDescription
optionalbooleanIndique si cette Locale peut être laissée vide lors du remplissage des champs obligatoires (required). La Locale par défaut est généralement à false (remplissage obligatoire).
fallbackCodestringLe code de la Locale à consulter à la place lorsqu'une valeur est absente (facultatif, chaînable). S'il n'est pas défini, la clé elle-même est absente de la réponse.

Notes de comportement

Une Locale dont default vaut true doit obligatoirement être remplie lors de la création d'un Content, et lors de l'interrogation d'un Content ou d'un Media, vous spécifiez locale avec son code pour recevoir les valeurs dans cette langue. Si fallbackCode est défini, lorsqu'une valeur est absente pour la Locale demandée, le système passe à la Locale désignée par fallbackCode pour y chercher la valeur (si cette Locale possède elle aussi un fallbackCode, la chaîne se poursuit). Une Locale sans fallbackCode renvoie directement null lorsqu'une valeur est absente. Les règles concernant la Locale par défaut, le fallback et le remplissage obligatoire sont traitées dans Multilingue (concept).

API

L'URL de base des endpoints ci-dessous est https://cda.weegloo.com/v1, et l'en-tête Authorization doit contenir un Bearer token qui authentifie auprès de la CDA. Comme la liste des Locale constitue la configuration de langue elle-même, elle n'accepte pas le paramètre de requête locale, contrairement à l'interrogation d'un Content ou d'un Media.

  • Aperçu de la CDA : la CDA dans son ensemble et le comportement de delivery commun.
  • CDA Content : recevoir un Content en choisissant la langue à recevoir via locale.
  • Multilingue (concept) : règles concernant la Locale par défaut, le fallback et le remplissage obligatoire.