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

## 概要

スタンドアロンの`getLocaleEmoji`関数を使うと、GTクラスのインスタンスがなくても、ロケールコードに対応する旗絵文字または記号を取得できます。
この関数は、ロケールの地域に基づいて、国や地域に適した旗絵文字を返し、カスタム絵文字マッピングにも対応しています。

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

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

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

***


## リファレンス

### パラメータ

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

### パラメータの説明

| パラメータ           | 説明                               |
| --------------- | -------------------------------- |
| `locale`        | 絵文字の取得対象となる BCP-47 ロケールコード       |
| `customMapping` | ロケールコードと絵文字の上書きに使用する任意のカスタムマッピング |

### 戻り値

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

* 地域を含むロケールでは、その国・地域の旗絵文字 (例: `🇺🇸`, `🇫🇷`, `🇯🇵`) 
* マッピングで定義されている場合はカスタム絵文字
* 認識されないロケールの場合はデフォルトの旗絵文字 (`🏳️`) 

***

## 例

### 絵文字の基本的な取得方法

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

// 一般的な国旗
console.log(getLocaleEmoji('en-US')); // "🇺🇸"
console.log(getLocaleEmoji('fr-FR')); // "🇫🇷"
console.log(getLocaleEmoji('de-DE')); // "🇩🇪"
console.log(getLocaleEmoji('ja-JP')); // "🇯🇵"
console.log(getLocaleEmoji('zh-CN')); // "🇨🇳"

// 複数の言語が使われる地域
console.log(getLocaleEmoji('en-CA')); // "🇨🇦"
console.log(getLocaleEmoji('fr-CA')); // "🇨🇦"
console.log(getLocaleEmoji('de-CH')); // "🇨🇭"
console.log(getLocaleEmoji('fr-CH')); // "🇨🇭"
```

***


## 注記

* Unicodeの地域指示記号を使用して国旗絵文字を返します
* カスタムマッピングの絵文字が地域ベースの選択より優先されます
* 幅広く対応するため、ISO 3166-1 alpha-2の地域コードをすべてサポートします

## 次のステップ

* GT クラスのメソッド [`getLocaleEmoji`](/docs/core/class/methods/locales/get-locale-emoji) を使用する
* [`getLocaleProperties`](/docs/core/functions/locales/get-locale-properties) でロケールのプロパティを取得する
* [`getLocaleName`](/docs/core/functions/locales/get-locale-name) でロケール名を取得する
* [`isValidLocale`](/docs/core/functions/locales/is-valid-locale) でロケールを検証する