# General Translation Platform: setConfig
URL: https://generaltranslation.com/ja/docs/platform/core/reference/gt-class/set-config.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: 既存の GT インスタンスの設定を更新します。setConfig の API リファレンス。

新しいインスタンスを作成せずに、作成済みの [GT](/docs/platform/core/reference/gt-class/constructor) インスタンスの API 認証情報、ロケール、その他の設定を変更します。

## 概要 [#overview]

インスタンスをインプレースで変更するには、`setConfig` を呼び出します。新しい値はコンストラクタに渡した設定にマージされ、以降のすべてのメソッド呼び出しに反映されます。

```typescript
const gt = new GT();

gt.setConfig({
  apiKey: 'your-new-api-key',
  projectId: 'your-project-id',
  sourceLocale: 'en',
  targetLocale: 'es',
});
```

シグネチャ:

```typescript
setConfig(params: GTConstructorParams): void
```

*注: `setConfig` は同期的に実行され、戻り値は `void` です。インスタンスはインプレースで更新されます。*

## 動作の仕組み [#how-it-works]

* **設定された識別子。** ロケールの表記はそのまま保持されます。`locales` を含め、指定されたすべてのロケールフィールドは、有効なカスタムマッピングに照らして検証されます。無効なコードを指定すると例外がスローされます。返されるロケールコードは[コンストラクタのルール](/docs/platform/core/reference/gt-class/constructor#how-it-works)に従います。
* **認証情報の変更。** 認証情報やプロジェクト設定を切り替えるには、このメソッドを使用してください。これらの変更をプロパティへの直接代入で行うことはサポートされていません。
* **設定のマージ。** 新しい値は、コンストラクタに渡した設定にマージされます。ただし、`customMapping` はマージされず、既存の マッピング を完全に置き換えます。
* **環境変数は再読み取りされません。** `setConfig` の呼び出し時に、環境変数 (`GT_API_KEY`、`GT_DEV_API_KEY`、`GT_PROJECT_ID`) が再読み取りされることはありません。
* **更新の失敗。** 更新に失敗した場合、一部の設定がすでに変更されている場合があります。

## パラメータ [#parameters]

`setConfig` は、[コンストラクタ](/docs/platform/core/reference/gt-class/constructor) と同じプロパティを持つ必須の [`GTConstructorParams`](/docs/platform/core/reference/types/gt-constructor-params) オブジェクトを受け取ります。

| パラメータ                              | 説明                                        | 型                                                                     | 任意 | デフォルト |
| ---------------------------------- | ----------------------------------------- | --------------------------------------------------------------------- | -- | ----- |
| [`apiKey`](#api-key)               | 翻訳サービス用のプロジェクト API キー。                    | `string`                                                              | はい | —     |
| [`devApiKey`](#dev-api-key)        | 代替のプロジェクト API キー。`apiKey` が未設定の場合に使用されます。 | `string`                                                              | はい | —     |
| [`projectId`](#project-id)         | 一意のプロジェクト ID。                             | `string`                                                              | はい | —     |
| [`sourceLocale`](#source-locale)   | 翻訳のデフォルトのソースロケール。                         | `string`                                                              | はい | —     |
| [`targetLocale`](#target-locale)   | 翻訳のデフォルトのターゲットロケール。                       | `string`                                                              | はい | —     |
| [`locales`](#locales)              | サポートされているロケールコード。                         | `string[]`                                                            | はい | —     |
| [`baseUrl`](#base-url)             | カスタムの API ベース URL。                        | `string`                                                              | はい | —     |
| [`customMapping`](#custom-mapping) | カスタムのロケールコードのマッピングとプロパティのオーバーライド。         | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | はい | —     |

`params` オブジェクト自体は必須ですが、含まれる各プロパティはすべて任意です。変更したい設定だけを渡してください。

### `apiKey` [#api-key]

**型** `string` · **任意**

翻訳サービスのプロジェクト API キー。

### `devApiKey` [#dev-api-key]

**型** `string` · **任意**

`apiKey` の互換性のための非推奨エイリアス。環境に関係なく、`apiKey` が未設定の場合に使用されます。

### `projectId` [#project-id]

**型** `string` · **任意**

一意のプロジェクト ID。

### `sourceLocale` [#source-locale]

**型** `string` · **任意**

翻訳のデフォルトのソースロケールです。表記は変更されずにそのまま保持され、エイリアス を含む有効な `customMapping` に基づいて検証されます。

### `targetLocale` [#target-locale]

**型** `string` · **任意**

翻訳のデフォルトのターゲットロケールです。表記は変更されずにそのまま保持され、エイリアス を含む実際に適用される `customMapping` を考慮して検証されます。

### `locales` [#locales]

**型** `string[]` · **任意**

サポートされているロケール識別子の配列です。各コードはそのまま保持され、有効な `customMapping` を使って検証されます。カスタムの エイリアス も使用できます。

### `baseUrl` [#base-url]

**Type** `string` · **任意**

カスタムの API ベース URL。

### `customMapping` [#custom-mapping]

**型** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **任意**

カスタムのロケールコードのマッピングとプロパティのオーバーライドを指定します。ほかの設定とは異なり、新しい `customMapping` は既存のマッピングにマージされず、完全に置き換えられます。

## 戻り値 [#returns]

**型** `void`

このメソッドはインスタンスの設定をインプレースで更新し、戻り値はありません。

## 例 [#examples]

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

// ターゲットロケールをスペイン語からフランス語に切り替える
gt.setConfig({
  targetLocale: 'fr',
});
```

## メモ [#notes]

* 設定の変更は、以降のメソッド呼び出しにただちに反映されます。
* 設定されたロケール識別子は、`locales` 内のエントリも含めてそのまま保持され、適用中のカスタムマッピングに基づいて検証されます。
* 空文字列や `undefined` を指定しても、認証情報はクリアされません。
* `setConfig` を呼び出しても、環境変数は再読み込みされません。
* カスタムマッピングは既存のマッピングを完全に置き換えます (マージはされません) 。
* 更新に失敗した場合でも、一部の設定はすでに変更されている可能性があります。
* このメソッドは同期的に動作し、`void` を返します。

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.