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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • สําหรับเว็บและ Android โครงสร้างคือ {"stringInputs":{"value":[""]}}
  • สําหรับ iOS โครงสร้างคือ ['']
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) ของเขตเวลาของผู้ใช้ ซึ่งวัดเป็นมิลลิวินาที โปรดดูรายละเอียดเพิ่มเติมในการเข้าถึงภาษาและเขตเวลาของผู้ใช้

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

ฟังก์ชันเรียกกลับของการดําเนินการ จะได้รับค่าวิดเจ็ตปัจจุบันในช่อง 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 หากส่วนเสริมอ่านรายชื่อผู้เข้าร่วมกิจกรรมได้ มิเช่นนั้น 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.currentEventAccessไฟล์ Manifest เป็น 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.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 จุด และหากต้องมีจุดแรกเข้าอีก 1 ประเภท
  • phone: เข้าร่วมการประชุมผ่านหมายเลขโทรศัพท์ การประชุมต้องไม่มีจุดแรกเข้า phone จุด 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
ปิดใช้โดยค่าเริ่มต้น รายชื่อ อีเมลของผู้รับ "สําเนาลับ:" ที่ตอนนี้รวมอยู่ในฉบับร่างที่ส่วนเสริมกําลังเขียนอยู่ หากต้องการเปิดช่องนี้ คุณต้องตั้งค่าช่อง 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
ปิดใช้โดยค่าเริ่มต้น รายชื่อ อีเมลของผู้รับ "ถึง:" ที่ตอนนี้รวมอยู่ในฉบับร่างที่ส่วนเสริมกําลังเขียนอยู่ หากต้องการเปิดช่องนี้ คุณต้องตั้งค่าช่อง addOns.gmail.composeTrigger.draftAccess ในไฟล์ Manifest เป็น METADATA

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

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

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

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

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

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

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