# General Translation Platform: getLocaleName
URL: https://generaltranslation.com/ja/docs/platform/core/reference/utility-functions/locales/get-locale-name.mdx
---

title: getLocaleName
description: GT インスタンスなしで、わかりやすいロケール名を返します。getLocaleName の API リファレンス。

---

[`getLocaleName`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-name) は、General Translation のコアライブラリに含まれるスタンドアロンのユーティリティ関数で、ロケールコードの表示名を返します。有効な BCP-47 ロケールコードであれば、`Intl.DisplayNames` API を使用してそのローカライズされた名前を生成します。

## 概要 [#overview]

`generaltranslation` から `getLocaleName` を直接インポートし、ロケールコードと省略可能な表示用ロケールを渡して呼び出します。API Key や [GT](/docs/platform/core/reference/gt-class/constructor) インスタンスは必要ありません。インスタンスベースの同等の機能を使う場合は、代わりに [`GT`](/docs/platform/core/reference/gt-class/constructor) インスタンスの [`getLocaleName`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-name) メソッドを使用してください。

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

const name = getLocaleName('fr-CA', 'en');
console.log(name); // "Canadian French"（カナダフランス語）
```

シグネチャ:

```typescript
getLocaleName(
  locale: string,
  defaultLocale?: string,
  customMapping?: CustomMapping
): string
```

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

### 表示言語の決定

この関数は、次の優先順位で名前をローカライズします。

1. 指定されている場合は、`defaultLocale` パラメータ。
2. ライブラリのデフォルトロケールである `en`。

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

* ロケールコードと名称の両方で、まず カスタムマッピング が参照されます。
* エイリアスの解決とカスタムの表示名に対応しています。
* マッピングされていないコードについては、標準の `Intl.DisplayNames` が使われます。

### 名前の解決戦略

1. **カスタムマッピング 名** (最優先) 。
2. **`Intl.DisplayNames`** をデフォルトロケールで使用。
3. **`Intl.DisplayNames`** をライブラリのデフォルト (`en`) で使用。
4. **空の文字列** (フォールバック) 。

*注: display name には CLDR の dialect 形式が使われるため、`fr-CA` は「Canadian French」、`es-ES` は「European Spanish」に解決され、「French (Canada)」や「Spanish (Spain)」にはなりません。`es` のようなベース言語は、リージョンなしの「Spanish」に解決されます。*

## パラメータ [#parameters]

| パラメータ                              | 説明                          | 型                                                                     | 任意  | デフォルト |
| ---------------------------------- | --------------------------- | --------------------------------------------------------------------- | --- | ----- |
| [`locale`](#locale)                | 表示名を取得する対象の BCP-47 ロケールコード。 | `string`                                                              | いいえ | —     |
| [`defaultLocale`](#default-locale) | 表示名のローカライズに使用するロケール。        | `string`                                                              | はい  | `en`  |
| [`customMapping`](#custom-mapping) | ロケールコードと名前に対するカスタムマッピング。    | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | はい  | —     |

### `locale` [#locale]

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

表示名を取得する対象の BCP-47 ロケールコードです。

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

**Type** `string` · **省略可能** · **デフォルト** `en`

返される表示名のローカライズに使用するロケール。

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

**型** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **任意**

ロケールコードと名前に対する任意のカスタムマッピングです。

## 戻り値 [#returns]

**型** `string`

ロケールのローカライズ済みの表示名です。表示名を特定できない場合は、空の文字列を返します。

## 例 [#examples]

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

// 英語の表示名
console.log(getLocaleName('es', 'en')); // "Spanish"
console.log(getLocaleName('ja', 'en')); // "Japanese"
console.log(getLocaleName('zh', 'en')); // "Chinese"
console.log(getLocaleName('fr-CA', 'en')); // "Canadian French"
console.log(getLocaleName('es-ES', 'en')); // "European Spanish"
```

```typescript
import { getLocaleName, getLocaleEmoji } from 'generaltranslation';

// ピッカー用のロケールオプションを構築する
function buildLocaleOptions(
  supportedLocales: string[],
  displayLocale: string = 'en'
) {
  return supportedLocales.map((locale) => ({
    value: locale,
    label: getLocaleName(locale, displayLocale),
    emoji: getLocaleEmoji(locale),
  }));
}

const options = buildLocaleOptions(['en', 'es', 'fr', 'de', 'ja'], 'en');

console.log(options);
// [
//   { value: 'en', label: 'English', emoji: '🇺🇸' },
//   { value: 'es', label: 'Spanish', emoji: '🇪🇸' },
//   ...
// ]
```

## メモ [#notes]

* カスタムマッピングは、標準の `Intl.DisplayNames` より優先されます。
* 表示名を特定できない場合は、空の文字列を返します。
* `defaultLocale` パラメータは、返される表示名の言語を決定します。