Google Chat'te hızlı komutlara yanıt verme

Bu sayfada, Google Chat uygulamanız için hızlı komutları nasıl ayarlayacağınız ve bu komutlara nasıl yanıt vereceğiniz açıklanmaktadır.

Hızlı komut, kullanıcıların Chat uygulamasını çağırıp bu uygulamayla etkileşime geçmesinin bir yoludur. Hızlı komut kullanmak için bir Chat alanında veya görüşmede Google Workspace Araçları'nı tıklayarak entegrasyon menüsünü açın ve ardından adı eğik çizgiyle (/) başlamayan bir uygulama komutu seçin. Hızlı komut seçtiğinizde Chat uygulaması, kullanıcıdan başka giriş alınmadan doğrudan çağrılır ve kullanıcının hızlı bir şekilde etkileşim kurması sağlanır.

Kullanıcılar, eğik çizgi komutu aracılığıyla da Chat uygulamasını çağırabilir. Eğik çizgiyle başlayan komutlara kıyasla hızlı komutlar, Chat kullanıcı arayüzünde daha kullanıcı dostu bir adla biçimlendirilir, seçildikten hemen sonra çağrılır ve kullanıcının eğik çizgiyle başlayan komutun adını hatırlamasını veya yazmasını gerektirmez.

Hızlı komutlar içeren entegrasyon menüsü
Şekil 1: Chat uygulamasına yönelik hızlı komutları içeren entegrasyon menüsü.

Google Chat API'de hızlı komut oluşturma

Hızlı komut oluşturmak veya mevcut eğik çizgi komutlarını hızlı komutlarla güncellemek için Chat uygulamanızın Google Chat API yapılandırmasında komutla ilgili bilgileri belirtmeniz gerekir.

Google Chat API'de hızlı 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. Yapılandırma'yı tıklayın.

  3. Gelişmiş ayarlar bölümünde Tetikleyiciler'e gidin ve Uygulama komutu alanının bir HTTP uç noktası veya Apps Script işlevi gibi bir tetikleyici içerdiğini kontrol edin. Hızlı komuta yanıt vermek için aşağıdaki bölümde bu tetikleyiciyi kullanmanız gerekir.

  4. Komutlar bölümünde Komut ekle'yi tıklayın.

  5. Komut için bir komut kimliği, ad, açıklama ve komut türü girin:

    • Komut kimliği: Chat uygulamanızın komutu tanıyıp yanıt döndürmek için kullandığı 1 ile 1.000 arasında bir sayı.
    • Ad: Komutun görünen adı. Adlar en fazla 50 karakter uzunluğunda olabilir ve özel karakterler içerebilir.
      • Komutların kullanıcı için net olmasını sağlamak amacıyla kısa, açıklayıcı ve uygulanabilir kelimeler veya kelime öbekleri kullanın. Örneğin, bir kişi kaydını değiştiren bir komut için Kişiyi güncelle'yi kullanın.
    • Açıklama: Komutun ne yaptığını açıklayan metin. Açıklamalar en fazla 50 karakter olabilir ve özel karakterler içerebilir.
      • Kullanıcıların komutu çağırdığında ne beklemeleri gerektiğini bilmesi için açıklamayı kısa ve net tutun.
      • Chat uygulamasının alandaki herkese mi yoksa komutu çağıran kullanıcıya özel olarak mı yanıt vereceğini kullanıcılara bildirin. Örneğin, Hakkında hızlı komutunu Bu uygulama hakkında bilgi edinin (Yalnızca size görünür) olarak tanımlayabilirsiniz.
    • Komut türü: Hızlı komut'u seçin.
  6. İ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.

  7. Kaydet'i tıklayın.

Hızlı komut artık Chat uygulaması için yapılandırılmıştır.

Hızlı komutlara yanıt verme

Kullanıcılar hızlı komutu çağrığında Chat uygulamanız, hızlı komutla ilgili bilgileri içeren bir etkinlik nesnesi alır. Etkinlik nesnesi, uygun bir yanıt döndürebilmeniz için çağrılan komutla ilgili ayrıntıları (komut kimliği dahil) içeren bir AppCommand yükü içerir.

Hızlı komutlara yanıt vermek için Chat uygulamanızın uygulama komutu meta verilerini içeren tüm etkinlik nesnelerini işleyebilmesi amacıyla uygulama komutu tetikleyicisini uygulamanız gerekir.

Aşağıdaki kodda, Yardım komutuna yanıt veren bir Chat uygulaması örneği gösterilmektedir. Chat uygulaması, hızlı komutlara yanıt vermek için uygulama komutu tetikleyicisinden etkinlik nesnelerini işler. Bir etkinlik nesnesinin yükü hızlı komut kimliği içerdiğinde Chat uygulaması, createMessageAction nesnesi içeren DataActions işlemini döndürür:

Apps Komut Dosyası

// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You must
// use the same ID as set in the Google Chat API configuration.
const HELP_COMMAND_ID = 0;

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onAppCommand(event) {

    // Stores the Google Chat app command metadata as a variable.
    const appCommandMetadata = event.chat.appCommandPayload.appCommandMetadata;

    if (appCommandMetadata.appCommandType == "QUICK_COMMAND") {

        // Executes the quick command logic based on its ID.
        // Quick command IDs are set in the Google Chat API configuration.
        switch (appCommandMetadata.appCommandId) {
            case HELP_COMMAND_ID:
                return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
                    text: 'The Avatar app replies to Google Chat messages.'
                }}}}};
        }
    }
}

Bu kod örneğini kullanmak için HELP_COMMAND_ID değerini, Chat API'de hızlı komutu yapılandırırken belirttiğiniz komut kimliğiyle değiştirin. Chat'te hızlı komutları test etmek için Google Workspace Araçları'nı tıklayıp hızlı komutunuzu seçerek entegrasyon menüsünü açın.