Eğik çizgi komutlarına Google Chat uygulaması olarak yanıt verme

Bu sayfada, Google Chat uygulaması.

Eğik çizgi komutları, kullanıcıların Chat uygulamasını çağırıp uygulamayla etkileşime geçmesinin yaygın bir yoludur. Eğik çizgi komutları, kullanıcıların Chat uygulamasının önemli özelliklerini keşfetmesine ve kullanmasına da yardımcı olur.

Eğik çizgi komutu kullanmak için kullanıcılar bir eğik çizgi (/) ve ardından Chat uygulaması hakkında bilgi almak için /about gibi kısa bir metin komutu yazar. Kullanıcılar, Google Chat'e eğik çizgi yazarak Chat uygulaması için kullanılabilen komutların listesini içeren bir pencere görüntüleyebilir:

Eğik çizgi komutu penceresi
Şekil 1: Kullanıcılar Google Chat'e eğik çizgi yazdığında görünen pencere

Eğik çizgi komutları ayarlamanız gerekip gerekmediğine karar vermek ve kullanıcı etkileşimleri tasarlamak için Tüm kullanıcı yolculuklarını tanımlayın.

Gizli yanıtlarla eğik çizgi komutları

Bir kullanıcı eğik çizgi komutu içeren bir mesaj gönderdiğinde bu mesaj yalnızca kullanıcı ve Chat uygulaması tarafından görülebilir. Chat uygulamanızı birden fazla kullanıcının bulunduğu alanlara eklenecek şekilde yapılandırdıysanız kullanıcı ile Chat uygulaması arasındaki etkileşimi gizli tutmak için eğik çizgi komutuna gizli olarak yanıt verebilirsiniz.

Örneğin, Arkadaş Bitkiler Projesi hakkında keşfetmek üzere kullanıcılar /about veya /help gibi komutlar kullanabilir. Alandaki diğer herkese bildirim göndermemek için Chat uygulaması, aşağıdakilerle ilgili bilgilerle gizli olarak yanıt verebilir: Chat uygulamasını kullanmayı ve destek almayı öğreteceğim.

Ön koşullar

Node.js

Etkileşimli özellikler için etkinleştirilmiş bir Google Chat uygulaması. Bir HTTP hizmeti kullanarak etkileşimli Chat uygulaması için bu hızlı başlangıç kılavuzunu tamamlayın.

Apps Komut Dosyası

Etkileşimli özellikler için etkinleştirilmiş bir Google Chat uygulaması. Bir Apps Komut Dosyası'ndaki etkileşimli Chat uygulaması için bu hızlı başlangıç kılavuzunu tamamlayın.

Python

Etkileşimli özellikler için etkinleştirilmiş bir Google Chat uygulaması. Bir HTTP hizmeti kullanarak etkileşimli Chat uygulaması için bu hızlı başlangıç kılavuzunu tamamlayın.

Java

Etkileşimli özellikler için etkinleştirilmiş bir Google Chat uygulaması. HTTP hizmetini kullanarak etkileşimli bir Chat uygulaması oluşturmak için bu hızlı başlangıç kılavuzunu tamamlayın.

Eğik çizgi komutu oluşturma

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

  1. Eğik çizgi komutunuz için bir ad oluşturun.
  2. Google Chat API'de eğik çizgi komutunu yapılandırın.

Eğik çizgi komutunuzu adlandırın

Eğik çizgi komutunun adı, kullanıcıların Chat mesajına yazdığı addır Chat uygulamasını çağırın. Kısa bir açıklama da komutun nasıl kullanılacağı konusunda daha ayrıntılı bilgi istemek için adın altında görünür:

Slash komutu adı ve açıklaması
Şekil 2: Eğik çizgi komutunun adı ve açıklaması.

Eğik çizgi komutunuz için bir ad ve açıklama seçerken, şu önerileri uygulayın:

  • Eğik çizgi komutunuzu adlandırmak için:

    • Komutları kullanıcı için net ve basit hale getirmek amacıyla kısa, açıklayıcı ve işlem yapılabilir kelimeler veya kelime öbekleri kullanın. Örneğin, /createAReminder yerine /remindMe yazın.
    • Komutunuz birden fazla kelimeden oluşuyorsa ilk kelime için tümüyle küçük harfleri, diğer kelimelerin ilk harfini büyük yazarak kullanıcıların komutu okumasına yardımcı olun. Örneğin, /updatecontact yerine /updateContact kullanın.
    • Komutunuz için benzersiz mi yoksa yaygın bir ad mı kullanacağınızı düşünün. Eğer komutunuz tipik bir etkileşimi veya özelliği açıklıyorsa kullanıcıların tanıdığı ve beklediği ortak ad, ör. /settings veya /feedback. Aksi takdirde, benzersiz komut adları kullanmayı deneyin. Aksi takdirde, komut adınız diğer Chat uygulamalarıyla aynıysa kullanıcının komutunuzu bulup kullanması için benzer komutları filtrelemesi gerekir.

  • Eğik çizgi komutunuzu açıklamak için:

    • Kullanıcıların komutu çağırdığında ne beklemeleri gerektiğini bilmesi için açıklamayı kısa ve net tutun.
    • Komut için herhangi bir biçimlendirme gereksinimi olup olmadığını kullanıcılara bildirin. Örneğin, bağımsız değişken metni gerektiren bir /remindMe komutu oluşturursanız açıklamayı Remind me to do [something] at [time] gibi bir değere ayarlayın.
    • Chat uygulaması yanıt verirse kullanıcılara haber verin veya komutu çağıran kullanıcıya özel olarak oluşturabilirsiniz. Örneğin, eğik çizgi komutu /about için bu komutu şu şekilde açıklayabilirsiniz: Learn about this app (Only visible to you).

Google Chat API'de eğik çizgi komutunuzu yapılandırma

Eğik çizgi komutu oluşturmak için komutla ilgili bilgileri Chat uygulamanızın Google Chat API yapılandırmasına gidin.

Google Chat API'de eğik çizgi komutunu yapılandırmak için aşağıdaki adımları uygulayın:

  1. Google Cloud konsolunda Menü'yü tıklayın. . > API'lar ve Hizmetler > Etkin API'ler ve Hizmetler > Google Chat API

    Google Chat API sayfasına gidin

  2. Yapılandırma'yı tıklayın.

  3. Eğik çizgi komutları altında, Eğik çizgi komutu ekle'yi tıklayın.

  4. Komut için bir ad, komut kimliği ve açıklama girin:

    1. Ad: komutun görünen adı ve kullanıcıların girdiği ad Eğik çizgiyle başlamalıdır, yalnızca metin içerebilir ve en fazla 50 karakter olmalıdır.
    2. Açıklama: nasıl kullanılacağını ve biçimlendirileceğini açıklayan metin komutudur. Açıklamalar en fazla 50 karakter uzunluğunda olabilir.
    3. Komut Kimliği: Anahtar kelimelerinizin, Chat uygulaması eğik çizgi komutunu tanımak için kullanır ve bir yanıt döndürüyor.

  5. İsteğe bağlı: Chat uygulamanızın yanıt vermesini istiyorsanız iletişim kutusunu kullanarak komut verdiğinizde, İletişim kutusu aç onay kutusu.

  6. Kaydet'i tıklayın.

Eğik çizgi komutu artık Chat uygulaması için yapılandırılmıştır.

Eğik çizgi komutuna yanıt verme

Kullanıcılar eğik çizgi komutu içeren bir Chat mesajı oluşturduğunda Chat uygulamanız bir MESSAGE etkileşim etkinliği alır. Etkinlik yükü, slashCommand ve slashCommandMetadata nesnelerini içerir. Bu nesneler, mesajda kullanılan komutla ilgili ayrıntıları içerir. (komut kimliği dahil) sağlamanız gerekir. Böylece, uygun bir yanıt döndürebilirsiniz.

Şu kullanıcı için özel mesaj: Cymbal Labs Chat uygulaması. Mesajda, Chat uygulaması, Cymbal Labs tarafından oluşturulmuştur ve bağlantısı paylaşmaktadır ve destek ekibiyle iletişim kurmak için kullanabileceğiniz bir bağlantı içerir.
Chat uygulaması, nasıl destek alacağınızı açıklamak için eğik çizgi komutuna /help özel olarak yanıt verir.

Aşağıdaki kodda bir Chat uygulaması örneği gösterilmektedir /about eğik çizgi komutuna MESSAGE etkileşim etkinliği ve algılama mesajın eşleşen komut kimliğini içerip içermediği. Mesajda Chat uygulaması bir özel mesaj döndürür:

Node.js

node/avatar-app/index.js
// 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 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
# Checks for the presence of a slash command in the message.
if "slashCommand" in request_json["message"]:
  # Executes the slash command logic based on its ID.
  # Slash command IDs are set in the Google Chat API configuration.
  if request_json["message"]["slashCommand"]["commandId"] == ABOUT_COMMAND_ID:
    return {
      "privateMessageViewer": request_json["user"],
      "text": 'The Avatar app replies to Google Chat messages.'
    }

Java

java/avatar-app/src/main/java/App.java
// Checks for the presence of a slash command in the message.
if (body.getAsJsonObject("message").has("slashCommand")) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  JsonObject slashCommand = body.getAsJsonObject("message").getAsJsonObject("slashCommand");
  switch (slashCommand.get("commandId").getAsString()) {
    case ABOUT_COMMAND_ID:
    JsonObject aboutMessage = new JsonObject();
    aboutMessage.addProperty("text", "The Avatar app replies to Google Chat messages.");
    aboutMessage.add("privateMessageViewer", body.getAsJsonObject("user"));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
  }
}

ABOUT_COMMAND_ID öğesini, oluşturduğunuz komut kimliğiyle ayarlayın Chat API'de eğik çizgi komutunu yapılandırdığınızdan emin olun. Bu kodu test etmek için bkz. Google Chat uygulamaları için etkileşimli özellikleri test edin.