# General Translation Platform: getRegionProperties
URL: https://generaltranslation.com/fr/docs/platform/core/reference/gt-class-methods/locales/get-region-properties.mdx
---

title: getRegionProperties
description: Renvoie les métadonnées d’une région pour un paramètre régional ou un code de région. Référence de l’API pour getRegionProperties.

---

Récupère les détails d’un code de région sur une instance de [GT](/docs/platform/core/reference/gt-class/constructor), notamment son nom localisé et l’émoji de drapeau associé. General Translation offre un moyen pratique d’obtenir des informations d’affichage propres à une région pour créer des interfaces utilisateur internationalisées.

## Vue d’ensemble [#overview]

Appelez `getRegionProperties` sur une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor) avec un code de région facultatif. S’il n’est pas indiqué, la méthode utilise la région du paramètre régional cible de l’instance.

```typescript
const gt = new GT({ sourceLocale: 'en-US', targetLocale: 'fr-FR' });

// Obtenir les propriétés de la région
const usProps = gt.getRegionProperties('US');
console.log(usProps);
// { code: 'US', name: 'États-Unis', emoji: '🇺🇸' }

const frProps = gt.getRegionProperties('FR');
console.log(frProps);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }

// Détection automatique à partir du paramètre régional actuel
const currentRegion = gt.getRegionProperties(); // Utilise la région du targetLocale
console.log(currentRegion);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }
```

Signature :

```typescript
getRegionProperties(
  region?: string,
  customMapping?: CustomRegionMapping
): { code: string; name: string; emoji: string }
```

*Remarque : `getRegionProperties` s’exécute localement à l’aide de `Intl.DisplayNames` et ne nécessite pas de clé API. Il utilise la région du `targetLocale` de l’instance lorsque `region` n’est pas renseigné, et localise le nom de la région dans le `targetLocale` de l’instance. Pour les recherches sans instance `GT`, consultez la version autonome de [`getRegionProperties`](/docs/platform/core/reference/utility-functions/locales/get-region-properties).*

## Fonctionnement [#how-it-works]

* **Codes de région.** Accepte les codes de région ISO 3166-1 alpha-2 ou UN M.49 (par exemple, `"US"`, `"FR"`, `"419"`).
* **Noms localisés.** Utilise `Intl.DisplayNames` pour localiser le nom de la région selon le `targetLocale` de l’instance, en utilisant le paramètre régional par défaut de la bibliothèque en secours.
* **Priorité du mappage personnalisé.** Si un `customMapping` fournit un `name` ou un `emoji` pour la région, ceux-ci remplacent les valeurs par défaut.
* **Contenus de secours.** Utilise le code de région comme `name` si la résolution du nom d’affichage échoue, et un émoji par défaut si aucun mappage d’émoji n’est trouvé.
* **Secours pour la région.** Lorsque `region` est omis, la région du paramètre régional cible de l’instance est utilisée.
* **Paramètre régional manquant.** Lève une `Error` si aucun paramètre régional cible n’est disponible pour déterminer les propriétés de la région.

## Paramètres [#parameters]

| Paramètre                          | Description                                                                           | Type                  | Facultatif | Par défaut                              |
| ---------------------------------- | ------------------------------------------------------------------------------------- | --------------------- | ---------- | --------------------------------------- |
| [`region`](#region)                | Code de région ISO 3166-1 alpha-2 ou code de région UN M.49.                          | `string`              | Oui        | `this.getLocaleProperties().regionCode` |
| [`customMapping`](#custom-mapping) | mappage personnalisé de région pour remplacer les noms et émojis par défaut. | `CustomRegionMapping` | Oui        | `this.customRegionMapping`              |

### `region` [#region]

**Type** `string` · **Facultatif** · **Par défaut** `this.getLocaleProperties().regionCode`

Code de région au format ISO 3166-1 alpha-2 ou UN M.49. S’il n’est pas fourni, la région du paramètre régional cible de l’instance est utilisée.

### `customMapping` [#custom-mapping]

**Type** `CustomRegionMapping` · **Facultatif** · **Par défaut** `this.customRegionMapping`

Mappage personnalisé facultatif des régions pour remplacer les noms et émojis de région par défaut.

## Renvoie [#returns]

**Type** `{ code: string; name: string; emoji: string }`

Un objet contenant :

* `code` : le code de région fourni en entrée.
* `name` : le nom de la région localisé (ou personnalisé) dans la langue du paramètre régional cible.
* `emoji` : le drapeau ou symbole émoji associé.

## Exemples [#examples]

```typescript
// Informations de base sur la région
const gt = new GT({ sourceLocale: 'en-US', targetLocale: 'en-US' });

// Codes de région courants
console.log(gt.getRegionProperties('US')); // { code: 'US', name: 'United States', emoji: '🇺🇸' }
console.log(gt.getRegionProperties('GB')); // { code: 'GB', name: 'United Kingdom', emoji: '🇬🇧' }
console.log(gt.getRegionProperties('DE')); // { code: 'DE', name: 'Germany', emoji: '🇩🇪' }
console.log(gt.getRegionProperties('JP')); // { code: 'JP', name: 'Japan', emoji: '🇯🇵' }
```

```typescript
// Le mappage personnalisé de région remplace les valeurs par défaut
const gt = new GT({ targetLocale: 'en-US' });

console.log(gt.getRegionProperties('US', { US: { name: 'USA', emoji: '🗽' } }));
// { code: 'US', name: 'USA', emoji: '🗽' }
```

## Remarques [#notes]

* Utilise l’API `Intl.DisplayNames` pour les noms de région localisés.
* Prend en charge les codes de région ISO 3166-1 alpha-2 et ONU M.49.
* Les mappages personnalisés remplacent les noms et émojis par défaut.
* Détecte automatiquement la région à partir du paramètre régional cible si aucun paramètre n’est fourni.
* Utilise le code de région comme nom si la résolution du nom d’affichage échoue.