本頁面由 Cloud Translation API 翻譯而成。

Node.js 快速入門導覽課程

快速入門導覽課程說明如何設定及執行會呼叫 Google Workspace API

Google Workspace 快速入門導覽課程會使用 API 用戶端程式庫驗證和授權流程的詳細資訊建議做法您為自己的應用程式使用用戶端程式庫本快速入門導覽課程會使用適合用於測試的簡易驗證方式環境。在正式環境中，建議您瞭解驗證與授權再選擇存取認證挑選適合您應用程式的語言版本

建立 Node.js 指令列應用程式，向 Google Chat API。

目標

設定環境。
安裝用戶端程式庫。
設定範例。
執行範例。

必要條件

如要執行本快速入門導覽課程，您必須具備下列先決條件：

Node.js 與npm。
Google Cloud 專案。

可存取 Google Chat 的 Google Workspace Business 或 Enterprise 帳戶。

設定環境

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

啟用 API

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

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

啟用 API

設定 OAuth 同意畫面

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

在 Google Cloud 控制台中，前往「選單」圖示 > API 與服務 >「OAuth 同意畫面」。
前往 OAuth 同意畫面
在「使用者類型」部分選取「內部」，然後按一下「建立」。
填寫應用程式註冊表單，然後按一下「儲存並繼續」。
您現在可以略過新增範圍的步驟，然後按一下「儲存並繼續」。日後您可以製作並使用應用程式 Google Workspace 機構，您必須將「使用者類型」變更為「外部」，新增應用程式所需的授權範圍。
查看應用程式註冊摘要。如要修改資訊，請按一下「編輯」。如果應用程式註冊看起來沒有問題，請按一下 [返回資訊主頁]。

授權電腦版應用程式憑證

如要驗證使用者及存取應用程式中的使用者資料，您必須：建立一或多個 OAuth 2.0 用戶端 ID。用戶端 ID 可用來識別單一應用程式傳送至 Google 的 OAuth 伺服器。如果您的應用程式在多個平台上運作您都必須為每個平台分別建立用戶端 ID。

在 Google Cloud 控制台中，依序點選「選單」圖示 > 「API 與」「服務」 >「憑證」。
前往「憑證」
依序點選「建立憑證」>「OAuth 用戶端 ID」。
依序按一下「應用程式類型」>「電腦版應用程式」。
在「名稱」欄位中輸入憑證的名稱。這個名稱只會顯示在 Google Cloud 控制台中。
按一下「建立」，系統隨即會顯示已建立 OAuth 用戶端的畫面，並顯示您的新用戶端 ID 和用戶端密鑰。
按一下「OK」(確定)。新建立的憑證會顯示在「OAuth 2.0 用戶端 ID」之下。
將下載的 JSON 檔案儲存為 credentials.json，然後移動檔案複製到工作目錄

設定 Google Chat 應用程式

如要呼叫 Google Chat API，您必須設定 Google Chat 應用程式。針對任何寫入要求，Google Chat 透過以下資訊

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

前往 Chat API 設定頁面
在「Application info」(應用程式資訊) 下方，輸入下列資訊：
1. 在「App name」(應用程式名稱) 欄位中輸入 Chat API quickstart app。
2. 在「顯示圖片」欄位中輸入 https://developers.google.com/chat/images/quickstart-app-avatar.png。
3. 在「Description」(說明) 欄位中輸入 Quickstart for calling the Chat API。
在「互動功能」下方，按一下「啟用互動功能」。切換至關閉位置，即可停用 Chat 應用程式。
按一下 [儲存]。

安裝用戶端程式庫

使用 npm 安裝程式庫：

npm install @google-apps/chat @google-cloud/local-auth@2.1.0 --save

設定範例

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

在檔案中貼上下列程式碼：

chat/quickstart/index.js

前往 GitHub 查看

const fs = require('fs').promises;
const path = require('path');
const process = require('process');
const {authenticate} = require('@google-cloud/local-auth');
const {ChatServiceClient} = require('@google-apps/chat');
const {auth} = require('google-auth-library');

// If modifying these scopes, delete token.json.
const SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly'];

// The file token.json stores the user's access and refresh tokens, and is
// created automatically when the authorization flow completes for the first
// time.
const TOKEN_PATH = path.join(process.cwd(), 'token.json');
const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');

/**
 * Reads previously authorized credentials from the save file.
 *
 * @return {Promise<OAuth2Client|null>}
 */
async function loadSavedCredentialsIfExist() {
  try {
    const content = await fs.readFile(TOKEN_PATH);
    const credentials = JSON.parse(content);
    return auth.fromJSON(credentials);
  } catch (err) {
    console.log(err);
    return null;
  }
}

/**
 * Serializes credentials to a file compatible with GoogleAuth.fromJSON.
 *
 * @param {OAuth2Client} client
 * @return {Promise<void>}
 */
async function saveCredentials(client) {
  const content = await fs.readFile(CREDENTIALS_PATH);
  const keys = JSON.parse(content);
  const key = keys.installed || keys.web;
  const payload = JSON.stringify({
    type: 'authorized_user',
    client_id: key.client_id,
    client_secret: key.client_secret,
    refresh_token: client.credentials.refresh_token,
  });
  await fs.writeFile(TOKEN_PATH, payload);
}

/**
 * Load or request or authorization to call APIs.
 *
 * @return {Promise<OAuth2Client>}
 */
async function authorize() {
  let client = await loadSavedCredentialsIfExist();
  if (client) {
    return client;
  }
  client = await authenticate({
    scopes: SCOPES,
    keyfilePath: CREDENTIALS_PATH,
  });
  if (client.credentials) {
    await saveCredentials(client);
  }
  return client;
}

/**
 * Lists spaces with user credential.
 * @param {OAuth2Client} authClient An authorized OAuth2 client.
 */
async function listSpaces(authClient) {
  // Create a client
  const chatClient = new ChatServiceClient({
    authClient: authClient,
    scopes: SCOPES,
  });

  // Initialize request argument(s)
  const request = {
    // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
    filter: 'space_type = "SPACE"'
  };

  // Make the request
  const pageResult = chatClient.listSpacesAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

authorize().then(listSpaces).catch(console.error);

執行範例

在工作目錄中執行範例：
```
node .
```

第一次執行範例時，系統會提示您授予存取權：
1. 如果尚未登入 Google 帳戶，請在系統提示時登入。如果您已登入多個帳戶，請選取一個用於授權的帳戶。
2. 然後點選 [Accept]。
您的 Nodejs 應用程式會執行並呼叫 Google Chat API。

授權資訊會儲存在檔案系統中，因此下次您執行範例時這樣系統就不會提示您授權

後續步驟

GitHub 上的 Google Chat API 用戶端