หน้านี้จะแสดงโครงสร้างของออบเจ็กต์เหตุการณ์ส่วนเสริมของ Google Workspace
ออบเจ็กต์เหตุการณ์เป็นโครงสร้าง JSON ที่สร้างขึ้นและส่งโดยอัตโนมัติ เป็นพารามิเตอร์ที่จะทริกเกอร์หรือฟังก์ชัน Callback เมื่อผู้ใช้โต้ตอบกับแท็ก ส่วนเสริม ออบเจ็กต์เหตุการณ์มีข้อมูลฝั่งไคลเอ็นต์เกี่ยวกับแอปโฮสต์และ บริบทปัจจุบันไปยังฟังก์ชัน Callback ฝั่งเซิร์ฟเวอร์ของส่วนเสริม
ส่วนเสริมของ Google Workspace จะใช้ออบเจ็กต์เหตุการณ์ในที่ต่อไปนี้
ทริกเกอร์หน้าแรก ทุกฟังก์ชัน
homepageTrigger
ที่คุณกำหนดจะส่งผ่านเหตุการณ์โดยอัตโนมัติ เมื่อฟังก์ชันทริกเกอร์หน้าแรกเริ่มทำงาน คุณสามารถใช้ออบเจ็กต์นี้ใน ฟังก์ชันทริกเกอร์หน้าแรกเพื่อระบุแอปโฮสต์ที่ใช้งานอยู่ แพลตฟอร์ม ภาษาของผู้ใช้ และข้อมูลอื่นๆออบเจ็กต์เหตุการณ์ที่สร้างเมื่อทริกเกอร์หน้าแรกเริ่มทำงานไม่มีเหตุการณ์ ไว้ในอีก 2 กรณี ได้แก่ เกี่ยวกับวิดเจ็ตและ ละเว้นข้อมูลบริบท
ทริกเกอร์ตามบริบท แอปพลิเคชันโฮสต์แต่ละรายการมีชุดทริกเกอร์ตามบริบทที่แตกต่างกันซึ่ง เริ่มทำงานเมื่อผู้ใช้เข้าสู่บริบทที่เฉพาะเจาะจง เช่น
- Gmail มีทริกเกอร์ตามบริบทเมื่อผู้ใช้ เปิดข้อความ และอีกรายการเมื่อผู้ใช้ เขียนข้อความ
- Google ปฏิทินมีทริกเกอร์ตามบริบทเพื่อแสดงเมื่อผู้ใช้ เปิดเหตุการณ์
- Google ไดรฟ์มีทริกเกอร์ตามบริบทเพื่อแสดงเมื่อผู้ใช้ เลือกไฟล์ในไดรฟ์
เมื่อทริกเกอร์ตามบริบทเริ่มทำงาน แอปพลิเคชันโฮสต์จะเรียกใช้เมธอด
runFunction
ที่เกี่ยวข้องซึ่งแสดงในไฟล์ Manifest ของส่วนเสริม โดยส่ง เป็นพารามิเตอร์ ออบเจ็กต์เหตุการณ์ที่สร้างขึ้นเมื่อตามบริบท ทริกเกอร์เริ่มทำงานมีช่องทั้งหมดรวมอยู่ในเหตุการณ์ทริกเกอร์หน้าแรก รวมถึงช่องที่มีข้อมูลตามบริบทการทำงานของวิดเจ็ต ออบเจ็กต์เหตุการณ์ ยังใช้เพื่อจัดเตรียมวิดเจ็ต การโต้ตอบ โดยใช้ รูปแบบการดำเนินการที่ส่วนเสริม Gmail ส่วนเสริมของ Google Workspace ใช้ฟังก์ชันของตัวแฮนเดิลวิดเจ็ตแบบเดียวกันทั้งหมด
Action
ออบเจ็กต์และการดำเนินการ คำตอบ แต่ในส่วนเสริมของ Google Workspace ออบเจ็กต์เหตุการณ์การดำเนินการ ระบุข้อมูลเพิ่มเติมที่ฟังก์ชัน Callback สามารถดําเนินการได้ออบเจ็กต์เหตุการณ์ที่เป็นผลมาจากการทำงานของวิดเจ็ตจะมีข้อมูลทั้งหมด ช่องที่รวมอยู่ในออบเจ็กต์เหตุการณ์ทริกเกอร์ตามบริบท และช่องที่มี ข้อมูลวิดเจ็ต
แสดงตัวอย่างทริกเกอร์ลิงก์ ใน Google เอกสาร, ชีต และสไลด์ คุณสามารถทำสิ่งต่อไปนี้ กำหนดค่าตัวอย่างลิงก์สำหรับบริการของบุคคลที่สาม ตามรูปแบบ URL เฉพาะ เมื่อผู้ใช้โต้ตอบกับลิงก์ที่ตรงกับ รูปแบบ
linkPreviewTriggers
เริ่มทำงานและออบเจ็กต์เหตุการณ์ที่มีลิงก์จะส่งไปยัง ฟังก์ชัน Callback ส่วนเสริมสามารถใช้ออบเจ็กต์เหตุการณ์นี้เพื่อสร้าง ชิปอัจฉริยะและการ์ดที่แสดงข้อมูลเกี่ยวกับลิงก์ภายในโฮสต์ แอปพลิเคชัน คุณยังสร้างการทำงานของวิดเจ็ตเพื่อให้ผู้ใช้โต้ตอบ การ์ดตัวอย่างและเนื้อหาในการ์ด
โครงสร้างออบเจ็กต์เหตุการณ์
ตารางต่อไปนี้อธิบายโครงสร้างระดับบนสุดของ
ออบเจ็กต์เหตุการณ์ส่วนเสริมของ 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 เป็น
สะดวกเมื่อคุณต้องการอ่านข้อมูลจาก Widget ต่างๆ
ค่าเอกพจน์ที่คาดหวัง เช่น การป้อนข้อความและสวิตช์ สำหรับ
วิดเจ็ตที่มีหลายค่า เช่น ช่องทำเครื่องหมาย คุณสามารถอ่านค่าแต่ละค่าจาก
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 เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น ตัวอักษร 2 ตัว ISO 639 ที่ระบุภาษาของผู้ใช้ โปรดดู การเข้าถึงผู้ใช้ ภาษาและเขตเวลา
สำหรับส่วนเสริมของ Google Workspace โปรดดูข้อมูลนี้ใน
|
eventObject.userTimezone.id |
string เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น ตัวระบุเขตเวลา สำหรับเขตเวลาของผู้ใช้ ตัวอย่างเช่น America/New_York , Europe/Vienna และ
Asia/Seoul โปรดดู
การเข้าถึงภาษาและเขตเวลาของผู้ใช้เพื่อดูรายละเอียดเพิ่มเติม
สำหรับส่วนเสริมของ Google Workspace โปรดดูข้อมูลนี้ใน
|
eventObject.userTimezone.offset |
string เลิกใช้งานและปิดใช้โดยค่าเริ่มต้น การชดเชยเวลาจาก Coordinated Universal Time (UTC) ของผู้ใช้ เขตเวลา หน่วยเป็นมิลลิวินาที โปรดดู การเข้าถึงภาษาและเขตเวลาของผู้ใช้เพื่อดูรายละเอียดเพิ่มเติม
สำหรับส่วนเสริมของ Google Workspace โปรดดูข้อมูลนี้ใน
|
ออบเจ็กต์เหตุการณ์ทั่วไป
ออบเจ็กต์เหตุการณ์ทั่วไปคือส่วนของออบเจ็กต์เหตุการณ์โดยรวมที่มี โดยทั่วไป ข้อมูลที่เป็นอิสระจากโฮสต์ไปยังส่วนเสริมจากไคลเอ็นต์ของผู้ใช้ ช่วงเวลานี้ ข้อมูลดังกล่าวรวมถึงรายละเอียด เช่น ภาษาของผู้ใช้ แอปโฮสต์ และแพลตฟอร์ม
นอกเหนือจากทริกเกอร์หน้าแรกและบริบทแล้ว ส่วนเสริมสร้างและส่ง
ออบเจ็กต์เหตุการณ์เป็นฟังก์ชัน Callback การดำเนินการ
เมื่อผู้ใช้โต้ตอบกับวิดเจ็ต ฟังก์ชัน Callback ของส่วนเสริมค้นหาได้
ออบเจ็กต์เหตุการณ์ทั่วไปเพื่อกำหนดเนื้อหาของวิดเจ็ตที่เปิดในบัญชี
เช่น ส่วนเสริมจะค้นหาข้อความที่ผู้ใช้ป้อนลงใน
วิดเจ็ต 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 การชดเชยเวลาจาก Coordinated Universal Time (UTC) ของผู้ใช้ เขตเวลา หน่วยเป็นมิลลิวินาที โปรดดู การเข้าถึงภาษาและเขตเวลาของผู้ใช้เพื่อดูรายละเอียดเพิ่มเติม |
ข้อมูลในแบบฟอร์มตัวเลือกวันที่และเวลา
ฟังก์ชัน Callback สำหรับการดำเนินการ
สามารถรับค่าปัจจุบันในวิดเจ็ต 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
ประจักษ์แจ้ง
ฟิลด์ถึง
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 หรือการประชุมของบุคคลที่สาม ข้อมูลนี้จะปรากฏใน
event หากและเฉพาะในกรณีที่มีข้อมูลนั้นอยู่ในกิจกรรมในปฏิทินและ
ส่วนเสริมจะตั้งค่าaddOns.calendar.currentEventAccess
ประจักษ์แจ้ง
ฟิลด์ถึง
READ
หรือ READ_WRITE
ออบเจ็กต์ข้อมูลการประชุม | |
---|---|
conferenceData.conferenceId |
string รหัสของการประชุม รหัสนี้คือรหัส ทำให้แอปพลิเคชันสามารถติดตามการประชุมได้ คุณไม่ควร แสดงรหัสนี้แก่ผู้ใช้ |
conferenceData.conferenceSolution |
object ออบเจ็กต์ที่แสดงถึงการประชุม เช่น Hangouts หรือ Google Meet |
conferenceData.conferenceSolution.iconUri |
string URL สำหรับไอคอนที่ผู้ใช้มองเห็นได้ซึ่งแสดง ซึ่งเป็นโซลูชันการประชุม |
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 ได้ ความยาวสูงสุดคือ 2048 อักขระ |
conferenceData.parameters |
object วัตถุที่มีแผนที่ของ ข้อมูลพารามิเตอร์ที่ส่วนเสริมใช้ |
conferenceData.parameters.addOnParameters |
object การแมปคีย์และค่าของสตริงพารามิเตอร์ นักพัฒนาซอฟต์แวร์ส่วนเสริมจะกำหนดคีย์และค่าเหล่านี้ให้แนบ ลงในการประชุมที่ระบุสำหรับการใช้งานส่วนเสริม |
จุดแรกเข้า
ออบเจ็กต์ของจุดแรกเข้ามีข้อมูลเกี่ยวกับวิธีการเข้าถึงซึ่งเป็นที่ยอมรับ
การประชุมหนึ่งๆ เช่น ทางโทรศัพท์หรือวิดีโอ ข้อมูลนี้มีอยู่ใน
ออบเจ็กต์กิจกรรมหากมีข้อมูลอยู่ในกิจกรรมในปฏิทินและ
ส่วนเสริมจะกำหนด addOns.calendar.currentEventAccess
ประจักษ์แจ้ง
ฟิลด์ถึง
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 URL ของจุดแรกเข้า สูงสุด ความยาว 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 ปิดใช้โดยค่าเริ่มต้น รายการ ของ "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
|
ออบเจ็กต์เหตุการณ์ของเอกสาร
ออบเจ็กต์เหตุการณ์ในเอกสารเป็นส่วนหนึ่งของออบเจ็กต์เหตุการณ์โดยรวมที่มี ข้อมูลเกี่ยวกับเอกสารของผู้ใช้และเนื้อหาในเอกสาร ซึ่งมีอยู่ใน event ของถ้าแอปพลิเคชันโฮสต์คือ 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" } } |
ออบเจ็กต์กิจกรรมชีต
ออบเจ็กต์เหตุการณ์ของชีตเป็นส่วนหนึ่งของออบเจ็กต์เหตุการณ์โดยรวมที่มี ข้อมูลเกี่ยวกับเอกสารของผู้ใช้และเนื้อหาในเอกสาร ซึ่งมีอยู่ใน Event หากแอปพลิเคชันโฮสต์คือ 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" } } |