ตอบกลับคําสั่งเครื่องหมายทับในรูปแบบแอป Google Chat

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

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

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

หน้าต่างคำสั่งเครื่องหมายทับ
รูปที่ 1: หน้าต่างที่ปรากฏขึ้นเมื่อผู้ใช้พิมพ์เครื่องหมายทับใน Google Chat

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

คำสั่งเครื่องหมายทับที่มีคำตอบส่วนตัว

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

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

ข้อกำหนดเบื้องต้น

Node.js

แอป Google Chat ที่เปิดใช้ฟีเจอร์แบบอินเทอร์แอกทีฟ หากต้องการสร้างแอป Chat แบบอินเทอร์แอกทีฟโดยใช้บริการ HTTP ให้ทําตามการเริ่มต้นใช้งานอย่างรวดเร็วนี้

Apps Script

แอป Google Chat ที่เปิดใช้ฟีเจอร์แบบอินเทอร์แอกทีฟ วิธีสร้าง แอป Chat แบบอินเทอร์แอกทีฟใน Apps Script โปรดกรอกข้อมูลในการเริ่มต้นอย่างรวดเร็วนี้

Python

แอป Google Chat ที่เปิดใช้ฟีเจอร์แบบอินเทอร์แอกทีฟ วิธีสร้าง แอป Chat แบบอินเทอร์แอกทีฟที่ใช้บริการ HTTP โปรดกรอกข้อมูลในการเริ่มต้นอย่างรวดเร็วนี้

Java

แอป Google Chat ที่เปิดใช้ฟีเจอร์แบบอินเทอร์แอกทีฟ หากต้องการสร้างแอป Chat แบบอินเทอร์แอกทีฟโดยใช้บริการ HTTP ให้ทําตามการเริ่มต้นใช้งานอย่างรวดเร็วนี้

ตั้งค่าคำสั่งเครื่องหมายทับ

ส่วนนี้จะอธิบายวิธีทำตามขั้นตอนต่อไปนี้เพื่อตั้งค่าเครื่องหมายทับ คำสั่ง:

  1. ตั้งชื่อคำสั่งสแลช
  2. กำหนดค่าคำสั่งเครื่องหมายทับใน Google Chat API

ตั้งชื่อคำสั่งเครื่องหมายทับ

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

ชื่อและคำอธิบายคำสั่งเครื่องหมายทับ
รูปที่ 2: ชื่อและคำอธิบายของคำสั่งเครื่องหมายทับ

เมื่อเลือกชื่อและคำอธิบายสำหรับคำสั่งแบบขีดกลาง ให้พิจารณาตามคำแนะนำต่อไปนี้

  • วิธีตั้งชื่อคำสั่งเครื่องหมายทับ

    • ใช้คำหรือวลีสั้นๆ ที่สื่อความหมายและนำไปใช้ได้จริงเพื่อให้คำสั่งชัดเจนและเข้าใจง่ายสำหรับผู้ใช้ เช่น ใช้ /remindMe แทนที่จะพูดว่า /createAReminder
    • หากคำสั่งของคุณมีมากกว่า 1 คำ โปรดช่วยให้ผู้ใช้อ่านคำสั่ง โดยใช้อักษรตัวพิมพ์เล็กทั้งหมดกับคำแรก แล้วตามด้วยตัวพิมพ์ใหญ่ขึ้นต้น ตัวอักษรเพิ่มเติม เช่น ใช้ /updateContact แทน /updatecontact
    • พิจารณาว่าจะใช้ชื่อเฉพาะหรือชื่อทั่วไปสำหรับคำสั่งของคุณ ถ้า คำสั่งของคุณจะอธิบายการโต้ตอบหรือคุณลักษณะทั่วไป คุณสามารถใช้ ชื่อทั่วไปที่ผู้ใช้รู้จักและคาดหวัง เช่น /settingsหรือ /feedback หรือลองใช้ชื่อคำสั่งที่ไม่ซ้ำกัน เนื่องจากหากชื่อคำสั่งของคุณเหมือนกับแอปแชทอื่นๆ ผู้ใช้จะต้องกรองคำสั่งที่คล้ายกันเพื่อค้นหาและใช้คำสั่งของคุณ
  • หากต้องการอธิบายคำสั่งเครื่องหมายทับ ให้ทำดังนี้

    • เขียนคำอธิบายให้สั้นและชัดเจนเพื่อให้ผู้ใช้รู้ว่าควรคาดหวังสิ่งใด เมื่อเรียกใช้คำสั่ง
    • แจ้งให้ผู้ใช้ทราบหากมีข้อกำหนดการจัดรูปแบบสำหรับคำสั่ง เช่น หากคุณสร้างคำสั่ง /remindMe ที่ต้องใช้อาร์กิวเมนต์ ข้อความ ให้กำหนดคำอธิบายเป็น Remind me to do [something] at [time]
    • แจ้งให้ผู้ใช้ทราบว่าแอป Chat จะตอบกลับทุกคนในพื้นที่ทำงานหรือตอบกลับผู้ใช้ที่เรียกใช้คำสั่งเป็นการส่วนตัว ตัวอย่างเช่น สำหรับคำสั่งเครื่องหมายทับ /about คุณสามารถอธิบายเป็น Learn about this app (Only visible to you)

กำหนดค่าคำสั่งเครื่องหมายทับใน Google Chat API

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

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

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

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

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

  3. คลิกเพิ่มคำสั่งเครื่องหมายทับในส่วนคำสั่งเครื่องหมายทับ

  4. ป้อนชื่อ รหัสคําสั่ง และคําอธิบายสําหรับคําสั่ง

    1. ชื่อ: ชื่อที่แสดงของคำสั่งและสิ่งที่ผู้ใช้พิมพ์ เพื่อเรียกใช้แอปของคุณ ต้องขึ้นต้นด้วยเครื่องหมายทับ มีได้เฉพาะข้อความเท่านั้น และสามารถ ไม่เกิน 50 อักขระ
    2. คําอธิบาย: ข้อความที่อธิบายวิธีใช้และจัดรูปแบบคําสั่ง คำอธิบายมีความยาวได้ไม่เกิน 50 อักขระ
    3. รหัสคําสั่ง: ตัวเลขตั้งแต่ 1 ถึง 1,000 ที่แอปแชทใช้เพื่อจดจําคําสั่งเครื่องหมายทับและแสดงผลตอบกลับ
  5. ไม่บังคับ: หากต้องการให้แอป Chat ตอบกลับ คำสั่งที่มีกล่องโต้ตอบ ให้เลือก ช่องทำเครื่องหมายเปิดกล่องโต้ตอบ

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

กำหนดค่าคำสั่งเครื่องหมายทับสำหรับแอป Chat แล้ว

ตอบกลับคำสั่งเครื่องหมายทับ

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

ข้อความส่วนตัวสำหรับแอป Chat ของ Cymbal Labs ข้อความระบุว่าแอป Chat สร้างขึ้นโดย Cymbal Labs และแชร์ลิงก์ไปยังเอกสารประกอบและลิงก์สำหรับติดต่อทีมสนับสนุน
แอปใน Chat จะตอบสนองแบบส่วนตัวต่อ คำสั่งเครื่องหมายทับ /help เพื่ออธิบายวิธีรับการสนับสนุน

โค้ดต่อไปนี้แสดงตัวอย่างของแอป Chat ที่ตอบกลับคำสั่งเครื่องหมายทับ /about โดยการจัดการ เหตุการณ์การโต้ตอบ MESSAGE รายการและการตรวจจับ ข้อความมีรหัสคำสั่งที่ตรงกันหรือไม่ หากข้อความประกอบด้วย รหัสคำสั่ง แอป Chat จะแสดงข้อความส่วนตัวดังนี้

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 Script

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 ด้วยรหัสคำสั่งที่คุณ ระบุเมื่อคุณ กำหนดค่าคำสั่งเครื่องหมายทับใน Chat API หากต้องการทดสอบโค้ดนี้ โปรดดูหัวข้อทดสอบฟีเจอร์แบบอินเทอร์แอกทีฟสำหรับแอป Google Chat