Membangun aplikasi Google Chat HTTP

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

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

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

Arsitektur aplikasi Chat yang menggunakan layanan web di server lokal.

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

  1. Pengguna mengirim pesan di Chat ke aplikasi Chat, baik di 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 diintegrasikan dengan layanan Google Workspace (seperti Kalender dan Spreadsheet), layanan Google lainnya (seperti Maps, YouTube, dan Vertex AI), atau layanan web lainnya (seperti sistem pengelolaan proyek atau alat pembuatan 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 didesain menggunakan bahasa pemrograman yang berbeda.

Tujuan

  • Siapkan lingkungan Anda.
  • Buat dan deploy fungsi Cloud Run.
  • Mengonfigurasi add-on Google Workspace untuk aplikasi Chat.
  • Uji aplikasi.

Prasyarat

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 fungsi Cloud Run

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

Untuk membuat dan men-deploy fungsi aplikasi Chat Anda, 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 Nama layanan, masukkan addonchatapp.
    2. Di daftar Region, pilih region.
    3. Dalam daftar Runtime, pilih Node.js versi terbaru.
    4. Di bagian Authentication, pilih Require authentication.
    5. Klik Create, dan tunggu hingga Cloud Run membuat layanan. Konsol akan mengalihkan Anda ke tab Sumber.

  4. Di tab Sumber:

    1. Di Entry point, hapus teks default dan masukkan avatarApp.
    2. Ganti konten index.js dengan kode berikut:
    /**
 * Google Cloud Run 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
 */
import { http } from '@google-cloud/functions-framework';

http('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 }
                    }]
                }]
            }
        }]
    }}}}});
});
    1. Ganti konten package.json dengan kode berikut:
    {
  "name": "avatar-app",
  "version": "1.0.0",
  "description": "Google Chat Avatar App",
  "main": "index.js",
  "type": "module",
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "@google-cloud/functions-framework": "^3.0.0"
  }
}
    1. Klik Simpan dan deploy ulang.

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 Nama layanan, masukkan addonchatapp.
    2. Di daftar Region, pilih region.
    3. Dalam daftar Runtime, pilih versi Python terbaru.
    4. Di bagian Authentication, pilih Require authentication.
    5. Klik Create, dan tunggu hingga Cloud Run membuat layanan. Konsol akan mengalihkan Anda ke tab Sumber.

  4. Di tab Sumber:

    1. Di Entry point, hapus teks default dan masukkan avatar_app.
    2. 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 Run 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 }
                    }]
                }]
            }
        }]
    }}}}}
    1. Klik Simpan dan deploy ulang.

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 Nama layanan, masukkan addonchatapp.
    2. Di daftar Region, pilih region.
    3. Dalam daftar Runtime, pilih versi Java terbaru.
    4. Di bagian Authentication, pilih Require authentication.
    5. Klik Create, dan tunggu hingga Cloud Run membuat layanan. Konsol akan mengalihkan Anda ke tab Sumber.

  4. Di tab Sumber:

    1. Di Entry point, hapus teks default dan masukkan AvatarApp.
    2. Ganti nama file Java default menjadi src/main/java/gcfv2/AvatarApp.java.
    3. 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;
    }
}

  5. 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>
    1. Klik Simpan dan deploy ulang.

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

Mengonfigurasi add-on

Setelah fungsi Cloud Run 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 tempat Anda mengaktifkan Cloud Run dipilih.

  2. Dalam daftar fungsi, klik addonchatapp.

  3. Di halaman Detail layanan, salin URL untuk fungsi tersebut. URL berakhir 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 Konfigurasi dan siapkan aplikasi Google Chat:

    1. Di Nama aplikasi, masukkan Add-on Chat app.
    2. Di Avatar URL, masukkan https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png.
    3. Di Deskripsi, 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. Salin Email akun layanan. Anda memerlukan email ini saat mengizinkan add-on untuk memanggil fungsi Anda.
    7. Di bagian Triggers, pilih Use a common HTTP endpoint URL for all triggers, dan tempel URL untuk pemicu fungsi Cloud Run ke dalam kotak.
    8. Di bagian Visibilitas, pilih Buat aplikasi Google Chat ini tersedia untuk orang dan grup tertentu di domain Anda, lalu masukkan alamat email Anda.
    9. Di bagian Logs, pilih Log errors to Logging.

  6. Klik Simpan.

Selanjutnya, beri otorisasi aplikasi Chat untuk memanggil fungsi Cloud Run.

Memberi otorisasi 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, pilih kotak centang di samping fungsi penerima. (Jangan mengklik fungsi.)

  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 aplikasi Chat Anda.

    Alamat email akun layanan ada di halaman konfigurasi Chat API, di bagian Setelan koneksi > URL endpoint HTTP > Email Akun Layanan:

    Buka konfigurasi Chat API

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

  7. Klik Simpan.

Aplikasi Chat siap menerima dan merespons pesan di Chat.

Menguji aplikasi Chat Anda

Untuk menguji aplikasi Chat Anda, 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 Percakapan 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.

  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 dalam gambar berikut:

Aplikasi Chat merespons dengan kartu yang menampilkan nama tampilan dan gambar avatar pengirim

Untuk menambahkan penguji tepercaya dan mempelajari lebih lanjut pengujian 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 jika 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 tersebut.

  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.