Node.js 版快速入门

快速入门介绍了如何设置和运行调用 Google Workspace API 的应用。

Google Workspace 快速入门使用 API 客户端库来处理身份验证和授权流程的某些细节。我们建议您为自己的应用使用客户端库。本快速入门使用适合测试环境的简化身份验证方法。对于生产环境，我们建议您先了解身份验证和授权，然后再选择适合您的应用的访问凭据。

创建一个 Node.js 命令行应用，用于向 Google Chat API 发出请求。

目标

• 设置环境。
• 安装客户端库。
• 设置示例。
• 运行示例。

前提条件

如需运行本快速入门，您需要满足以下前提条件：

• 安装了 Node.js 和 npm。
• Google Cloud 项目。

• 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。

设置环境

如需完成本快速入门，请设置您的环境。

启用 API

在使用 Google API 之前，您需要先在 Google Cloud 项目中启用这些 API。您可以在单个 Google Cloud 项目中启用一个或多个 API。

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

  启用 API

配置 OAuth 权限请求页面

如果您使用新的 Google Cloud 项目完成本快速入门，请配置 OAuth 同意屏幕。如果您已为 Cloud 项目完成此步骤，请跳至下一部分。

1. 在 Google Cloud 控制台中，依次点击“菜单”图标 > > 品牌。

   前往“品牌”页面

2. 如果您已配置 ，则可以在品牌、受众群体和数据访问中配置以下 OAuth 同意屏幕设置。如果您看到一条消息，其中显示 尚未配置，请点击开始：
1. 在应用信息下的应用名称中，输入应用的名称。
2. 在用户支持电子邮件中，选择一个支持电子邮件地址，以便用户在对其同意问题有疑问时与您联系。
3. 点击下一步。
4. 在观众下，选择内部。
5. 点击下一步。
6. 在联系信息下，输入一个电子邮件地址，以便您接收有关项目的任何更改的通知。
7. 点击下一步。
8. 在完成下方，查看 Google API 服务用户数据政策，如果您同意，请选择我同意 Google API 服务：用户数据政策。
9. 点击继续。
10. 点击创建。
3. 目前，您可以跳过添加镜重。 今后，如果您创建的应用供 Google Workspace 组织之外的用户使用，则必须将用户类型更改为外部。然后，添加您的应用所需的授权范围。如需了解详情，请参阅完整的配置 OAuth 同意指南。

为桌面应用授权凭据

如需对最终用户进行身份验证并访问应用中的用户数据，您需要创建一个或多个 OAuth 2.0 客户端 ID。客户端 ID 用于向 Google 的 OAuth 服务器标识单个应用。如果您的应用在多个平台上运行，您必须为每个平台分别创建客户端 ID。

注意 ：此快速入门必须在本地运行，并且需要有权访问浏览器。如果在 Cloud Shell 等远程终端或通过 SSH 运行，则不起作用。

1. 在 Google Cloud 控制台中，依次点击“菜单”图标 > > 客户端。

   前往“客户”页面

2. 点击创建客户端。
3. 依次点击应用类型 > 桌面应用。
4. 在名称字段中，输入凭据的名称。此名称仅在 Google Cloud 控制台中显示。
5. 点击创建。

   新创建的凭据会显示在“OAuth 2.0 客户端 ID”下。

6. 将下载的 JSON 文件另存为 credentials.json，然后将该文件移至您的工作目录。

配置 Google Chat 应用

如需调用 Google Chat API，您必须配置 Google Chat 应用。对于任何写入请求，Google Chat 都会使用以下信息在界面中归因 Google Chat 应用。

1. 在 Google Cloud 控制台中，前往 Chat API 配置页面：

   前往 Chat API 配置页面

2. 在应用信息下，输入以下信息：

   1. 在应用名称字段中，输入 Chat API quickstart app。
   2. 在头像网址字段中，输入 https://developers.google.com/chat/images/quickstart-app-avatar.png。
   3. 在说明字段中，输入 Quickstart for calling the Chat API。

3. 在互动功能下，将启用互动功能切换开关切换到关闭位置，以停用 Chat 应用的互动功能。

4. 点击保存。

安装客户端库

• 使用 npm 安装库：

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

设置示例

1. 在工作目录中，创建一个名为 index.js 的文件。

2. 在该文件中，粘贴以下代码：

   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);

运行示例

1. 在工作目录中，运行示例：

   node .
   

2. 首次运行该示例时，系统会提示您授予访问权限：
   1. 如果您尚未登录 Google 账号，请在系统提示时登录。如果您登录了多个账号，请选择一个账号用于授权。
   2. 点击接受。

   您的 Nodejs 应用运行并调用 Google Chat API。

   授权信息会存储在文件系统中，因此当您下次运行示例代码时，系统不会提示您进行授权。

后续步骤

• GitHub 上的 Google Chat API 客户端