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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ออบเจ็กต์เหตุการณ์
eventObject.commonEventObject Common fields object
ออบเจ็กต์ที่มีข้อมูลที่เหมือนกันสำหรับออบเจ็กต์เหตุการณ์ทั้งหมด ไม่ว่าจะมีแอปพลิเคชันโฮสต์ใดก็ตาม
eventObject.calendar Calendar event object
แสดงเฉพาะในกรณีที่โฮสต์ที่โทรเป็น Google ปฏิทิน ออบเจ็กต์ที่มีข้อมูลปฏิทินและกิจกรรม
eventObject.chat Chat event object
แสดงเฉพาะในกรณีที่โฮสต์ที่โทรเป็น Google Chat ออบเจ็กต์ที่มีข้อมูล Chat
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
ระบุแหล่งที่มาของเหตุการณ์ ("WEB", "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
พารามิเตอร์เพิ่มเติมที่คุณระบุให้กับการดําเนินการโดยใช้ actionParameters หรือ Action.setParameters()

ตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์: สำหรับส่วนเสริมที่ขยาย Google Chat ให้ใช้ค่าของคีย์ "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]) เพื่อแนะนำรายการตามสิ่งที่ผู้ใช้พิมพ์ในเมนูแบบเลือกหลายรายการ คุณสามารถใช้ค่านี้เพื่อค้นหาฐานข้อมูลและแนะนำรายการที่เลือกได้ให้กับผู้ใช้ขณะที่พิมพ์ โปรดดูรายละเอียดที่หัวข้อรวบรวมและประมวลผลข้อมูลจากผู้ใช้ Google Chat
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
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 ได้ ความยาวสูงสุดคือ 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 อย่างน้อย 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"
  }
}