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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

นอกจากทริกเกอร์หน้าแรกและตามบริบทแล้ว ส่วนเสริมจะสร้างและส่งออบเจ็กต์เหตุการณ์ไปยังฟังก์ชันการเรียกกลับการดำเนินการเมื่อผู้ใช้โต้ตอบกับวิดเจ็ต ฟังก์ชัน Callback ของส่วนเสริมค้นหาได้ ออบเจ็กต์เหตุการณ์ทั่วไปเพื่อกำหนดเนื้อหาของวิดเจ็ตที่เปิดในบัญชี ของคุณ เช่น ส่วนเสริมสามารถค้นหาข้อความที่ผู้ใช้ป้อนลงในวิดเจ็ต 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

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

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

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

ออบเจ็กต์กิจกรรมชีต

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

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

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

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

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