# General Translation Platform: クイックスタート
URL: https://generaltranslation.com/ja/docs/platform/core/quickstart.mdx
---

title: クイックスタート
description: '`generaltranslation` Core ライブラリの機能、どのような場合に使うべきか、そして最初の文字列を翻訳する方法を学びます。'
related:
  links:
    - /docs/platform/core/guides/translating-strings
    - /docs/platform/core/guides/translating-files
    - /docs/platform/core/guides/locale-codes

---

`generaltranslation` ライブラリは、翻訳、書式設定、ロケールユーティリティを提供する General Translation の中核となる i18n ライブラリです。

ほとんどのフレームワークアプリでは、まず [gt-react または gt-next](/docs/react/overview) から始めるのがおすすめです。より低レベルな制御が必要な場合や、カスタムワークフローを構築したい場合、あるいはフレームワーク統合なしで翻訳ユーティリティを使いたい場合は、`generaltranslation` を直接使用してください。

## `generaltranslation` でできること [#what-it-does]

`generaltranslation` を使うと、次の機能を直接利用できます。

* **String translation**：コード内の strings や構造化コンテンツを翻訳できます。
* **ファイル翻訳**：ソースファイルをアップロードし、翻訳ジョブをキューに追加して、ステータスを確認し、翻訳済みの出力をダウンロードできます。
* **ロケールユーティリティ**：ロケールコードの検証、比較、解決、表示を行えます。
* **書式設定ユーティリティ**：ロケールに応じた数値、日付、メッセージ、リスト、相対時間を扱えます。

## `generaltranslation` を使用するタイミング [#when-to-use]

次のような場合は `generaltranslation` を使用してください。

* スクリプト、バックエンドサービス、ワーカー、またはカスタムのビルドステップからコンテンツを翻訳する場合。
* CLI を使わずに翻訳ファイルをアップロードおよびダウンロードする場合。
* プロジェクトファイル、ジョブ、ブランチ、またはタグを基盤に独自の翻訳自動化を構築する場合。
* React や Next.js の外部で、数値、日付、メッセージ、またはロケール名を整形する場合。
* 同じフロントエンドフレームワークを使わないパッケージ間で GT の挙動を共有する場合。

## クイックスタート [#quickstart]

`generaltranslation` をインストールし、プロジェクトIDとAPI キーを使って [GT](/docs/platform/core/reference/gt-class/constructor) インスタンスを作成し、最初の文字列を翻訳しましょう。

### 1. `generaltranslation` をインストールします

<Tabs items={['npm', 'yarn', 'bun', 'pnpm']}>
  <Tab value="npm">
    ```bash
    npm install generaltranslation
    ```
  </Tab>

  <Tab value="yarn">
    ```bash
    yarn add generaltranslation
    ```
  </Tab>

  <Tab value="bun">
    ```bash
    bun add generaltranslation
    ```
  </Tab>

  <Tab value="pnpm">
    ```bash
    pnpm add generaltranslation
    ```
  </Tab>
</Tabs>

### 2. API キーを取得する

ダッシュボードで `GT_PROJECT_ID` と `GT_API_KEY` を作成します。[API キーのページ](https://dash.generaltranslation.com/api-keys)を開き、**Create API Key** をクリックし、名前を入力して確定します。

```bash
GT_PROJECT_ID=your-project-id
GT_API_KEY=your-api-key
```

General Translation では、個人用プロジェクト、個人開発者、コミュニティ向けに、無料で利用できる余裕のあるレート制限を設けています。

### 3. GT クラス を初期化する

[GT](/docs/platform/core/reference/gt-class/constructor) クラスを初期化し、`GT_PROJECT_ID` と `GT_API_KEY` を安全に設定します。

```typescript title="src/index.ts"
import { GT } from 'generaltranslation';

const gt = new GT({
  projectId: 'your-project-id',
  apiKey: 'your-api-key',
});
```

[GT](/docs/platform/core/reference/gt-class/constructor) インスタンスでデフォルトロケールを設定できます。ほとんどの呼び出しで同じソースロケールまたはターゲットロケールを使う場合は、デフォルトロケールを使用してください。

```typescript title="src/index.ts"
const gt = new GT({
  projectId: 'your-project-id',
  apiKey: 'your-api-key',
  sourceLocale: 'en',
  targetLocale: 'es',
});
```

[GT クラス](/docs/platform/core/reference/gt-class/constructor)で、コンストラクタのすべてのオプションを確認できます。

### 4. 最初の文字列を翻訳する

[translate](/docs/platform/core/reference/gt-class-methods/translation/translate) メソッドを呼び出して、最初の文字列を翻訳します。翻訳したい文字列と対象ロケールを渡します。

```typescript title="src/index.ts"
const result = await gt.translate('Hello, world!', 'es');

if (result.success) {
  console.log(result.translation); // "¡Hola, mundo!"（スペイン語で「こんにちは、世界！」）
} else {
  console.error(`Translation failed: ${result.error}`);
}
```

翻訳メソッドの利用には、API キーとプロジェクトIDが必要です。書式設定とロケールユーティリティは、translation API へのアクセスがなくても使用できます。
## Next steps

- /docs/platform/core/guides/translating-strings
- /docs/platform/core/guides/translating-files
- /docs/platform/core/guides/locale-codes