作为 Google Chat 应用进行身份验证

Java

• JDK 1.7 或更高版本
• Maven 软件包管理工具
• 已初始化的 Maven 项目。如需初始化新项目，请在命令行界面中运行以下命令：

  mvn archetype:generate -DgroupId=com.google.chat.app.authsample -DartifactId=auth-sample-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

• 启用了交互功能的 Google Chat 应用。如需使用 HTTP 服务创建交互式 Chat 应用，请完成此快速入门。
• 将 Chat 应用添加到聊天室。如需添加 Chat 应用，请参阅 测试 Google Chat 应用的交互功能。

Python

• Python 3.6 或更高版本
• pip 软件包管理工具
• 启用了交互功能的 Google Chat 应用。如需使用 HTTP 服务创建交互式 Chat 应用，请完成此快速入门。
• 将 Chat 应用添加到聊天室。如需添加 Chat 应用，请参阅 测试 Google Chat 应用的交互功能。

Node.js

• Node.js 14 或更高版本
• npm 软件包管理工具
• 初始化的 Node.js 项目。如需初始化新项目，请创建并切换到新文件夹，然后在命令行界面中运行以下命令：

  npm init

• 启用了交互功能的 Google Chat 应用。如需使用 HTTP 服务创建交互式 Chat 应用，请完成此快速入门。
• 将 Chat 应用添加到聊天室。如需添加 Chat 应用，请参阅 测试 Google Chat 应用的交互功能。

Apps 脚本

• 启用了交互功能的 Google Chat 应用。如需在 Apps 脚本中创建交互式 Chat 应用，请完成此快速入门。
• 将 Chat 应用添加到聊天室。如需添加 Chat 应用，请参阅 测试 Google Chat 应用的交互功能。

Java

如需将 Google 客户端库和其他所需依赖项添加到 Maven 项目，请修改项目目录中的 pom.xml 文件，然后添加以下依赖项：

<dependencies>
  <!-- ... existing dependencies ... -->
  <dependency>
    <groupId>com.google.apis</groupId>
    <artifactId>google-api-services-chat</artifactId>
    <version>v1-rev20230905-2.0.0</version>
  </dependency>
  <dependency>
    <groupId>com.google.auth</groupId>
    <artifactId>google-auth-library-oauth2-http</artifactId>
    <version>1.19.0</version>
  </dependency>
  <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.10.1</version>
  </dependency>
</dependencies>

Python

如果您尚未安装 Python 版 Google 客户端库，请在命令行界面中运行以下命令：

pip3 install --upgrade google-api-python-client google-auth

Node.js

如需将 Google 客户端库添加到 Node.js 项目，请切换到项目的目录，然后在命令行界面中运行以下命令：

npm install "@googleapis/chat"

Apps 脚本

此示例使用 适用于 Apps 脚本的 OAuth2 库生成 JWT 令牌以进行服务账号身份验证。如需将该库添加到您的 Apps 脚本项目中，请执行以下操作：

1. 点击左侧的编辑器图标 code。
2. 在左侧，点击“库”旁边的添加库图标 add。
3. 输入脚本 ID 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF。
4. 点击查找，然后点击添加。

此示例使用高级聊天服务调用 Google Chat API。如需为您的 Apps Script 项目开启该服务，请执行以下操作：

1. 点击左侧的编辑器图标 code。
2. 在左侧的服务旁边，点击添加服务 add。
3. 选择 Google Chat API。
4. 在版本中，选择 v1。
5. 点击添加。

Java

1. 在项目目录中，打开 src/main/java/com/google/chat/app/authsample/App.java 文件。

2. 将 App.java 中的内容替换为以下代码：

   package com.google.chat.app.authsample;
   
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.HttpRequestInitializer;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.services.chat.v1.HangoutsChat;
   import com.google.api.services.chat.v1.model.Message;
   import com.google.auth.http.HttpCredentialsAdapter;
   import com.google.auth.oauth2.GoogleCredentials;
   
   /**
    * Authenticates with Chat API using service account credentials,
    * then creates a Chat message.
    */
   public class App {
       // Specify required scopes.
       private static final String CHAT_SCOPE = "https://www.googleapis.com/auth/chat.bot";
   
       // Specify service account details.
       private static final String PRIVATE_KEY_RESOURCE_URI = "/credentials.json";
   
       public static void main( String[] args ) {
           try {
               // Run app.
               Message response = App.createChatMessage();
               // Print details about the created message.
               System.out.println(response);
           } catch (Exception e) {
               e.printStackTrace();
           }
       }
   
       private static Message createChatMessage() throws Exception {
           // Build the Chat API client and authenticate with the service account.
           GoogleCredentials credentials = GoogleCredentials.fromStream(
               App.class.getResourceAsStream(PRIVATE_KEY_RESOURCE_URI))
               .createScoped(CHAT_SCOPE);
           HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);
           HangoutsChat chatService = new HangoutsChat.Builder(
               GoogleNetHttpTransport.newTrustedTransport(),
               GsonFactory.getDefaultInstance(),
               requestInitializer)
               .setApplicationName("auth-sample-app")
               .build();
   
           // The space to create the message in.
           //
           // Replace SPACE_NAME with a space name.
           // Obtain the space name from the spaces resource of Chat API,
           // or from a space's URL.
           String spaceName = "spaces/SPACE_NAME";
   
           // Create a Chat message.
           Message message = new Message().setText("Hello, world!");
           return chatService.spaces().messages().create(spaceName, message).execute();
       }
   }
   

3. 在代码中，将 SPACE_NAME 替换为聊天室名称，您可以通过 Chat API 中的 spaces.list 方法或聊天室的网址获取该名称。

4. 在项目目录中创建一个名为 resources 的新子目录。

5. 确保服务账号的私钥文件名为 credentials.json，并将其复制到 resources 子目录。

6. 如需配置 Maven 以在项目软件包中添加私钥文件，请修改项目目录中的 pom.xml 文件，并将以下配置添加到 <build> 部分：

   <build>
     <!-- ... existing configurations ... -->
     <resources>
       <resource>
         <directory>resources</directory>
       </resource>
     </resources>
   </build>
   

7. 如需配置 Maven 以将依赖项添加到项目软件包中并执行应用的主类，请修改项目目录中的 pom.xml 文件，并将以下配置添加到 <plugins> 部分：

   <plugins>
     <!-- ... existing configurations ... -->
     <plugin>
       <artifactId>maven-assembly-plugin</artifactId>
       <configuration>
         <archive>
           <manifest>
             <mainClass>com.google.chat.app.authsample.App</mainClass>
           </manifest>
         </archive>
         <descriptorRefs>
           <descriptorRef>jar-with-dependencies</descriptorRef>
         </descriptorRefs>
       </configuration>
     </plugin>
   </plugins>
   

Python

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

2. 在 chat_app_auth.py 中添加以下代码：

   from apiclient.discovery import build
   from google.oauth2 import service_account
   
   # Specify required scopes.
   SCOPES = ['https://www.googleapis.com/auth/chat.bot']
   
   # Specify service account details.
   creds = service_account.Credentials.from_service_account_file(
       'credentials.json', scopes=SCOPES)
   
   # Build the URI and authenticate with the service account.
   chat = build('chat', 'v1', credentials=creds)
   
   # Create a Chat message.
   result = chat.spaces().messages().create(
   
       # The space to create the message in.
       #
       # Replace SPACE_NAME with a space name.
       # Obtain the space name from the spaces resource of Chat API,
       # or from a space's URL.
       parent='spaces/SPACE_NAME',
   
       # The message to create.
       body={'text': 'Hello, world!'}
   
   ).execute()
   
   # Prints details about the created message.
   print(result)
   

3. 在代码中，将 SPACE_NAME 替换为聊天室名称，您可以通过 Chat API 中的 spaces.list 方法或聊天室的网址获取该名称。确保服务账号的私钥文件名为 credentials.json。

Node.js

1. 在项目目录中，创建一个名为 chat_app_auth.js 的文件。

2. 在 chat_app_auth.js 中添加以下代码：

   const chat = require('@googleapis/chat');
   
   async function createMessage() {
     const auth = new chat.auth.GoogleAuth({
   
       // Specify service account details.
       keyFilename: 'credentials.json',
   
       // Specify required scopes.
       scopes: ['https://www.googleapis.com/auth/chat.bot']
   
     });
     const authClient = await auth.getClient();
   
     // Create the Chat API client and authenticate with the service account.
     const chatClient = await chat.chat({
       version: 'v1',
       auth: authClient
     });
   
     // Create a Chat message.
     const result = await chatClient.spaces.messages.create({
   
       // The space to create the message in.
       //
       // Replace SPACE_NAME with a space name.
       // Obtain the space name from the spaces resource of Chat API,
       // or from a space's URL.
       parent: 'spaces/SPACE_NAME',
   
       // The message to create.
       requestBody: { 'text': 'Hello, world!' }
   
     });
     return result;
   }
   
   // Execute function then print details about the created message.
   createMessage().then(console.log);
   

3. 在代码中，将 SPACE_NAME 替换为聊天室名称，您可以通过 Chat API 中的 spaces.list 方法或聊天室的网址获取该名称。确保服务账号的私钥文件名为 credentials.json。

Apps 脚本

1. 在 Apps Script 编辑器中，修改 appsscript.json 文件，并添加发出外部请求以获取服务账号 OAuth 令牌所需的 OAuth 范围：

     "oauthScopes": [
       "https://www.googleapis.com/auth/script.external_request"
     ]
   

2. 将以下代码保存在 Apps Script 项目中名为 ChatAppAuth.gs 的文件中：

   // Specify the contents of the file credentials.json.
   const CREDENTIALS = CREDENTIALS;
   
   const SCOPE = 'https://www.googleapis.com/auth/chat.bot';
   
   // The space to create the message in.
   //
   // Replace SPACE_NAME with a space name.
   // Obtain the space name from the spaces resource of Chat API,
   // or from a space's URL.
   const PARENT = 'spaces/SPACE_NAME'
   
   /**
    * Authenticates with Chat API using app credentials, then posts a message.
    */
   function createMessageWithAppCredentials() {
     try {
       const service = getService_();
       if (!service.hasAccess()) {
         console.error(service.getLastError());
         return;
       }
   
       // Specify the message to create.
       const message = {'text': 'Hello world!'};
   
       // Call Chat API with a service account to create a message.
       const result = Chat.Spaces.Messages.create(
           message,
           PARENT,
           {},
           // Authenticate with the service account token.
           {'Authorization': 'Bearer ' + service.getAccessToken()});
   
       // Log details about the created message.
       console.log(result);
   
     } catch (err) {
       // TODO (developer) - Handle exception.
       console.log('Failed to create message with error %s', err.message);
     }
   }
   
   /**
    * Configures the OAuth library to authenticate with the service account.
    */
   function getService_() {
     return OAuth2.createService(CREDENTIALS.client_email)
         .setTokenUrl('https://oauth2.googleapis.com/token')
         .setPrivateKey(CREDENTIALS.private_key)
         .setIssuer(CREDENTIALS.client_email)
         .setSubject(CREDENTIALS.client_email)
         .setScope(SCOPE)
         .setPropertyStore(PropertiesService.getScriptProperties());
   }
   

3. 在代码中，将 CREDENTIALS 替换为文件 credentials.json 的内容。

4. 在代码中，将 SPACE_NAME 替换为聊天室名称，您可以通过 Chat API 中的 spaces.list 方法或聊天室的网址获取该名称。

Java

mvn compile assembly:single
java -jar target/auth-sample-app-1.0-SNAPSHOT-jar-with-dependencies.jar

Python

python3 chat_app_auth.py

Node.js

node chat_app_auth.js

Apps 脚本

在 Apps Script 编辑器中打开 ChatAppAuth.gs 文件，然后点击运行。