ตอบสนองต่อคำสั่งด่วนใน Google Chat

ตัวอย่างนักพัฒนา: มีให้เป็นส่วนหนึ่งของโปรแกรมตัวอย่างสำหรับนักพัฒนา Google Workspace ซึ่งให้สิทธิ์การเข้าถึงฟีเจอร์บางอย่างก่อนใคร

หน้านี้จะอธิบายวิธีตั้งค่าและตอบสนองต่อคำสั่งสั้นๆ สำหรับแอป Google Chat

คำสั่งสั้นๆเป็นวิธีที่ผู้ใช้สามารถเรียกใช้และโต้ตอบกับแอป Chat หากต้องการใช้คำสั่งสั้นๆ ให้เปิดเมนูการผสานรวมโดยคลิกเครื่องมือ Google Workspace ในพื้นที่ใน Chat หรือการสนทนา จากนั้นเลือกคำสั่งแอปที่มีชื่อไม่ขึ้นต้นด้วยเครื่องหมายทับ (/) การเลือกคำสั่งสั้นๆ จะเป็นการเรียกใช้แอป Chat โดยตรงโดยไม่ต้องรับข้อมูลจากผู้ใช้เพิ่มเติม ซึ่งช่วยให้ผู้ใช้โต้ตอบได้อย่างรวดเร็ว

นอกจากนี้ ผู้ใช้ยังเรียกใช้แอป Chat ผ่านคำสั่งแบบเครื่องหมายทับได้ด้วย เมื่อเทียบกับคำสั่งเครื่องหมายทับ คำสั่งด่วนจะมีรูปแบบที่มีชื่อที่ใช้งานง่ายกว่าใน UI ของ Chat โดยจะเรียกใช้ทันทีที่เลือก และผู้ใช้ไม่จําเป็นต้องจดจําหรือพิมพ์ชื่อของคําสั่งเครื่องหมายทับ

รูปที่ 1: เมนูการผสานรวมที่มีคำสั่งลัดสำหรับแอปใน Chat

ตั้งค่าคําสั่งสั้นๆ ใน Google Chat API

หากต้องการสร้างคำสั่งสั้นๆ หรืออัปเดตคำสั่งเครื่องหมายทับที่มีอยู่เป็นคำสั่งสั้นๆ คุณต้องระบุข้อมูลเกี่ยวกับคำสั่งในการกำหนดค่าแอป Google Chat สำหรับ Google Chat API

หากต้องการกำหนดค่าคำสั่งสั้นๆ ใน Google Chat API ให้ทำตามขั้นตอนต่อไปนี้

1. ในคอนโซล Google Cloud ให้คลิกเมนู > API และบริการ > API และบริการที่เปิดใช้ > Google Chat API

   ไปที่หน้า Google Chat API

2. คลิกการกําหนดค่า

3. ในส่วนการตั้งค่าขั้นสูง ให้ไปที่ทริกเกอร์ แล้วตรวจสอบว่าช่องคําสั่งแอปมีทริกเกอร์ เช่น ปลายทาง HTTP หรือฟังก์ชัน Apps Script คุณต้องทริกเกอร์นี้ในส่วนถัดไปเพื่อตอบสนองต่อคำสั่งสั้นๆ

4. ในส่วนคำสั่ง ให้คลิกเพิ่มคำสั่ง

5. ป้อนรหัส ชื่อ คำอธิบาย และประเภทคำสั่งสำหรับคำสั่ง

   • รหัสคําสั่ง: ตัวเลขตั้งแต่ 1 ถึง 1,000 ที่แอปแชทใช้เพื่อจดจําคําสั่งและแสดงคําตอบ
   • ชื่อ: ชื่อที่แสดงของคําสั่ง ชื่อมีอักขระได้ไม่เกิน 50 ตัวและอาจมีสัญลักษณ์พิเศษ
     • ใช้คำหรือวลีสั้นๆ ที่สื่อความหมายและนำไปใช้ได้จริงเพื่อให้ผู้ใช้เข้าใจคำสั่งได้ชัดเจน เช่น ใช้ อัปเดตรายชื่อติดต่อสำหรับคำสั่งที่แก้ไขระเบียนรายชื่อติดต่อ
   • คําอธิบาย: ข้อความที่อธิบายสิ่งที่คําสั่งทํา คำอธิบายมีความยาวได้ไม่เกิน 50 อักขระและใส่อักขระพิเศษได้
     • เขียนคำอธิบายให้สั้นและชัดเจนเพื่อให้ผู้ใช้ทราบว่าจะเกิดอะไรขึ้นเมื่อเรียกใช้คําสั่ง
     • แจ้งให้ผู้ใช้ทราบว่าแอป Chat จะตอบกลับทุกคนในพื้นที่ทำงานหรือตอบกลับผู้ใช้ที่เรียกใช้คําสั่งเป็นการส่วนตัว เช่น สำหรับคำสั่งสั้นๆ อย่างเกี่ยวกับ คุณอาจอธิบายเป็นดูข้อมูลเกี่ยวกับแอปนี้ (คุณเท่านั้นที่เห็นได้)
   • ประเภทคำสั่ง: เลือกคำสั่งสั้นๆ

6. ไม่บังคับ: หากต้องการให้แอป Chat ตอบสนองต่อคำสั่งด้วยกล่องโต้ตอบ ให้เลือกช่องทำเครื่องหมายเปิดกล่องโต้ตอบ

7. คลิกบันทึก

ตอนนี้คุณกำหนดค่าคำสั่งด่วนสำหรับแอป Chat แล้ว

ตอบสนองต่อคำสั่งสั้นๆ

เมื่อผู้ใช้เรียกใช้คำสั่งสั้นๆ แอป Chat ของคุณจะได้รับออบเจ็กต์เหตุการณ์ที่มีข้อมูลเกี่ยวกับคำสั่งสั้นๆ ออบเจ็กต์เหตุการณ์มีเพย์โหลด AppCommand พร้อมรายละเอียดเกี่ยวกับคําสั่งที่เรียกใช้ (รวมถึงรหัสคําสั่ง) เพื่อให้คุณตอบกลับได้อย่างเหมาะสม

หากต้องการตอบสนองต่อคําสั่งด่วน คุณต้องติดตั้งใช้งานทริกเกอร์คําสั่งแอปเพื่อให้แอป Chat จัดการออบเจ็กต์เหตุการณ์ที่มีข้อมูลเมตาคําสั่งแอปได้

โค้ดต่อไปนี้แสดงตัวอย่างแอป Chat ที่ตอบกลับคําสั่ง Help หากต้องการตอบสนองต่อคำสั่งสั้นๆ แอป Chat จะจัดการออบเจ็กต์เหตุการณ์จากทริกเกอร์คําสั่งแอป เมื่อเพย์โหลดของออบเจ็กต์เหตุการณ์มีรหัสคำสั่งด่วน แอป Chat จะแสดงผลการดำเนินการ DataActions ด้วยออบเจ็กต์ createMessageAction ดังนี้

Apps Script

// 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.'
                }}}}};
        }
    }
}

หากต้องการใช้ตัวอย่างโค้ดนี้ ให้แทนที่ HELP_COMMAND_ID ด้วยรหัสคำสั่งที่คุณระบุไว้เมื่อกําหนดค่าคําสั่งสั้นๆ ใน Chat API หากต้องการทดสอบคำสั่งด่วนใน Chat ให้เปิดเมนูการผสานรวมโดยคลิกเครื่องมือ Google Workspace แล้วเลือกคำสั่งด่วน