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

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

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

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

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

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

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

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

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

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

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

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

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

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

ออบเจ็กต์เหตุการณ์
eventObject.commonEventObject Common fields object
ออบเจ็กต์ที่มีข้อมูลทั่วไปสำหรับออบเจ็กต์เหตุการณ์ทั้งหมด แอปพลิเคชันจะเป็นโฮสต์ใดก็ตาม
eventObject.calendar Calendar event object
แสดงเฉพาะในกรณีที่โฮสต์ที่โทรเป็น Google ปฏิทิน ออบเจ็กต์ที่มีข้อมูลปฏิทินและกิจกรรม
eventObject.drive Drive event object
แสดงเฉพาะในกรณีที่โฮสต์ที่เรียกใช้คือ Google ไดรฟ์ ออบเจ็กต์ที่มีข้อมูลไดรฟ์
eventObject.gmail Gmail event object
แสดงเฉพาะในกรณีที่โฮสต์ที่โทรเป็น Gmail ออบเจ็กต์ที่มีข้อมูล Gmail
eventObject.docs Docs event object
แสดงเมื่อโฮสต์การโทรคือ Google เอกสารเท่านั้น ออบเจ็กต์ที่มีข้อมูลเอกสาร
eventObject.sheets Sheets event object
แสดงเฉพาะในกรณีที่โฮสต์ที่โทรเป็น Google ชีต ออบเจ็กต์ที่มีข้อมูลชีต
eventObject.slides Slides event object
แสดงเฉพาะในกรณีที่โฮสต์ที่โทรเป็น Google สไลด์ วัตถุ ที่มีข้อมูลสไลด์อยู่
ช่องส่วนเสริมเดิมของ Gmail
eventObject.messageMetadata.accessToken string
เลิกใช้งานแล้ว โทเค็นการเข้าถึง คุณสามารถใช้ตัวเลือกนี้เพื่อเปิดการเข้าถึงข้อมูลผู้ใช้โดยใช้ขอบเขตส่วนเสริม Gmail ชั่วคราว

สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง eventObject.gmail.accessToken

eventObject.messageMetadata.messageId string
เลิกใช้งานแล้ว รหัสข้อความของชุดข้อความ เปิดใน UI ของ Gmail

สำหรับส่วนเสริมของ Google Workspace โปรดดูข้อมูลนี้ใน eventObject.gmail.messageId ด้วย

eventObject.clientPlatform string
เลิกใช้งานแล้ว ระบุตำแหน่งของกิจกรรม (เว็บ, iOS หรือ Android)

สำหรับส่วนเสริมของ Google Workspace โปรดดูข้อมูลนี้ใน eventObject.commonEventObject.platform ด้วย

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

สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง eventObject.commonEventObject.formInputs แทน วิดเจ็ตที่มีค่าเดี่ยวจะแสดงเป็นอาร์เรย์ที่มีองค์ประกอบเดียว

eventObject.formInputs object
เลิกใช้งานแล้ว แผนที่แสดงค่าปัจจุบันของ วิดเจ็ตในการ์ดแสดงเป็นรายการสตริง คีย์คือรหัสสตริงที่เชื่อมโยงกับวิดเจ็ต สําหรับวิดเจ็ตที่มีค่าเดี่ยว ระบบจะแสดงค่าในอาร์เรย์องค์ประกอบเดี่ยว สําหรับวิดเจ็ตที่มีค่าหลายค่า เช่น กลุ่มช่องทําเครื่องหมาย ระบบจะแสดงค่าทั้งหมดในรายการ

สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง eventObject.commonEventObject.formInputs

eventObject.parameters object
เลิกใช้งานแล้ว แผนที่ของข้อมูลเพิ่มเติม พารามิเตอร์ที่คุณระบุให้กับ Actionกำลังใช้ Action.setParameters() คีย์และค่าของแผนที่ สตริง

สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง eventObject.commonEventObject.parameters

eventObject.userCountry string
เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น รหัส 2 ตัวอักษรที่ระบุประเทศหรือภูมิภาคของผู้ใช้ หรืออาจเป็นรหัสประเทศUN M49 แบบตัวเลขก็ได้

สำหรับส่วนเสริมของ Google Workspace โปรดดูข้อมูลนี้ใน eventObject.commonEventObject.userLocale ด้วย

eventObject.userLocale string
เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น รหัส ISO 639 2 ตัวอักษรที่ระบุภาษาของผู้ใช้ ดูรายละเอียดเพิ่มเติมได้ที่การเข้าถึงภาษาและเขตเวลาของผู้ใช้

สำหรับส่วนเสริมของ Google Workspace โปรดดูข้อมูลนี้ใน eventObject.commonEventObject.userLocale ด้วย

eventObject.userTimezone.id string
เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น ตัวระบุเขตเวลา สำหรับเขตเวลาของผู้ใช้ ตัวอย่างเช่น America/New_York, Europe/Vienna และ Asia/Seoul โปรดดู การเข้าถึงภาษาและเขตเวลาของผู้ใช้เพื่อดูรายละเอียดเพิ่มเติม

สำหรับส่วนเสริมของ Google Workspace โปรดดูข้อมูลนี้ใน eventObject.commonEventObject.timeZone.id ด้วย

eventObject.userTimezone.offset string
เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น เวลาออฟเซ็ตจากเวลาสากลเชิงพิกัด (UTC) ของเขตเวลาของผู้ใช้ ซึ่งวัดเป็นมิลลิวินาที โปรดดู การเข้าถึงภาษาและเขตเวลาของผู้ใช้เพื่อดูรายละเอียดเพิ่มเติม

สำหรับส่วนเสริมของ Google Workspace โปรดดูข้อมูลนี้ใน eventObject.commonEventObject.timeZone.offset ด้วย

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

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

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

ช่องออบเจ็กต์เหตุการณ์ทั่วไป
commonEventObject.platform string
ระบุตำแหน่งเริ่มต้นของเหตุการณ์ ("เว็บ" "IOS" หรือ "ANDROID")
commonEventObject.formInputs object
แผนที่ที่มีค่าปัจจุบันของ วิดเจ็ตในการ์ดที่แสดง คีย์การแมปคือรหัสสตริงที่กำหนดให้กับวิดเจ็ตแต่ละรายการ

โครงสร้างของออบเจ็กต์ค่าแผนที่จะขึ้นอยู่กับประเภทวิดเจ็ต ดังนี้

  • วิดเจ็ตที่มีค่าเดียว (เช่น กล่องข้อความ): รายการสตริง (องค์ประกอบเดียวเท่านั้น)

    ตัวอย่าง: สำหรับวิดเจ็ตการป้อนข้อความที่มี เข้าถึงข้อความ employeeName เป็นรหัส ค่าที่ป้อนที่มี: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • วิดเจ็ตที่มีค่าหลายค่า (เช่น กลุ่มช่องทําเครื่องหมาย) รายการสตริง

    ตัวอย่าง: สำหรับวิดเจ็ตที่มีหลายค่าที่มี เข้าถึงค่า participants เป็นรหัส อาร์เรย์ที่มี e.commonEventObject.formInputs.participants.stringInputs.value

  • A date-time picker: น. DateTimeInput object

    ตัวอย่าง: สําหรับเครื่องมือเลือกที่มีรหัส myDTPicker ให้เข้าถึงออบเจ็กต์ DateTimeInput โดยใช้ e.commonEventObject.formInputs.myDTPicker.dateTimeInput

  • A date-only picker: น. DateInput object

    ตัวอย่าง: สําหรับเครื่องมือเลือกที่มีรหัส myDatePicker ให้เข้าถึงออบเจ็กต์ DateInput โดยใช้ e.commonEventObject.formInputs.myDatePicker.dateInput

  • A time-only picker: a TimeInput object

    ตัวอย่าง: สำหรับเครื่องมือเลือกที่มีรหัสเป็น myTimePicker เข้าถึง TimeInput ออบเจ็กต์กำลังใช้ e.commonEventObject.formInputs.myTimePicker.timeInput
commonEventObject.hostApp string
ระบุแอปโฮสต์ที่ส่วนเสริมทำงานอยู่เมื่อสร้างออบเจ็กต์เหตุการณ์ ค่าที่เป็นไปได้ ได้แก่
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
พารามิเตอร์เพิ่มเติมใดๆ ให้กับ Action โดยใช้ Action.setParameters()
commonEventObject.userLocale string
ปิดใช้โดยค่าเริ่มต้น ภาษาของผู้ใช้ และประเทศ/ภูมิภาคในรูปแบบ ISO 639 รหัสภาษา-ISO 3166 รหัสประเทศ/ภูมิภาค เช่น en-US

หากต้องการเปิดช่องนี้ คุณต้องตั้งค่า addOns.common.useLocaleFromApp เป็น true ในไฟล์ Manifest ของส่วนเสริม รายการขอบเขตของส่วนเสริมต้องรวม https://www.googleapis.com/auth/script.locale ด้วย โปรดดูรายละเอียดเพิ่มเติมที่หัวข้อการเข้าถึงภาษาและเขตเวลาของผู้ใช้

commonEventObject.timeZone string
ปิดใช้โดยค่าเริ่มต้น รหัสและออฟเซ็ตเขตเวลา หากต้องการเปิดช่องนี้ คุณต้องตั้งค่า addOns.common.useLocaleFromApp ไปยัง true ในไฟล์ Manifest ของส่วนเสริม รายการขอบเขตของส่วนเสริมต้องมี https://www.googleapis.com/auth/script.locale ด้วย โปรดดูรายละเอียดเพิ่มเติมที่หัวข้อการเข้าถึงภาษาและเขตเวลาของผู้ใช้
commonEventObject.timeZone.id string
ตัวระบุเขตเวลาของเขตเวลาของผู้ใช้ ตัวอย่างเช่น America/New_York, Europe/Vienna และ Asia/Seoul หากต้องการเปิดใช้ช่องนี้ คุณต้องตั้งค่า addOns.common.useLocaleFromApp เป็น true ในไฟล์ Manifest ของส่วนเสริม รายการขอบเขตของส่วนเสริมต้องมี https://www.googleapis.com/auth/script.locale ด้วย ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อการเข้าถึงภาษาและเขตเวลาของผู้ใช้
commonEventObject.timeZone.offset string
การถดเวลาจากเวลาสากลเชิงพิกัด (UTC) ของเขตเวลาของผู้ใช้ ซึ่งวัดเป็นมิลลิวินาที ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อการเข้าถึงภาษาและเขตเวลาของผู้ใช้

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

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

ออบเจ็กต์ DateTimeInput
dateTimeInput.hasDate boolean
true หากเวลาวันที่ที่ป้อนมีวันที่ หาก false มีเฉพาะเวลา
dateTimeInput.hasTime boolean
true หากวันที่และเวลาที่ป้อน รวมเวลา หาก false ระบุเพียงวันที่
dateTimeInput.msSinceEpoch string
เวลาที่ผู้ใช้เลือกเป็นมิลลิวินาที ตั้งแต่ Epoch (00:00:00 น. ตามเขตเวลา UTC ของวันที่ 1 มกราคม 1970)
ออบเจ็กต์ DateInput
dateInput.msSinceEpoch string
เวลาที่ผู้ใช้เลือกเป็นมิลลิวินาทีนับจาก Epoch (00:00:00 UTC ในวันที่ 1 มกราคม 1970)
ออบเจ็กต์ TimeInput
timeInput.hours number
หมายเลขชั่วโมงที่ผู้ใช้เลือก
timeInput.minutes number
หมายเลขนาทีที่ผู้ใช้เลือก

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

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

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

ออบเจ็กต์กิจกรรมในปฏิทิน
calendar.attendees[] list of attendee objects
ข้อมูลที่ผู้ใช้สร้างขึ้น รายชื่อผู้เข้าร่วมปฏิทิน กิจกรรม
calendar.calendarId string
รหัสปฏิทิน
calendar.capabilities object
ข้อมูลที่ผู้ใช้สร้างขึ้น วัตถุ อธิบายความสามารถของส่วนเสริมเพื่อดูหรืออัปเดตเหตุการณ์
calendar.capabilities.canAddAttendees boolean
ข้อมูลที่ได้จากผู้ใช้ true ส่วนเสริมจะเพิ่มผู้เข้าร่วมรายใหม่ลงในรายชื่อผู้เข้าร่วมกิจกรรมได้หรือไม่ false หรือไม่เช่นนั้น
calendar.capabilities.canSeeAttendees boolean
ข้อมูลที่ได้จากผู้ใช้ true if the add-on can read the event attendee list; false otherwise.
calendar.capabilities.canSeeConferenceData boolean
ข้อมูลที่ได้จากผู้ใช้ true if the add-on can read the event conference data; false otherwise.
calendar.capabilities.canSetConferenceData boolean
ข้อมูลที่ผู้ใช้สร้างขึ้น true ส่วนเสริมสามารถอัปเดตข้อมูลการประชุมกิจกรรมได้หรือไม่ false หรือไม่เช่นนั้น
calendar.capabilities.canAddAttachments boolean
ข้อมูลที่ผู้ใช้สร้างขึ้น true ส่วนเสริมใหม่สามารถเพิ่มไฟล์แนบใหม่ในกิจกรรมได้หรือไม่ false หรือไม่เช่นนั้น
calendar.conferenceData Conference data object
ข้อมูลที่ได้จากผู้ใช้ ออบเจ็กต์ที่แสดงข้อมูลการประชุมที่เชื่อมโยงกับกิจกรรมนี้ เช่น รายละเอียดการประชุม Google Meet
calendar.id string
รหัสเหตุการณ์
calendar.organizer object
ออบเจ็กต์ที่แสดงถึงผู้จัด กิจกรรม
calendar.organizer.email string
อีเมลของผู้จัดกิจกรรม
calendar.recurringEventId string
รหัสของกิจกรรมที่เกิดซ้ำ

ผู้เข้าร่วม

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

ออบเจ็กต์ผู้เข้าร่วม
attendee.additionalGuests number
จำนวนผู้เข้าร่วมเพิ่มเติม ได้ระบุว่าพวกเขานำมา ค่าเริ่มต้นคือ 0
attendee.comment string
ความคิดเห็นตอบกลับของผู้เข้าร่วม (หากมี)
attendee.displayName string
ชื่อที่แสดงของผู้เข้าร่วม
attendee.email string
อีเมลของผู้เข้าร่วม
attendee.optional boolean
true หากมีการทําเครื่องหมายการเข้าร่วมของผู้เข้าร่วมรายนี้ว่าไม่บังคับ หรือ false หากไม่ได้ทําเครื่องหมาย
attendee.organizer boolean
true หากผู้เข้าร่วมเป็นผู้จัดกิจกรรมนี้
attendee.resource boolean
true หากผู้เข้าร่วมแสดงถึง ทรัพยากร เช่น ห้องหรืออุปกรณ์ false หรือไม่เช่นนั้น
attendee.responseStatus string
สถานะการตอบกลับของผู้เข้าร่วม เป็นไปได้ มีดังนี้
  • accepted: ผู้เข้าร่วมยอมรับคำเชิญเข้าร่วมกิจกรรมแล้ว
  • declined: ผู้เข้าร่วมปฏิเสธกิจกรรม คำเชิญ
  • needsAction: ผู้เข้าร่วมยังไม่ได้ตอบกลับคำเชิญเข้าร่วมกิจกรรม
  • tentative: ผู้เข้าร่วมตอบรับคร่าวๆ แล้ว คำเชิญเข้าร่วมกิจกรรม
attendee.self boolean
true หากผู้เข้าร่วมรายนี้เป็นตัวแทน ปฏิทินที่กิจกรรมนี้ปรากฏ false หรือไม่เช่นนั้น

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

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

ออบเจ็กต์ข้อมูลการประชุม
conferenceData.conferenceId string
รหัสของการประชุม รหัสนี้คือรหัส ทำให้แอปพลิเคชันสามารถติดตามการประชุมได้ คุณไม่ควร แสดงรหัสนี้แก่ผู้ใช้
conferenceData.conferenceSolution object
ออบเจ็กต์ที่แสดงถึงการประชุม เช่น Hangouts หรือ Google Meet
conferenceData.conferenceSolution.iconUri string
URL สำหรับไอคอนที่ผู้ใช้มองเห็นได้ซึ่งแสดง ซึ่งเป็นโซลูชันการประชุม
conferenceData.conferenceSolution.key object
คีย์ที่ระบุโซลูชันการประชุมสำหรับกิจกรรมนี้โดยไม่ซ้ำกัน
conferenceData.conferenceSolution.key.type string
ประเภทโซลูชันการประชุม ค่าที่เป็นไปได้ ได้แก่
  • eventHangout สำหรับ Hangouts สำหรับผู้ใช้ทั่วไป (http://hangouts.google.com)
  • eventNamedHangoutสำหรับ Hangouts แบบคลาสสิกสำหรับ ผู้ใช้ Google Workspace (http://hangouts.google.com)
  • hangoutsMeet สำหรับ Google Meet (http://meet.google.com)
conferenceData.conferenceSolution.name string
ชื่อที่ผู้ใช้มองเห็นของการประชุมนี้ โซลูชัน (ไม่ได้แปล)
conferenceData.entryPoints[] list of entry point objects
รายการจุดเข้าใช้งานการประชุม เช่น URL หรือหมายเลขโทรศัพท์
conferenceData.notes string
หมายเหตุเพิ่มเติม (เช่น วิธีการจากผู้ดูแลระบบโดเมนหรือประกาศทางกฎหมาย) เกี่ยวกับการประชุมที่จะแสดงต่อผู้ใช้ มี HTML ได้ ความยาวสูงสุดคือ 2048 อักขระ
conferenceData.parameters object
วัตถุที่มีแผนที่ของ ข้อมูลพารามิเตอร์ที่ส่วนเสริมใช้
conferenceData.parameters.addOnParameters object
การแมปคีย์และค่าของสตริงพารามิเตอร์ นักพัฒนาซอฟต์แวร์ส่วนเสริมจะกำหนดคีย์และค่าเหล่านี้ให้แนบ ลงในการประชุมที่ระบุสำหรับการใช้งานส่วนเสริม

จุดแรกเข้า

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

ออบเจ็กต์จุดแรกเข้า
entryPoint.accessCode string
รหัสเข้าถึงที่ใช้เข้าถึงการประชุม ความยาวสูงสุด 128 อักขระ โดยปกติแล้วผู้ให้บริการการประชุมจะใช้เพียงชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้บริการเข้าถึงการประชุม จับคู่และแสดงเฉพาะฟิลด์ ที่ผู้ให้บริการประชุมใช้
entryPoint.entryPointFeatures list
ฟีเจอร์ของจุดแรกเข้า ในปัจจุบัน ฟีเจอร์ใช้ได้กับจุดแรกเข้า phone เท่านั้น:
  • toll: จุดแรกเข้าคือการโทรผ่านโทรศัพท์แบบเรียกเก็บเงิน
  • toll_free: จุดแรกเข้าคือการโทรหาหมายเลขโทรฟรี
entryPoint.entryPointType string
ประเภทของจุดแรกเข้า ค่าที่เป็นไปได้มีดังนี้
  • more: วิธีการเข้าร่วมการประชุมเพิ่มเติม เช่น หมายเลขโทรศัพท์อื่น การประชุมจะมีจุดแรกเข้าmoreได้เพียงจุดเดียว หากมีจุดแรกเข้าประเภทอื่นด้วยจะต้องมีจุดแรกเข้าประเภทอื่นอย่างน้อย 1 ประเภท
  • phone: เข้าร่วมการประชุมผ่านหมายเลขโทรศัพท์ ต การประชุมอาจมีจุดแรกเข้า phone เท่ากับศูนย์หรือมากกว่า Google ปฏิทินจะแสดงจุดแรกเข้าของโทรศัพท์ 2 จุดแรกเท่านั้น หลังจากจัดรูปแบบและเรียงลำดับตามตัวอักษร
  • sip: เข้าร่วมการประชุมผ่าน SIP การประชุมมีจุดเข้าใช้งาน sip ได้สูงสุด 1 จุด
  • video: เข้าร่วมการประชุมผ่าน HTTP การประชุมมีจุดเข้าใช้งาน video ได้สูงสุด 1 จุด
entryPoint.label string
ป้ายกำกับที่ผู้ใช้มองเห็นได้สำหรับ URI ของจุดแรกเข้า (ไม่ได้แปล)
entryPoint.meetingCode string
รหัสการประชุมที่ใช้ในการเข้าถึงการประชุม มีความยาวได้สูงสุดไม่เกิน 128 อักขระ โดยปกติแล้วผู้ให้บริการการประชุมจะใช้เพียงชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้บริการเข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้
entryPoint.passcode string
รหัสผ่านที่ใช้ในการเข้าถึงการประชุม ความยาวสูงสุด 128 อักขระ โดยปกติแล้วผู้ให้บริการการประชุมจะใช้เพียงชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้บริการเข้าถึงการประชุม จับคู่และแสดงเฉพาะฟิลด์ ที่ผู้ให้บริการประชุมใช้
entryPoint.password string
รหัสผ่านที่ใช้เข้าถึงการประชุม ความยาวสูงสุด 128 อักขระ โดยปกติแล้วผู้ให้บริการการประชุม ใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} ไปยัง ให้เข้าถึงการประชุมได้ จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้
entryPoint.pin string
PIN ที่ใช้เข้าถึงการประชุม มีความยาวได้สูงสุดไม่เกิน 128 อักขระ โดยปกติแล้วผู้ให้บริการการประชุมจะใช้เพียงชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้บริการเข้าถึงการประชุม จับคู่และแสดงเฉพาะฟิลด์ ที่ผู้ให้บริการประชุมใช้
entryPoint.regionCode string
รหัสภูมิภาคของหมายเลขโทรศัพท์ ผู้ใช้ต้องใช้หาก URI ไม่ได้ระบุรหัสประเทศ ค่าต่างๆ จะอิงตาม สาธารณะ รายการรหัสภูมิภาค CLDR
entryPoint.uri string
URI ของจุดแรกเข้า สูงสุด ความยาว 1,300 อักขระ การจัดรูปแบบจะขึ้นอยู่กับจุดแรกเข้า ประเภท:
  • more: ต้องระบุสคีมา http: หรือ https:
  • phone: ต้องมีสคีมา tel: URI ควรมีลำดับการโทรทั้งหมด (เช่น "tel:+12345678900,,,12345678;1234")
  • sip: sip: หรือ sips: ต้องระบุสคีมา เช่น "sip:12345678@myprovider.com"
  • video: ต้องระบุสคีมา http: หรือ https:

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

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

ออบเจ็กต์เหตุการณ์ของไดรฟ์
drive.activeCursorItem Drive item object
รายการไดรฟ์ที่ใช้งานอยู่ในปัจจุบัน
drive.selectedItems[] list of Drive item objects
รายชื่อรายการ (ไฟล์หรือโฟลเดอร์) ที่เลือกในไดรฟ์

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

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

ออบเจ็กต์รายการในไดรฟ์
item.addonHasFileScopePermission boolean
หากเป็น true แสดงว่าส่วนเสริมได้ขอและได้รับสิทธิ์ระดับ https://www.googleapis.com/auth/drive.file สำหรับรายการนี้ มิฉะนั้นช่องนี้จะมีค่าเป็น false
item.id string
รหัสของรายการที่เลือก
item.iconUrl string
URL ของไอคอนที่แสดงถึง รายการที่เลือก
item.mimeType string
ประเภท MIME ของรายการที่เลือก
item.title string
ชื่อของรายการที่เลือก

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

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

ออบเจ็กต์เหตุการณ์ของ Gmail
gmail.accessToken string
โทเค็นการเข้าถึงสำหรับ Gmail โดยเฉพาะ คุณสามารถใช้ โทเค็นนี้ที่มี GmailApp.setCurrentMessageAccessToken(accessToken) เพื่อให้สิทธิ์เข้าถึงชั่วคราวสำหรับการเข้าถึง เปิดข้อความ Gmail หรือให้ส่วนเสริมเขียนร่างจดหมายใหม่
gmail.bccRecipients[] list of strings
ปิดใช้โดยค่าเริ่มต้น รายการอีเมลของผู้รับ "สำเนาลับ:" ที่รวมอยู่ในฉบับร่างที่ส่วนเสริมกำลังเขียนอยู่ หากต้องการเปิดใช้ช่องนี้ คุณต้องตั้งค่าช่อง addOns.gmail.composeTrigger.draftAccess ในไฟล์ Manifest เป็น METADATA
gmail.ccRecipients[] list of strings
ปิดใช้โดยค่าเริ่มต้น รายการอีเมลของผู้รับ "สำเนา" ที่รวมอยู่ในฉบับร่างที่ส่วนเสริมกำลังเขียนอยู่ หากต้องการเปิดใช้ช่องนี้ คุณต้องตั้งค่าช่อง addOns.gmail.composeTrigger.draftAccess ในไฟล์ Manifest เป็น METADATA
gmail.messageId string
รหัสของข้อความ Gmail ที่เปิดอยู่ตอนนี้
gmail.threadId string
รหัสชุดข้อความของ Gmail ที่เปิดอยู่ในขณะนี้
gmail.toRecipients[] list of strings
ปิดใช้โดยค่าเริ่มต้น รายการอีเมลผู้รับ "ถึง:" ที่รวมอยู่ในฉบับร่างที่ส่วนเสริมกำลังเขียนอยู่ หากต้องการเปิดใช้ช่องนี้ คุณต้องตั้งค่าช่อง addOns.gmail.composeTrigger.draftAccess ในไฟล์ Manifest เป็น METADATA

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

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

ออบเจ็กต์เหตุการณ์ของเอกสาร
docs.id string
จะแสดงเฉพาะในกรณีที่ผู้ใช้ให้สิทธิ์สโคป https://www.googleapis.com/auth/drive.file
รหัสของเอกสารที่เปิดอยู่ใน UI ของเอกสาร
docs.title string
จะแสดงเฉพาะในกรณีที่ผู้ใช้ให้สิทธิ์ในขอบเขต https://www.googleapis.com/auth/drive.file
ชื่อเอกสารที่เปิดใน UI ของเอกสาร
docs.addonHasFileScopePermission boolean
หากเป็น true แสดงว่าส่วนเสริมได้ขอและได้รับสิทธิ์ระดับ https://www.googleapis.com/auth/drive.file ในการเข้าถึงเอกสารที่เปิดอยู่ใน UI ของเอกสาร มิเช่นนั้นช่องนี้จะมีค่าเป็น false
docs.matchedUrl.url string
แสดงเมื่อเป็นไปตามเงื่อนไขต่อไปนี้เท่านั้น
  • https://www.googleapis.com/auth/workspace.linkpreview ได้รับการอนุมัติจากผู้ใช้แล้ว
  • URL ตรงกับรูปแบบโฮสต์ที่ระบุในทริกเกอร์ LinkPreviewTriggers

URL ของลิงก์ที่สร้างตัวอย่างใน Google เอกสาร หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า LinkPreviewTriggers ในไฟล์ Manifest ของส่วนเสริม ดูรายละเอียดเพิ่มเติมได้ที่แสดงตัวอย่างลิงก์ด้วยชิปอัจฉริยะ

ตัวอย่างเพย์โหลดเมื่อผู้ใช้ดูตัวอย่างลิงก์ https://www.example.com/12345 

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

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

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

ออบเจ็กต์เหตุการณ์ของชีต
sheets.id string
แสดงก็ต่อเมื่อมีการกำหนดขอบเขต https://www.googleapis.com/auth/drive.file แล้ว ให้สิทธิ์จากผู้ใช้ รหัสของสเปรดชีตที่เปิดอยู่ใน UI ของชีต
sheets.title string
จะแสดงเฉพาะในกรณีที่ผู้ใช้ให้สิทธิ์สโคป https://www.googleapis.com/auth/drive.file ชื่อของสเปรดชีตที่เปิดในชีต UI
sheets.addonHasFileScopePermission boolean
หากเป็น true แสดงว่าส่วนเสริมได้ขอ และได้รับ https://www.googleapis.com/auth/drive.file การให้สิทธิ์ขอบเขตสำหรับสเปรดชีตที่เปิดใน UI ของชีต หรือไม่เช่นนั้น ช่องนี้คือ false
sheets.matchedUrl.url string
จะแสดงก็ต่อเมื่อมีคุณสมบัติตรงตามเงื่อนไขต่อไปนี้
  • https://www.googleapis.com/auth/workspace.linkpreview ได้รับการอนุมัติจากผู้ใช้แล้ว
  • URL ตรงกับรูปแบบโฮสต์ที่ระบุในทริกเกอร์ LinkPreviewTriggers

URL ของลิงก์ที่สร้างตัวอย่างใน Google ชีต หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า LinkPreviewTriggers ในไฟล์ Manifest ของส่วนเสริม ดูรายละเอียดเพิ่มเติมได้ที่แสดงตัวอย่างลิงก์ด้วยชิปอัจฉริยะ

ตัวอย่างเพย์โหลดเมื่อผู้ใช้แสดงตัวอย่างลิงก์ https://www.example.com/12345

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

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

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

ออบเจ็กต์เหตุการณ์ของสไลด์
slides.id string
แสดงก็ต่อเมื่อมีการกำหนดขอบเขต https://www.googleapis.com/auth/drive.file แล้ว ให้สิทธิ์จากผู้ใช้ รหัสของงานนำเสนอที่เปิดในสไลด์ UI
slides.title string
จะแสดงเฉพาะในกรณีที่ผู้ใช้ให้สิทธิ์สโคป https://www.googleapis.com/auth/drive.file ชื่อของงานนำเสนอที่เปิดใน UI ของสไลด์
slides.addonHasFileScopePermission boolean
หากเป็น true แสดงว่าส่วนเสริมได้ขอและได้รับสิทธิ์https://www.googleapis.com/auth/drive.fileระดับขอบเขตสําหรับงานนำเสนอที่เปิดอยู่ใน UI ของสไลด์ มิเช่นนั้น ช่องนี้จะมีค่าเป็น false
slides.matchedUrl.url string
จะแสดงก็ต่อเมื่อมีคุณสมบัติตรงตามเงื่อนไขต่อไปนี้
  • https://www.googleapis.com/auth/workspace.linkpreview ได้รับการอนุมัติจากผู้ใช้แล้ว
  • URL ตรงกับรูปแบบโฮสต์ที่ระบุในทริกเกอร์ LinkPreviewTriggers

URL ของลิงก์ที่สร้างตัวอย่างใน Google สไลด์ หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า LinkPreviewTriggers ในไฟล์ Manifest ของส่วนเสริม ดูรายละเอียดเพิ่มเติมได้ที่แสดงตัวอย่างลิงก์ด้วยชิปอัจฉริยะ

ตัวอย่างเพย์โหลดเมื่อผู้ใช้แสดงตัวอย่างลิงก์ https://www.example.com/12345

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