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

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

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

ฟังก์ชันเรียกกลับการดำเนินการ จะรับค่าปัจจุบันของวิดเจ็ตในช่อง 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 โดยจะอยู่ในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อส่วนเสริมขยาย Google Chat

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

string (Timestamp format)

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

ฟิลด์ Union payload

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

object (MessagePayload)

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

object (AddedToSpacePayload)

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

object (RemovedFromSpacePayload)

เพย์โหลดที่แอป Chat ได้รับจากทริกเกอร์ Removed from space
chat.buttonClickedPayload

object (ButtonClickedPayload)

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

object (WidgetUpdatedPayload)

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

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

chat.appCommandPayload

object (AppCommandPayload)

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

เพย์โหลด

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

เพย์โหลดของข้อความ
MessagePayload
chat.messagePayload.message object (Message)
ข้อความ Chat ที่ทริกเกอร์เหตุการณ์
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 ลงในพื้นที่ทำงาน โดยใช้ข้อความหรือไม่ก็ตาม เช่น @mention แอป Chat หรือใช้คำสั่ง หาก true Chat จะส่งออบเจ็กต์เหตุการณ์อีกรายการที่มี messagePayload ซึ่งมีข้อมูลเกี่ยวกับข้อความ
chat.addedToSpacePayload.configCompleteRedirectUri string
URL ที่แอป Chat ควรเปลี่ยนเส้นทางผู้ใช้ไปหลังจากที่ผู้ใช้ทำขั้นตอนการให้สิทธิ์หรือการกำหนดค่าภายนอก Google Chat เสร็จสมบูรณ์ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเชื่อมต่อส่วนเสริมของ Google Workspace กับบริการของบุคคลที่สาม

นำออกจากเพย์โหลดของพื้นที่ทำงาน
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
พื้นที่ Chat ที่ผู้ใช้ได้นำแอป 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.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 ได้ ความยาวสูงสุดคือ 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"
  }
}