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

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

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

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

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

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

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

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

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

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

  • ทริกเกอร์ลิงก์แสดงตัวอย่าง ใน 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

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

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

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

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

  • A date-only picker: a 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) ของเขตเวลาของผู้ใช้ซึ่งวัดเป็นมิลลิวินาที ดูรายละเอียดเพิ่มเติมได้ที่ การเข้าถึงภาษาและเขตเวลาของผู้ใช้

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

ฟังก์ชันเรียกกลับของการดำเนินการ สามารถรับค่าวิดเจ็ตปัจจุบันในช่อง 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 ได้ไม่เกิน 0 จุด 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

ออบเจ็กต์กิจกรรมของเอกสาร

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

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

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