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

title: getRegionProperties
description: GT インスタンスなしでリージョンのメタデータを返します。getRegionProperties の API リファレンス。

---

[`getRegionProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) は、General Translation の Core ライブラリに含まれるスタンドアロンのユーティリティ関数で、ローカライズされた名前や代表的な emoji など、リージョンコードに関するメタデータを返します。

## 概要 [#overview]

`generaltranslation` から `getRegionProperties` を直接インポートし、リージョンコードと任意の表示ロケールを指定して呼び出します。API キーや [GT](/docs/platform/core/reference/gt-class/constructor) インスタンスは必要ありません。インスタンスベースの同等の機能を使う場合は、代わりに [`GT`](/docs/platform/core/reference/gt-class/constructor) インスタンスの [`getRegionProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) メソッドを使用してください。

```typescript
import { getRegionProperties } from 'generaltranslation';

console.log(getRegionProperties('US', 'en-US'));
// { code: 'US', name: 'United States', emoji: '🇺🇸' }
```

シグネチャ:

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

## 仕組み [#how-it-works]

* **ローカライズされた名前。** `Intl.DisplayNames` API を使って、`defaultLocale` 向けにローカライズされたリージョン名を生成します。
* **リージョンコード。** ISO 3166-1 alpha-2 と UN M.49 のリージョンコードに対応しています。
* **カスタムマッピング。** `CustomRegionMapping` で、デフォルトの名前と絵文字を上書きできます。
* **フォールバック。** 表示名を解決できない場合は、リージョンコードにフォールバックします。

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

| パラメーター                             | 説明                         | Type                  | 任意  | デフォルト |
| ---------------------------------- | -------------------------- | --------------------- | --- | ----- |
| [`region`](#region)                | プロパティを取得する対象のリージョンコード。     | `string`              | いいえ | —     |
| [`defaultLocale`](#default-locale) | リージョン名のローカライズに使用するロケール。    | `string`              | はい  | `en`  |
| [`customMapping`](#custom-mapping) | リージョンコード、名前、絵文字のカスタムマッピング。 | `CustomRegionMapping` | はい  | —     |

### `region` [#region]

**型** `string` · **必須**

プロパティを取得する対象のリージョンコード (ISO 3166-1 alpha-2 または UN M.49) 。

### `defaultLocale` [#default-locale]

**型** `string` · **任意** · **デフォルト** `en`

返されるリージョン名のローカライズに使用するロケール。

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

**型** `CustomRegionMapping` · **任意**

リージョンコード用の任意のカスタムマッピングです。デフォルトの名前や絵文字を上書きできます。

## 戻り値 [#returns]

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

リージョンコード、ローカライズされた名前、絵文字を含むリージョン情報オブジェクトです。

## 例 [#examples]

```typescript
import { getRegionProperties } from 'generaltranslation';

// 英語名でのリージョンプロパティ
console.log(getRegionProperties('US', 'en-US'));
// { code: 'US', name: 'United States', emoji: '🇺🇸' }

console.log(getRegionProperties('JP', 'en-US'));
// { code: 'JP', name: 'Japan', emoji: '🇯🇵' }

// ローカライズされた名前でのリージョンプロパティ
console.log(getRegionProperties('US', 'de-DE'));
// { code: 'US', name: 'Vereinigte Staaten', emoji: '🇺🇸' }
```

## メモ [#notes]

* ローカライズされたリージョン名には `Intl.DisplayNames` API を使用します。
* ISO 3166-1 alpha-2 および UN M.49 のリージョンコードに対応しています。
* カスタムマッピングでデフォルトの名前と絵文字を上書きできます。
* 表示名を解決できない場合は、リージョンコードにフォールバックします。
* ブラウザ API 以外の外部依存関係はありません。