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

title: getRegionProperties
description: ロケールまたはリージョンコードのリージョンメタデータを返します。getRegionProperties の API リファレンス。

---

[GT](/docs/platform/core/reference/gt-class/constructor) インスタンス上のリージョンコードに関する詳細情報 (ローカライズされた名前や対応する emoji flag など) を取得します。General Translation では、国際化されたユーザーインターフェースの構築に必要なリージョン固有の表示情報を、手軽に取得できます。

## 概要 [#overview]

[`GT`](/docs/platform/core/reference/gt-class/constructor) インスタンスに対して、必要に応じてリージョンコードを指定して `getRegionProperties` を呼び出します。省略した場合は、そのインスタンスの対象ロケールのリージョンが使用されます。

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

// リージョンのプロパティを取得
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: '🇫🇷' }

// 現在のロケールから自動検出
const currentRegion = gt.getRegionProperties(); // targetLocale のリージョンを使用
console.log(currentRegion);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }
```

シグネチャ:

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

*注: `getRegionProperties` は `Intl.DisplayNames` を使ってローカルで実行されるため、API Key は不要です。`region` を省略した場合はインスタンスの `targetLocale` に含まれるリージョンを使用し、そのインスタンスの `targetLocale` に合わせてリージョン名をローカライズします。`GT` インスタンスを使わないルックアップについては、スタンドアロンの [`getRegionProperties`](/docs/platform/core/reference/utility-functions/locales/get-region-properties) を参照してください。*

## 動作の仕組み [#how-it-works]

* **リージョンコード。** ISO 3166-1 alpha-2 または UN M.49 のリージョンコード (例: `"US"`、`"FR"`、`"419"`) を受け付けます。
* **ローカライズされた名前。** `Intl.DisplayNames` を使用して、インスタンスの `targetLocale` 向けにリージョン名をローカライズします。利用できない場合は、library のデフォルトロケールにフォールバックします。
* **カスタムマッピングの優先順位。** `customMapping` でそのリージョンの `name` または `emoji` が指定されている場合は、そちらがデフォルトより優先されます。
* **フォールバック。** 表示名の解決に失敗した場合は `name` としてリージョンコードを使用し、`emoji` の mapping が見つからない場合はデフォルトの絵文字を使用します。
* **リージョンのフォールバック。** `region` が省略されている場合は、インスタンスの `targetLocale` のリージョンが使用されます。
* **ロケール不在時。** リージョンのプロパティを判定するための `targetLocale` が利用できない場合は、`Error` をスローします。

## パラメーター [#parameters]

| パラメーター                             | 説明                                        | 型                     | 任意 | デフォルト                                   |
| ---------------------------------- | ----------------------------------------- | --------------------- | -- | --------------------------------------- |
| [`region`](#region)                | ISO 3166-1 alpha-2 または UN M.49 のリージョンコード。 | `string`              | はい | `this.getLocaleProperties().regionCode` |
| [`customMapping`](#custom-mapping) | デフォルトの名前や絵文字を上書きするためのカスタム リージョンマッピング。     | `CustomRegionMapping` | はい | `this.customRegionMapping`              |

### `region` [#region]

**型** `string` · **任意** · **デフォルト** `this.getLocaleProperties().regionCode`

ISO 3166-1 alpha-2 または UN M.49 のリージョンコードです。指定しない場合は、インスタンスの対象ロケールに設定されたリージョンが使用されます。

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

**型** `CustomRegionMapping` · **任意** · **デフォルト** `this.customRegionMapping`

デフォルトのリージョン名と絵文字を上書きするための、カスタムのリージョンマッピングです。

## 戻り値 [#returns]

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

以下を含むオブジェクトです。

* `code`: 入力されたリージョンコード。
* `name`: 対象ロケールの言語で表示される、ローカライズ済み (またはカスタム) のリージョン名。
* `emoji`: 対応する国旗の絵文字または記号。

## 例 [#examples]

```typescript
// 基本的なリージョン情報
const gt = new GT({ sourceLocale: 'en-US', targetLocale: 'en-US' });

// 一般的なリージョンコード
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
// カスタムのリージョンマッピングはデフォルトを上書きする
const gt = new GT({ targetLocale: 'en-US' });

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

## メモ [#notes]

* ローカライズされたリージョン名には `Intl.DisplayNames` API を使用します。
* ISO 3166-1 alpha-2 と UN M.49 の両方のリージョンコードに対応しています。
* カスタムマッピングは、デフォルトの名前と絵文字を上書きします。
* パラメータが指定されていない場合は、対象ロケールからリージョンを自動的に検出します。
* 表示名を解決できない場合は、リージョンコードを名前として使用します。