JavaScript 快速入門導覽課程

快速入門導覽課程說明如何設定及執行呼叫 Google Workspace API 的應用程式。

Google Workspace 快速入門導覽課程使用 API 用戶端程式庫處理驗證和授權流程的一些詳細資料。建議您在自己的應用程式中使用用戶端程式庫。本快速入門導覽課程採用適用於測試環境的簡化驗證方法。如果是實際工作環境，建議先瞭解驗證與授權，再選擇適合應用程式的存取憑證。

建立 JavaScript 網頁應用程式向 Gmail API 發出要求。

目標

  • 設定環境。
  • 設定範例。
  • 執行範例。

必要條件

  • 已啟用 Gmail 的 Google 帳戶。

設定環境

如要完成本快速入門導覽課程，請設定環境。

啟用 API

使用 Google API 前，您必須在 Google Cloud 專案中啟用 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。

  • 在 Google Cloud 控制台中啟用 Gmail API。

    啟用 API

如果您是使用新的 Google Cloud 專案來完成本快速入門導覽課程，請設定 OAuth 同意畫面，並將自己新增為測試使用者。如果您已為 Cloud 專案完成這個步驟，請跳到下一節。

  1. 在 Google Cloud 控制台中，依序點選「選單」圖示 >「API 和服務」>「OAuth 同意畫面」。

    前往 OAuth 同意畫面

  2. 選取應用程式的使用者類型，然後按一下「建立」。
  3. 填寫應用程式註冊表單，然後按一下「儲存並繼續」。

  4. 您現在可以略過新增範圍的步驟，然後按一下「儲存並繼續」。 日後如果您建立的應用程式供 Google Workspace 機構外部使用，就必須新增並驗證應用程式所需的授權範圍。

  5. 如果您將使用者類型設為「外部」，請新增測試使用者：
    1. 在「測試使用者」下方，按一下「新增使用者」。
    2. 輸入您的電子郵件地址和其他任何獲得授權的測試使用者，然後按一下 [儲存並繼續]。
  6. 查看應用程式註冊摘要。如要修改資訊，請按一下「編輯」。如果應用程式註冊看起來沒問題，請按一下「Back to Dashboard」(返回資訊主頁)。

授權網頁應用程式的憑證

如要以使用者身分進行驗證並在應用程式中存取使用者資料，您必須建立一或多個 OAuth 2.0 用戶端 ID。用戶端 ID 可用來向 Google 的 OAuth 伺服器識別單一應用程式。如果應用程式在多個平台上執行，就必須為每個平台建立不同的用戶端 ID。
  1. 在 Google Cloud 控制台中，依序點選「選單」圖示 >「API 和服務」>「憑證」。

    前往「憑證」

  2. 依序按一下「建立憑證」>「OAuth 用戶端 ID」。
  3. 依序點選「應用程式類型」>「網頁應用程式」。
  4. 在「Name」(名稱) 欄位中，輸入憑證名稱。這個名稱只會顯示在 Google Cloud 控制台中。
  5. 新增與應用程式相關的授權 URI：
    • 用戶端應用程式 (JavaScript)：在「已授權的 JavaScript 來源」下方，按一下「新增 URI」。接著，輸入要用於瀏覽器要求的 URI。這會識別應用程式可將 API 要求傳送至 OAuth 2.0 伺服器的網域。
    • 伺服器端應用程式 (Java、Python 等)：在「已授權的重新導向 URI」下方，按一下「新增 URI」。接著輸入 OAuth 2.0 伺服器可將回應傳送至哪個端點 URI。
  6. 按一下「建立」，系統隨即會顯示 OAuth 用戶端建立的畫面，顯示您的新用戶端 ID 和用戶端密鑰。

    記下用戶端 ID。用戶端密鑰不適用於網頁應用程式。

  7. 按一下「OK」。新建立的憑證會顯示在「OAuth 2.0 用戶端 ID」下方。

請記下這些憑證，因為本快速入門導覽課程稍後會用到這些憑證。

建立 API 金鑰

  1. 在 Google Cloud 控制台中，依序點選「選單」圖示 >「API 和服務」>「憑證」。

    前往「憑證」

  2. 依序按一下「建立憑證」>「API 金鑰」。
  3. 系統隨即顯示新的 API 金鑰。
    • 按一下「複製」圖示 來複製 API 金鑰，以便用於應用程式的程式碼中。您也可以在專案憑證的「API 金鑰」專區中找到 API 金鑰。
    • 按一下「限制金鑰」即可更新進階設定，並限制 API 金鑰的使用。詳情請參閱「套用 API 金鑰限制」。

設定範例

  1. 在工作目錄中，建立名為 index.html 的檔案。

  2. 在 index.html 檔案中，貼上下列程式碼：

    gmail/quickstart/index.html
    <!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>

    更改下列內容：

執行範例

  1. 在工作目錄中，安裝 http-server 套件：

    npm install http-server

  2. 在工作目錄中啟動網路伺服器：

    npx http-server -p 8000

  3. 在瀏覽器中前往 http://localhost:8000。

  4. 首次執行範例時，系統會提示您授予存取權：

    1. 如果您尚未登入 Google 帳戶，系統會提示您登入。如果您登入多個帳戶，請選取一個要用於授權的帳戶。
    2. 然後點選 [Accept]。
    3. 複製瀏覽器中的程式碼，貼到指令列提示中，然後按下 Enter 鍵。

    授權資訊會儲存在檔案系統中，因此下次執行程式碼範例時，系統不會提示您授權。

您已成功建立第一個 JavaScript 應用程式，向 Gmail API 提出要求。

後續步驟