Google Apps Script 快速入門導覽課程

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

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

建立向 Google Chat API 提出要求的 Google Apps Script。

目標

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

必要條件

設定 Cloud 專案

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

在 Google Cloud 控制台中開啟 Cloud 專案

如果尚未開啟，請開啟要用於本範例的 Cloud 專案：

  1. 在 Google Cloud 控制台中，前往「Select a project」頁面。

    選取 Cloud 專案

  2. 選取要使用的 Google Cloud 專案。或者，您也可以按一下「建立專案」，然後按照畫面上的指示操作。如果您建立 Google Cloud 專案，可能需要為專案啟用計費功能。

開啟 Chat API

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

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

    啟用 API

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

    前往 OAuth 同意畫面

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

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

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

設定 Google Chat 應用程式

如要呼叫 Google Chat API，您必須設定 Google Chat 應用程式。對於任何寫入要求，Google Chat 會使用下列資訊，在 UI 中歸屬 Google Chat 應用程式。

  1. 在 Google Cloud 控制台中，前往 Chat API 的「設定」頁面：

    前往 Chat API 設定頁面

  2. 在「Application info」(應用程式資訊) 下方輸入下列資訊：

    1. 在「App name」(應用程式名稱) 欄位中輸入 Chat API quickstart app。
    2. 在「Avatar URL」(顯示圖片網址) 欄位中輸入 https://developers.google.com/chat/images/quickstart-app-avatar.png。
    3. 在「Description」(說明) 欄位中輸入 Quickstart for calling the Chat API。

  3. 在「互動功能」下方，將「啟用互動功能」切換鈕切換為關閉位置，即可停用 Chat 應用程式的互動功能。

  4. 按一下 [儲存]。

建立指令碼

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

即時通訊/quickstart/Code.gs
/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken
    });
    // Handle response pages
    if (responsePage.spaces) {
      responsePage.spaces.forEach((space) => console.log(space));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

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

設定指令碼

複製 Cloud 專案編號

  1. 在 Google Cloud 控制台中，依序前往「Menu」(選單) >「IAM & Admin」(IAM 與管理)>「Settings」(設定)。

    前往「IAM 與管理員設定」

  2. 在「專案編號」欄位中複製值。
  1. 開啟 Apps Script 專案。
  2. 按一下「Project Settings」圖示 。
  3. 在「Google Cloud Platform (GCP) Project」(Google Cloud Platform (GCP) 專案) 下方，按一下 [變更專案]。
  4. 在「GCP 專案編號」中，貼上 Google Cloud 專案編號。
  5. 按一下「設定專案」。

啟用 Google Chat API

  1. 開啟 Apps Script 專案。
  1. 按一下「專案設定」圖示 。
  2. 在「General settings」(一般設定) 下方，啟用「在編輯器中顯示「appsscript.json」資訊清單檔案」。
  3. 按一下「編輯器」，選取檔案 appscript.json，然後將內容替換成以下程式碼：

chat/quickstart/appsscript.json
{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.spaces.readonly"
  ],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [{
      "userSymbol": "Chat",
      "version": "v1",
      "serviceId": "chat"
    }]
  }
}

執行範例

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

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

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

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

後續步驟