JavaScript 快速入門導覽課程

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

Google Workspace 快速入門會使用 API 用戶端程式庫處理驗證和授權流程的部分細節。建議您為自家應用程式使用用戶端程式庫。本快速入門導覽課程會使用簡化的驗證方法，適合測試環境使用。如要使用正式環境，建議您先瞭解驗證和授權，再選擇適合應用程式的存取憑證。

建立向 Directory API 提出要求的 JavaScript 網頁應用程式。

目標

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

必要條件

  • 已啟用 API 存取權的 Google Workspace 網域。
  • 該網域中具有管理員權限的 Google 帳戶。

設定環境

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

啟用 API

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

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

    啟用 API

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

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

    前往 OAuth 同意畫面

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

  4. 目前您可以略過新增範圍，直接按一下「儲存並繼續」。日後，如果您建立的應用程式是用於 Google Workspace 機構以外的環境，就必須將使用者類型變更為外部，然後新增應用程式所需的授權範圍。

  5. 查看應用程式註冊摘要。如要修改資訊，請按一下「編輯」。如果應用程式註冊看起來沒問題，請按一下「返回資訊主頁」。

授權網頁應用程式的憑證

如要驗證使用者，並在應用程式中存取使用者資料，您需要建立一或多個 OAuth 2.0 用戶端 ID。用戶端 ID 可讓 Google 的 OAuth 伺服器識別單一應用程式。如果您的應用程式是在多個平台中運作，則必須為每個平台建立專屬的用戶端 ID。
  1. 在 Google Cloud 控制台中，依序前往「Menu」 >「APIs & Services」>「Credentials」。

    前往「憑證」

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

    記下用戶端 ID。網頁應用程式不會使用用戶端密鑰。

  7. 按一下「確定」。新建立的憑證會顯示在「OAuth 2.0 Client IDs」下方。

請記下這些憑證，因為您稍後會在本快速入門課程中使用。

建立 API 金鑰

  1. 在 Google Cloud 控制台中，依序前往「Menu」(選單) >「APIs & Services」(API 和服務) >「Credentials」(憑證)。

    前往「憑證」

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

設定範例

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

  2. 在 index.html 檔案中貼上以下程式碼範例：

    adminSDK/directory/index.html
    <!DOCTYPE html>
<html>
  <head>
    <title>Directory API Quickstart</title>
    <meta charset="utf-8" />
  </head>
  <body>
    <p>Directory 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/admin/directory_v1/rest';

      // Authorization scopes required by the API; multiple scopes can be
      // included, separated by spaces.
      const SCOPES = 'https://www.googleapis.com/auth/admin.directory.user.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 listUsers();
        };

        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 the first 10 users in the domain.
       */
      async function listUsers() {
        let response;
        try {
          const request = {
            'customer': 'my_customer',
            'maxResults': 10,
            'orderBy': 'email',
          };
          response = await gapi.client.directory.users.list(request);
        } catch (err) {
          document.getElementById('content').innerText = err.message;
          return;
        }

        const users = response.result.users;
        if (!users || users.length == 0) {
          document.getElementById('content').innerText = 'No users found.';
          return;
        }
        // Flatten to string to display
        const output = users.reduce(
            (str, user) => `${str}${user.primaryEmail} (${user.name.fullName})\n`,
            'Users:\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
  1. 在瀏覽器中前往 http://localhost:8000。
  2. 畫面上會顯示授予存取權的提示：
    1. 如果尚未登入 Google 帳戶，請在系統提示時登入。如果您登入了多個帳戶，請選取要用於授權的帳戶。
    2. 然後點選 [Accept]。

JavaScript 應用程式會執行並呼叫 Directory API。

後續步驟