ทริกเกอร์สำหรับส่วนเสริมของ Google Workspace

ทริกเกอร์ Apps Script ทําให้ฟังก์ชันสคริปต์ที่ระบุ (ฟังก์ชันทริกเกอร์) ทำงานทุกครั้งที่มีเหตุการณ์ที่ระบุเกิดขึ้น เฉพาะบางเหตุการณ์เท่านั้นที่ทริกเกอร์ให้ทำงานได้ และแอปพลิเคชัน Google Workspace แต่ละรายการรองรับชุดเหตุการณ์ที่แตกต่างกัน

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

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

หน้านี้มีหลักเกณฑ์เกี่ยวกับการใช้ทริกเกอร์ในโปรเจ็กต์ส่วนเสริมของ Google Workspace

ทริกเกอร์ไฟล์ Manifest

ปัจจุบันส่วนเสริม Google Workspace ใช้ทริกเกอร์แบบง่ายของ Apps Script ไม่ได้ ต่างจากส่วนเสริม Editor แต่จะใช้ทริกเกอร์ไฟล์ Manifest ที่ออกแบบมาสำหรับส่วนเสริม Google Workspace โดยเฉพาะ

ทริกเกอร์ไฟล์ Manifest จะกำหนดไว้ในไฟล์ Manifest ของส่วนเสริม Google Workspace โดยสมบูรณ์ ตัวอย่างทริกเกอร์ไฟล์ Manifest มีดังนี้

  • ทริกเกอร์หน้าแรกที่สร้างและแสดงหน้าแรกของส่วนเสริม
  • ทริกเกอร์กิจกรรมในปฏิทินเปิดที่แสดงการ์ดใหม่หรือดำเนินการอื่นๆ เมื่อเปิดกิจกรรมในปฏิทิน
  • ทริกเกอร์ eventUpdate ของปฏิทินที่แสดงการ์ดใหม่หรือดําเนินการอื่นๆ เมื่อผู้ใช้แก้ไขและบันทึกกิจกรรมในปฏิทิน
  • ทริกเกอร์ onItemsSelected ของไดรฟ์ที่แสดงการ์ดใหม่หรือดําเนินการอื่นๆ เมื่อผู้ใช้เลือกไฟล์หรือโฟลเดอร์อย่างน้อย 1 รายการในไดรฟ์
  • ทริกเกอร์การเขียนของ Gmail ที่แสดงการ์ดส่วนเสริมเมื่อผู้ใช้เปิดส่วนเสริมในหน้าต่างเขียนของ Gmail
  • ทริกเกอร์ตามบริบทของ Gmail ที่แสดงการ์ดใหม่หรือดําเนินการอื่นๆ เมื่อผู้ใช้เปิดข้อความ Gmail
  • ทริกเกอร์ Editor onFileScopeGranted ที่แสดงการ์ดใหม่เมื่อผู้ใช้ให้สิทธิ์สําหรับขอบเขต OAuth drive.file ในเอกสาร Editor ปัจจุบัน

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

นอกเหนือจากทริกเกอร์ไฟล์ Manifest แล้ว ส่วนเสริม Google Workspace ยังใช้ทริกเกอร์ที่ติดตั้งได้ของ Apps Script ได้ด้วย

ข้อจำกัด

ทริกเกอร์ไฟล์ Manifest มีข้อจํากัดบางอย่างในการใช้งาน

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