以 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 Script

• 已啟用互動功能的 Google Chat 應用程式。如要在 Apps Script 中建立互動式 Chat 應用程式，請完成這個快速入門。
• 將 Chat 應用程式新增至聊天室。如要新增 Chat 應用程式，請參閱「 測試 Google Chat 應用程式的互動功能」。

Java

如要在 Maven 專案中新增 Google 用戶端程式庫和其他必要依附元件，請編輯專案目錄中的 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 Script

這個範例會使用 Apps Script 程式庫的 OAuth2 產生 JWT 權杖，用於服務帳戶驗證。如要將程式庫新增至 Apps Script 專案，請按照下列步驟操作：

1. 按一下左側的「編輯器」圖示 code。
2. 在左側的「媒體庫」旁，按一下「新增媒體庫」圖示 add。
3. 輸入指令碼 ID 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF。
4. 依序點選「查詢」和「新增」。

這個範例會使用進階 Chat 服務呼叫 Google Chat API。如要為 Apps Script 專案啟用服務，請按照下列步驟操作：

1. 按一下左側的「編輯器」圖示 code。
2. 在左側的「服務」旁，按一下「新增服務」圖示 add。
3. 選取「Google Chat API」。
4. 在「Version」中，選取「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 Script

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 Script

在 Apps Script 編輯器中開啟檔案 ChatAppAuth.gs，然後按一下「Run」。