Merespons perintah garis miring sebagai aplikasi Google Chat

Halaman ini menjelaskan cara menyiapkan dan merespons perintah garis miring untuk Aplikasi Google Chat.

Perintah garis miring adalah cara umum yang digunakan pengguna untuk memanggil dan berinteraksi dengan Aplikasi Chat. Perintah garis miring juga membantu pengguna menemukan dan menggunakan fitur-fitur utama aplikasi Chat.

Untuk menggunakan perintah garis miring, pengguna mengetik garis miring (/) lalu perintah teks pendek, seperti /about untuk mendapatkan informasi tentang aplikasi Chat. Pengguna dapat menemukan perintah garis miring yang tersedia dengan mengetik Google Chat, yang menampilkan jendela yang mencantumkan perintah yang tersedia untuk Aplikasi Chat:

Untuk memutuskan apakah Anda harus mengatur perintah garis miring, dan untuk memahami cara mendesain interaksi pengguna, melihat Mendefinisikan semua perjalanan pengguna.

Perintah garis miring dengan respons pribadi

Ketika pengguna mengirim pesan yang berisi perintah garis miring, pesan itu hanya terlihat oleh pengguna dan aplikasi Chat. Jika Anda telah mengonfigurasi aplikasi Chat untuk ditambahkan ke ruang dengan beberapa orang, Anda dapat mempertimbangkan untuk merespons perintah {i>/.<i} secara pribadi, untuk menjaga privasi interaksi antara pengguna dan Aplikasi Chat.

Misalnya, untuk mempelajari aplikasi Chat yang temukan di ruang, pengguna dapat menggunakan perintah seperti /about atau /help. Agar tidak memberi tahu semua orang di ruang, Aplikasi Chat dapat merespons secara pribadi dengan informasi tentang cara menggunakan aplikasi Chat dan mendapatkan dukungan.

Prasyarat

Menyiapkan perintah garis miring

Bagian ini menjelaskan cara menyelesaikan langkah-langkah berikut untuk menyiapkan garis miring berikut:

1. Buat nama untuk perintah garis miring Anda.
2. Konfigurasikan perintah garis miring di Google Chat API.

Beri nama perintah garis miring Anda

Nama perintah garis miring adalah hal yang diketik pengguna dalam pesan Chat untuk memanggil aplikasi Chat. Deskripsi singkat juga akan muncul di bawah nama, untuk memberi tahu pengguna lebih lanjut tentang cara menggunakan perintah tersebut:

Saat memilih nama dan deskripsi untuk perintah garis miring Anda, pertimbangkan rekomendasi berikut:

• Untuk memberi nama perintah garis miring:

  • Gunakan kata atau frasa pendek, deskriptif, dan dapat ditindaklanjuti untuk menyampaikan perintah yang jelas dan sederhana bagi pengguna. Misalnya, daripada mengatakan /createAReminder, gunakan /remindMe.
  • Jika perintah Anda berisi lebih dari satu kata, bantu pengguna membaca perintah tersebut dengan menggunakan huruf kecil semua untuk kata pertama dan menggunakan huruf besar untuk kata pertama huruf dari kata tambahan. Misalnya, sebagai ganti /updatecontact, gunakan /updateContact.
  • Pertimbangkan apakah akan menggunakan nama yang unik atau umum untuk perintah Anda. Jika perintah Anda menjelaskan interaksi atau fitur khas, Anda dapat menggunakan nama umum yang dikenali dan diharapkan pengguna, seperti /settingsatau /feedback. Jika tidak, coba gunakan nama perintah yang unik, karena jika sama dengan nama perintah untuk aplikasi Chat lainnya, pengguna harus menyaring perintah yang mirip untuk menemukan dan menggunakan milik Anda.

• Untuk mendeskripsikan perintah garis miring:

  • Buat deskripsi yang singkat dan jelas sehingga pengguna tahu apa yang diharapkan ketika mereka memanggil perintah itu.
  • Beri tahu pengguna jika ada persyaratan pemformatan untuk perintah tersebut. Misalnya, jika Anda membuat perintah /remindMe yang memerlukan argumen teks, setel deskripsi menjadi Remind me to do [something] at [time].
  • Beri tahu pengguna jika aplikasi Chat membalas semua orang di ruang, atau secara pribadi kepada pengguna yang menjalankan perintah. Misalnya, untuk perintah garis miring /about, Anda dapat mendeskripsikannya sebagai Learn about this app (Only visible to you). Untuk merespons secara pribadi Perintah garis miring, lihat bagian Merespons dengan pesan pribadi.

Konfigurasi perintah garis miring di Google Chat API

Untuk membuat perintah garis miring, Anda perlu menentukan informasi tentang perintah tersebut di konfigurasi aplikasi Chat Anda untuk Google Chat API.

Untuk mengonfigurasi perintah garis miring di Google Chat API, selesaikan langkah-langkah berikut langkah:

1. Di Konsol Google Cloud, klik Menu menu &gt; API & Layanan &gt; API yang diaktifkan & Layanan &gt; Google Chat API

   Buka halaman Google Chat API

2. Klik Konfigurasi.

3. Di bagian Perintah garis miring, klik Tambahkan perintah garis miring.

4. Masukkan nama, ID perintah, dan deskripsi untuk perintah tersebut:

   1. Name: nama tampilan untuk perintah, dan jenis pengguna untuk memanggil aplikasi Anda. Harus diawali dengan garis miring, hanya berisi teks, dan dapat hingga 50 karakter.
   2. Deskripsi: teks yang menjelaskan cara menggunakan dan memformat perintah tersebut. Deskripsi dapat berisi hingga 50 karakter.
   3. Command ID: angka dari 1 sampai 1000 yang Aplikasi Chat yang digunakan untuk mengenali perintah garis miring dan memberikan respons.

5. Opsional: Jika Anda ingin aplikasi Chat merespons perintah dengan dialog, pilih Kotak centang Buka dialog.

6. Klik Simpan.

Perintah garis miring sekarang dikonfigurasi untuk aplikasi Chat.

Merespons perintah garis miring

Saat pengguna membuat pesan Chat yang berisi perintah garis miring, aplikasi Chat Anda menerima peristiwa interaksi MESSAGE. Payload peristiwa berisi slashCommand dan slashCommandMetadata objek terstruktur dalam jumlah besar. Objek ini berisi detail tentang perintah yang digunakan dalam pesan (termasuk ID perintah), sehingga Anda bisa mengembalikan respons yang sesuai.

Kode berikut menunjukkan contoh aplikasi Chat yang membalas perintah garis miring /help dengan menangani MESSAGE peristiwa interaksi dan deteksi apakah pesan berisi ID perintah yang cocok atau tidak. Jika pesan berisi ID perintah, aplikasi Chat akan menampilkan pesan pribadi yang menjelaskan cara mendapatkan bantuan:

/**
* Responds to a MESSAGE event in Google Chat.
*
* @param {!Object} req Request sent from Google Chat app
* @param {!Object} res Response to send back
*
* @return {!Object} respond to slash command
*/
exports.onMessage = function onMessage(req, res) {
  if (req.method === 'GET' || !req.body.message) {
    return res.send('Hello! This function is meant to be used in Google Chat app.');
  }

  const event = req.body;

  // Checks for the presence of event.message.slashCommand.
  // If the slash command is "/help", responds with a private text message.
  if (event.message.slashCommand) {
    switch (event.message.slashCommand.commandId) {
      case 'ID': // The ID for your slash command
        return res.json({
          privateMessageViewer: event.user, // Optional. Responds privately to the slash command.
          text: 'This Chat app was created by Cymbal Labs. To get help with this app, <https://cymbalgroup.com/docs|see our documentation> or <https://cymbalgroup.com/support|contact our support team>.'
        });
    }
  }

  // If the Chat app doesn't detect a slash command, it responds
  // with a private text message
  return res.json({
    privateMessageViewer: event.user,
    text: 'Try a slash command.'
  });
};

/**
* Responds to a MESSAGE event in Google Chat.
*
* @param {Object} event the event object from Google Chat
*/
function onMessage(event) {
  if (event.message.slashCommand) {
    switch (event.message.slashCommand.commandId) {
      case ID: // The ID for your slash command
        return {
          "privateMessageViewer": event.user, // Optional. Responds privately to the slash command.
          "text": "This Chat app was created by Cymbal Labs. To get help with this app, <https://cymbalgroup.com/docs|see our documentation> or <https://cymbalgroup.com/support|contact our support team>."
        };
    }
  }
  else {
    return { "text": "Try a slash command.", "privateMessageViewer": event.user };
  }
}

from typing import Any, Mapping

import flask
import functions_framework

@functions_framework.http
def main(req: flask.Request) -> Mapping[str, Any]:
  """Responds to a MESSAGE event in Google Chat.

  Args:
      req (flask.Request): the event object from Chat API.

  Returns:
      Mapping[str, Any]: open a Dialog in response to a card's button click.
  """
  if req.method == 'GET':
    return 'Hello! This function must be called from Google Chat.'

  request = req.get_json(silent=True)

  # Checks for the presence of event.message.slashCommand.
  # If the slash command is "/help", responds with a private text message.
  if request.get('message', {}).get('slashCommand'):
    command_id = request.get('message', {}).get('slashCommand').get('commandId')
    if command_id == 'ID': # The ID for your slash command
      return {
          'privateMessageViewer': request.get('user'),
          'text': (
              'This Chat app was created by Cymbal Labs. To get help with this'
              ' app, <https://cymbalgroup.com/docs|see our documentation> or'
              ' <https://cymbalgroup.com/support|contact our support team>.'
          ),
      }

  return {
      'privateMessageViewer': request.get('user'), # Optional. Responds privately to the slash command.
      'text': 'Try a slash command.',
  }

Ganti ID dengan ID perintah yang Anda tentukan saat Anda mengonfigurasi perintah garis miring di Chat API. Untuk menguji kode ini, lihat Menguji fitur interaktif untuk aplikasi Google Chat.

Topik terkait

• Lihat contoh aplikasi Chat yang menggunakan perintah garis miring
• Mengirim pesan
• Mengirim pesan pribadi
• Membuka dialog interaktif