Melakukan autentikasi sebagai aplikasi Google Chat

Panduan ini menjelaskan cara menyiapkan dan menggunakan akun layanan untuk mengakses Google Chat API atas nama aplikasi Chat. Pertama, panduan ini akan memandu Anda terkait cara membuat akun layanan. Kemudian, bagian ini menunjukkan cara menulis skrip yang menggunakan akun layanan untuk melakukan autentikasi dengan Chat API dan memposting pesan dalam ruang Chat.

Aplikasi Chat dapat menggunakan akun layanan untuk mengautentikasi saat memanggil Google Chat API secara asinkron sehingga dapat:

  • Kirim pesan ke Google Chat dengan spaces.messages.create untuk:
    • Memberi tahu pengguna saat tugas latar belakang yang berjalan lama selesai berjalan.
    • Beri tahu pengguna bahwa server telah offline.
    • Minta staf dukungan pelanggan untuk menangani kasus pelanggan yang baru dibuka.
  • Perbarui pesan yang dikirim sebelumnya dengan spaces.messages.update untuk:
    • Mengubah status operasi yang sedang berjalan.
    • Memperbarui penerima tugas atau tanggal jatuh tempo.
  • Cantumkan pengguna dalam ruang dengan spaces.members.list untuk:
    • Melihat siapa saja yang ada dalam ruang.
    • Verifikasi bahwa keanggotaan ruang mencakup semua orang dalam tim.

Saat diautentikasi dengan akun layanan, untuk mendapatkan data tentang atau melakukan tindakan di ruang Chat, aplikasi Chat harus memiliki keanggotaan di ruang tersebut. Misalnya, untuk menampilkan daftar anggota ruang atau membuat pesan di ruang, aplikasi Chat harus menjadi anggota ruang tersebut.

Jika aplikasi Chat Anda perlu mengakses data pengguna atau melakukan tindakan atas nama pengguna, lakukan autentikasi sebagai pengguna.

Jika Anda adalah administrator domain, Anda dapat memberikan delegasi tingkat domain untuk mengizinkan akun layanan aplikasi mengakses data pengguna tanpa mengharuskan setiap pengguna memberikan izin. Setelah mengonfigurasi delegasi di seluruh domain, Anda dapat melakukan panggilan API menggunakan akun layanan untuk meniru akun pengguna. Meskipun akun layanan digunakan untuk autentikasi, delegasi seluruh domain meniru identitas pengguna sehingga dianggap sebagai autentikasi pengguna. Fungsi apa pun yang memerlukan autentikasi pengguna, Anda dapat menggunakan delegasi seluruh domain.

Untuk mempelajari lebih lanjut kapan aplikasi Chat memerlukan autentikasi dan jenis autentikasi yang akan digunakan, lihat Jenis autentikasi yang diperlukan di ringkasan autentikasi dan otorisasi Chat API.

Prasyarat

Untuk menjalankan contoh dalam panduan ini, Anda memerlukan prasyarat berikut:

Selain itu, Anda memerlukan prasyarat khusus bahasa berikut:

Java

  • JDK 1.7 atau yang lebih tinggi
  • Alat pengelolaan paket Maven
  • Project Maven yang diinisialisasi. Untuk menginisialisasi project 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
  • Alat pengelolaan paket pip

Node.js

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

    npm init
    

Apps Script

Langkah 1: Buat akun layanan di konsol Google Cloud

Buat akun layanan yang dapat digunakan aplikasi Chat Anda untuk mengakses Google API.

Membuat akun layanan

Untuk membuat akun layanan, ikuti langkah-langkah berikut:

Konsol Google Cloud

  1. Di konsol Google Cloud, buka Menu > IAM & Admin > Service Accounts.

    Buka Akun Layanan

  2. Klik Create service account.
  3. Isi detail akun layanan, lalu klik Buat dan lanjutkan.
  4. Opsional: Tetapkan peran ke akun layanan Anda untuk memberikan akses ke resource project Google Cloud Anda. Untuk detail selengkapnya, lihat Memberikan, mengubah, dan mencabut akses ke resource.
  5. Click Continue.
  6. Opsional: Masukkan pengguna atau grup yang dapat mengelola dan melakukan tindakan dengan akun layanan ini. Untuk detail selengkapnya, lihat Mengelola peniruan akun layanan.
  7. Klik Done. Catat alamat email untuk akun layanan.

gcloud CLI

  1. Buat akun layanan:
    gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
      --display-name="SERVICE_ACCOUNT_NAME"
  2. Opsional: Tetapkan peran ke akun layanan Anda untuk memberikan akses ke resource project Google Cloud Anda. Untuk detail selengkapnya, lihat Memberikan, mengubah, dan mencabut akses ke resource.

Akun layanan akan muncul di halaman akun layanan. Selanjutnya, buat kunci pribadi untuk akun layanan.

Membuat kunci pribadi

Untuk membuat dan mendownload kunci pribadi untuk akun layanan, ikuti langkah-langkah berikut:

  1. Di konsol Google Cloud, buka Menu > IAM & Admin > Service Accounts.

    Buka Akun Layanan

  2. Pilih akun layanan Anda.
  3. Klik Keys > Add key > Create new key.
  4. Pilih JSON, lalu klik Buat.

    Pasangan kunci umum/pribadi baru Anda akan dihasilkan dan didownload ke mesin sebagai file baru. Simpan file JSON yang didownload sebagai credentials.json di direktori kerja Anda. File ini adalah satu-satunya salinan kunci ini. Untuk mengetahui informasi tentang cara menyimpan kunci Anda dengan aman, lihat Mengelola kunci akun layanan.

  5. Klik Close.

Untuk mengetahui informasi selengkapnya tentang akun layanan, lihat akun layanan dalam dokumentasi Google Cloud IAM.

Langkah 2: Instal library klien Google dan dependensi lainnya

Instal library klien Google dan dependensi lain yang diperlukan untuk project.

Java

Untuk menambahkan library klien Google dan dependensi lain yang diperlukan ke project Maven Anda, edit file pom.xml di direktori project Anda dan 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 membuat token JWT untuk autentikasi akun layanan. Untuk menambahkan library ke project Apps Script:

  1. Di sebelah kiri, klik Editor .
  2. Di sebelah kiri, di samping Library, klik Tambahkan library .
  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 untuk project Apps Script Anda:

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

Anda dapat menggunakan bahasa apa pun yang didukung oleh library klien kami.

Langkah 3: Tulis skrip yang menggunakan akun layanan untuk melakukan autentikasi dengan Chat API

Kode berikut mengautentikasi dengan Chat API menggunakan akun layanan, lalu memposting pesan ke ruang Chat:

Java

  1. Dalam direktori project Anda, buka file 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 nama ruang, yang dapat Anda peroleh dari metode 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 dan 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 konfigurasi berikut 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 menjalankan class utama aplikasi Anda, edit file pom.xml di 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 Anda, 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 nama ruang, yang dapat Anda peroleh dari metode spaces.list di Chat API, atau dari URL ruang. Pastikan 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 nama ruang, yang dapat Anda peroleh dari metode spaces.list di Chat API, atau dari URL ruang. Pastikan 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 konten file credentials.json.

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

Langkah 4: Jalankan contoh lengkap

Di direktori kerja Anda, buat dan jalankan contoh:

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 Apps Script Editor, lalu klik Run.

Skrip Anda membuat permintaan terautentikasi ke Chat API, yang merespons dengan memposting pesan di ruang Chat sebagai aplikasi Chat.

Memecahkan masalah contoh

Bagian ini menjelaskan masalah umum yang mungkin Anda alami saat mencoba menjalankan contoh ini.

Anda tidak diizinkan menggunakan aplikasi ini

Saat menjalankan skrip, Anda mungkin menerima error yang menyatakan:

<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}/messages?alt=json returned "You are not permitted to use this app". Details: "You are not permitted to use this app">

Pesan error ini berarti bahwa aplikasi Chat tidak memiliki izin untuk membuat pesan Chat di ruang Chat yang ditentukan.

Untuk mengatasi error, tambahkan aplikasi Chat ke ruang Chat yang ditentukan dalam skrip.

Pelajari hal lain yang dapat dilakukan Chat API dengan meninjau dokumentasi referensi Chat API.