Xác thực dưới dạng ứng dụng Google Chat

Java

• JDK 1.7 trở lên
• Công cụ quản lý gói Maven
• Một dự án Maven đã khởi tạo. Để khởi chạy một dự án mới, hãy chạy lệnh sau trong giao diện dòng lệnh:

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

• Một ứng dụng Google Chat đã bật các tính năng tương tác. Để tạo một tương tác bằng ứng dụng Chat bằng dịch vụ HTTP, hãy hoàn thành phần bắt đầu nhanh này.
• Thêm ứng dụng Chat vào một không gian. Để thêm Ứng dụng Chat, hãy xem Kiểm thử các tính năng tương tác cho các ứng dụng của Google Chat.

Python

• Python 3.6 trở lên
• Công cụ quản lý gói pip
• Một ứng dụng Google Chat đã bật các tính năng tương tác. Để tạo một tương tác bằng ứng dụng Chat bằng dịch vụ HTTP, hãy hoàn thành phần bắt đầu nhanh này.
• Thêm ứng dụng Chat vào một không gian. Để thêm Ứng dụng Chat, hãy xem Kiểm thử các tính năng tương tác cho các ứng dụng của Google Chat.

Node.js

• Node.js 14 trở lên
• npm công cụ quản lý gói
• Một dự án Node.js đã khởi tạo. Để khởi chạy một dự án mới, hãy tạo và chuyển sang một thư mục mới, sau đó chạy lệnh sau trong giao diện dòng lệnh:

  npm init

• Một ứng dụng Google Chat đã bật các tính năng tương tác. Để tạo một tương tác bằng ứng dụng Chat bằng dịch vụ HTTP, hãy hoàn thành phần bắt đầu nhanh này.
• Thêm ứng dụng Chat vào một không gian. Để thêm Ứng dụng Chat, hãy xem Kiểm thử các tính năng tương tác cho các ứng dụng của Google Chat.

Apps Script

• Một ứng dụng Google Chat đã bật các tính năng tương tác. Để tạo một ứng dụng Chat tương tác trong Apps Script, hãy hoàn thành phần bắt đầu nhanh này.
• Thêm ứng dụng Chat vào một không gian. Để thêm Ứng dụng Chat, hãy xem Kiểm thử các tính năng tương tác cho các ứng dụng của Google Chat.

Java

Để thêm thư viện ứng dụng của Google và các phần phụ thuộc bắt buộc khác vào Dự án Maven, hãy chỉnh sửa tệp pom.xml trong thư mục của dự án rồi thêm phần tử các phần phụ thuộc sau:

<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

Nếu bạn chưa cài đặt thư viện ứng dụng của Google cho Python, hãy chạy lệnh sau trong giao diện dòng lệnh:

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

Node.js

Để thêm các thư viện ứng dụng của Google vào dự án Node.js, hãy chuyển sang thư mục của dự án và chạy lệnh sau trong giao diện dòng lệnh:

npm install "@googleapis/chat"

Apps Script

Mẫu này sử dụng phương pháp OAuth2 cho thư viện Apps Script để tạo mã thông báo JWT nhằm xác thực tài khoản dịch vụ. Cách thêm thư viện vào dự án Apps Script:

1. Ở bên trái, hãy nhấp vào biểu tượng Trình chỉnh sửa code.
2. Ở bên trái, bên cạnh mục Thư viện, hãy nhấp vào Thêm thư viện add.
3. Nhập mã tập lệnh 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF.
4. Nhấp vào Tra cứu, rồi nhấp vào Thêm.

Mẫu này sử dụng phương pháp Dịch vụ Chat nâng cao để gọi API Google Chat. Để bật dịch vụ cho Dự án Apps Script:

1. Ở bên trái, hãy nhấp vào biểu tượng Trình chỉnh sửa code.
2. Ở bên trái, bên cạnh Dịch vụ, hãy nhấp vào Thêm dịch vụ add.
3. Chọn API Google Chat.
4. Trong Phiên bản, hãy chọn v1.
5. Nhấp vào Thêm.

Java

1. Trong thư mục của dự án, hãy mở tệp src/main/java/com/google/chat/app/authsample/App.java.

2. Thay thế nội dung trong App.java bằng mã sau:

   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 via 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. Trong mã, hãy thay thế SPACE_NAME bằng một dấu cách mà bạn có thể lấy từ spaces.list trong API Chat hoặc từ URL của một không gian.

4. Tạo một thư mục con mới có tên là resources trong thư mục của dự án.

5. Đảm bảo rằng bạn đã đặt tên cho tệp khoá riêng tư cho tài khoản dịch vụ của mình credentials.json rồi sao chép tệp này vào thư mục con resources.

6. Cách định cấu hình Maven đưa tệp khoá riêng tư vào gói dự án: chỉnh sửa tệp pom.xml trong thư mục của dự án và thêm đoạn mã sau cấu hình cho phần <build>:

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

7. Để định cấu hình Maven đưa các phần phụ thuộc vào gói dự án và để thực thi lớp chính của ứng dụng, hãy chỉnh sửa tệp pom.xml trong thư mục của dự án và thêm cấu hình sau vào thư mục Mục <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. Trong thư mục đang làm việc, hãy tạo một tệp có tên chat_app_auth.py.

2. Đưa mã sau vào 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.
   CREDENTIALS = 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=CREDENTIALS)
   
   # 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. Trong mã, hãy thay thế SPACE_NAME bằng một dấu cách mà bạn có thể lấy từ spaces.list trong API Chat hoặc từ URL của một không gian. Hãy đảm bảo rằng tệp khoá riêng tư cho tài khoản dịch vụ của bạn có tên là credentials.json.

Node.js

1. Trong thư mục của dự án, hãy tạo một tệp có tên chat_app_auth.js.

2. Đưa mã sau vào 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. Trong mã, hãy thay thế SPACE_NAME bằng một dấu cách mà bạn có thể lấy từ spaces.list trong API Chat hoặc từ URL của một không gian. Hãy đảm bảo rằng tệp khoá riêng tư cho tài khoản dịch vụ của bạn có tên là credentials.json.

Apps Script

1. Trong trình chỉnh sửa Apps Script, hãy chỉnh sửa tệp appsscript.json và thêm phạm vi OAuth cần thiết để thực hiện các yêu cầu bên ngoài nhằm lấy mã thông báo OAuth của tài khoản dịch vụ:

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

2. Lưu mã sau trong tệp có tên ChatAppAuth.gs trong dự án Apps Script của bạn:

   // 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 via 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. Trong mã này, hãy thay thế CREDENTIALS bằng nội dung của tệp credentials.json.

4. Trong mã, hãy thay thế SPACE_NAME bằng một dấu cách mà bạn có thể lấy từ spaces.list trong API Chat hoặc từ URL của một không gian.

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 Script

Mở tệp ChatAppAuth.gs trong Trình chỉnh sửa Apps Script và nhấp vào Run (Chạy).