クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。
Google Workspace クイックスタートでは、API クライアント ライブラリを使用して認証と認可フローの詳細を処理します。独自のアプリではクライアント ライブラリを使用することをおすすめします。このクイックスタートでは、テスト環境に適した簡略化された認証方法を使用します。本番環境では、アプリに適したアクセス認証情報を選択する前に、認証と認可について確認することをおすすめします。
Google Classroom API にリクエストを送信する Java コマンドライン アプリケーションを作成します。
目標
- 環境を設定する。
- サンプルをセットアップします。
- サンプルを実行します。
前提条件
- Java 1.8 以降。
- Gradle 7.0 以降。
- Google Cloud プロジェクト。
- Google Classroom が有効になっている Google for Education アカウント。
環境を設定する
このクイックスタートを完了するには、環境を設定します。
API を有効にする
Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。Google Cloud コンソールで、Google Classroom API を有効にします。
OAuth 同意画面を構成する
新しい Google Cloud プロジェクトを使用してこのクイックスタートを完了するには、OAuth 同意画面を構成して、自分自身をテストユーザーとして追加します。Cloud プロジェクトでこの手順をすでに完了している場合は、次のセクションに進みます。
- Google Cloud コンソールで、メニュー > [API とサービス] > [OAuth 同意画面] に移動します。
- [ユーザーの種類] で [内部] を選択し、[作成] をクリックします。
- アプリ登録フォームに入力し、[保存して次へ] をクリックします。
現時点では、スコープの追加をスキップして、[Save and Continue] をクリックします。今後、Google Workspace 組織外で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更してから、アプリに必要な認証スコープを追加する必要があります。
- アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリ登録に問題がない場合は、[Back to Dashboard] をクリックします。
デスクトップ アプリケーションの認証情報を承認する
エンドユーザーを認証し、アプリ内でユーザーデータにアクセスするには、1 つ以上の OAuth 2.0 クライアント ID を作成する必要があります。クライアント ID は、Google の OAuth サーバーで個々のアプリを識別するために使用します。アプリを複数のプラットフォームで実行する場合は、プラットフォームごとに個別のクライアント ID を作成する必要があります。- Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。
- [認証情報を作成] > [OAuth クライアント ID] をクリックします。
- [アプリケーションの種類] > [デスクトップ アプリ] をクリックします。
- [名前] フィールドに、認証情報の名前を入力します。この名前は Google Cloud コンソールにのみ表示されます。
- [作成] をクリックします。[OAuth クライアントの作成] 画面が表示され、新しいクライアント ID とクライアント シークレットが表示されます。
- [OK] をクリックします。新しく作成された認証情報が [OAuth 2.0 クライアント ID] に表示されます。
- ダウンロードした JSON ファイルを
credentials.json
として保存し、ファイルを作業ディレクトリに移動します。
職場環境を整える
作業ディレクトリに新しいプロジェクト構造を作成します。
gradle init --type basic mkdir -p src/main/java src/main/resources
src/main/resources/
ディレクトリで、以前にダウンロードしたcredentials.json
ファイルをコピーします。デフォルトの
build.gradle
ファイルを開き、内容を次のコードに置き換えます。
サンプルのセットアップ
src/main/java/
ディレクトリに、build.gradle
ファイルのmainClassName
値と一致する名前で新しい Java ファイルを作成します。新しい Java ファイルに次のコードを追加します。
サンプルの実行
サンプルを実行する
gradle run
-
サンプルを初めて実行すると、アクセスの承認を求められます。
- Google アカウントにまだログインしていない場合は、ログインを求められたらログインします。複数のアカウントにログインしている場合は、認証に使用するアカウントを 1 つ選択してください。
- [Accept] をクリックします。
Java アプリケーションが Google Classroom API を実行し、呼び出します。
認可情報はファイル システムに保存されるため、サンプルコードを次回実行するときに、認可を求められません。
次のステップ
- 認証と認可に関する問題のトラブルシューティング
- Classroom API リファレンス ドキュメント
- Java 用 Google API クライアントのドキュメント
- Google Classroom API の Javadoc ドキュメント