หน้านี้จะสรุปโครงสร้างของออบเจ็กต์เหตุการณ์ส่วนเสริมของ Google Workspace
ออบเจ็กต์เหตุการณ์เป็นโครงสร้าง JSON ที่สร้างขึ้นและส่งเป็นพารามิเตอร์โดยอัตโนมัติเพื่อทริกเกอร์หรือเรียกใช้ฟังก์ชันเรียกกลับเมื่อผู้ใช้โต้ตอบกับส่วนเสริม ออบเจ็กต์เหตุการณ์มีข้อมูลฝั่งไคลเอ็นต์เกี่ยวกับแอปโฮสต์และบริบทปัจจุบันไปยังฟังก์ชันเรียกกลับฝั่งเซิร์ฟเวอร์ของส่วนเสริม
ส่วนเสริมของ Google Workspace จะใช้ออบเจ็กต์เหตุการณ์ในตำแหน่งต่อไปนี้
ทริกเกอร์หน้าแรก ทุกฟังก์ชัน
homepageTrigger
ที่คุณกำหนดจะส่งออบเจ็กต์เหตุการณ์โดยอัตโนมัติเมื่อฟังก์ชันทริกเกอร์หน้าแรกเริ่มทำงาน คุณสามารถใช้ออบเจ็กต์นี้ในฟังก์ชันทริกเกอร์หน้าแรกเพื่อระบุแอปโฮสต์ที่ใช้งานอยู่ แพลตฟอร์มของไคลเอ็นต์ ภาษาของผู้ใช้ และข้อมูลอื่นๆออบเจ็กต์เหตุการณ์ที่สร้างขึ้นเมื่อทริกเกอร์หน้าแรกไม่มีฟิลด์ทั้งหมดที่รวมอยู่ในอีก 2 กรณี นั่นคือ ช่องที่เกี่ยวข้องกับวิดเจ็ตและข้อมูลบริบทจะถูกละไว้
ทริกเกอร์ตามบริบท แอปพลิเคชันโฮสต์แต่ละแอปมีชุดทริกเกอร์ตามบริบทที่แตกต่างกันซึ่งจะเริ่มทำงานเมื่อผู้ใช้ป้อนบริบทที่เฉพาะเจาะจง เช่น
- Gmail จะมีทริกเกอร์ตามบริบทเมื่อผู้ใช้เปิดข้อความ และอีกตัวเลือกหนึ่งเมื่อผู้ใช้เขียนข้อความ
- Google ปฏิทินจะมีทริกเกอร์ตามบริบทเมื่อผู้ใช้เปิดกิจกรรม
- Google ไดรฟ์จะแสดงทริกเกอร์ตามบริบทเมื่อผู้ใช้เลือกไฟล์ในไดรฟ์
เมื่อทริกเกอร์ตามบริบทเริ่มทำงาน แอปพลิเคชันโฮสต์จะเรียกใช้
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.messageMetadata.messageId |
string เลิกใช้งานแล้ว รหัสข้อความของชุดข้อความจะเปิดขึ้นใน UI ของ Gmail
สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง |
eventObject.clientPlatform |
string เลิกใช้งานแล้ว ระบุตำแหน่งของเหตุการณ์ (เว็บ, iOS หรือ Android)
สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง |
eventObject.formInput |
object เลิกใช้งานแล้ว แผนที่ค่าปัจจุบันของวิดเจ็ตแบบฟอร์มทั้งหมดในการ์ด จำกัดไว้ที่ 1 ค่าต่อวิดเจ็ต คีย์คือรหัสสตริงที่เชื่อมโยงกับวิดเจ็ต และค่าคือสตริง ออบเจ็กต์เหตุการณ์จะมี formInput เป็นตัวช่วยสำหรับกรณีที่คุณต้องการอ่านข้อมูลจากวิดเจ็ตหลายรายการที่มีค่าเอกพจน์ที่คาดไว้ เช่น การป้อนข้อมูลข้อความและสวิตช์ สําหรับวิดเจ็ตที่มีค่าหลายรายการ เช่น ช่องทําเครื่องหมาย คุณก็อ่านแต่ละค่าจาก formInputs แทนได้
สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง |
eventObject.formInputs |
object เลิกใช้งานแล้ว แผนที่ค่าปัจจุบันของวิดเจ็ตในการ์ดที่แสดงเป็นรายการสตริง คีย์คือรหัสสตริงที่เชื่อมโยงกับวิดเจ็ต สำหรับวิดเจ็ตที่มีค่าเดียว ค่าจะแสดงในอาร์เรย์องค์ประกอบเดียว สำหรับวิดเจ็ตที่มีหลายค่า เช่น กลุ่มช่องทำเครื่องหมาย ค่าทั้งหมดจะแสดงเป็นรายการ
สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง |
eventObject.parameters |
object เลิกใช้งานแล้ว แมปของพารามิเตอร์เพิ่มเติมทั้งหมดที่คุณให้ไว้กับ Action โดยใช้
Action.setParameters() คีย์และค่าการแมปเป็นสตริง
สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง |
eventObject.userCountry |
string เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น รหัส 2 ตัวอักษรที่ระบุประเทศหรือภูมิภาคของผู้ใช้ หรืออาจเป็นรหัสประเทศ UN M49 ที่เป็นตัวเลขก็ได้
สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง |
eventObject.userLocale |
string เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น รหัส ISO 639 แบบ 2 ตัวอักษรที่ระบุภาษาของผู้ใช้ ดูรายละเอียดเพิ่มเติมได้ที่การเข้าถึงภาษาและเขตเวลาของผู้ใช้
สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง |
eventObject.userTimezone.id |
string เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น ตัวระบุเขตเวลาของเขตเวลาของผู้ใช้ ตัวอย่างเช่น America/New_York , Europe/Vienna และ Asia/Seoul ดูรายละเอียดเพิ่มเติมได้ที่
การเข้าถึงภาษาและเขตเวลาของผู้ใช้
สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง |
eventObject.userTimezone.offset |
string เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น การชดเชยเวลาจากเวลาสากลเชิงพิกัด (UTC) ของเขตเวลาของผู้ใช้ ซึ่งวัดเป็นมิลลิวินาที ดูรายละเอียดเพิ่มเติมได้ที่ การเข้าถึงภาษาและเขตเวลาของผู้ใช้
สำหรับส่วนเสริมของ Google Workspace ให้ค้นหาข้อมูลนี้ในช่อง |
ออบเจ็กต์เหตุการณ์ทั่วไป
ออบเจ็กต์เหตุการณ์ทั่วไปคือส่วนของออบเจ็กต์เหตุการณ์โดยรวมที่มีข้อมูลทั่วไปที่ไม่ขึ้นอยู่กับโฮสต์ไปยังส่วนเสริมจากไคลเอ็นต์ของผู้ใช้ ข้อมูลนี้จะรวมถึงรายละเอียด เช่น ภาษาของผู้ใช้ แอปโฮสต์ และแพลตฟอร์ม
นอกเหนือจากทริกเกอร์หน้าแรกและทริกเกอร์ตามบริบทแล้ว ส่วนเสริมจะสร้างและส่งออบเจ็กต์เหตุการณ์ไปยังฟังก์ชันการเรียกกลับของการดำเนินการ เมื่อผู้ใช้โต้ตอบกับวิดเจ็ต ฟังก์ชันเรียกกลับของส่วนเสริมสามารถค้นหาออบเจ็กต์เหตุการณ์ทั่วไปเพื่อระบุเนื้อหาของวิดเจ็ตที่เปิดอยู่ในไคลเอ็นต์ของผู้ใช้ เช่น ส่วนเสริมจะค้นหาข้อความที่ผู้ใช้ป้อนลงในวิดเจ็ต TextInput
ในออบเจ็กต์ eventObject.commentEventObject.formInputs
ได้
ช่องออบเจ็กต์เหตุการณ์ทั่วไป | |
---|---|
commonEventObject.platform |
string ระบุตำแหน่งของเหตุการณ์ ("เว็บ", "IOS" หรือ "ANDROID") |
commonEventObject.formInputs |
object แผนที่ที่มีค่าปัจจุบันของวิดเจ็ตในการ์ดที่แสดง คีย์การแมปคือรหัสสตริงที่กำหนดให้กับวิดเจ็ตแต่ละรายการ โครงสร้างของออบเจ็กต์ค่าแมปจะขึ้นอยู่กับประเภทวิดเจ็ต ดังนี้
|
commonEventObject.hostApp |
string ระบุแอปโฮสต์ที่ส่วนเสริมทำงานอยู่เมื่อมีการสร้างออบเจ็กต์เหตุการณ์ ค่าที่เป็นไปได้มีดังนี้
|
commonEventObject.parameters |
object พารามิเตอร์เพิ่มเติมทั้งหมดที่คุณให้ไว้กับ
Action โดยใช้
Action.setParameters()
|
commonEventObject.userLocale |
string ปิดใช้โดยค่าเริ่มต้น ตัวระบุภาษาและประเทศ/ภูมิภาคของผู้ใช้ในรูปแบบรหัสภาษา ISO 639 - รหัสประเทศ/ภูมิภาค ISO 3166 เช่น en-US
หากต้องการเปิดช่องนี้ คุณต้องตั้งค่า |
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
ซึ่งรวมถึงค่าวันที่หรือเวลาที่เลือกของผู้ใช้ในวิดเจ็ตเครื่องมือเลือกวันที่หรือเวลา
อย่างไรก็ตาม โครงสร้างของข้อมูลจะแตกต่างกันไป โดยขึ้นอยู่กับว่าวิดเจ็ตได้รับการกำหนดค่าเป็นเครื่องมือเลือกวันที่และเวลา เครื่องมือเลือกวันที่เท่านั้น หรือเครื่องมือเลือกเวลาเท่านั้น ความแตกต่างเชิงโครงสร้างอธิบายไว้ในตารางต่อไปนี้
ออบเจ็กต์กิจกรรมในปฏิทิน
ออบเจ็กต์กิจกรรมในปฏิทินเป็นส่วนของออบเจ็กต์กิจกรรมโดยรวมที่มีข้อมูลเกี่ยวกับปฏิทินและกิจกรรมในปฏิทินของผู้ใช้ ซึ่งจะแสดงในออบเจ็กต์กิจกรรมก็ต่อเมื่อแอปพลิเคชันโฮสต์คือ 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 สถานะการตอบกลับของผู้เข้าร่วม ค่าที่เป็นไปได้มีดังนี้
|
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 ประเภทโซลูชันการประชุม ค่าที่เป็นไปได้มีดังนี้
|
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 เท่านั้น
|
entryPoint.entryPointType |
string ประเภทของจุดแรกเข้า ค่าที่เป็นไปได้มีดังนี้
|
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 อักขระ การจัดรูปแบบจะขึ้นอยู่กับประเภทจุดแรกเข้า ดังนี้
|
ออบเจ็กต์เหตุการณ์ของไดรฟ์
ออบเจ็กต์เหตุการณ์ไดรฟ์คือส่วนของออบเจ็กต์เหตุการณ์โดยรวมที่มีข้อมูลเกี่ยวกับ 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
จะแสดงเมื่อเป็นไปตามเงื่อนไขต่อไปนี้เท่านั้น
URL ของลิงก์ที่สร้างตัวอย่างใน Google เอกสาร หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า LinkPreviewTriggers ในไฟล์ Manifest ของส่วนเสริม ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อแสดงตัวอย่างลิงก์ที่มีชิปอัจฉริยะ
ตัวอย่างเพย์โหลดเมื่อผู้ใช้ดูตัวอย่างลิงก์ "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
จะแสดงเมื่อเป็นไปตามเงื่อนไขต่อไปนี้เท่านั้น
URL ของลิงก์ที่สร้างตัวอย่างใน Google ชีต หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า LinkPreviewTriggers ในไฟล์ Manifest ของส่วนเสริม ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อแสดงตัวอย่างลิงก์ที่มีชิปอัจฉริยะ
ตัวอย่างเปย์โหลดเมื่อผู้ใช้ดูตัวอย่างลิงก์ "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
จะแสดงเมื่อเป็นไปตามเงื่อนไขต่อไปนี้เท่านั้น
URL ของลิงก์ที่สร้างตัวอย่างใน Google สไลด์ หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า LinkPreviewTriggers ในไฟล์ Manifest ของส่วนเสริม
ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อแสดงตัวอย่างลิงก์ที่มีชิปอัจฉริยะ
ตัวอย่างเปย์โหลดเมื่อผู้ใช้ดูตัวอย่างลิงก์ "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |