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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ออบเจ็กต์เหตุการณ์
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

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

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

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

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

  • A date-only picker: DateInput object

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

  • A time-only picker: TimeInput object

    ตัวอย่าง: สำหรับเครื่องมือเลือกที่มีรหัส myTimePicker ให้เข้าถึงออบเจ็กต์ TimeInput โดยใช้ e.commonEventObject.formInputs.myTimePicker.timeInput
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
ตัวเลขนาทีที่ผู้ใช้เลือก

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

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

แชท
chat.user object (User)
ผู้ใช้ Chat ที่โต้ตอบกับแอปใน Chat
chat.space object (Space)
พื้นที่ใน Chat ที่ผู้ใช้โต้ตอบกับแอปใน Chat
chat.eventTime

string (Timestamp format)

เวลาที่เกิดการโต้ตอบ

ฟิลด์ Union payload สำหรับทริกเกอร์หน้าแรกของแอป (เมื่อผู้ใช้เปิดแท็บหน้าแรก) ระบบจะไม่ตั้งค่า payload และ chat จะมี chat.user และ chat.eventTime

payload ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
chat.messagePayload

object (MessagePayload)

เพย์โหลดที่แอปใน Chat ได้รับจากทริกเกอร์ข้อความ
chat.addedToSpacePayload

object (AddedToSpacePayload)

เพย์โหลดที่แอปใน Chat ได้รับจากทริกเกอร์เพิ่มไปยังพื้นที่ทำงาน
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

เพย์โหลดที่แอปใน Chat ได้รับจากทริกเกอร์นำออกจากพื้นที่ทำงาน
chat.buttonClickedPayload

object (ButtonClickedPayload)

เพย์โหลดที่แอปใน Chat ได้รับเมื่อผู้ใช้คลิกปุ่มจากข้อความหรือการ์ด หากผู้ใช้คลิกปุ่มเพื่อส่งข้อมูล ออบเจ็กต์ commonEventObject.formInputs จะมีค่าที่รวบรวมจากผู้ใช้ โปรดดูรายละเอียดที่หัวข้อ รวบรวมข้อมูลจากผู้ใช้ Google Chat
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

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

ออบเจ็กต์ CommonEventObject.parameters['autocomplete_widget_query'] มีค่าสตริงที่ผู้ใช้พิมพ์ลงในเมนู

chat.appCommandPayload

object (AppCommandPayload)

เพย์โหลดที่แอปใน Chat ได้รับเมื่อผู้ใช้ใช้คำสั่งจากแอปใน Chat

เพย์โหลด

เหตุการณ์จะมีเพย์โหลดที่มีทรัพยากร Chat API อย่างน้อย 1 รายการ ทั้งนี้ขึ้นอยู่กับประเภทการโต้ตอบของแอป Chat

เพย์โหลดข้อความ
MessagePayload
chat.messagePayload.message object (Message)
ข้อความแชทที่ทริกเกอร์เหตุการณ์
chat.messagePayload.space object (Space)
พื้นที่ใน Chat ที่ผู้ใช้ส่งข้อความที่เรียกใช้แอปใน Chat
chat.messagePayload.configCompleteRedirectUri string
URL ที่แอปใน Chat ควรเปลี่ยนเส้นทางผู้ใช้ไปหลังจากที่ผู้ใช้ทำขั้นตอนการให้สิทธิ์หรือการกำหนดค่านอก Google Chat เสร็จสมบูรณ์ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเชื่อมต่อส่วนเสริมของ Google Workspace กับบริการของบุคคลที่สาม
เพิ่มลงในเพย์โหลดของพื้นที่ทำงานแล้ว
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
พื้นที่ทำงานใน Chat ที่ผู้ใช้เพิ่มหรือติดตั้งแอปใน Chat

เมื่อผู้ดูแลระบบติดตั้งแอปใน Chat ระบบจะตั้งค่าช่อง space.adminInstalled เป็น true

chat.addedToSpacePayload.interactionAdd boolean
ผู้ใช้เพิ่มแอปใน Chat ไปยังพื้นที่ทำงานโดยใช้ข้อความหรือไม่ เช่น @พูดถึงแอปใน Chat หรือใช้คำสั่ง หากเป็น true Chat จะส่งออบเจ็กต์เหตุการณ์อีกรายการพร้อมกับ messagePayload ที่มีข้อมูลเกี่ยวกับข้อความ
chat.addedToSpacePayload.configCompleteRedirectUri string
URL ที่แอปใน Chat ควรเปลี่ยนเส้นทางผู้ใช้ไปหลังจากที่ผู้ใช้ทำขั้นตอนการให้สิทธิ์หรือการกำหนดค่านอก Google Chat เสร็จสมบูรณ์ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเชื่อมต่อส่วนเสริมของ Google Workspace กับบริการของบุคคลที่สาม
เพย์โหลดที่นำออกจากพื้นที่ทำงาน
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
พื้นที่ใน Chat ที่ผู้ใช้นำแอป Chat ออกหรือถอนการติดตั้ง

เมื่อผู้ดูแลระบบถอนการติดตั้งแอปใน Chat ระบบจะตั้งค่าช่อง space.adminInstalled เป็น false

เพย์โหลดที่คลิกปุ่ม
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
ข้อความ Chat ที่มีปุ่มที่ผู้ใช้คลิก
chat.buttonClickedPayload.space object (Space)
พื้นที่ใน Chat ที่ผู้ใช้คลิกปุ่มจากข้อความของแอปใน Chat
chat.buttonClickedPayload.isDialogEvent boolean
ผู้ใช้คลิกปุ่มเพื่อโต้ตอบกับกล่องโต้ตอบหรือไม่
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
หาก isDialogEvent เป็น true ประเภทของการโต้ตอบในกล่องโต้ตอบ

Enum DialogEventType

ค่าของ dialogEventType ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
TYPE_UNSPECIFIED ค่าเริ่มต้น ไม่ระบุ
REQUEST_DIALOG ผู้ใช้ขอให้เปิดกล่องโต้ตอบ เช่น ใช้คำสั่งหรือคลิกปุ่มจากข้อความ
SUBMIT_DIALOG ผู้ใช้คลิกองค์ประกอบแบบอินเทอร์แอกทีฟภายในกล่องโต้ตอบ เช่น ผู้ใช้กรอกข้อมูลในกล่องโต้ตอบและคลิกปุ่มเพื่อส่งข้อมูล
เพย์โหลดที่อัปเดตวิดเจ็ต
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
พื้นที่ใน Chat ที่มีการโต้ตอบเกิดขึ้น
เพย์โหลดคำสั่งของแอป
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
ข้อมูลเมตาเกี่ยวกับคำสั่งที่ผู้ใช้ใช้และวิธีเรียกใช้คำสั่ง
chat.appCommandPayload.space object (Space)
พื้นที่ใน Chat ที่ผู้ใช้ใช้คำสั่ง
chat.appCommandPayload.thread object (Thread)
หากการโต้ตอบเกิดขึ้นในชุดข้อความ ชุดข้อความ Chat ที่ผู้ใช้ใช้คำสั่ง
chat.appCommandPayload.message object (Message)
สำหรับคำสั่งเครื่องหมายทับ ข้อความที่มีคำสั่งเครื่องหมายทับ
chat.appCommandPayload.configCompleteRedirectUri string
หากคำสั่งต้องมีการให้สิทธิ์หรือการกำหนดค่า ให้ระบุ URL เพื่อเปลี่ยนเส้นทางผู้ใช้หลังจากที่ผู้ใช้ดำเนินการตามกระบวนการนอก Google Chat เสร็จสมบูรณ์
chat.appCommandPayload.isDialogEvent boolean
คำสั่งจะเปิดกล่องโต้ตอบหรือไม่
chat.appCommandPayload.dialogEventType enum (DialogEventType)
ประเภทการโต้ตอบกับกล่องโต้ตอบ

Enum DialogEventType

ค่าของ dialogEventType ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
TYPE_UNSPECIFIED ค่าเริ่มต้น ไม่ระบุ
REQUEST_DIALOG ผู้ใช้ขอให้เปิดกล่องโต้ตอบ เช่น ใช้คำสั่งหรือคลิกปุ่มจากข้อความ
SUBMIT_DIALOG ผู้ใช้คลิกองค์ประกอบแบบอินเทอร์แอกทีฟภายในกล่องโต้ตอบ เช่น ผู้ใช้กรอกข้อมูลในกล่องโต้ตอบและคลิกปุ่มเพื่อส่งข้อมูล
ข้อมูลเมตาของคำสั่งแอป
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

รหัสคำสั่ง
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
ประเภทของคำสั่ง

Enum AppCommandType

ค่าของ AppCommandType ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
APP_COMMAND_TYPE_UNSPECIFIED ค่าเริ่มต้น ไม่ระบุ
SLASH_COMMAND ผู้ใช้จะใช้คำสั่งโดยส่งข้อความที่ขึ้นต้นด้วยเครื่องหมายทับ /
QUICK_COMMAND ผู้ใช้เลือกคำสั่งจากเมนู Chat ในส่วนตอบกลับข้อความ

ออบเจ็กต์กิจกรรมในปฏิทิน

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

ตารางต่อไปนี้แสดงช่องที่มีอยู่ในช่อง calendarEventObject ของออบเจ็กต์เหตุการณ์ ช่องที่ทำเครื่องหมายเป็นข้อมูลที่ผู้ใช้สร้างขึ้นจะปรากฏในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อข้อมูลนั้นปรากฏในกิจกรรมในปฏิทินและส่วนเสริมตั้งค่าช่องaddOns.calendar.currentEventAccess ไฟล์ Manifest เป็น READ หรือ READ_WRITE

ฟิลด์จำนวนมากในออบเจ็กต์นี้และโครงสร้างย่อยจะแมปโดยตรงกับฟิลด์ทรัพยากรกิจกรรมของ Calendar API ที่มีชื่อเดียวกัน หากคำอธิบายช่องแตกต่างกัน ข้อมูลในตารางต่อไปนี้จะถูกต้อง

ออบเจ็กต์กิจกรรมในปฏิทิน
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 จุดด้วย
  • 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 เพื่อให้ส่วนเสริมมีสิทธิ์เข้าถึงข้อความ 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"
  }
}