# generaltranslation: General Translation Core SDK: getLocaleProperties
URL: https://generaltranslation.com/ja/docs/core/functions/locales/get-locale-properties.mdx
---
title: getLocaleProperties
description: スタンドアロンの getLocaleProperties 関数の API リファレンス
---

## 概要

スタンドアロンの `getLocaleProperties` 関数は、GT クラスのインスタンスを作成しなくても、ロケールコードのプロパティを取得できます。
完全な `LocaleProperties` オブジェクトとして、表示名、リージョンコード、文字体系情報、絵文字フラグなどの詳細情報を返します。

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

const props = getLocaleProperties('fr-CA', 'en');
console.log(props.name); // "French (Canada)"
console.log(props.nativeName); // "français (Canada)"
console.log(props.emoji); // "🇨🇦"
console.log(props.regionCode); // "CA"
```

***


## リファレンス

### パラメーター

<TypeTable
  type={{
  "locale": {
    type: 'string',
    optional: false,
  },
  "defaultLocale?": {
    type: 'string',
    optional: true,
  },
  "customMapping?": {
    type: 'CustomMapping',
    optional: true,
  }
}}
/>

### パラメーターの説明

| パラメーター          | 説明                                            |
| --------------- | --------------------------------------------- |
| `locale`        | プロパティを取得する対象の BCP-47 ロケールコード                  |
| `defaultLocale` | 表示名をローカライズする際に使用するロケール (デフォルトは &#39;en&#39;)  |
| `customMapping` | ロケールコードとプロパティ用の任意のカスタムマッピング                   |

### 戻り値

`LocaleProperties` - すべてのロケール情報を含むオブジェクト:

* `code`: 標準化されたロケールコード
* `name`: デフォルトのロケールでの表示名
* `nativeName`: そのロケール自体での表示名
* `languageCode`, `languageName`, `nativeLanguageName`: 言語情報
* `regionCode`, `regionName`, `nativeRegionName`: リージョン情報
* `scriptCode`, `scriptName`, `nativeScriptName`: 文字体系情報
* `maximizedCode`, `minimizedCode`: 正規化された形式
* `nameWithRegionCode`, `nativeNameWithRegionCode`: 結合された表示形式
* `emoji`: 旗またはそれを表す絵文字

***

## 挙動

### カスタムマッピングの統合

* すべてのプロパティで、最初にカスタムマッピングを確認
* エイリアスの解決とプロパティのオーバーライドをサポート
* マッピングされていないコードは標準の Intl API にフォールバック
* エイリアス化されたロケールの正規化区域設定を決定

***

## 例

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

// 英語の表示名
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "Spanish (Mexico)"
console.log(enProps.languageName); // "Spanish"
console.log(enProps.regionName); // "Mexico"
console.log(enProps.emoji); // "🇲🇽"

// フランス語の表示名
const frProps = getLocaleProperties('es-MX', 'fr');
console.log(frProps.name); // "espagnol (Mexique)"
console.log(frProps.languageName); // "espagnol"
console.log(frProps.regionName); // "Mexique"

// ネイティブ名は常にターゲットロケールで表示される
console.log(enProps.nativeName); // "español (México)"
console.log(frProps.nativeName); // "español (México)"
```

***


## 注記

* GT クラスをインスタンス化せずにロケールデータを取得できます
* カスタムのマッピングプロパティは標準の Intl API より優先されます
* 常に完全な `LocaleProperties` インターフェースが返されます
* ネイティブ名は常に対象ロケール自体に基づいて算出されます

## 次のステップ

* [`LocaleProperties` interface](/docs/core/types/locale-properties)を確認する - インターフェース の完全なリファレンス
* GT クラスメソッド [`getLocaleProperties`](/docs/core/class/methods/locales/get-locale-properties)を使用する
* [`getLocaleName`](/docs/core/functions/locales/get-locale-name)でシンプルなロケール名を取得する
* [`getLocaleEmoji`](/docs/core/functions/locales/get-locale-emoji)でロケールの絵文字を取得する