Membangun aplikasi Google Chat HTTP

Halaman ini menjelaskan cara membangun add-on Google Workspace yang berfungsi di Google Chat menggunakan layanan HTTP.

Catatan: Di Google Chat, add-on muncul kepada pengguna sebagai aplikasi Google Chat. Anda juga dapat membangun aplikasi Chat menggunakan peristiwa interaksi Google Chat API. Untuk mempelajari lebih lanjut, lihat Ringkasan memperluas Google Chat.

Panduan memulai ini menunjukkan cara membangun layanan HTTP menggunakan layanan Google Cloud. Untuk membangun aplikasi Chat, Anda menulis dan men-deploy a Cloud Run Function yang digunakan aplikasi Chat untuk merespons pesan pengguna.

Dengan arsitektur HTTP, Anda mengonfigurasi Chat untuk berintegrasi dengan Google Cloud atau server lokal menggunakan HTTP, seperti yang ditunjukkan dalam diagram berikut:

Dalam diagram sebelumnya, pengguna yang berinteraksi dengan aplikasi Chat HTTP memiliki alur informasi berikut:

1. Pengguna mengirim pesan di Chat ke aplikasi Chat, baik dalam pesan langsung maupun di ruang Chat.
2. Permintaan HTTP dikirim ke server web yang merupakan sistem cloud atau lokal yang berisi logika aplikasi Chat.
3. Secara opsional, logika aplikasi Chat dapat berintegrasi dengan layanan Google Workspace (seperti Kalender dan Spreadsheet), layanan Google lainnya (seperti Maps, YouTube, dan Vertex AI), atau layanan web lainnya (seperti sistem pengelolaan project atau alat tiket).
4. Server web mengirimkan respons HTTP kembali ke layanan aplikasi Chat di Chat.
5. Respons dikirimkan kepada pengguna.
6. Secara opsional, aplikasi Chat dapat memanggil Chat API untuk memposting pesan secara asinkron atau melakukan operasi lainnya.

Arsitektur ini memberikan fleksibilitas untuk menggunakan library dan komponen yang sudah ada di sistem Anda karena aplikasi Chat ini dapat didesain menggunakan bahasa pemrograman yang berbeda.

Tujuan

• Menyiapkan lingkungan Anda.
• Membuat dan men-deploy Cloud Run Function.
• Mengonfigurasi add-on Google Workspace untuk aplikasi Chat.
• Menguji aplikasi.

Prasyarat

• Akun Google Workspace Bisnis atau Enterprise dengan akses ke Google Chat.
• Project Google Cloud yang mengaktifkan penagihan. Untuk memeriksa apakah penagihan diaktifkan untuk project yang ada, lihat Memverifikasi status penagihan project Anda. Untuk membuat project dan menyiapkan penagihan, lihat Membuat project Google Cloud.

Menyiapkan lingkungan

Sebelum menggunakan Google API, Anda harus mengaktifkannya di project Google Cloud. Anda dapat mengaktifkan satu atau beberapa API dalam satu project Google Cloud.

• Di konsol Google Cloud, aktifkan Cloud Build API, Cloud Functions API, Cloud Pub/Sub API, Cloud Logging API, Artifact Registry API, dan Cloud Run API.

  Aktifkan API

Membuat dan men-deploy Cloud Run Function

Buat dan deploy Cloud Run Function yang menghasilkan kartu Chat dengan nama tampilan dan gambar avatar pengirim. Saat menerima pesan, aplikasi Chat akan menjalankan fungsi dan merespons dengan kartu.

Untuk membuat dan men-deploy fungsi untuk aplikasi Chat, selesaikan langkah-langkah berikut:

Node.js

1. Di konsol Google Cloud, buka halaman Cloud Run:

   Buka Cloud Run

   Pastikan project untuk aplikasi Chat Anda dipilih.

2. Klik Write a function.

3. Di halaman Create service, siapkan fungsi Anda:

   1. Di kolom Service name, masukkan addonchatapp.
   2. Di daftar Region, pilih region.
   3. Di daftar Runtime, pilih versi Node.js terbaru.
   4. Di bagian Authentication, pilih Require authentication.
   5. Klik Create, lalu tunggu Cloud Run membuat layanan. Konsol akan mengalihkan Anda ke tab Source.

4. Di tab Source:

   1. Di Entry point, hapus teks default dan masukkan avatarApp.
   2. Ganti konten index.js dengan kode berikut:
   node/chat/avatar-app/index.js

   Lihat di GitHub
   import { http } from '@google-cloud/functions-framework';
   
   // The ID of the slash command "/about".
   // You must use the same ID in the Google Chat API configuration.
   const ABOUT_COMMAND_ID = 1;
   
   /**
    * Handle requests from Google Workspace add on
    *
    * @param {Object} req Request sent by Google Chat
    * @param {Object} res Response to be sent back to Google Chat
    */
   http('avatarApp', (req, res) => {
     const chatEvent = req.body.chat;
     let message;
     if (chatEvent.appCommandPayload) {
       message = handleAppCommand(chatEvent);
     } else {
       message = handleMessage(chatEvent);
     }
     res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: {
       message: message
     }}}});
   });
   
   /**
    * Responds to an APP_COMMAND event in Google Chat.
    *
    * @param {Object} event the event object from Google Chat
    * @return the response message object.
    */
   function handleAppCommand(event) {
     switch (event.appCommandPayload.appCommandMetadata.appCommandId) {
       case ABOUT_COMMAND_ID:
         return {
           text: 'The Avatar app replies to Google Chat messages.'
         };
     }
   }
   
   /**
    * Responds to a MESSAGE event in Google Chat.
    *
    * @param {Object} event the event object from Google Chat
    * @return the response message object.
    */
   function handleMessage(event) {
     // Stores the Google Chat user as a variable.
     const chatUser = event.messagePayload.message.sender;
     const displayName = chatUser.displayName;
     const avatarUrl = chatUser.avatarUrl;
     return {
       text: 'Here\'s your avatar',
       cardsV2: [{
         cardId: 'avatarCard',
         card: {
           name: 'Avatar Card',
           header: {
             title: `Hello ${displayName}!`,
           },
           sections: [{ widgets: [{
             textParagraph: { text: 'Your avatar picture: ' }
           }, {
             image: { imageUrl: avatarUrl }
           }]}]
         }
       }]
     };
   }

   1. Klik Save and redeploy.

Python

1. Di konsol Google Cloud, buka halaman Cloud Run:

   Buka Cloud Run

   Pastikan project untuk aplikasi Chat Anda dipilih.

2. Klik Write a function.

3. Di halaman Create service, siapkan fungsi Anda:

   1. Di kolom Service name, masukkan addonchatapp.
   2. Di daftar Region, pilih region.
   3. Di daftar Runtime, pilih versi Python terbaru.
   4. Di bagian Authentication, pilih Require authentication.
   5. Klik Create, lalu tunggu Cloud Run membuat layanan. Konsol akan mengalihkan Anda ke tab Source.

4. Di tab Source:

   1. Di Entry point, hapus teks default dan masukkan avatar_app.
   2. Ganti konten main.py dengan kode berikut:
   python/chat/avatar-app/main.py

   Lihat di GitHub
   from typing import Any, Mapping
   
   import flask
   import functions_framework
   
   # The ID of the slash command "/about".
   # You must use the same ID in the Google Chat API configuration.
   ABOUT_COMMAND_ID = 1
   
   @functions_framework.http
   def avatar_app(req: flask.Request) -> Mapping[str, Any]:
     """Handle requests from Google Workspace add on
   
     Args:
       flask.Request req: the request sent by Google Chat
   
     Returns:
       Mapping[str, Any]: the response to be sent back to Google Chat
     """
     chat_event = req.get_json(silent=True)["chat"]
     if chat_event and "appCommandPayload" in chat_event:
       message = handle_app_command(chat_event)
     else:
       message = handle_message(chat_event)
     return { "hostAppDataAction": { "chatDataAction": { "createMessageAction": {
         "message": message
     }}}}
   
   def handle_app_command(event: Mapping[str, Any]) -> Mapping[str, Any]:
     """Responds to an APP_COMMAND event in Google Chat.
   
     Args:
       Mapping[str, Any] event: the event object from Google Chat
   
     Returns:
       Mapping[str, Any]: the response message object.
     """
     if event["appCommandPayload"]["appCommandMetadata"]["appCommandId"] == ABOUT_COMMAND_ID:
       return {
         "text": "The Avatar app replies to Google Chat messages.",
       }
     return {}
   
   def handle_message(event: Mapping[str, Any]) -> Mapping[str, Any]:
     """Responds to a MESSAGE event in Google Chat.
   
     Args:
       Mapping[str, Any] event: the event object from Google Chat
   
     Returns:
       Mapping[str, Any]: the response message object.
     """
     # Stores the Google Chat user as a variable.
     chat_user = event["messagePayload"]["message"]["sender"]
     display_name = chat_user.get("displayName", "")
     avatar_url = chat_user.get("avatarUrl", "")
     return {
       "text": "Here's your avatar",
       "cardsV2": [{
         "cardId": "avatarCard",
         "card": {
           "name": "Avatar Card",
           "header": {
             "title": f"Hello {display_name}!"
           },
           "sections": [{ "widgets": [
             { "textParagraph": { "text": "Your avatar picture:" }},
             { "image": { "imageUrl": avatar_url }},
           ]}]
         }
       }]
     }

   1. Klik Save and redeploy.

Java

1. Di konsol Google Cloud, buka halaman Cloud Run:

   Buka Cloud Run

   Pastikan project untuk aplikasi Chat Anda dipilih.

2. Klik Write a function.

3. Di halaman Create service, siapkan fungsi Anda:

   1. Di kolom Service name, masukkan addonchatapp.
   2. Di daftar Region, pilih region.
   3. Di daftar Runtime, pilih versi Java terbaru.
   4. Di bagian Authentication, pilih Require authentication.
   5. Klik Create, lalu tunggu Cloud Run membuat layanan. Konsol akan mengalihkan Anda ke tab Source.

4. Di tab Source:

   1. Di Entry point, hapus teks default dan masukkan App.
   2. Ganti nama file Java default menjadi src/main/java/com/google/chat/avatar/App.java.
   3. Ganti konten App.java dengan kode berikut:
   java/chat/avatar-app/src/main/java/com/google/chat/avatar/App.java

   Lihat di GitHub
   package com.google.chat.avatar;
   
   import com.google.api.services.chat.v1.model.CardWithId;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1Card;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1CardHeader;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1Image;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1Section;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1TextParagraph;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1Widget;
   import com.google.api.services.chat.v1.model.Message;
   import com.google.cloud.functions.HttpFunction;
   import com.google.cloud.functions.HttpRequest;
   import com.google.cloud.functions.HttpResponse;
   import com.google.gson.Gson;
   import com.google.gson.JsonObject;
   import java.util.List;
   
   public class App implements HttpFunction {
     // The ID of the slash command "/about".
     // You must use the same ID in the Google Chat API configuration.
     private static final int ABOUT_COMMAND_ID = 1;
   
     private static final Gson gson = new Gson();
   
     /**
      * Handle requests from Google Workspace add on
      * 
      * @param request the request sent by Google Chat
      * @param response the response to be sent back to Google Chat
      */
     @Override
     public void service(HttpRequest request, HttpResponse response) throws Exception {
       JsonObject event = gson.fromJson(request.getReader(), JsonObject.class);
       JsonObject chatEvent = event.getAsJsonObject("chat");
       Message message;
       if (chatEvent.has("appCommandPayload")) {
         message = handleAppCommand(chatEvent);
       } else {
         message = handleMessage(chatEvent);
       }
       JsonObject createMessageAction = new JsonObject();
       createMessageAction.add("message", gson.fromJson(gson.toJson(message), JsonObject.class));
       JsonObject chatDataAction = new JsonObject();
       chatDataAction.add("createMessageAction", createMessageAction);
       JsonObject hostAppDataAction = new JsonObject();
       hostAppDataAction.add("chatDataAction", chatDataAction);
       JsonObject dataActions = new JsonObject();
       dataActions.add("hostAppDataAction", hostAppDataAction);
       response.getWriter().write(gson.toJson(dataActions));
     }
   
     /**
      * Handles an APP_COMMAND event in Google Chat.
      *
      * @param event the event object from Google Chat
      * @return the response message object.
      */
     private Message handleAppCommand(JsonObject event) throws Exception {
       switch (event.getAsJsonObject("appCommandPayload")
         .getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt()) {
         case ABOUT_COMMAND_ID:
           return new Message()
             .setText("The Avatar app replies to Google Chat messages.");
         default:
           return null;
       }
     }
   
     /**
      * Handles a MESSAGE event in Google Chat.
      *
      * @param event the event object from Google Chat
      * @return the response message object.
      */
     private Message handleMessage(JsonObject event) throws Exception {
       // Stores the Google Chat user as a variable.
       JsonObject chatUser = event.getAsJsonObject("messagePayload").getAsJsonObject("message").getAsJsonObject("sender");
       String displayName = chatUser.has("displayName") ? chatUser.get("displayName").getAsString() : "";
       String avatarUrl = chatUser.has("avatarUrl") ? chatUser.get("avatarUrl").getAsString() : "";
       return new Message()
         .setText("Here's your avatar")
         .setCardsV2(List.of(new CardWithId()
           .setCardId("avatarCard")
           .setCard(new GoogleAppsCardV1Card()
             .setName("Avatar Card")
             .setHeader(new GoogleAppsCardV1CardHeader()
               .setTitle(String.format("Hello %s!", displayName)))
             .setSections(List.of(new GoogleAppsCardV1Section().setWidgets(List.of(
               new GoogleAppsCardV1Widget().setTextParagraph(new GoogleAppsCardV1TextParagraph()
                 .setText("Your avatar picture:")),
               new GoogleAppsCardV1Widget()
                 .setImage(new GoogleAppsCardV1Image().setImageUrl(avatarUrl)))))))));
     }
   }

5. Ganti konten pom.xml dengan kode berikut:

   java/chat/avatar-app/pom.xml

   Lihat di GitHub
   <project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
   
     <groupId>com.google.chat</groupId>
     <artifactId>avatar-app</artifactId>
     <version>1.0-SNAPSHOT</version>
   
     <properties>
       <maven.compiler.target>17</maven.compiler.target>
       <maven.compiler.source>17</maven.compiler.source>
     </properties>
   
     <dependencies>
       <dependency>
         <groupId>com.google.cloud.functions</groupId>
         <artifactId>functions-framework-api</artifactId>
         <version>1.1.4</version>
       </dependency>
       <dependency>
         <groupId>com.google.code.gson</groupId>
         <artifactId>gson</artifactId>
         <version>2.9.1</version>
       </dependency>
       <dependency>
         <groupId>com.google.apis</groupId>
         <artifactId>google-api-services-chat</artifactId>
         <version>v1-rev20230115-2.0.0</version>
       </dependency>
     </dependencies>
   
     <build>
       <plugins>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-compiler-plugin</artifactId>
           <version>3.8.1</version>
           <configuration>
           <excludes>
             <exclude>.google/</exclude>
           </excludes>
           </configuration>
         </plugin>
       </plugins>
     </build>
   </project>

   1. Klik Save and redeploy.

Halaman detail layanan Cloud Run akan terbuka. Tunggu hingga fungsi di-deploy.

Mengonfigurasi add-on

Setelah Cloud Run Function di-deploy, ikuti langkah-langkah berikut untuk membuat add-on dan men-deploy aplikasi Google Chat:

1. Di konsol Google Cloud, buka halaman Cloud Run:

   Buka Cloud Run

   Pastikan project yang mengaktifkan Cloud Run dipilih.

2. Dalam daftar fungsi, klik addonchatapp.

3. Di halaman Service details, salin URL untuk fungsi tersebut. URL tersebut diakhiri dengan run.app.

4. Di kolom penelusuran Google Cloud, telusuri "Google Chat API", lalu klik Google Chat API, dan klik Manage.

   Buka Chat API

5. Klik Configuration dan siapkan aplikasi Google Chat:

   1. Di App name, masukkan Add-on Chat app.
   2. Di Avatar URL, masukkan https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png.
   3. Di Description, masukkan Add-on Chat app.
   4. Di bagian Functionality, pilih Join spaces and group conversations.
   5. Di bagian Connection settings, pilih HTTP endpoint URL.
   6. Di bagian Triggers, pilih Use a common HTTP endpoint URL for all triggers, lalu tempel URL untuk pemicu Cloud Run Function ke dalam kotak.
   7. Di bagian Visibility, pilih Make this Google Chat app available to specific people and groups di domain Anda, lalu masukkan alamat email Anda.
   8. Di bagian Logs, pilih Log errors to Logging.

6. Klik Save.

7. Di bagian Connection settings, salin Service account email. Anda memerlukan email ini saat mengizinkan add-on untuk memanggil fungsi Anda.

Selanjutnya, izinkan aplikasi Chat untuk memanggil Cloud Run Function.

Mengizinkan Google Chat untuk memanggil fungsi Anda

Untuk mengizinkan add-on Google Workspace memanggil fungsi Anda, tambahkan akun layanan add-on Google Workspace dengan peran Cloud Run Service Invoker.

1. Di konsol Google Cloud, buka halaman Cloud Run:

   Buka Cloud Run

2. Dalam daftar layanan Cloud Run, centang kotak di samping fungsi penerima. (Jangan klik fungsi itu sendiri.)

3. Klik Permissions. Panel Permissions akan terbuka.

4. Klik Add principal.

5. Di New principals, masukkan alamat email akun layanan add-on Google Workspace yang terkait dengan aplikasi Chat Anda.

   Alamat email akun layanan ada di halaman konfigurasi Chat API, di bagian Connection settings > HTTP endpoint URL > Service Account Email:

   Buka konfigurasi Chat API

6. Di Select a role, pilih Cloud Run > Cloud Run Invoker.

7. Klik Save.

Aplikasi Chat siap menerima dan merespons pesan di Chat.

Menguji aplikasi Chat Anda

Untuk menguji aplikasi Chat, buka ruang pesan langsung dengan aplikasi Chat dan kirim pesan:

1. Buka Google Chat menggunakan akun Google Workspace yang Anda berikan saat menambahkan diri Anda sebagai penguji tepercaya.

   Buka Google Chat

2. Klik Chat baru.
3. Di kolom Tambahkan 1 atau beberapa orang, ketik nama aplikasi Chat Anda.

4. Pilih aplikasi Chat Anda dari hasil. Pesan langsung akan terbuka.

   Catatan: Jika Anda tidak melihat aplikasi Chat di daftar hasil, pastikan Anda telah menyertakan akun Google Workspace di setelan Visibility halaman Chat API Configuration di konsol Google Cloud.
5. Di pesan langsung baru dengan aplikasi, ketik Hello, lalu tekan enter.

Pesan aplikasi Chat berisi kartu yang menampilkan nama dan gambar avatar pengirim, seperti yang ditunjukkan pada gambar berikut:

Untuk menambahkan penguji tepercaya dan mempelajari lebih lanjut cara menguji fitur interaktif, lihat Menguji fitur interaktif untuk aplikasi Google Chat.

Memecahkan masalah

Saat aplikasi atau kartu Google Chat menampilkan error, antarmuka Chat akan menampilkan pesan yang mengatakan "Terjadi masalah." atau "Tidak dapat memproses permintaan Anda." Terkadang, UI Chat tidak menampilkan pesan error apa pun, tetapi aplikasi atau kartu Chat menghasilkan hasil yang tidak terduga; misalnya, pesan kartu mungkin tidak muncul.

Meskipun pesan error mungkin tidak ditampilkan di UI Chat, pesan error deskriptif dan data log tersedia untuk membantu Anda memperbaiki error saat logging error untuk aplikasi Chat diaktifkan. Untuk mendapatkan bantuan dalam melihat, men-debug, dan memperbaiki error, lihat Memecahkan masalah dan memperbaiki error Google Chat.

Pembersihan

Agar tidak menimbulkan biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam tutorial ini, sebaiknya hapus project Cloud.

Perhatian: Penghapusan project akan mengakibatkan:

• Semua hal dalam project akan dihapus. Jika Anda menggunakan project yang ada untuk tutorial ini, saat menghapusnya, Anda juga akan menghapus pekerjaan lain yang telah Anda lakukan di project tersebut.
• Project ID kustom akan hilang. Saat membuat project ini, Anda mungkin telah membuat project ID kustom yang masih ingin Anda gunakan pada masa mendatang. Untuk mempertahankan URL yang menggunakan project ID tersebut, seperti URL di appspot.com, hapus resource yang dipilih di dalam project, alih-alih menghapus seluruh project.

Jika Anda berencana mempelajari beberapa tutorial dan panduan memulai, menggunakan kembali project dapat membantu Anda agar tidak melampaui batas kuota project.

1. Di konsol Google Cloud, buka halaman Manage resources. Klik Menu > IAM & Admin > Manage Resources.

   Buka Resource Manager

2. Pada daftar project, pilih project yang ingin Anda hapus, lalu klik Delete .
3. Pada dialog, ketik project ID, lalu klik Shut down untuk menghapus the project.