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

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

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

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

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

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

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

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

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

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

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

ตารางต่อไปนี้อธิบายโครงสร้างระดับบนสุดของออบเจ็กต์เหตุการณ์ส่วนเสริมของ 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 เอกสารเท่านั้น ออบเจ็กต์ที่มีข้อมูล 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

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

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

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

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

    ตัวอย่าง: สําหรับวิดเจ็ตการป้อนข้อความที่มี 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: 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.general.useLocaleFromApp" เป็น "true" ในไฟล์ Manifest ของส่วนเสริม รายการขอบเขตส่วนเสริมต้องระบุ `https://www.googleapis.com/auth/script.locale` ด้วย ดูรายละเอียดเพิ่มเติมได้ที่การเข้าถึงภาษาและเขตเวลาของผู้ใช้

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

ข้อมูลในแบบฟอร์มเครื่องมือเลือกวันที่-เวลา

ฟังก์ชันเรียกกลับการดําเนินการ รับค่าวิดเจ็ตปัจจุบันในช่อง 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.currentEventAccessManifest เป็น 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หากส่วนเสริมอ่านรายชื่อผู้เข้าร่วมกิจกรรมได้ false
calendar.capabilities.canSeeConferenceData boolean
ข้อมูลที่ผู้ใช้สร้างขึ้น trueหากส่วนเสริมอ่านข้อมูลการประชุมกิจกรรมได้ false
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.currentEventAccessManifest เป็น READ หรือ READ_WRITE เท่านั้น

ออบเจ็กต์ข้อมูลการประชุม
conferenceData.conferenceId string
รหัสของการประชุม รหัสนี้ใช้สําหรับอนุญาตให้แอปพลิเคชันติดตามการประชุม และไม่ควรแสดงรหัสนี้ให้ผู้ใช้อื่นเห็น
conferenceData.conferenceSolution object
ออบเจ็กต์ที่เป็นตัวแทนของโซลูชันการประชุม เช่น Hangouts หรือ Google Meet
conferenceData.conferenceSolution.iconUri string
URI ของไอคอนที่ผู้ใช้มองเห็นได้ซึ่งแสดงถึงโซลูชันการประชุมนี้
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 ได้ ความยาวสูงสุดคือ 2,048 อักขระ
conferenceData.parameters object
ออบเจ็กต์ที่มีแผนที่ของข้อมูลพารามิเตอร์ที่กําหนดไว้สําหรับการใช้โดยส่วนเสริม
conferenceData.parameters.addOnParameters object
การแมปคีย์และค่าพารามิเตอร์ของพารามิเตอร์ นักพัฒนาส่วนเสริมเป็นผู้กําหนดคีย์และค่าเหล่านี้เพื่อแนบข้อมูลไปกับการประชุมที่จะใช้ส่วนเสริมได้

จุดแรกเข้า

ออบเจ็กต์จุดแรกเข้ามีข้อมูลเกี่ยวกับการเข้าถึงการประชุมที่กําหนดขึ้น เช่น ทางโทรศัพท์หรือวิดีโอ ข้อมูลนี้จะปรากฏในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อข้อมูลอยู่ในกิจกรรมในปฏิทินและส่วนเสริมจะตั้งค่าช่อง addOns.calendar.currentEventAccessManifest เป็น 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 จุดเท่านั้น แต่จะต้องเพิ่มจุดเข้าถึงอีกอย่างน้อย 1 ประเภท
  • phone: เข้าร่วมการประชุมผ่านหมายเลขโทรศัพท์ การประชุมต้องมีจุดเข้า phone อย่างน้อย 0 จุด Google ปฏิทินจะแสดงเฉพาะจุดแรกของโทรศัพท์ 2 จุดแรก หลังจากจัดรูปแบบและจัดเรียงตามตัวอักษร
  • sip: เข้าร่วมการประชุมผ่าน SIP การประชุมมีจุดเข้าถึงได้ไม่เกิน sip จุด
  • video: เข้าร่วมการประชุมผ่าน HTTP การประชุมมีจุดเข้าถึงได้ไม่เกิน video จุด
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
ปิดใช้โดยค่าเริ่มต้น รายชื่อของ "BCC:" ที่อยู่อีเมลของผู้รับที่อยู่ในฉบับร่างซึ่งส่วนเสริมกําลังเขียนอยู่ในขณะนี้ หากต้องการเปิดใช้ช่องนี้ คุณต้องตั้งค่าช่อง `addOns.gmail.composeTrigger.draftAccess` ในไฟล์ Manifest เป็น "METADATA"
gmail.ccRecipients[] list of strings
ปิดใช้โดยค่าเริ่มต้น รายการของ "CC:" ที่อยู่อีเมลของผู้รับที่อยู่ในฉบับร่างซึ่งส่วนเสริมกําลังเขียนอยู่ในขณะนี้ หากต้องการเปิดใช้ช่องนี้ คุณต้องตั้งค่าช่อง `addOns.gmail.composeTrigger.draftAccess` ในไฟล์ Manifest เป็น "METADATA"
gmail.messageId string
รหัสของข้อความ Gmail ที่เปิดอยู่ในปัจจุบัน
gmail.threadId string
รหัสชุดข้อความ Gmail ที่เปิดอยู่ในขณะนี้
gmail.toRecipients[] list of strings
ปิดใช้โดยค่าเริ่มต้น รายชื่อของ "To:" ที่อยู่อีเมลของผู้รับที่อยู่ในฉบับร่างขณะนี้ ซึ่งเป็นส่วนเสริมของการเขียน หากต้องการเปิดใช้ช่องนี้ คุณต้องตั้งค่าช่อง `addOns.gmail.composeTrigger.draftAccess` ในไฟล์ Manifest เป็น "METADATA"

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

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

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

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

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

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