# generaltranslation: General Translation Core SDK: getRegionProperties
URL: https://generaltranslation.com/zh/docs/core/class/methods/locales/get-region-properties.mdx
---
title: getRegionProperties
description: GT getRegionProperties 方法的 API 参考文档
---

## 概述

`getRegionProperties` 方法用于获取某个区域代码的详细信息，包括其本地化名称及对应的旗帜表情符号。
它可便捷地获取区域相关的显示信息，便于构建国际化用户界面。

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

// 获取区域属性
const usProps = gt.getRegionProperties('US');
console.log(usProps);
// { code: 'US', name: 'United States', emoji: '🇺🇸' }

const frProps = gt.getRegionProperties('FR');
console.log(frProps);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }

// 从当前区域设置自动检测
const currentRegion = gt.getRegionProperties(); // 使用 targetLocale 的区域
console.log(currentRegion);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }
```

***


## 参考

### 参数

<TypeTable
  type={{
  "region?": {
    type: 'string',
    optional: true,
    default: 'this.getLocaleProperties().regionCode'
  },
  "customMapping?": {
    type: 'CustomRegionMapping',
    optional: true,
    default: 'this.customRegionMapping'
  }
}}
/>

### 参数说明

| 参数              | 说明                                                        |
| --------------- | --------------------------------------------------------- |
| `region`        | ISO 3166-1 alpha-2 或 UN M.49 区域代码。若未提供，则使用该实例目标区域设置中的区域代码 |
| `customMapping` | 可选的自定义区域映射，用于覆盖默认的区域名称和表情符号                               |

### 返回值

`{ code: string; name: string; emoji: string }` - 返回一个包含以下内容的对象：

* `code`：输入的区域代码
* `name`：目标区域设置语言中的本地化区域名称
* `emoji`：对应的 emoji 旗帜或符号

***

## 示例

### 区域基本信息

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

// 常见区域代码
console.log(gt.getRegionProperties('US')); // { code: 'US', name: 'United States', emoji: '🇺🇸' }
console.log(gt.getRegionProperties('GB')); // { code: 'GB', name: 'United Kingdom', emoji: '🇬🇧' }
console.log(gt.getRegionProperties('DE')); // { code: 'DE', name: 'Germany', emoji: '🇩🇪' }
console.log(gt.getRegionProperties('JP')); // { code: 'JP', name: 'Japan', emoji: '🇯🇵' }
```

***


## 说明

* 使用 `Intl.DisplayNames` API 获取本地化的区域名称
* 同时支持 ISO 3166-1 alpha-2 和 UN M.49 区域代码
* 自定义映射会覆盖默认名称和表情符号
* 如果未提供参数，会自动从目标区域设置中检测区域
* 如果显示名称解析失败，会回退为使用区域代码作为名称

## 后续步骤

* 使用 [`getLocaleProperties`](/docs/core/class/methods/locales/get-locale-properties) 获取完整的区域设置属性
* 使用 [`getLocaleEmoji`](/docs/core/class/methods/locales/get-locale-emoji) 获取区域设置对应的表情符号