# generaltranslation: General Translation Core SDK: getRegionProperties
URL: https://generaltranslation.com/ja/docs/core/class/methods/locales/get-region-properties.mdx
---
title: getRegionProperties
description: GTのgetRegionPropertiesメソッドのAPIリファレンス
---

## 概要

`getRegionProperties` メソッドは、ローカライズされた名称や対応する絵文字フラグなど、地域コードに関する詳細情報を取得します。
国際化されたユーザーインターフェースを構築する際に、地域ごとの表示情報を手軽に取得できる便利なメソッドです。

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

// 地域プロパティを取得
const usProps = gt.getRegionProperties('US');
console.log(usProps);
// { code: 'US', name: 'United States', 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: '🇫🇷' }
```

***


## リファレンス

### パラメータ

<TypeTable
  type={{
  "region?": {
    type: 'string',
    optional: true,
    default: 'this.getLocaleProperties().regionCode'
  },
  "customMapping?": {
    type: 'CustomRegionMapping',
    optional: true,
    default: 'this.customRegionMapping'
  }
}}
/>

### パラメータの説明

| パラメータ           | 説明                                                                     |
| --------------- | ---------------------------------------------------------------------- |
| `region`        | ISO 3166-1 alpha-2 または UN M.49 の地域コード。指定しない場合は、インスタンスの対象ロケールの地域が使用されます |
| `customMapping` | 既定の地域名と絵文字を上書きするための任意のカスタム地域マッピング                                      |

### 戻り値

`{ code: string; name: string; emoji: string }` - 以下を含むオブジェクト:

* `code`: 入力された地域コード
* `name`: 対象ロケールの言語で表示された地域名
* `emoji`: 対応する絵文字の旗または記号

***

## 例

### 地域の基本情報

```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: '🇯🇵' }
```

***


## 注意事項

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

## 次のステップ

* [`getLocaleProperties`](/docs/core/class/methods/locales/get-locale-properties) でロケールの詳細なプロパティを取得する
* [`getLocaleEmoji`](/docs/core/class/methods/locales/get-locale-emoji) でロケールの絵文字を取得する