# node: initializeGT
URL: https://generaltranslation.com/ja/docs/node/api/initialize-gt.mdx
---
title: initializeGT
description: initializeGT セットアップ関数の API リファレンス
---

## 概要

`initializeGT` 関数は、Node.js runtime で General Translation を使用するための設定を行います。
翻訳関数を使用する前に、必ず一度呼び出す必要があります。

```js
import { initializeGT } from 'gt-node';

initializeGT({
  defaultLocale: 'en-US',
  locales: ['en-US', 'es', 'fr'],
  projectId: 'your-project-id',
});
```

<Callout type="warn">
  **必須のセットアップ:**
  `withGT`、`getGT`、`getMessages`、またはその他の翻訳関数を使用する前に、`initializeGT` を呼び出す必要があります。
  サーバーの初期化時に一度だけ呼び出してください (たとえば、エントリファイルの先頭) 。
</Callout>

## リファレンス

### パラメータ

<TypeTable
  type={{
"defaultLocale?": {
  type: 'string',
  optional: true,
  default: "'en-US'",
},
"locales?": {
  type: 'string[]',
  optional: true,
},
"projectId?": {
  type: 'string',
  optional: true,
},
"devApiKey?": {
  type: 'string',
  optional: true,
},
"cacheUrl?": {
  type: 'string | null',
  optional: true,
},
"runtimeUrl?": {
  type: 'string | null',
  optional: true,
},
"loadTranslations?": {
  type: 'TranslationsLoader',
  optional: true,
},
"customMapping?": {
  type: 'Record<string, string | Partial<LocaleProperties>>',
  optional: true,
},
"enableI18n?": {
  type: 'boolean',
  optional: true,
},
"cacheExpiryTime?": {
  type: 'number',
  optional: true,
},
}}
/>

### 説明

| Prop               | 説明                                                |
| ------------------ | ------------------------------------------------- |
| `defaultLocale`    | アプリケーションのデフォルトロケールです。既定値は `'en-US'` です。           |
| `locales`          | アプリケーションがサポートするロケールコードの配列です。                      |
| `projectId`        | クラウド翻訳サービスに必要な General Translation のプロジェクト ID です。 |
| `devApiKey`        | 開発環境でオンデマンド翻訳を行うための API キーです。                     |
| `cacheUrl`         | GT キャッシュサービスの URL です。無効にするには `null` を設定します。       |
| `runtimeUrl`       | GT runtime 翻訳サービスの URL です。無効にするには `null` を設定します。  |
| `loadTranslations` | 独自のデータソースから翻訳を読み込むためのカスタム関数です。                    |
| `customMapping`    | カスタムロケールコードを標準ロケールコードまたはロケールプロパティにマッピングします。       |
| `enableI18n`       | i18n 機能を有効にするかどうかです。                              |
| `cacheExpiryTime`  | キャッシュされた翻訳の有効期限が切れるまでの時間 (ミリ秒) です。                |

### 戻り値

`void`

***

## 例

### 基本セットアップ

```js title="server.js"
import { initializeGT } from 'gt-node';

initializeGT({
  defaultLocale: 'en-US',
  locales: ['en-US', 'es', 'fr', 'ja'],
  projectId: process.env.GT_PROJECT_ID,
});
```


### カスタム翻訳ローダーを使う場合

```js title="server.js"
import { initializeGT } from 'gt-node';

initializeGT({
  defaultLocale: 'en-US',
  locales: ['en-US', 'es'],
  loadTranslations: async (locale) => {
    const res = await fetch(`https://my-api.com/translations/${locale}`);
    return res.json();
  },
});
```

***


## 注意事項

* `initializeGT` は、翻訳関数を使用する前に **1回だけ** 呼び出す必要があります。
* GT のクラウドサービスを使用する場合は、`projectId` を指定してください。開発時は、`devApiKey` も指定してください。
* `loadTranslations` オプションを使うと、GT の CDN ではなく独自の翻訳ソースを利用できます。

## 次のステップ

* 各リクエストにロケール コンテキストを提供するには、[`withGT`](/docs/node/api/with-gt)を参照してください。
* 文字列を翻訳するには、[`getGT`](/docs/node/api/get-gt)と [`getMessages`](/docs/node/api/get-messages)を参照してください。