Cloud API とライブラリの管理

Cloud API を使用すると、Google Cloud Platform のプロダクトとサービスにコードからアクセスできます。Cloud API では、クライアント ライブラリ経由で呼び出し可能な単純な JSON REST インターフェースを公開します。

このドキュメントでは、Cloud API を有効にし、サービス アカウントと環境変数を管理して API にローカルでアクセスすることで、Maven プロジェクトに Java 用 Cloud クライアント ライブラリを追加する方法を説明します。

注: Maven 以外のプロジェクトの場合、Cloud クライアント ライブラリはビルドに追加されませんが、ここで説明されている他の機能はサポートされます。

注: 以下の IDE でこの機能がサポートされます。

• IntelliJ IDEA - Ultimate
• IntelliJ IDEA - Community
• その他の IntelliJ Platform ベースの IDE

注: App Engine スタンダード環境のアプリケーションでは、Java 7 はサポートされません。GitHub のサポート対象プラットフォームのページをご覧ください。

準備

クイックスタートの説明に従って、IntelliJ IDEA のインストールとセットアップを行います。

Cloud クライアント ライブラリの追加

IntelliJ でプロジェクトにライブラリを追加するには:

Maven プロジェクトの場合

1. [Tools] > [Cloud Code] > [Add Cloud libraries and Manage Cloud APIs] を選択します。

[Add Google Cloud Libraries] ダイアログが開き、サポートされるライブラリが表示されます。


2. [GCP Project:] フィールドで、正しいプロジェクトとアカウントが表示されていることを確認します。表示されていない場合には、省略記号をクリックして、正しいプロジェクトとアカウントを選択します。
3. [Add Google Client Library to Module] プルダウン メニューで、ライブラリを追加するモジュールを選択します。
4. [Google Cloud Java] プルダウン メニューで、使用する Google Cloud Java BOM のバージョンを選択します。

[Google Cloud Java] での選択に応じて、ライブラリ間のバージョンの競合を解決するために、Google Cloud Java BOM（部品表）がプロジェクトの pom.xml ファイルに追加されます。

5. 追加するライブラリのチェックボックスをオンにします。
API の中には、事前に Google Cloud Platform 上で有効化することが必要なものがあります。このような API の場合、チェックボックスをオンにすると、[Enable the API on the Google Cloud Platform] が自動的に選択されます。
6. [続行] をクリックします。

[Enable GCP APIs and Manage Service Accounts Confirmation] ダイアログが表示されます。


7. [Service account name] フィールドで、デフォルトの名前をそのまま使用するか、新しい名前を入力します。
8. [Download path] フィールドで、サービス アカウント キーをダウンロードする場所に移動します。
このキーは安全な場所に保管し、ソース管理にはチェックインしないでください。
9. API での必要に応じて、サービス アカウントに追加する役割を選択します。
10. [OK] をクリックします。


IntelliJ により、次の更新が行われます。

• 選択された依存関係を pom.xml に追加します。
• Google Cloud Platform で、選択された API を有効にします。
• サービス アカウントを作成し、そのキーを指定された場所にダウンロードします。
11. ローカルで Google Cloud API にアクセスするには、GOOGLE_APPLICATION_CREDENTIALS 環境変数と GOOGLE_CLOUD_PROJECT 環境変数を、ローカルの開発用サーバーやローカルの実行構成で次のように設定します。
1. コピーアイコンをクリックして変数をクリップボードにコピーします。
2. 実行構成を編集します。
3. 環境変数セクションで、貼り付けアイコンをクリックします。

ローカル アプリケーション サーバーの場合、このセクションは [Startup/Connection] タブに表示されます。

4. 環境変数は自動的に挿入されます。
App Engine スタンダードを使用していて、ローカルの実行構成がある場合は、その実行構成が確認ダイアログに表示されます。これらの環境変数を追加する構成を選択し、[Add Variables] をクリックします

Maven プロジェクト以外の場合

1. [Tools] > [Cloud Code] > [Manage Cloud APIs] を選択します。

[Manage Google Cloud APIs] ダイアログにが開き、サポートされるライブラリが表示されます。


2. [GCP Project:] フィールドで、正しいプロジェクトとアカウントが表示されていることを確認します。表示されていない場合には、省略記号をクリックして、正しいプロジェクトとアカウントを選択します。
3. 追加するライブラリのチェックボックスをオンにします。
API の中には、事前に Google Cloud Platform 上で有効化することが必要なものがあります。このような API の場合、チェックボックスをオンにすると、[Enable the API on the Google Cloud Platform] が自動的に選択されます。
4. [続行] をクリックします。

[Enable GCP APIs and Manage Service Accounts Confirmation] ダイアログが表示されます。


5. [Service account name] フィールドで、デフォルトの名前をそのまま使用するか、新しい名前を入力します。
6. [Download path] フィールドで、サービス アカウント キーをダウンロードする場所に移動します。
このキーは安全な場所に保管し、ソース管理にはチェックインしないでください。
7. API での必要に応じて、サービス アカウントに追加する役割を選択します。
8. [OK] をクリックします。


IntelliJ により、次の更新が行われます。

• Google Cloud Platform で、選択された API を有効にします。
• サービス アカウントを作成し、そのキーを指定された場所にダウンロードします。
9. ローカルで Google Cloud API にアクセスするには、GOOGLE_APPLICATION_CREDENTIALS 環境変数と GOOGLE_CLOUD_PROJECT 環境変数を、ローカルの開発用サーバーやローカルの実行構成で次のように設定します。
1. コピーアイコンをクリックして変数をクリップボードにコピーします。
2. 実行構成を編集します。
3. 環境変数セクションで、貼り付けアイコンをクリックします。

ローカル アプリケーション サーバーの場合、このセクションは [Startup/Connection] タブに表示されます。

4. 環境変数は自動的に挿入されます。
App Engine スタンダードを使用していて、ローカルの実行構成がある場合は、その実行構成が確認ダイアログに表示されます。これらの環境変数を追加する構成を選択し、[Add Variables] をクリックします。

サポートの利用

フィードバックを送信するには、GitHub で問題を報告します。または、Stack Overflow で質問します。