ตอบกลับคําสั่งเครื่องหมายทับในรูปแบบแอป 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 ถึง 1000 ที่แอป Chat ใช้เพื่อจดจำคำสั่งเครื่องหมายทับและแสดงผลการตอบกลับ

  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:
      Message aboutMessage = new Message();
      aboutMessage.setText("The Avatar app replies to Google Chat messages.");
      aboutMessage.setPrivateMessageViewer(new User()
        .setName(body.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
  }
}

ตั้งค่า ABOUT_COMMAND_ID ด้วยรหัสคำสั่งที่คุณระบุไว้เมื่อกําหนดค่าคําสั่งเครื่องหมายทับใน Chat API หากต้องการทดสอบโค้ดนี้ โปรดดูหัวข้อทดสอบฟีเจอร์แบบอินเทอร์แอกทีฟสำหรับแอป Google Chat