Google Apps Script 快速入門

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

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

建立用於向 Directory API 提出要求的 Google Apps Script。

目標

  • 設定環境。
  • 建立並設定指令碼。
  • 執行指令碼。

必要條件

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

  • 存取 Google 雲端硬碟

建立指令碼

  1. 前往 script.google.com/create 建立新指令碼。
  2. 使用下列程式碼取代指令碼編輯器的內容：

adminSDK/directory/quickstart.gs
/**
 * Lists users in a Google Workspace domain.
 * @see https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list
 */
function listUsers() {
  const optionalArgs = {
    customer: 'my_customer',
    maxResults: 10,
    orderBy: 'email'
  };
  try {
    const response = AdminDirectory.Users.list(optionalArgs);
    const users = response.users;
    if (!users || users.length === 0) {
      console.log('No users found.');
      return;
    }
    // Print the list of user's full name and email
    console.log('Users:');
    for (const user of users) {
      console.log('%s (%s)', user.primaryEmail, user.name.fullName);
    }
  } catch (err) {
    // TODO (developer)- Handle exception from the Directory API
    console.log('Failed with error %s', err.message);
  }
}

  1. 按一下「儲存」圖示 。
  2. 按一下「Untitled project」，輸入「Quickstart」，然後點選「Rename」。

設定指令碼

啟用 Directory API

  1. 開啟 Apps Script 專案。
  1. 按一下「編輯器」圖示 。
  2. 按一下「服務」旁的「新增服務」圖示 。
  3. 選取 Admin Directory API，然後按一下「新增」。

執行範例

在 Apps Script 編輯器中，按一下「Run」。

第一次執行範例時，系統會提示您授權存取權：

  1. 按一下「查看權限」。
  2. 選擇所需帳戶。
  3. 按一下「允許」。

指令碼的執行記錄會顯示在視窗底部。

後續步驟