Google Apps Script 快速入門

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

快速入門指南會說明如何設定及執行呼叫 Google Workspace API 的應用程式。本快速入門導覽課程會使用簡化的驗證方法，適用於測試環境。在正式環境中，建議您先瞭解驗證和授權，再選擇適合應用程式的存取憑證。

在 Apps Script 中，Google Workspace 快速入門導覽會使用進階 Google 服務呼叫 Google Workspace API，並處理驗證和授權流程的部分詳細資料。

目標

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

必要條件

設定 Cloud 專案

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

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

如果尚未開啟，請開啟您打算用於這個範例的 Cloud 專案：

  1. 前往 Google Cloud 控制台的「選取專案」頁面。

    選取 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 控制台中，依序前往「選單」 > >「品牌」。

    前往「品牌宣傳」

  2. 如果您已設定 ，可以在「品牌」、「目標對象」和「資料存取權」中設定下列 OAuth 同意畫面設定。如果看到「尚未設定」 訊息，請按一下「開始使用」：
    1. 在「App Information」(應用程式資訊) 下方的「App name」(應用程式名稱) 欄位中，輸入應用程式名稱。
    2. 在「使用者支援電子郵件」中，選擇支援電子郵件地址，方便使用者在同意聲明方面有任何疑問時與您聯絡。
    3. 點選 [下一步]。
    4. 在「觀眾」下方，選取「內部」。
    5. 點選 [下一步]。
    6. 在「聯絡資訊」下方，輸入可接收專案異動通知的電子郵件地址。
    7. 點選 [下一步]。
    8. 在「完成」下方，詳閱《Google API 服務：使用者資料政策》，然後選取「我同意《Google API 服務：使用者資料政策》」。
    9. 按一下 [繼續]。
    10. 按一下「Create」(建立)。
  3. 目前可以略過新增範圍。 日後為 Google Workspace 機構以外的使用者建立應用程式時，請務必將「使用者類型」變更為「外部」。然後新增應用程式需要的授權範圍。詳情請參閱完整的「設定 OAuth 同意畫面」指南。

設定 Google Chat 應用程式

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

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

    前往 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. 將指令碼編輯器的內容替換成下列程式碼：

chat/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. 按一下「無標題的專案」，輸入「Quickstart」，然後按一下「重新命名」。

設定指令碼

複製 Cloud 專案編號

  1. 在 Google Cloud 控制台中，依序前往「選單」圖示 >「IAM 與管理」 >「設定」。

    前往「IAM & Admin Settings」(IAM 與管理員設定)

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

啟用 Google Chat API

開啟 Apps Script 專案。

  1. 按一下「專案設定」。
  2. 在「一般設定」下方，啟用「在編輯器中顯示『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. 按一下「允許」。

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

後續步驟