クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。
Google Workspace のクイックスタートでは、認証と認可フローの詳細の処理に API クライアント ライブラリを使用します。独自のアプリにはクライアント ライブラリを使用することをおすすめします。このクイックスタートでは、テスト環境に適した簡略化された認証方法を使用しています。本番環境の場合は、アプリに適したアクセス認証情報を選択する前に、認証と認可を確認することをおすすめします。
Gmail API にリクエストを送信する JavaScript ウェブ アプリケーションを作成します。
目標
- 環境を設定する。
- サンプルを設定します。
- サンプルを実行します。
Prerequisites
- Node.js と npm がインストールされていること。
- Google Cloud プロジェクト。
- Gmail が有効になっている Google アカウント。
環境をセットアップする
このクイックスタートを完了するには、環境を設定します。
API の有効化
Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。Google Cloud コンソールで、Gmail API を有効にします。
ウェブ アプリケーションの認証情報を承認する
エンドユーザーとして認証し、アプリ内でユーザーデータにアクセスするには、OAuth 2.0 クライアント ID を 1 つ以上作成する必要があります。クライアント ID は、Google の OAuth サーバーで 1 つのアプリを識別するために使用されます。アプリを複数のプラットフォームで実行する場合は、プラットフォームごとに個別のクライアント ID を作成する必要があります。- Google Cloud コンソールで、メニュー アイコン > [API とサービス] > [認証情報] の順に選択します。
- [認証情報を作成] > [OAuth クライアント ID] をクリックします。
- [アプリケーションの種類] > [ウェブ アプリケーション] をクリックします。
- [名前] フィールドに、認証情報の名前を入力します。この名前は Google Cloud コンソールにのみ表示されます。
- アプリに関連する承認済みの URI を追加します。
- クライアントサイド アプリ(JavaScript)- [承認済みの JavaScript 生成元] で [URI を追加] をクリックします。次に、ブラウザ リクエストに使用する URI を入力します。これにより、アプリケーションが OAuth 2.0 サーバーに API リクエストを送信できるドメインを識別します。
- サーバーサイド アプリ(Java、Python など) - [承認済みのリダイレクト URI] の下にある [URI を追加] をクリックします。次に、OAuth 2.0 サーバーがレスポンスを送信できるエンドポイント URI を入力します。
- [作成] をクリックします。OAuth クライアントの作成画面が表示され、新しいクライアント ID とクライアント シークレットが表示されます。
クライアント ID をメモします。クライアント シークレットはウェブ アプリケーションには使用されません。
- [OK] をクリックします。新しく作成された認証情報が [OAuth 2.0 クライアント ID] に表示されます。
この認証情報は、このクイックスタートの後半で必要になるため、メモしておきます。
API キーを作成する
- Google Cloud コンソールで、メニュー アイコン > [API とサービス] > [認証情報] に移動します。
- [認証情報を作成] > [API キー] の順にクリックします。
- 新しい API キーが表示されます。
- コピーアイコン をクリックして、アプリのコードで使用する API キーをコピーします。API キーは、プロジェクトの認証情報の [API キー] セクションでも確認できます。
- [キーを制限] をクリックして、詳細設定を更新し、API キーの使用を制限します。詳しくは、API キーの制限を適用するをご覧ください。
サンプルのセットアップ
- 作業ディレクトリに
index.html
という名前のファイルを作成します。 index.html
ファイルに次のサンプルコードを貼り付けます。以下を置き換えます。
YOUR_CLIENT_ID
: ウェブ アプリケーションの認証情報を承認したときに作成したクライアント ID。YOUR_API_KEY
: 前提条件として作成した API キー。
サンプルの実行
作業ディレクトリに http-server パッケージをインストールします。
npm install http-server
作業ディレクトリで、ウェブサーバーを起動します。
npx http-server -p 8000
ブラウザで
http://localhost:8000
に移動します。サンプルの初回実行時に、アクセスを許可するよう求められます。
- Google アカウントにまだログインしていない場合は、ログインを求められます。複数のアカウントにログインしている場合は、認可に使用するアカウントを 1 つ選択します。
- [同意する] をクリックします。
- ブラウザからコードをコピーしてコマンドライン プロンプトに貼り付け、
Enter
を押します。
認可情報はファイル システムに保存されるため、次回サンプルコードを実行するときに、認可を求めるプロンプトは表示されません。
Gmail API にリクエストを送信する最初の JavaScript アプリケーションが正常に作成されました。