ออบเจ็กต์เหตุการณ์

หน้านี้จะแสดงโครงสร้างของออบเจ็กต์เหตุการณ์ส่วนเสริม Google Workspace

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

ส่วนเสริม Google Workspace ใช้ออบเจ็กต์เหตุการณ์ในตำแหน่งต่อไปนี้

• ทริกเกอร์หน้าแรก ฟังก์ชัน homepageTrigger ทั้งหมดที่คุณกําหนดจะส่งออบเจ็กต์เหตุการณ์โดยอัตโนมัติเมื่อฟังก์ชันทริกเกอร์ของหน้าแรกเริ่มทํางาน คุณสามารถใช้ออบเจ็กต์นี้ในฟังก์ชันทริกเกอร์หน้าแรกเพื่อระบุแอปโฮสต์ที่ใช้งานอยู่ แพลตฟอร์มของลูกค้า ภาษาของผู้ใช้ และข้อมูลอื่นๆ

  ออบเจ็กต์เหตุการณ์ที่สร้างเมื่อทริกเกอร์หน้าแรกทำงานจะไม่มีฟิลด์ทั้งหมดที่รวมอยู่ในอีก 2 กรณี ฟิลด์ที่เกี่ยวข้องกับวิดเจ็ตและข้อมูลตามบริบทจะละเว้น

• ทริกเกอร์ตามบริบท แอปพลิเคชันโฮสต์แต่ละรายการจะมีชุดทริกเกอร์ตามบริบทที่แตกต่างกัน ซึ่งจะทริกเกอร์เมื่อผู้ใช้เข้าสู่บริบทที่เฉพาะเจาะจง เช่น

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

  เมื่อทริกเกอร์ตามบริบทเริ่มทํางาน แอปพลิเคชันโฮสต์จะเรียก runFunction ที่เกี่ยวข้องซึ่งแสดงในไฟล์ Manifest ของส่วนเสริม โดยส่งออบเจ็กต์เหตุการณ์เป็นพารามิเตอร์ ออบเจ็กต์เหตุการณ์ที่สร้างเมื่อทริกเกอร์ตามบริบทเริ่มทํางานจะมีช่องทั้งหมดที่รวมอยู่ในออบเจ็กต์เหตุการณ์ทริกเกอร์ของหน้าแรก รวมถึงช่องที่มีข้อมูลตามบริบท

• การดำเนินการกับวิดเจ็ต นอกจากนี้ ระบบยังใช้ออบเจ็กต์เหตุการณ์เพื่อมอบการโต้ตอบของวิดเจ็ตโดยใช้รูปแบบการดำเนินการเดียวกับที่ส่วนเสริมของ Gmail ใช้ ส่วนเสริมของ Google Workspace ใช้ฟังก์ชันตัวแฮนเดิลวิดเจ็ต Action ออบเจ็กต์ และการตอบสนองการดําเนินการเดียวกันทั้งหมด อย่างไรก็ตาม ในส่วนเสริมของ Google Workspace นั้น ออบเจ็กต์เหตุการณ์การดำเนินการจะมีข้อมูลเพิ่มเติมที่ฟังก์ชันการเรียกกลับสามารถดำเนินการได้

  ออบเจ็กต์เหตุการณ์ที่สร้างจากการกระทำของวิดเจ็ตจะมีช่องทั้งหมดที่รวมอยู่ในออบเจ็กต์เหตุการณ์ทริกเกอร์ตามบริบท รวมถึงช่องที่มีข้อมูลวิดเจ็ต

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

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

โครงสร้างออบเจ็กต์เหตุการณ์

ตารางต่อไปนี้อธิบายโครงสร้างระดับบนสุดของออบเจ็กต์เหตุการณ์ของส่วนเสริม Google Workspace โครงสร้างออบเจ็กต์เหตุการณ์มีcommonEventObjectช่องระดับบนสุดสําหรับข้อมูลที่ไม่พึ่งพาโฮสต์ ออบเจ็กต์เหตุการณ์แต่ละรายการยังมีช่องระดับบนสุดที่เจาะจงโฮสต์อย่างใดอย่างหนึ่งต่อไปนี้ได้ด้วย ซึ่งจะกำหนดโดยแอปโฮสต์ที่ใช้งานอยู่ นั่นคือ gmailEventObject, calendarEventObject หรือ driveEventObject

ออบเจ็กต์เหตุการณ์ของส่วนเสริม Google Workspace จะมีช่องเดิมทั้งหมดที่ใช้ในออบเจ็กต์เหตุการณ์การดําเนินการของส่วนเสริม Gmail ด้วย เพื่อใช้งานร่วมกับเวอร์ชันเก่าได้ ฟิลด์เหล่านี้แสดงอยู่ในตารางด้านล่างในส่วน "ฟิลด์ส่วนเสริมเดิมของ Gmail" ระบบจะสร้างข้อมูลในฟิลด์เหล่านี้อีกครั้งในโครงสร้างออบเจ็กต์ใหม่

ออบเจ็กต์เหตุการณ์ทั่วไป

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

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

อินพุตของแบบฟอร์มเครื่องมือเลือกวันที่และเวลา

ฟังก์ชัน Callback ของการดำเนินการรับค่าวิดเจ็ตปัจจุบันในฟิลด์ commonEventObject.formInputs ได้ ซึ่งรวมถึงค่าวันที่หรือเวลาของผู้ใช้ที่เลือกในวิดเจ็ตเครื่องมือเลือกวันที่หรือเวลา อย่างไรก็ตาม โครงสร้างของข้อมูลจะแตกต่างกันไปโดยขึ้นอยู่กับว่ามีการกําหนดค่าวิดเจ็ตเป็นเครื่องมือเลือกวันที่และเวลา เครื่องมือเลือกวันที่เท่านั้น หรือเครื่องมือเลือกเวลาเท่านั้น ความแตกต่างของโครงสร้างมีคำอธิบายอยู่ในตารางต่อไปนี้

ออบเจ็กต์กิจกรรมในปฏิทิน

ออบเจ็กต์กิจกรรมในปฏิทินคือส่วนของออบเจ็กต์กิจกรรมโดยรวมซึ่งมีข้อมูลเกี่ยวกับปฏิทินและกิจกรรมในปฏิทินของผู้ใช้ โดยจะปรากฏในออบเจ็กต์กิจกรรมก็ต่อเมื่อแอปพลิเคชันโฮสต์คือ Google ปฏิทิน

ตารางต่อไปนี้แสดงรายการช่องที่อยู่ในฟิลด์ calendarEventObject ของออบเจ็กต์เหตุการณ์ ช่องที่มีการทำเครื่องหมายเป็นข้อมูลที่ผู้ใช้สร้างขึ้นจะปรากฏอยู่ในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อมีข้อมูลอยู่ในกิจกรรมของปฏิทิน และส่วนเสริมตั้งค่าช่อง addOns.calendar.currentEventAccess manifest ไว้เป็น READ หรือ READ_WRITE

ผู้เข้าร่วม

ออบเจ็กต์ผู้เข้าร่วมจะนําข้อมูลเกี่ยวกับผู้เข้าร่วมแต่ละรายไปยังกิจกรรมใน Google ปฏิทิน ข้อมูลนี้จะอยู่ในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อข้อมูลอยู่ในกิจกรรมในปฏิทินและส่วนเสริมตั้งค่าช่อง addOns.calendar.currentEventAccess manifest ไว้เป็น READ หรือ READ_WRITE

ข้อมูลการประชุม

ออบเจ็กต์ข้อมูลการประชุมมีข้อมูลเกี่ยวกับการประชุมที่แนบมากับกิจกรรมใน Google ปฏิทิน ซึ่งอาจเป็นโซลูชันการประชุมของ Google เช่น Google Meet หรือการประชุมของบุคคลที่สาม ข้อมูลนี้จะอยู่ในออบเจ็กต์กิจกรรมก็ต่อเมื่อข้อมูลอยู่ในกิจกรรมในปฏิทิน และส่วนเสริมตั้งค่าช่อง addOns.calendar.currentEventAccess manifest เป็น READ หรือ READ_WRITE

จุดแรกเข้า

ออบเจ็กต์จุดแรกเข้าจะมีข้อมูลเกี่ยวกับวิธีการเข้าถึงการประชุมหนึ่งๆ ที่กำหนดไว้ เช่น ทางโทรศัพท์หรือวิดีโอ ข้อมูลนี้จะอยู่ในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อมีข้อมูลอยู่ในกิจกรรมในปฏิทิน และส่วนเสริมตั้งค่าช่อง addOns.calendar.currentEventAccess manifest เป็น READ หรือ READ_WRITE

ออบเจ็กต์เหตุการณ์ของไดรฟ์

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

รายการในไดรฟ์

ออบเจ็กต์รายการในไดรฟ์มีข้อมูลเกี่ยวกับรายการที่เฉพาะเจาะจงในไดรฟ์ เช่น ไฟล์หรือโฟลเดอร์

ออบเจ็กต์เหตุการณ์ Gmail

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

ออบเจ็กต์เหตุการณ์ของเอกสาร

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

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}
        

ออบเจ็กต์เหตุการณ์ของชีต

ออบเจ็กต์เหตุการณ์ของชีตคือส่วนของออบเจ็กต์เหตุการณ์โดยรวมซึ่งมีข้อมูลเกี่ยวกับเอกสารของผู้ใช้และเนื้อหาของเอกสาร โดยจะปรากฏอยู่ในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อแอปพลิเคชันโฮสต์คือ Google ชีต

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}
        

ออบเจ็กต์เหตุการณ์สไลด์

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

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}