Membangun aplikasi Google Chat HTTP

Halaman ini menjelaskan cara mem-build Add-on Google Workspace yang berfungsi di Google Chat menggunakan layanan HTTP. Di Google Chat, add-on akan muncul kepada pengguna sebagai aplikasi Google Chat. Untuk mempelajari lebih lanjut, lihat Ringkasan memperluas Google Chat.

Panduan memulai ini menunjukkan cara mem-build layanan HTTP menggunakan layanan Google Cloud. Untuk mem-build aplikasi Chat, Anda menulis dan men-deploy Cloud 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:

Pada 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 Sheet), layanan Google lainnya (seperti Maps, YouTube, dan Vertex AI), atau layanan web lainnya (seperti sistem pengelolaan project atau alat penjualan 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 memberi Anda fleksibilitas untuk menggunakan library dan komponen yang sudah ada di sistem Anda karena aplikasi Chat ini dapat dirancang menggunakan bahasa pemrograman yang berbeda.

Tujuan

• Siapkan lingkungan Anda.
• Membuat dan men-deploy Cloud Function.
• Mengonfigurasi Add-on Google Workspace untuk aplikasi Chat.
• Uji aplikasi.

Prasyarat

• Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
• Project Google Cloud yang mengaktifkan penagihan. Untuk memeriksa apakah project yang ada telah mengaktifkan penagihan, 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 Google Chat API, Cloud Build API, Cloud Functions API, Cloud Pub/Sub API, Cloud Logging API, Artifact Registry API, dan Cloud Run API.

  Anda juga harus mengaktifkan Google Workspace Add-ons API, tetapi Anda tidak dapat menggunakan API ini untuk membuat dan mengelola deployment aplikasi Chat. Untuk mengetahui detailnya, lihat Batasan dan masalah umum.

  Aktifkan API

Membuat dan men-deploy Cloud Function

Buat dan deploy Cloud 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 Functions:

   Buka Cloud Functions

   Pastikan project untuk aplikasi Chat Anda dipilih.

2. Klik Create Function.

3. Di halaman Create function, siapkan fungsi Anda:

   1. Di Environment, pilih Cloud Run Function.
   2. Di Function name, masukkan AddOnChatApp.
   3. Di Region, pilih region.
   4. Di bagian Authentication, pilih Require authentication.
   5. Klik Berikutnya.

4. Di Runtime, pilih Node.js versi terbaru.

5. Di Source code, pilih Inline Editor.

6. Di Entry point, hapus teks default dan masukkan avatarApp.

7. Ganti konten index.js dengan kode berikut:

   /**
    * Google Cloud Function that responds to messages sent from a
    * Google Chat space.
    *
    * @param {Object} req Request sent from Google Chat space
    * @param {Object} res Response to send back
    */
   exports.avatarApp = function avatarApp(req, res) {
       if (req.method === 'GET' || !req.body.chat) {
           return res.send('Hello! This function is meant to be used ' +
               'in a Google Chat Space.');
       }
   
       // Stores the Google Chat event as a variable.
       const chatMessage = req.body.chat.messagePayload.message;
   
       // Replies with the sender's avatar in a card.
       const displayName = chatMessage.sender.displayName;
       const avatarUrl = chatMessage.sender.avatarUrl;
       res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
           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 }
                       }]
                   }]
               }
           }]
       }}}}});
   };
   

8. Klik Deploy.

Python

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

   Buka Cloud Functions

   Pastikan project untuk aplikasi Chat Anda dipilih.

2. Klik Create Function.

3. Di halaman Create function, siapkan fungsi Anda:

   1. Di Environment, pilih Cloud Run Function.
   2. Di Function name, masukkan AddOnChatApp.
   3. Di Region, pilih region.
   4. Di bagian Authentication, pilih Require authentication.
   5. Klik Berikutnya.

4. Di Runtime, pilih versi Python terbaru.

5. Di Source code, pilih Inline Editor.

6. Di Entry point, hapus teks default dan masukkan avatar_app.

7. Ganti konten main.py dengan kode berikut:

   from typing import Any, Mapping
   
   import flask
   import functions_framework
   
   @functions_framework.http
   def avatar_app(req: flask.Request) -> Mapping[str, Any]:
       """Google Cloud Function that handles requests from Google Chat
   
       Args:
           flask.Request: the request
   
       Returns:
           Mapping[str, Any]: the response
       """
       if req.method == "GET":
           return "Hello! This function must be called from Google Chat."
   
       request_json = req.get_json(silent=True)
   
       # Stores the Google Chat event as a variable.
       chat_message = request_json["chat"]["messagePayload"]["message"]
   
       # Replies with the sender's avatar in a card.
       display_name = chat_message["sender"]["displayName"]
       avatar_url = chat_message["sender"]["avatarUrl"]
       return { "hostAppDataAction": { "chatDataAction": { "createMessageAction": { "message": {
           "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 }
                       }]
                   }]
               }
           }]
       }}}}}
   

8. Klik Deploy.

Java

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

   Buka Cloud Functions

   Pastikan project untuk aplikasi Chat Anda dipilih.

2. Klik Create Function.

3. Di halaman Create function, siapkan fungsi Anda:

   1. Di Environment, pilih Cloud Run Function.
   2. Di Function name, masukkan AddOnChatApp.
   3. Di Region, pilih region.
   4. Di bagian Authentication, pilih Require authentication.
   5. Klik Berikutnya.

4. Di Runtime, pilih versi Java terbaru.

5. Di Source code, pilih Inline Editor.

6. Di Entry point, hapus teks default dan masukkan AvatarApp.

7. Ganti nama file Java default menjadi src/main/java/AvatarApp.java.

8. Ganti konten AvatarApp.java dengan kode berikut:

   import java.util.List;
   
   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;
   
   public class AvatarApp implements HttpFunction {
       private static final Gson gson = new Gson();
   
       @Override
       public void service(HttpRequest request, HttpResponse response) throws Exception {
           JsonObject body = gson.fromJson(request.getReader(), JsonObject.class);
           if (request.getMethod().equals("GET") || !body.has("chat")) {
               response.getWriter().write("Hello! This function is meant to be used " +
                   "in a Google Chat Space..");
               return;
           }
   
           // Stores the Google Chat event as a variable.
           JsonObject chatMessage = body.getAsJsonObject("chat")
               .getAsJsonObject("messagePayload").getAsJsonObject("message");
   
           // Replies with the sender's avatar in a card.
           String displayName = chatMessage.getAsJsonObject("sender").get("displayName").getAsString();
           String avatarUrl = chatMessage.getAsJsonObject("sender").get("avatarUrl").getAsString();
           Message message = createMessage(displayName, avatarUrl);
   
           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));
       }
   
       Message createMessage(String displayName, String avatarUrl) {
           GoogleAppsCardV1CardHeader cardHeader = new GoogleAppsCardV1CardHeader();
           cardHeader.setTitle(String.format("Hello %s!", displayName));
   
           GoogleAppsCardV1TextParagraph textParagraph = new GoogleAppsCardV1TextParagraph();
           textParagraph.setText("Your avatar picture: ");
   
           GoogleAppsCardV1Widget avatarWidget = new GoogleAppsCardV1Widget();
           avatarWidget.setTextParagraph(textParagraph);
   
           GoogleAppsCardV1Image image = new GoogleAppsCardV1Image();
           image.setImageUrl(avatarUrl);
   
           GoogleAppsCardV1Widget avatarImageWidget = new GoogleAppsCardV1Widget();
           avatarImageWidget.setImage(image);
   
           GoogleAppsCardV1Section section = new GoogleAppsCardV1Section();
           section.setWidgets(List.of(avatarWidget, avatarImageWidget));
   
           GoogleAppsCardV1Card card = new GoogleAppsCardV1Card();
           card.setName("Avatar Card");
           card.setHeader(cardHeader);
           card.setSections(List.of(section));
   
           CardWithId cardWithId = new CardWithId();
           cardWithId.setCardId("avatarCard");
           cardWithId.setCard(card);
   
           Message message = new Message();
           message.setText("Here's your avatar");
           message.setCardsV2(List.of(cardWithId));
   
           return message;
       }
   }
   

9. Ganti konten pom.xml dengan kode berikut:

   <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.0.4</version>
           </dependency>
   
           <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
           <dependency>
               <groupId>com.google.code.gson</groupId>
               <artifactId>gson</artifactId>
               <version>2.9.1</version>
           </dependency>
   
           <!-- https://mvnrepository.com/artifact/com.google.apis/google-api-services-chat -->
           <dependency>
               <groupId>com.google.apis</groupId>
               <artifactId>google-api-services-chat</artifactId>
               <version>v1-rev20230115-2.0.0</version>
           </dependency>
       </dependencies>
   
       <!-- Required for Java functions in the inline editor -->
       <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>
   

10. Klik Deploy.

Halaman detail Cloud Functions akan terbuka, dan fungsi Anda akan muncul dengan dua indikator progres: satu untuk build dan satu untuk layanan. Saat kedua indikator progres menghilang dan diganti dengan tanda centang, fungsi Anda akan di-deploy dan siap.

Memberi otorisasi Google Chat untuk memanggil fungsi Anda

Untuk Memberi otorisasi Add-on Google Workspace untuk memanggil fungsi Anda, tambahkan akun layanan Add-on Google Workspace dengan peran Cloud Run Invoker.

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

   Buka Cloud Run

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

3. Klik Izin. Panel Izin akan terbuka.

4. Klik Tambahkan akun utama.

5. Di New principals, masukkan alamat email akun layanan Add-on Google Workspace yang terkait dengan project Anda.

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

7. Klik Simpan.

Mengonfigurasi add-on

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

1. Di konsol Google Cloud, klik Menu > Cloud Functions.

   Buka Cloud Functions

   Pastikan project tempat Anda mengaktifkan Cloud Functions dipilih.

2. Dalam daftar fungsi, klik AddOnChatApp.

3. Klik tab Trigger.

4. Di bagian HTTPS, salin URL.

5. Telusuri "Google Chat API" dan klik Google Chat API, lalu klik Kelola.

   Buka Chat API

6. Klik Konfigurasi dan siapkan aplikasi Google Chat:

   1. Di App name, masukkan Add-on Chat app.
   2. Di Avatar URL, masukkan https://developers.google.com/chat/images/quickstart-app-avatar.png.
   3. Di Deskripsi, masukkan Add-on Chat app.
   4. Di bagian Functionality, pilih Receive 1:1 messages dan Join spaces and group conversations.
   5. Di bagian Connection settings, pilih HTTP endpoint URL dan tempelkan URL untuk pemicu Cloud Function ke dalam kotak.
   6. Di Authentication Audience, pilih HTTP endpoint URL.
   7. Di bagian Visibilitas, pilih Buat aplikasi Google Chat ini tersedia untuk orang dan grup tertentu di domain Anda, lalu masukkan alamat email Anda.
   8. Di bagian Logs, pilih Log errors to Logging.

7. Klik Simpan.

Aplikasi Chat siap menerima dan merespons pesan di Chat.

Menguji aplikasi Chat

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 sebagai penguji tepercaya.

   Buka Google Chat

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

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

   Catatan: Jika Anda tidak melihat aplikasi Chat dalam daftar hasil, pastikan Anda telah menyertakan akun Google Workspace di setelan Visibilitas di halaman Konfigurasi Chat API 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 Google Chat atau kartu menampilkan error, antarmuka Chat akan menampilkan pesan yang bertuliskan "Terjadi masalah". atau "Tidak dapat memproses permintaan Anda". Terkadang UI Chat tidak menampilkan pesan error, 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: Menghapus project memiliki efek berikut:

• Semua hal dalam project akan dihapus. Jika menggunakan project yang sudah ada untuk tutorial ini, saat menghapusnya, Anda juga akan menghapus pekerjaan lain yang telah dilakukan dalam 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 > Kelola Resource.

   Buka Resource Manager

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