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

## 概要

`getLocaleName` メソッドは、`Intl.DisplayNames` API を使用してロケールコードの表示名を取得します。
有効な BCP-47 ロケールコードであれば、そのインスタンスのソースロケールに応じてローカライズされた、人が読んで理解しやすい名称を返します。

```typescript
const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'es'
});

const name = gt.getLocaleName('fr-CA');
console.log(name); // "French (Canada)"
```

***


## リファレンス

### パラメータ

<TypeTable
  type={{
  "locale?": {
    type: 'string',
    optional: true,
    default: 'this.targetLocale',
  }
}}
/>

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

| パラメーター   | 説明                                                                   |
| -------- | -------------------------------------------------------------------- |
| `locale` | 表示名を取得する対象の BCP-47 ロケールコードです。指定しない場合は、インスタンスの `targetLocale` が使用されます |

### 戻り値

`string` - ローカライズされたロケールの表示名。

### 例外

* `Error` - ロケールが指定されておらず、インスタンスに `targetLocale` も設定されていない場合

***

## 挙動

### 表示言語

表示名は、以下に基づいてローカライズされます：

1. インスタンスの `sourceLocale` (設定されている場合) 
2. ライブラリのデフォルトロケール (&#39;en&#39;)

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

* まずカスタムロケールマッピングが確認されます
* カスタム名が定義されている場合は、そちらが優先されます
* 標準の BCP-47 コードについては、`Intl.DisplayNames` がフォールバックとして使用されます

***

## 例

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

// ターゲットロケールの名前を取得
console.log(gt.getLocaleName()); // "French (France)"

// 他のロケールの名前を取得
console.log(gt.getLocaleName('es')); // "Spanish (Spain)"
console.log(gt.getLocaleName('de')); // "German (Germany)"
console.log(gt.getLocaleName('ja')); // "Japanese (Japan)"
```

***


## 注記

* このメソッドは、表示言語の判定にインスタンスの `sourceLocale` を使用します
* カスタムマッピング名は、標準の `Intl.DisplayNames` より優先されます

## 次のステップ

* [`getLocaleEmoji`](/docs/core/class/methods/locales/get-locale-emoji) でロケールの絵文字を取得
* [`getLocaleProperties`](/docs/core/class/methods/locales/get-locale-properties) でロケールの詳細情報を取得
* [CustomMapping 型について学ぶ](/docs/core/types/custom-mapping)