API Keys
General Translation での APIキー の使い方
概要
General Translation では、2種類の API Keys が使用されます。
- 本番用 APIキー: 本番環境でコンテンツを翻訳する際に使用します。
- 開発用 APIキー: 開発環境でコンテンツを翻訳する際に使用します。
この2種類のキーは挙動が異なるため、利用中の環境に合わせて適切なキーを正しく使い分けてください。
GT_PROJECT_ID=your-project-id
GT_API_KEY=your-api-keygt-next または gt-react を単体の i18n ライブラリとして使用している場合は、APIキーを使う必要はありません。
取得方法
General Translation のウェブサイトで、プロジェクトのダッシュボードに移動します。
"API Keys" または "Developer Keys" タブをクリックします。
"Create API Key" ボタンをクリックします。
APIキーをコピーし、プロジェクトの .env ファイルに貼り付けます。
挙動
簡単に言うと、Prod API Keys は翻訳を保存しますが、Dev API Keys は保存しません。 翻訳のプロトタイピングには Dev API Keys を、デプロイの準備ができたら Prod API Keys を使用します。
開発用APIキー
この種類のキーは、テストや開発に便利です。 開発用APIキーを使用すると、翻訳はオンデマンドで実行され、メモリにキャッシュ(メモ化)されます。 翻訳は保存されません。
開発用APIキーは、ブラウザでレンダーされるコンポーネント(クライアントサイド)およびサーバーサイドでレンダーされるコンポーネントで、オンデマンド翻訳を行うために使用されます。 そのため、クライアントへエクスポートする必要があります。 このキーを本番環境で使用しては絶対にいけませんし、本番環境でクライアントに渡しても絶対にいけません。
# 開発用のVite .envファイルの例
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # 開発時のみ使用警告: 開発用のAPIキーは、開発時のクライアントサイド翻訳を行うためにクライアントへ渡されます。 これは開発環境では問題ありませんが、本番環境ではセキュリティ上のリスクになります。 アプリケーションがインターネットに公開されている場合は、開発用のAPIキーを絶対に使用しないでください。
本番用 APIキー
本番用の APIキーを使用すると、翻訳は永続化されます。 つまり、翻訳は実行時に利用できるよう(CDN またはアプリのバンドル内)に保存されます。
このキーは次の 2 か所で使用されます:
- gtx-cliツール。詳細はドキュメントを参照してください。
- 本番ビルドで、サーバーサイドで実行時翻訳を行う際の gt-nextライブラリ(サーバーサイド専用。gt-reactでは使用しません)。
APIキーはサーバーでのみ使用し、クライアントへエクスポートしてはなりません。
GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # このキーはクライアントに公開してはいけません注意事項
- 開発用のAPIキーはテストおよび開発目的で使用します。開発環境でのみ使用してください。
- 本番用のAPIキーは本番環境で使用します。
次のステップ
- 開発中にライブ翻訳を確認するには、<T>コンポーネントの使い方をご覧ください。
このガイドはどうでしたか?

