ทริกเกอร์สําหรับส่วนเสริม Google Workspace

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

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

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

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

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

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

ทริกเกอร์ไฟล์ Manifest ได้รับการกำหนดไว้อย่างครบถ้วนในไฟล์ Manifest ของส่วนเสริม Google Workspace ตัวอย่างทริกเกอร์ของไฟล์ Manifest ได้แก่

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

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

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

พบข้อจำกัด

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

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