People API にリクエストを行う Java コマンドライン アプリケーションを作成します。
クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。このクイックスタートでは、テスト環境に適した簡略化された認証方法を使用します。本番環境では、アプリに適したアクセス認証情報を選択する前に、 認証と認可 について学習することをおすすめします。
このクイックスタートでは、Google Workspace の推奨 API クライアント ライブラリを使用して、認証と認可フローの詳細を処理します。
目標
- 環境をセットアップする。
- サンプルをセットアップする。
- サンプルを実行する。
前提条件
- Java 11 以降。
- Gradle 7.0 以降。
- Google Cloud プロジェクト。
- API アクセスが有効になっている Google Workspace ドメイン。
- 管理者権限を持つ、そのドメイン内の Google アカウント。
環境をセットアップする
このクイックスタートを完了するには、環境をセットアップします。
API を有効にする
Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。Google Cloud コンソールで、People API を有効にします。
OAuth 同意画面を構成する
このクイックスタートを完了するために新しい Google Cloud プロジェクトを使用している場合は、OAuth 同意画面を構成します。Cloud プロジェクトでこの手順をすでに完了している場合は、次のセクションに進みます。
- Google API Console で、メニュー > [Google Auth Platform] > [Branding] に移動します。
- Google Auth Platform をすでに構成している場合は、[Branding]、[Audience]、および [Data Access] で次の OAuth 同意画面の設定を構成できます。[**Google Auth Platform はまだ構成されていません**] というメッセージが表示されたら、[**Get Started**] をクリックします。
- [App Information] の [App name] に、アプリの名前を入力します。
- [User support email] で、ユーザーが同意について問い合わせる際に使用するサポートのメールアドレスを選択します。
- [Next] をクリックします。
- [Audience] で [Internal] を選択します。
- [Next] をクリックします。
- [Contact Information] の [Email address] に、プロジェクトに対する変更の通知を受け取るメールアドレスを入力します。
- [Next] をクリックします。
- [Finish] で、Google API サービスのユーザーデータに関するポリシー を確認し、同意する場合は [I agree to the Google API Services: User Data Policy] を選択します。
- [Continue] をクリックします。
- [Create] をクリックします。
- 現時点では、スコープの追加はスキップできます。 今後、Google Workspace 組織外で使用するアプリを作成する場合は、 [User type] を [External] に変更する必要があります。次に、アプリに必要な認可スコープを追加します。詳細については、 OAuth 同意画面を構成するをご覧ください。
デスクトップ アプリケーションの認証情報を認可する
エンドユーザーを認証してアプリ内のユーザーデータにアクセスするには、1 つ以上の OAuth 2.0 クライアント ID を作成する必要があります。クライアント ID は、Google の OAuth サーバーで個々のアプリを識別するために使用します。アプリが複数のプラットフォームで実行される場合は、プラットフォームごとに個別のクライアント ID を作成する必要があります。- Google API Console で、メニュー > [Google Auth Platform] > [Clients] に移動します。
- [Create Client] をクリックします。
- [Application type] > [Desktop app] をクリックします。
- [Name] フィールドに、認証情報の名前を入力します。この名前は Google API Console にのみ表示されます。
- [Create] をクリックします。
新しく作成した認証情報が [OAuth 2.0 クライアント ID] に表示されます。
- ダウンロードした JSON ファイルを
credentials.jsonとして保存し、 ファイルを作業ディレクトリに移動します。
職場環境を整える
作業ディレクトリに、新しいプロジェクト構造を作成します。
gradle init --type basic mkdir -p src/main/java src/main/resourcessrc/main/resources/ディレクトリに、以前にダウンロードしたcredentials.jsonファイルをコピーします。デフォルトの
build.gradleファイルを開き、その内容を次のコードに置き換えます。
サンプルのセットアップ
src/main/java/ディレクトリに、build.gradleファイルのmainClassName値と一致する名前の新しい Java ファイルを作成します。新しい Java ファイルに次のコードを追加します。
サンプルの実行
サンプルを実行する
gradle run
-
サンプルを初めて実行すると、アクセス権の承認を求めるメッセージが表示されます。
- Google アカウントにまだログインしていない場合は、ログインを求められたらログインします。複数のアカウントにログインしている場合は、承認に使用するアカウントを 1 つ選択します。
- [Accept] をクリックします。
Java アプリケーションが実行され、People API が呼び出されます。
認可情報はファイル システムに保存されるため、次回サンプル コードを実行するときに認可を求められることはありません。
次のステップ
- API Explorer で Google Workspace API を試す
- 認証と認可に関する問題のトラブルシューティングを行う
- People API リファレンス ドキュメントを確認する
- Java 用 Google API クライアントのドキュメントを確認する
- People API Javadoc ドキュメントを確認する