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

## 概要

`getLocaleEmoji` メソッドは、ロケールコードの地域に基づいて、そのロケールに対応する旗の絵文字または記号を取得します。
国や地域には適切な旗の絵文字を返し、特定の地域がない言語にはフォールバックを適用できるほか、マッピングによるカスタム絵文字にも対応しています。

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

const emoji = gt.getLocaleEmoji('fr-CA');
console.log(emoji); // "🇨🇦" (カナダの国旗)

const usEmoji = gt.getLocaleEmoji('en-US');
console.log(usEmoji); // "🇺🇸" (アメリカの国旗)

const enEmoji = gt.getLocaleEmoji('en');
console.log(enEmoji); // "🇺🇸" (アメリカの国旗)
```

***


## リファレンス

### パラメータ

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

### パラメータの説明

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

### 戻り値

`string` - ロケールを表す旗の絵文字または記号:

* 地域を含むロケールでは、国/地域の旗の絵文字 (例: `🇺🇸`, `🇫🇷`, `🇯🇵`) 
* 地域を含まない一部の言語では、言語固有の絵文字
* 認識できないロケールでは、デフォルトの旗の絵文字 (`🏳️`)

### 例外

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

***

## 例

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

// ターゲットロケールの絵文字を取得
console.log(gt.getLocaleEmoji()); // "🇪🇸" (uses targetLocale 'es')

// 異なるロケールの絵文字を取得
console.log(gt.getLocaleEmoji('en-US')); // "🇺🇸"
console.log(gt.getLocaleEmoji('fr-FR')); // "🇫🇷"
console.log(gt.getLocaleEmoji('de-DE')); // "🇩🇪"
console.log(gt.getLocaleEmoji('ja-JP')); // "🇯🇵"
console.log(gt.getLocaleEmoji('zh-CN')); // "🇨🇳"
```

***


## 注記

* 利用可能な場合は、ロケールの地域コードに基づいて国旗の絵文字を返します
* カスタムの絵文字マッピングは、地域ベースの選択よりも優先されます
* 国旗の生成には、Unicode の地域指示記号を使用します
* 認識できない、または無効なロケールの場合は、デフォルトで `🏳️` (白旗) を使用します
* Unicode 絵文字をサポートする最新のブラウザーおよびオペレーティングシステムに対応しています

## 次のステップ

* [`getLocaleProperties`](/docs/core/class/methods/locales/get-locale-properties) でロケールのプロパティを取得する
* [`getLocaleName`](/docs/core/class/methods/locales/get-locale-name) でロケール名を取得する
* [`isValidLocale`](/docs/core/class/methods/locales/is-valid-locale) でロケールが有効かどうかを検証する
* [CustomMapping 型について学ぶ](/docs/core/types/custom-mapping)