Melakukan autentikasi sebagai aplikasi Google Chat

Java

• JDK 1.7 atau yang lebih baru
• Maven alat pengelolaan paket

• Project Maven yang diinisialisasi. Untuk menginisialisasi proyek baru, jalankan perintah berikut di antarmuka command line Anda:

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

Python

• Python 3.6 atau yang lebih baru
• pip alat pengelolaan paket

Node.js

• Node.js
• npm alat pengelolaan paket

• Project Node.js yang diinisialisasi. Untuk menginisialisasi proyek baru, buat dan beralih ke folder baru, lalu jalankan perintah berikut di antarmuka command line Anda:

  npm init
  

Apps Script

• Project Apps Script yang terhubung ke project Google Cloud Anda. Kepada melakukan inisialisasi project Apps Script, lihat Panduan memulai aplikasi Chat Google Apps Script.

Java

Untuk menambahkan library klien Google dan dependensi lain yang diperlukan ke pada project Maven, edit file pom.xml di direktori project Anda lalu tambahkan dependensi berikut:

<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

Jika Anda belum menginstal library klien Google untuk Python, jalankan perintah berikut di antarmuka command line Anda:

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

Node.js

Untuk menambahkan library klien Google ke project Node.js Anda, beralihlah ke direktori project dan jalankan perintah berikut di antarmuka command line Anda:

npm install "@googleapis/chat"

Apps Script

Contoh ini menggunakan OAuth2 untuk library Apps Script guna menghasilkan token JWT untuk otentikasi akun layanan. Untuk menambahkan library ke project Apps Script Anda:

1. Di sebelah kiri, klik Editor code.
2. Di sebelah kiri, di samping Koleksi, klik Tambahkan koleksi add.
3. Masukkan ID skrip 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF.
4. Klik Cari, lalu klik Tambahkan.

Contoh ini menggunakan Layanan Chat lanjutan untuk memanggil Google Chat API. Untuk mengaktifkan layanan bagi Project Apps Script:

1. Di sebelah kiri, klik Editor code.
2. Di sebelah kiri, di samping Layanan, klik Tambahkan layanan add.
3. Pilih Google Chat API.
4. Di Version, pilih v1.
5. Klik Tambahkan.

Java

1. Di direktori project, buka file tersebut src/main/java/com/google/chat/app/authsample/App.java.

2. Ganti konten di App.java dengan kode berikut:

   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. Dalam kode, ganti SPACE_NAME dengan spasi Anda, yang dapat diperoleh dari spaces.list di Chat API, atau dari URL ruang.

4. Buat subdirektori baru bernama resources dalam direktori project Anda.

5. Pastikan file kunci pribadi untuk akun layanan Anda diberi nama credentials.json, lalu salin ke subdirektori resources.

6. Untuk mengonfigurasi Maven agar menyertakan file kunci pribadi dalam paket project, edit file pom.xml di direktori project Anda dan tambahkan berikut ini konfigurasi ke bagian <build>:

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

7. Untuk mengonfigurasi Maven agar menyertakan dependensi dalam paket project dan untuk mengeksekusi class utama aplikasi Anda, edit file pom.xml di pada direktori project dan tambahkan konfigurasi berikut ke Bagian <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. Di direktori kerja, buat file bernama chat_app_auth.py.

2. Sertakan kode berikut di 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. Dalam kode, ganti SPACE_NAME dengan spasi Anda, yang dapat diperoleh dari spaces.list di Chat API, atau dari URL ruang. Pastikan bahwa file kunci pribadi untuk akun layanan Anda diberi nama credentials.json.

Node.js

1. Di direktori project Anda, buat file bernama chat_app_auth.js.

2. Sertakan kode berikut di 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. Dalam kode, ganti SPACE_NAME dengan spasi Anda, yang dapat diperoleh dari spaces.list di Chat API, atau dari URL ruang. Pastikan bahwa file kunci pribadi untuk akun layanan Anda diberi nama credentials.json.

Apps Script

1. Di editor Apps Script, edit file appsscript.json dan tambahkan cakupan OAuth yang diperlukan untuk membuat permintaan eksternal guna mendapatkan token OAuth akun layanan:

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

2. Simpan kode berikut dalam file bernama ChatAppAuth.gs di project Apps Script Anda:

   // 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. Dalam kode, ganti CREDENTIALS dengan isi file credentials.json.

4. Dalam kode, ganti SPACE_NAME dengan spasi Anda, yang dapat diperoleh dari spaces.list di Chat API, atau dari URL ruang.

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

Buka file ChatAppAuth.gs di Editor Apps Script dan klik Run.