このページは Cloud Translation API によって翻訳されました。

JavaScript クイックスタート

クイックスタートでは、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 を有効にします。

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 ファイルに次のサンプルコードを貼り付けます。

gmail/quickstart/index.html

GitHub で表示

<!DOCTYPE html>
<html>
  <head>
    <title>Gmail API Quickstart</title>
    <meta charset="utf-8" />
  </head>
  <body>
    <p>Gmail API Quickstart</p>

    <!--Add buttons to initiate auth sequence and sign out-->
    <button id="authorize_button" onclick="handleAuthClick()">Authorize</button>
    <button id="signout_button" onclick="handleSignoutClick()">Sign Out</button>

    <pre id="content" style="white-space: pre-wrap;"></pre>

    <script type="text/javascript">
      /* exported gapiLoaded */
      /* exported gisLoaded */
      /* exported handleAuthClick */
      /* exported handleSignoutClick */

      // TODO(developer): Set to client ID and API key from the Developer Console
      const CLIENT_ID = '<YOUR_CLIENT_ID>';
      const API_KEY = '<YOUR_API_KEY>';

      // Discovery doc URL for APIs used by the quickstart
      const DISCOVERY_DOC = 'https://www.googleapis.com/discovery/v1/apis/gmail/v1/rest';

      // Authorization scopes required by the API; multiple scopes can be
      // included, separated by spaces.
      const SCOPES = 'https://www.googleapis.com/auth/gmail.readonly';

      let tokenClient;
      let gapiInited = false;
      let gisInited = false;

      document.getElementById('authorize_button').style.visibility = 'hidden';
      document.getElementById('signout_button').style.visibility = 'hidden';

      /**
       * Callback after api.js is loaded.
       */
      function gapiLoaded() {
        gapi.load('client', initializeGapiClient);
      }

      /**
       * Callback after the API client is loaded. Loads the
       * discovery doc to initialize the API.
       */
      async function initializeGapiClient() {
        await gapi.client.init({
          apiKey: API_KEY,
          discoveryDocs: [DISCOVERY_DOC],
        });
        gapiInited = true;
        maybeEnableButtons();
      }

      /**
       * Callback after Google Identity Services are loaded.
       */
      function gisLoaded() {
        tokenClient = google.accounts.oauth2.initTokenClient({
          client_id: CLIENT_ID,
          scope: SCOPES,
          callback: '', // defined later
        });
        gisInited = true;
        maybeEnableButtons();
      }

      /**
       * Enables user interaction after all libraries are loaded.
       */
      function maybeEnableButtons() {
        if (gapiInited && gisInited) {
          document.getElementById('authorize_button').style.visibility = 'visible';
        }
      }

      /**
       *  Sign in the user upon button click.
       */
      function handleAuthClick() {
        tokenClient.callback = async (resp) => {
          if (resp.error !== undefined) {
            throw (resp);
          }
          document.getElementById('signout_button').style.visibility = 'visible';
          document.getElementById('authorize_button').innerText = 'Refresh';
          await listLabels();
        };

        if (gapi.client.getToken() === null) {
          // Prompt the user to select a Google Account and ask for consent to share their data
          // when establishing a new session.
          tokenClient.requestAccessToken({prompt: 'consent'});
        } else {
          // Skip display of account chooser and consent dialog for an existing session.
          tokenClient.requestAccessToken({prompt: ''});
        }
      }

      /**
       *  Sign out the user upon button click.
       */
      function handleSignoutClick() {
        const token = gapi.client.getToken();
        if (token !== null) {
          google.accounts.oauth2.revoke(token.access_token);
          gapi.client.setToken('');
          document.getElementById('content').innerText = '';
          document.getElementById('authorize_button').innerText = 'Authorize';
          document.getElementById('signout_button').style.visibility = 'hidden';
        }
      }

      /**
       * Print all Labels in the authorized user's inbox. If no labels
       * are found an appropriate message is printed.
       */
      async function listLabels() {
        let response;
        try {
          response = await gapi.client.gmail.users.labels.list({
            'userId': 'me',
          });
        } catch (err) {
          document.getElementById('content').innerText = err.message;
          return;
        }
        const labels = response.result.labels;
        if (!labels || labels.length == 0) {
          document.getElementById('content').innerText = 'No labels found.';
          return;
        }
        // Flatten to string to display
        const output = labels.reduce(
            (str, label) => `${str}${label.name}\n`,
            'Labels:\n');
        document.getElementById('content').innerText = output;
      }
    </script>
    <script async defer src="https://apis.google.com/js/api.js" onload="gapiLoaded()"></script>
    <script async defer src="https://accounts.google.com/gsi/client" onload="gisLoaded()"></script>
  </body>
</html>

以下を置き換えます。

YOUR_CLIENT_ID: ウェブアプリケーションの認証情報を承認したときに作成したクライアント ID。
YOUR_API_KEY: 前提条件として作成した API キー。

サンプルの実行

作業ディレクトリに http-server パッケージをインストールします。
```
npm install http-server
```
作業ディレクトリで、ウェブサーバーを起動します。
```
npx http-server -p 8000
```
ブラウザで http://localhost:8000 に移動します。
サンプルの初回実行時に、アクセスを許可するよう求められます。
1. Google アカウントにまだログインしていない場合は、ログインを求められます。複数のアカウントにログインしている場合は、認可に使用するアカウントを 1 つ選択します。
2. [同意する] をクリックします。
3. ブラウザからコードをコピーしてコマンドラインプロンプトに貼り付け、Enter を押します。
認可情報はファイルシステムに保存されるため、次回サンプルコードを実行するときに、認可を求めるプロンプトは表示されません。

Gmail API にリクエストを送信する最初の JavaScript アプリケーションが正常に作成されました。