รับและตอบสนองต่อเหตุการณ์การโต้ตอบ

หน้านี้อธิบายวิธีที่แอป Google Chat รับและตอบสนองต่อการโต้ตอบของผู้ใช้ ซึ่งเรียกอีกอย่างว่าเหตุการณ์การโต้ตอบของแอป Google Chat

หน้านี้จะอธิบายวิธีการทำสิ่งต่อไปนี้

• กำหนดค่าแอป Chat เพื่อรับเหตุการณ์การโต้ตอบ
• ประมวลผลเหตุการณ์การโต้ตอบในโครงสร้างพื้นฐาน
• หากเหมาะสม ให้ตอบกลับเหตุการณ์การโต้ตอบ

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

• บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
• สร้างโปรเจ็กต์ Google Cloud
• กำหนดค่าหน้าจอขอความยินยอม OAuth
• เปิดใช้ Google Chat API

ประเภทของเหตุการณ์การโต้ตอบ

เหตุการณ์การโต้ตอบของแอป Google Chat แสดงถึงการดำเนินการใดๆ ที่ผู้ใช้ทำเพื่อเรียกใช้หรือโต้ตอบกับแอป Chat เช่น การ @พูดถึงแอป Chat หรือการเพิ่มแอปไปยังพื้นที่

เมื่อผู้ใช้โต้ตอบกับแอป Chat Google Chat จะส่งเหตุการณ์การโต้ตอบไปยังแอป Chat ซึ่งแสดงเป็นประเภท Event ใน Chat API แอป Chat สามารถใช้เหตุการณ์เพื่อ ประมวลผลการโต้ตอบ และอาจตอบกลับด้วยข้อความ

สำหรับการโต้ตอบของผู้ใช้แต่ละประเภท Google Chat จะส่งเหตุการณ์การโต้ตอบประเภทต่างๆ ซึ่งจะช่วยให้แอป Chat จัดการเหตุการณ์แต่ละประเภทได้อย่างเหมาะสม ประเภทของเหตุการณ์การโต้ตอบจะแสดงโดยใช้ออบเจ็กต์ eventType

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

ตารางต่อไปนี้แสดงการโต้ตอบของผู้ใช้ที่พบบ่อย ประเภทของเหตุการณ์การโต้ตอบที่แอป Chat ได้รับ และวิธีที่แอป Chat ตอบกลับโดยทั่วไป

หากต้องการดูเหตุการณ์การโต้ตอบที่รองรับทั้งหมด โปรดดูเอกสารประกอบEventTypeอ้างอิง

เหตุการณ์การโต้ตอบจากกล่องโต้ตอบ

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

• isDialogEvent ตั้งค่าเป็น true
• DialogEventType จะอธิบายว่าการโต้ตอบจะทริกเกอร์ให้กล่องโต้ตอบเปิดขึ้น ส่ง ข้อมูลจากกล่องโต้ตอบ หรือปิดกล่องโต้ตอบ

ตารางต่อไปนี้แสดงการโต้ตอบทั่วไปกับกล่องโต้ตอบ ประเภทเหตุการณ์ของกล่องโต้ตอบที่เกี่ยวข้อง และคำอธิบายเกี่ยวกับวิธีที่แอป Chat ตอบกลับโดยทั่วไป

ดูข้อมูลเพิ่มเติมได้ที่เปิดกล่องโต้ตอบแบบอินเทอร์แอกทีฟ

รับเหตุการณ์การโต้ตอบของแอป Chat

ส่วนนี้อธิบายวิธีรับและประมวลผลเหตุการณ์การโต้ตอบสำหรับแอป Chat

กำหนดค่าแอป Chat เพื่อรับเหตุการณ์การโต้ตอบ

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

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

1. ในคอนโซล Google Cloud ให้ไปที่หน้า Chat API แล้วคลิกหน้าการกำหนดค่า

   ไปที่หน้าการกำหนดค่า Chat API

2. ในส่วนฟีเจอร์แบบอินเทอร์แอกทีฟ ให้ตรวจสอบการตั้งค่าและอัปเดตตาม ฟีเจอร์ที่ต้องการสร้าง

   ช่อง	คำอธิบาย
   ฟังก์ชันการทำงาน	ต้องระบุ ชุดฟิลด์ที่กำหนดวิธีที่แอป Chat โต้ตอบกับผู้ใช้ โดยค่าเริ่มต้น ผู้ใช้จะค้นหาและส่งข้อความถึงแอป Chat ได้โดยตรงใน Google Chat เข้าร่วมพื้นที่ทำงานและการสนทนากลุ่ม: ผู้ใช้สามารถเพิ่มแอป Chat ลงในพื้นที่ทำงานและการสนทนากลุ่มได้
   การตั้งค่าการเชื่อมต่อ	ต้องระบุ ปลายทางสำหรับแอป Chat ซึ่งเป็นหนึ่งในรายการต่อไปนี้ URL ปลายทาง HTTP: ปลายทาง HTTPS ที่โฮสต์การติดตั้งใช้งานแอป Chat Apps Script: รหัสการติดตั้งใช้งานสำหรับโปรเจ็กต์ Apps Script ที่ใช้แอป Chat ชื่อหัวข้อ Cloud Pub/Sub: หัวข้อ Pub/Sub ที่แอป Chat ติดตามเป็นปลายทาง Dialogflow: ลงทะเบียนแอป Chat กับการผสานรวม Dialogflow ดูข้อมูลเพิ่มเติมได้ที่สร้างแอป Dialogflow Google Chat ที่เข้าใจภาษาที่เป็นธรรมชาติ
   คำสั่ง	ไม่บังคับ คำสั่งเครื่องหมายทับและคำสั่งด่วนสำหรับแอป Chat คำสั่งช่วยให้ผู้ใช้ขอการดำเนินการหรือใช้ฟีเจอร์ที่เฉพาะเจาะจงของแอป Chat ได้ ดูข้อมูลเพิ่มเติมได้ที่ตอบกลับคำสั่งแอป Google Chat
   พรอมต์เริ่มต้น	ไม่บังคับ (science เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์) พรอมต์สถานะค่าเป็นศูนย์สูงสุด 3 รายการซึ่งจะปรากฏเมื่อผู้ใช้เปิดข้อความส่วนตัวแบบ 1:1 ที่ว่างเปล่าด้วยแอป Chat พรอมต์สามารถป้อนข้อความในพื้นที่เขียน (พร้อมรองรับการแปลหลายภาษา) หรือทริกเกอร์คำสั่ง Slash/Quick ได้โดยตรง ดูข้อมูลเพิ่มเติมได้ที่กำหนดค่าพรอมต์เริ่มต้น
   ตัวอย่างลิงก์	ไม่บังคับ รูปแบบ URL ที่แอปใน Chat รู้จักและแสดงเนื้อหาเพิ่มเติมเมื่อผู้ใช้ส่งลิงก์ ดูข้อมูลเพิ่มเติมได้ที่ดูตัวอย่างลิงก์
   ระดับการแชร์	ไม่บังคับ บุคคลสูงสุด 5 คน หรือ Google Groups อย่างน้อย 1 กลุ่มที่ดูและติดตั้งแอป Chat ของคุณได้ ใช้ช่องนี้เพื่อทดสอบแอป Chat หรือแชร์แอป Chat กับทีม ดูข้อมูลเพิ่มเติมได้ที่ทดสอบฟีเจอร์แบบอินเทอร์แอกทีฟ

3. คลิกบันทึก เมื่อบันทึกการกำหนดค่าแอป Chat แล้ว แอป Chat จะพร้อมใช้งานสำหรับผู้ใช้ที่ระบุในองค์กร Google Workspace

ตอนนี้แอป Chat ได้รับการกำหนดค่าให้รับเหตุการณ์การโต้ตอบจาก Google Chat แล้ว

กำหนดค่าพรอมต์เริ่มต้น

พรอมต์เริ่มต้นจะช่วยให้ผู้ใช้ค้นพบฟังก์ชันการทำงานของแอป Chat เมื่อเปิดข้อความส่วนตัวแบบ 1:1 ที่ว่างเปล่ากับแอปของคุณ คุณสามารถ กำหนดค่าพรอมต์เริ่มต้นได้สูงสุด 3 รายการ

วิธีเพิ่มและกำหนดค่าพรอมต์เริ่มต้น

1. ในคอนโซล Google Cloud ให้ไปที่หน้าการกำหนดค่า Chat API โดยทำดังนี้

   ไปที่หน้าการกำหนดค่า Chat API

2. ในส่วนฟีเจอร์แบบอินเทอร์แอกทีฟ ให้ค้นหาพรอมต์เริ่มต้น แล้วคลิกเพิ่มพรอมต์

3. ในช่องอันดับ (1-3) ให้ป้อนตัวเลขตั้งแต่ 1 ถึง 3 เพื่อระบุลําดับการแสดง

4. ในส่วนการเลือกประเภท ให้เลือกวิธีที่พรอมต์ทํางาน

   • พรอมต์ข้อความ: ป้อนข้อความที่กำหนดไว้ล่วงหน้าลงในช่องสำหรับเขียนเมื่อผู้ใช้คลิกชิปพรอมต์
   • Command Prompt: เรียกใช้คำสั่งเครื่องหมายทับหรือคำสั่งด่วนที่ลงทะเบียนไว้เมื่อคลิก คุณเลือกคำสั่งที่ต้องมีอาร์กิวเมนต์เพิ่มเติมไม่ได้

5. กำหนดค่าพรอมต์ตามประเภทที่คุณเลือก

   • หากเลือกพรอมต์ข้อความ ให้ทำดังนี้

     1. ในชื่อ ให้ป้อนชื่อพรอมต์ที่แสดงในชิป (สูงสุด 30 อักขระ)
     2. ในข้อความพรอมต์ ให้ป้อนข้อความที่ป้อนในช่องสำหรับเขียน (ไม่เกิน 60 อักขระ)
     3. ไม่บังคับ: เพิ่มชื่อและข้อความที่แปลเป็นภาษาท้องถิ่นสำหรับผู้ใช้ในภาษาอื่นๆ โดยทำดังนี้
     4. ในส่วนพรอมต์ที่แปลแล้ว ให้คลิกเพิ่มภาษา
     5. ในภาษา ให้เลือกภาษาที่รองรับจากเมนูแบบเลื่อนลง
     6. ในชื่อที่แปลแล้ว ให้ป้อนชื่อที่แปลแล้ว (สูงสุด 30 อักขระ)
     7. ในข้อความพรอมต์ที่แปลแล้ว ให้ป้อนข้อความพรอมต์ที่แปลแล้ว (สูงสุด 60 อักขระ)
     8. ทำซ้ำเพื่อเพิ่มภาษาอื่นๆ ตามต้องการ

   • หากคุณเลือก Command Prompt ให้ทำดังนี้

     1. ในคำสั่งเครื่องหมายทับ / คำสั่งด่วน ให้เลือกคำสั่งจากเมนูแบบเลื่อนลง

6. คลิกเสร็จสิ้น แล้วคลิกบันทึกที่ด้านล่างของหน้า

จัดการการลองใหม่ของการเรียก HTTP ไปยังบริการของคุณ

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

ประมวลผลหรือตอบกลับเหตุการณ์การโต้ตอบ

ส่วนนี้อธิบายวิธีที่แอป Google Chat ประมวลผลและตอบกลับเหตุการณ์การโต้ตอบได้

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

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

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

แผนภาพต่อไปนี้แสดงวิธีที่แอป Google Chat โดยทั่วไปประมวลผลหรือตอบสนองต่อเหตุการณ์การโต้ตอบประเภทต่างๆ

ตอบกลับแบบเรียลไทม์

เหตุการณ์การโต้ตอบช่วยให้แอปแชทตอบกลับได้แบบเรียลไทม์หรือพร้อมกัน การตอบกลับแบบซิงโครนัสไม่จำเป็นต้องมีการตรวจสอบสิทธิ์

หากต้องการตอบกลับแบบเรียลไทม์ แอป Chat ต้องแสดงออบเจ็กต์ Message หากต้องการตอบกลับด้วยข้อความในพื้นที่ทำงาน ออบเจ็กต์ Message จะมีออบเจ็กต์ text, cardsV2 และ accessoryWidgets ได้ หากต้องการใช้กับคำตอบประเภทอื่นๆ โปรดดูคำแนะนำต่อไปนี้

• เปิดกล่องโต้ตอบแบบอินเทอร์แอกทีฟ
• ลิงก์ตัวอย่าง
• ประมวลผลข้อมูลที่ผู้ใช้ส่ง

ตอบกลับด้วยข้อความ

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

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

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} req The event object from Chat API.
 * @param {Object} res The response object from the Chat app.
 */
exports.cymbalApp = function cymbalApp(req, res) {
  // Send an onboarding message when added to a Chat space
  if (req.body.type === 'ADDED_TO_SPACE') {
    res.json({
      'text': 'Hi, Cymbal at your service. I help you manage your calendar
      from Google Chat. Take a look at your schedule today by typing
      `/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To
      learn what else I can do, type `/help`.'
    });
  }
};

from flask import Flask, request, json
app = Flask(__name__)

@app.route('/', methods=['POST'])
def cymbal_app():
  """Sends an onboarding message when the Chat app is added to a space.

  Returns:
    Mapping[str, Any]: The response object from the Chat app.
  """
  event = request.get_json()
  if event['type'] == 'ADDED_TO_SPACE':
    return json.jsonify({
      'text': 'Hi, Cymbal at your service. I help you manage your calendar' +
      'from Google Chat. Take a look at your schedule today by typing' +
      '`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To' +
      'learn what else I can do, type `/help`.'
    })
  return json.jsonify({})

@SpringBootApplication
@RestController
public class App {
  public static void main(String[] args) {
    SpringApplication.run(App.class, args);
  }

  /*
   * Sends an onboarding message when the Chat app is added to a space.
   *
   * @return The response object from the Chat app.
   */
  @PostMapping("/")
  @ResponseBody
  public Message onEvent(@RequestBody JsonNode event) {
    switch (event.get("type").asText()) {
      case "ADDED_TO_SPACE":
        return new Message().setText(
          "Hi, Cymbal at your service. I help you manage your calendar" +
          "from Google Chat. Take a look at your schedule today by typing" +
          "`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`." +
          "To learn what else I can do, type `/help`.");
      default:
        return new Message();
    }
  }
}

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app.
 */
function onAddToSpace(event) {
  return {
    'text': 'Hi, Cymbal at your service. I help you manage your calendar
    from Google Chat. Take a look at your schedule today by typing
    `/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To learn
    what else I can do, type `/help`.'
  }
}

ตัวอย่างโค้ดจะแสดงผลข้อความต่อไปนี้

ตอบกลับแบบอะซิงโครนัส

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

หากต้องการสร้างข้อความโดยใช้ Chat API โปรดดูสร้างข้อความ ดูคำแนะนำเกี่ยวกับการใช้ เมธอด Chat API อื่นๆ ได้ที่ ภาพรวมของ Chat API

หัวข้อที่เกี่ยวข้อง

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