Google Chat uygulama komutlarına yanıt verme

Bu sayfada, Google Chat uygulaması olarak komutların nasıl ayarlanacağı ve yanıtlanacağı açıklanmaktadır.

Komutlar, kullanıcıların Chat uygulamasının temel özelliklerini keşfetmesine ve kullanmasına yardımcı olur. Komutun içeriğini yalnızca Chat uygulamaları görebilir. Örneğin, bir kullanıcı eğik çizgi komutu içeren bir mesaj gönderirse mesaj yalnızca kullanıcı ve Chat uygulaması tarafından görülebilir.

Komut oluşturmanız gerekip gerekmediğine karar vermek ve kullanıcı etkileşimlerini nasıl tasarlayacağınızı anlamak için Tüm kullanıcı yolculuklarını tanımlama bölümüne bakın.

Chat uygulaması komutlarının türleri

Chat Uygulaması komutlarını eğik çizgi komutları, hızlı komutlar veya mesaj işlemleri olarak oluşturabilirsiniz. Kullanıcılar, her komut türünü kullanmak için aşağıdakileri yapabilir:
  1. Eğik çizgi komutları: Kullanıcılar, menüden bir eğik çizgi komutu seçebilir veya eğik çizgi (/) ve ardından /about gibi önceden tanımlanmış bir metin yazabilir. Chat uygulamaları genellikle eğik çizgi komutu için bağımsız değişken metni gerektirir.

    Chat uygulamanız kullanıcıdan ek giriş gerektiriyorsa eğik çizgi komutu oluşturun. Örneğin, kullanıcı aranacak bir ifade (ör. /search receipts) girdikten sonra çalışan /search adlı bir eğik çizgi komutu oluşturabilirsiniz.

  2. Hızlı komutlar: Kullanıcılar, Chat sohbet mesajının yanıt alanından menüyü açarak komutları kullanır. Kullanıcılar bir komutu kullanmak için Ekle'yi tıklayıp menüden bir komut seçer.

    Chat uygulamanız ek giriş beklemeden kullanıcıya hemen yanıt verebiliyorsa hızlı komut oluşturun. Örneğin, hemen bir resimle yanıt veren Rastgele resim adlı bir hızlı komut oluşturabilirsiniz.

  3. Mesaj işlemleri: Kullanıcılar, fareyle bir mesajın üzerine gelip üç nokta menüsünü tıklayarak mesaj işlemlerini kullanır. Kullanıcılar, bir komutu kullanmak için üç nokta menüsünü açıp menüden bir komut seçer.

    Chat uygulamanız bir mesajın bağlamına göre işlem yapabiliyorsa mesaj işlemi oluşturun.

Aşağıdaki resimlerde, kullanıcıların eğik çizgi ve hızlı komutlar ile mesaj işlemleri menüsünü nasıl bulduğu gösterilmektedir:

Ön koşullar

HTTP

Kullanıcı etkileşimlerini alıp yanıtlayan bir Google Chat uygulaması. HTTP uç noktası oluşturmak için HTTP hızlı başlangıç kılavuzunu tamamlayın.

Apps Komut Dosyası

Kullanıcı etkileşimlerini alan ve bunlara yanıt veren bir Google Chat uygulaması. Bir tane oluşturmak için Apps Komut Dosyası hızlı başlangıç kılavuzunu tamamlayın.

Komutu ayarlama

Bu bölümde, bir komut oluşturmak için aşağıdaki adımların nasıl tamamlanacağı açıklanmaktadır:

  1. Komut için bir ad ve açıklama oluşturun.
  2. Google Cloud Console'da komutu yapılandırın.
  3. İsteğe bağlı: Komutları başlangıç istemleriyle eşleyin.

Komuta bir ad verin ve açıklama ekleyin

Komutun adı, kullanıcıların Chat uygulamasını çağırmak için yazdığı veya seçtiği addır. Adın altında, kullanıcıları komutun nasıl kullanılacağı konusunda daha fazla bilgilendiren kısa bir açıklama da görünür:

Eğik çizgi komutunun adı ve açıklaması
Eğik çizgi komutunun adı ve açıklaması.

Komutunuz için ad ve açıklama seçerken aşağıdaki önerileri göz önünde bulundurun:

Bir komuta ad vermek için:

  • Komutların kullanıcı tarafından net bir şekilde anlaşılması için kısa, açıklayıcı ve uygulanabilir kelimeler veya ifadeler kullanın. Örneğin, Create a reminder adı yerine Remind me kullanın.
  • Komutunuz için benzersiz veya yaygın bir ad kullanabilirsiniz. Komutunuz tipik bir etkileşimi veya özelliği açıklıyorsa kullanıcıların tanıdığı ve beklediği Settings veya Feedback gibi yaygın bir ad kullanabilirsiniz. Aksi takdirde benzersiz komut adları kullanmaya çalışın. Komut adınız diğer Chat uygulamalarıyla aynıysa kullanıcı, sizinkini bulup kullanmak için benzer komutları filtrelemek zorunda kalır.

Bir komutu açıklamak için:

  • Kullanıcıların komutu kullandıklarında ne bekleyeceklerini bilmeleri için açıklamayı kısa ve net tutun.
  • Kullanıcılara komut için herhangi bir biçimlendirme şartı olup olmadığını bildirin. Örneğin, bağımsız değişken metni gerektiren bir eğik çizgi komutu oluşturursanız açıklamayı Remind me to do [something] at [time] gibi bir değere ayarlayın.
  • Chat uygulamasının alandaki herkese mi yoksa komutu çağıran kullanıcıya özel olarak mı yanıt verdiğini kullanıcılara bildirin. Örneğin, About hızlı komutunu Learn about this app (Only visible to you) olarak tanımlayabilirsiniz.

Komutu Google Cloud Console'da yapılandırma

Eğik çizgi komutu, hızlı komut veya mesaj işlemi oluşturmak için Chat uygulamanızın Google Chat API yapılandırmasında komut veya işlemle ilgili bilgileri belirtirsiniz.

Google Chat API'de bir komut yapılandırmak için aşağıdaki adımları uygulayın:

  1. Google Cloud Console'da Menü > API'ler ve Hizmetler > Etkin API'ler ve Hizmetler > Google Chat API'yi tıklayın.

    Google Chat API sayfasına gidin

  2. Configuration'ı (Yapılandırma) tıklayın.

  3. Bağlantı ayarları bölümünde Tetikleyiciler'e gidin ve uç nokta ayrıntılarınızı belirtin. Komuta yanıt vermek için bu tetikleyiciyi aşağıdaki bölümde kullanmanız gerekir.

    1. HTTP uç nokta URL'si: Burada bir ortak HTTP uç nokta URL'si belirtebilirsiniz. Alternatif olarak, farklı tetikleyiciler için farklı HTTP uç noktaları kullanmak istiyorsanız uç noktayı doğrudan Uygulama komutu alanında belirtin.
    2. Apps Komut Dosyası: Apps Komut Dosyası Dağıtım Kimliği'ni girin. Varsayılan olarak onAppCommand işlevi çağrılır. Farklı bir Apps Komut Dosyası işlevi kullanmak için Uygulama komutu alanında özel işlev adını belirtin.
  4. Komutlar bölümünde Komut ekle'yi tıklayın.

  5. Komutla ilgili aşağıdaki bilgileri girin:

    1. Komut kimliği: Chat uygulamanızın komutu tanımak ve yanıt döndürmek için kullandığı 1 ile 1.000 arasında bir sayı.
    2. Açıklama: Komutun nasıl kullanılacağını ve biçimlendirileceğini açıklayan metindir. Açıklamalar en fazla 50 karakter uzunluğunda olabilir.
    3. Komut türü: Hızlı komut, Eğik çizgi komutu veya Mesaj işlemi'ni seçin.
    4. Komut için bir ad belirtin:
      • Hızlı komut adı: Kullanıcıların komutu çağırmak için menüden seçtiği görünen ad. En fazla 50 karakter olabilir ve özel karakterler içerebilir. Örneğin, Remind me.
      • Eğik çizgi komutu adı: Kullanıcıların bir mesajda komutu çağırmak için yazdığı metin. Eğik çizgiyle başlamalı, yalnızca metin içermeli ve en fazla 50 karakterden oluşmalıdır. Örneğin, /remindMe.
      • Mesaj işlemi adı: Kullanıcıların mesaj işlemini çağırmak için menüden seçtiği görünen ad. En fazla 50 karakter olabilir ve özel karakterler içerebilir. Örneğin, Remind me.
  6. İsteğe bağlı: Bildirim mesajı yükleniyor: Mesaj işlemi yürütülürken kullanıcıya gösterilecek bir bildirim mesajı. Yalnızca iletişim kutusu açmayan mesaj işlemleri için kullanılabilir.

  7. İsteğe bağlı: Chat uygulamanızın komuta iletişim kutusu ile yanıt vermesini istiyorsanız İletişim kutusu aç onay kutusunu işaretleyin.

  8. Kaydet'i tıklayın.

Komut, Chat uygulaması için yapılandırılmıştır.

Komutları başlangıç istemleriyle eşleme

Komutlarınızı başlangıç istemleri olarak öne çıkarabilirsiniz. Böylece kullanıcılar, Chat uygulamanızla boş bir bire bir doğrudan mesaj başlattıklarında bu komutları etkileşimli çipler olarak görür.

Bir komutu başlangıç istemiyle eşlemek için:

  1. Komutunuzun ek özel bağımsız değişkenler gerektirmediğinden emin olun (başlangıç istemleri olarak yalnızca Bağımsız değişken yok veya Temel bağımsız değişkenler içeren komutlar desteklenir).
  2. Google Cloud Console'da Chat API Yapılandırma sayfasına gidin.
  3. Etkileşimli özellikler > Başlangıç istemleri bölümünde İstem ekle'yi tıklayın.
  4. Görüntüleme sırası için Sıra (1-3) değerini ayarlayın.
  5. Tür seçimi bölümünde Komut istemi'ni seçin ve açılır listeden komutunuzu belirleyin.
  6. Bitti'yi ve ardından Kaydet'i tıklayın.

Komutlara yanıt verme

Kullanıcılar bir komut kullandığında Chat uygulamanız bir olay nesnesi alır. Etkinlik yükü (event.chat.appCommandPayload), çağrılan komutla ilgili ayrıntıları (komut kimliği ve komut türü dahil) içeren bir appCommandPayload nesnesi içerir. Böylece uygun bir yanıt döndürebilirsiniz. Olay nesnesi, Uygulama komutu tetikleyicisini yapılandırırken belirttiğiniz HTTP uç noktasına veya Apps Komut Dosyası işlevine gönderilir.

Cymbal Labs Chat uygulaması için özel mesaj. Mesajda, Chat uygulamasının Cymbal Labs tarafından oluşturulduğu belirtiliyor ve dokümanların bağlantısı ile destek ekibiyle iletişime geçme bağlantısı paylaşılıyor.
Bir Chat uygulaması, destek alma yöntemini açıklamak için /help eğik çizgi komutuna gizli olarak yanıt verir.

Eğik çizgi komutuna veya hızlı komuta yanıt verme

Aşağıdaki kodda, /about eğik çizgi komutuna kısa mesajla yanıt veren bir Chat uygulaması örneği gösterilmektedir. Chat uygulaması, eğik çizgi komutlarına veya hızlı komutlara yanıt vermek için Uygulama komutu tetikleyicisinden gelen olay nesnelerini (event.chat.appCommandPayload) işler. Bir olay nesnesinin yükü eşleşen bir komut kimliği içerdiğinde Chat uygulaması, createMessageAction (hostAppDataAction.chatDataAction.createMessageAction) nesnesiyle DataActions işlemini döndürür:

Node.js

node/chat/avatar-app/index.js
// 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.'
      };
  }
}

Python

python/chat/avatar-app/main.py
# 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 {}

Java

java/chat/avatar-app/src/main/java/com/google/chat/avatar/App.java
// 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;
  }
}

Apps Komut Dosyası

apps-script/chat/avatar-app/Code.gs
// The ID of the slash command "/about".
// You must use the same ID in the Google Chat API configuration.
const ABOUT_COMMAND_ID = 1;

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onAppCommand(event) {
  // Executes the app command logic based on ID.
  switch (event.chat.appCommandPayload.appCommandMetadata.appCommandId) {
    case ABOUT_COMMAND_ID:
      return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
        text: 'The Avatar app replies to Google Chat messages.'
      }}}}};
  }
}

Bu kod örneğini kullanmak için ABOUT_COMMAND_ID değerini, Chat API'de komutu yapılandırırken belirttiğiniz komut kimliğiyle değiştirin.

Mesaj işlemine yanıt verme

Aşağıdaki kodda, Bana hatırlat mesaj işlemine kısa mesajla yanıt veren bir Chat uygulaması örneği gösterilmektedir. Chat uygulaması, mesaj işlemlerine yanıt vermek için Uygulama komutu tetikleyicisinden gelen olay nesnelerini işler. Bir olay nesnesinin yükü mesaj işlemi komut kimliği içerdiğinde Chat uygulaması, createMessageAction nesnesiyle DataActions işlemini döndürür:

Node.js

/**
 * Responds to an APP_COMMAND interaction event from Google Chat.
 *
 * @param {Object} event The interaction event from Google Chat.
 * @param {Object} res The HTTP response object.
 * @return {Object} The JSON response message with a confirmation.
 */
function onAppCommand(event, res) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} =
    event.chat.appCommandPayload.appCommandMetadata;

  if (appCommandType === 'MESSAGE_ACTION' &&
      appCommandId === REMIND_ME_COMMAND_ID) {

    // Message actions can access the context of the message they were
    // invoked on, such as the text or sender of that message.
    const messageText = event.chat.appCommandPayload.message.text;

    // Return a response that includes details from the original message.
    return res.json({
      "hostAppDataAction": {
        "chatDataAction": {
          "createMessageAction": {
            "message": {
              "text": `Setting a reminder for message: "${messageText}"`
            }
          }
        }
      }
    });
  }
}

Python

def on_app_command(event):
    """Responds to an APP_COMMAND interaction event from Google Chat.

    Args:
        event (dict): The interaction event from Google Chat.

    Returns:
        dict: The JSON response message with a confirmation.
    """
    # Collect the command ID and type from the event metadata.
    payload = event.get('chat', {}).get('appCommandPayload', {})
    metadata = payload.get('appCommandMetadata', {})
    if metadata.get('appCommandType') == 'MESSAGE_ACTION' and \
       metadata.get('appCommandId') == REMIND_ME_COMMAND_ID:

        # Message actions can access the context of the message they were
        # invoked on, such as the text or sender of that message.
        message_text = payload.get('message', {}).get('text')

        # Return a response that includes details from the original message.
        return {
            "hostAppDataAction": {
                "chatDataAction": {
                    "createMessageAction": {
                        "message": {
                            "text": f'Setting a reminder for message: "{message_text}"'
                        }
                    }
                }
            }
        }

Java

/**
 * Responds to an APP_COMMAND interaction event from Google Chat.
 *
 * @param event The interaction event from Google Chat.
 * @param response The HTTP response object.
 */
void onAppCommand(JsonObject event, HttpResponse response) throws Exception {
  // Collect the command ID and type from the event metadata.
  JsonObject payload = event.getAsJsonObject("chat").getAsJsonObject("appCommandPayload");
  JsonObject metadata = payload.getAsJsonObject("appCommandMetadata");
  String appCommandType = metadata.get("appCommandType").getAsString();

  if (appCommandType.equals("MESSAGE_ACTION")) {
    int commandId = metadata.get("appCommandId").getAsInt();
    if (commandId == REMIND_ME_COMMAND_ID) {
      // Message actions can access the context of the message they were
      // invoked on, such as the text or sender of that message.
      String messageText = payload.getAsJsonObject("message").get("text").getAsString();

      // Return a response that includes details from the original message.
      JsonObject responseMessage = new JsonObject();
      responseMessage.addProperty("text", "Setting a reminder for message: " + messageText);

      JsonObject createMessageAction = new JsonObject();
      createMessageAction.add("message", responseMessage);

      JsonObject chatDataAction = new JsonObject();
      chatDataAction.add("createMessageAction", createMessageAction);

      JsonObject hostAppDataAction = new JsonObject();
      hostAppDataAction.add("chatDataAction", chatDataAction);

      JsonObject finalResponse = new JsonObject();
      finalResponse.add("hostAppDataAction", hostAppDataAction);

      response.getWriter().write(finalResponse.toString());
    }
  }
}

Apps Komut Dosyası

/**
 * Responds to an APP_COMMAND interaction event in Google Chat.
 *
 * @param {Object} event The interaction event from Google Chat.
 * @return {Object} The JSON response message with a confirmation.
 */
function onAppCommand(event) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} =
    event.chat.appCommandPayload.appCommandMetadata;

  if (appCommandType === 'MESSAGE_ACTION' &&
      appCommandId === REMIND_ME_COMMAND_ID) {

    // Message actions can access the context of the message they were
    // invoked on, such as the text or sender of that message.
    const messageText = event.chat.appCommandPayload.message.text;

    // Return a response that includes details from the original message.
    return CardService.newChatResponseBuilder()
        .setText("Setting a reminder for message: " + messageText)
        .build();
  }
}

Bu kod örneğini kullanmak için REMIND_ME_COMMAND_ID değerini, Chat API'de komutu yapılandırırken belirttiğiniz komut kimliğiyle değiştirin.

Komutu test etme

Komutu ve kodu test etmek için Google Chat uygulamaları için etkileşimli özellikleri test etme başlıklı makaleyi inceleyin.

Komutu Chat kullanıcı arayüzünde nasıl test edeceğinizi ve kullanacağınızı öğrenmek için Google Chat Yardım belgelerindeki Google Chat'te uygulamaları kullanma başlıklı makaleyi inceleyin.

Eklenti olmayan Chat uygulamaları: Komutlara yanıt verme

Aşağıdaki belgeler, Google Workspace eklentisi olmayan Chat Uygulamaları için geçerlidir. Eklenti olmayan bir Chat uygulamasını taşımak için Google Chat uygulamasını Google Workspace eklentisine dönüştürme başlıklı makaleyi inceleyin.

Kullanıcılar bir komut kullandığında, eklenti olmayan bir Chat uygulaması bir etkileşim etkinliği alır ve doğrudan bir Message nesnesi döndürerek yanıt verebilir. Etkinlik yükü, çağrılan komutla ilgili ayrıntıları (komut kimliği ve komut türü dahil) içeren meta veriler içerir. Böylece uygun bir yanıt döndürebilirsiniz.

Eklenti olmayan bir Chat uygulamasındaki her komut türüne yanıt vermek için etkinlik yükündeki farklı etkinlik türlerini ve meta veri nesnelerini işlemeniz gerekir:

Komut türü Etkinlik türü Komut meta verileri
Eğik çizgi komutu MESSAGE message.slashCommand veya message.annotation.slashCommand
Hızlı komut APP_COMMAND appCommandMetadata
Mesaj işlemi APP_COMMAND appCommandMetadata

Eğik çizgi komutuna yanıt verme

Aşağıdaki kodda, /about eğik çizgi komutuna yanıt veren ve eklenti olmayan bir Chat uygulaması örneği gösterilmektedir. Chat uygulaması, MESSAGE etkileşim etkinliklerini işler, etkileşim etkinliğinin eşleşen komut kimliğini içerip içermediğini algılar ve özel bir Message nesnesi döndürür:

Node.js

node/avatar-app/index.js
/**
 * Handles slash and quick commands.
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleAppCommands(event, res) {
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
    case HELP_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

Apps Komut Dosyası

apps-script/avatar-app/avatar-app.gs
// Checks for the presence of a slash command in the message.
if (event.message.slashCommand) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  switch (event.message.slashCommand.commandId) {
    case ABOUT_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Python

python/avatar-app/main.py
def handle_app_commands(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles slash and quick commands.

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """
    app_command_id = event["appCommandMetadata"]["appCommandId"]

    if app_command_id == ABOUT_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    elif app_command_id == HELP_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    return {}

Java

java/avatar-app/src/main/java/AvatarApp.java
/**
 * Handles slash and quick commands.
 *
 * @param event    The Google Chat event.
 * @param response The HTTP response object.
 */
private void handleAppCommands(JsonObject event, HttpResponse response) throws Exception {
  int appCommandId = event.getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt();

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      Message aboutMessage = new Message();
      aboutMessage.setText("The Avatar app replies to Google Chat messages.");
      aboutMessage.setPrivateMessageViewer(new User()
          .setName(event.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
    case HELP_COMMAND_ID:
      Message helpMessage = new Message();
      helpMessage.setText("The Avatar app replies to Google Chat messages.");
      helpMessage.setPrivateMessageViewer(new User()
          .setName(event.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(helpMessage));
      return;
  }
}

ABOUT_COMMAND_ID ifadesini, Google Cloud Console'da komutu yapılandırırken belirttiğiniz komut kimliğiyle değiştirin.

Kısa komutlara yanıt verme

Aşağıdaki kodda, Yardım hızlı komutuna yanıt veren ve eklenti olmayan bir Chat uygulaması örneği gösterilmektedir. Chat uygulaması, APP_COMMAND etkileşim etkinliklerini işler, etkileşim etkinliğinin eşleşen komut kimliğini içerip içermediğini algılar ve özel bir Message nesnesi döndürür:

Node.js

node/avatar-app/index.js
/**
 * Handles slash and quick commands.
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleAppCommands(event, res) {
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
    case HELP_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

Apps Komut Dosyası

apps-script/avatar-app/avatar-app.gs
/**
 * Handles the APP_COMMAND event type. This function is triggered when a user
 * interacts with a quick command within the Google Chat app.  It responds
 * based on the command ID.
 *
 * @param {Object} event The event object from Google Chat, containing details
 *     about the app command interaction.  It includes information like the
 *     command ID and the user who triggered it.
 */
function onAppCommand(event) {
  // Executes the quick command logic based on its ID.
  // Command IDs are set in the Google Chat API configuration.
  switch (event.appCommandMetadata.appCommandId) {
    case HELP_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Python

python/avatar-app/main.py
def handle_app_commands(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles slash and quick commands.

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """
    app_command_id = event["appCommandMetadata"]["appCommandId"]

    if app_command_id == ABOUT_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    elif app_command_id == HELP_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    return {}

Java

java/avatar-app/src/main/java/AvatarApp.java
/**
 * Handles slash and quick commands.
 *
 * @param event    The Google Chat event.
 * @param response The HTTP response object.
 */
private void handleAppCommands(JsonObject event, HttpResponse response) throws Exception {
  int appCommandId = event.getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt();

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      Message aboutMessage = new Message();
      aboutMessage.setText("The Avatar app replies to Google Chat messages.");
      aboutMessage.setPrivateMessageViewer(new User()
          .setName(event.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
    case HELP_COMMAND_ID:
      Message helpMessage = new Message();
      helpMessage.setText("The Avatar app replies to Google Chat messages.");
      helpMessage.setPrivateMessageViewer(new User()
          .setName(event.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(helpMessage));
      return;
  }
}

HELP_COMMAND_ID ifadesini, Google Cloud Console'da komutu yapılandırırken belirttiğiniz komut kimliğiyle değiştirin.

Mesaj işlemine yanıt verme

Aşağıdaki kodda, Bana hatırlat mesaj işlemine yanıt veren ve eklenti olmayan bir Chat uygulaması örneği gösterilmektedir. Chat uygulaması, APP_COMMAND etkileşim etkinliklerini işler, etkileşim etkinliğinin eşleşen komut kimliğini içerip içermediğini algılar ve özel bir Message nesnesi döndürür:

Node.js

/**
 * Responds to an APP_COMMAND interaction event from Google Chat.
 *
 * @param {Object} event The interaction event from Google Chat.
 * @param {Object} res The HTTP response object.
 * @return {Object} The JSON response message with a confirmation.
 */
function handleAppCommand(event, res) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  // Use appCommandType to detect message actions.
  if (appCommandType === 'MESSAGE_ACTION' &&
      appCommandId === REMIND_ME_COMMAND_ID) {

    // Message actions can access the context of the message they were
    // invoked on, such as the text or sender of that message.
    const messageText = event.message.text;

    // Return a response that includes details from the original message.
    return res.send({
      text: `Setting a reminder for this message: "${messageText}"`
    });
  }
}

Apps Komut Dosyası

/**
 * Responds to an APP_COMMAND interaction event in Google Chat.
 *
 * @param {Object} event The interaction event from Google Chat.
 * @return {Object} The JSON response message with a confirmation.
 */
function onAppCommand(event) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  if (appCommandType === 'MESSAGE_ACTION' &&
      appCommandId === REMIND_ME_COMMAND_ID) {

    // Message actions can access the context of the message they were
    // invoked on, such as the text or sender of that message.
    const messageText = event.message.text;

    // Return a response that includes details from the original message.
    return { "text": "Setting a reminder for message: " + messageText };
  }
}

Python

def handle_app_command(event):
    """Responds to an APP_COMMAND interaction event from Google Chat.

    Args:
        event (dict): The interaction event from Google Chat.

    Returns:
        dict: The JSON response message with a confirmation.
    """
    # Collect the command ID and type from the event metadata.
    metadata = event.get('appCommandMetadata', {})
    if metadata.get('appCommandType') == 'MESSAGE_ACTION' and \
       metadata.get('appCommandId') == REMIND_ME_COMMAND_ID:

        # Message actions can access the context of the message they were
        # invoked on, such as the text or sender of that message.
        message_text = event.get('message', {}).get('text')

        # Return a response that includes details from the original message.
        return {
            "text": f'Setting a reminder for message: "{message_text}"'
        }

Java

/**
 * Responds to an APP_COMMAND interaction event from Google Chat.
 *
 * @param event The interaction event from Google Chat.
 * @param response The HTTP response object.
 */
void handleAppCommand(JsonObject event, HttpResponse response) throws Exception {
  // Collect the command ID and type from the event metadata.
  JsonObject metadata = event.getAsJsonObject("appCommandMetadata");
  String appCommandType = metadata.get("appCommandType").getAsString();

  if (appCommandType.equals("MESSAGE_ACTION")) {
    int commandId = metadata.get("appCommandId").getAsInt();
    if (commandId == REMIND_ME_COMMAND_ID) {
      // Message actions can access the context of the message they were
      // invoked on, such as the text or sender of that message.
      String messageText = event.getAsJsonObject("message").get("text").getAsString();

      // Return a response that includes details from the original message.
      JsonObject responseMessage = new JsonObject();
      responseMessage.addProperty("text", "Setting a reminder for message: " + messageText);
      response.getWriter().write(responseMessage.toString());
    }
  }
}

REMIND_ME_COMMAND_ID ifadesini, Google Cloud Console'da komutu yapılandırırken belirttiğiniz komut kimliğiyle değiştirin.