การดำเนินการเสริม

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

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

กำหนดค่าวิดเจ็ตด้วยAction โดยใช้กระบวนการทั่วไปดังต่อไปนี้

  1. สร้างออบเจ็กต์ Action ระบุฟังก์ชัน Callback ที่ควร ดำเนินการควบคู่กับพารามิเตอร์ที่จำเป็น
  2. เรียกฟังก์ชันเครื่องจัดการวิดเจ็ตที่เหมาะสม บนวิดเจ็ตโดยใช้ Action ออบเจ็กต์
  3. ใช้ฟังก์ชัน Callback เพื่อกำหนดลักษณะการทำงานที่จำเป็น

ฟังก์ชันเครื่องจัดการวิดเจ็ต

วิธีลิงก์วิดเจ็ตกับ Action เฉพาะ หรือการทำงานอื่นๆ โดยใช้วิดเจ็ต ของตัวแฮนเดิล ฟังก์ชันตัวแฮนเดิลจะกำหนดประเภทการโต้ตอบ (เช่น การคลิกวิดเจ็ตหรือการแก้ไขช่องข้อความ) จะเรียกเมธอด พฤติกรรมการดำเนินการ ฟังก์ชันเครื่องจัดการจะกำหนด ขั้นตอนที่ UI ใช้ หากมี หลังจากที่การดำเนินการเสร็จสมบูรณ์

ตารางต่อไปนี้แสดงเครื่องจัดการประเภทต่างๆ สำหรับวิดเจ็ตและ วิดเจ็ตที่ใช้กับ

ฟังก์ชันเครื่องจัดการ ทริกเกอร์การดำเนินการ วิดเจ็ตที่เกี่ยวข้อง คำอธิบาย
setOnChangeAction() ค่าวิดเจ็ตมีการเปลี่ยนแปลง DatePicker
DateTimePicker
SelectionInput
Switch
TextInput TimePicker
ตั้งค่า Action ที่เรียกใช้ฟังก์ชัน Apps Script เมื่อวิดเจ็ตขาดโฟกัส เช่น เช่น เมื่อผู้ใช้ป้อนข้อความในอินพุตและกด Enter ตัวแฮนเดิลจะส่งผ่าน eventobject ไปยังฟังก์ชันที่เรียกใช้ คุณแทรกข้อมูลพารามิเตอร์เพิ่มเติมในออบเจ็กต์เหตุการณ์นี้ได้ หากต้องการ
setOnClickAction() ผู้ใช้คลิกวิดเจ็ต CardAction
Image
ImageButton
DecoratedText
TextButton
ตั้งค่า Action ที่เรียกใช้ฟังก์ชัน Apps Script เมื่อผู้ใช้คลิกวิดเจ็ต ตัวแฮนเดิลจะส่งผ่าน eventobject ไปยังฟังก์ชันที่เรียกใช้ คุณสามารถแทรกข้อมูลพารามิเตอร์ที่ไม่บังคับในออบเจ็กต์เหตุการณ์นี้
setComposeAction() ผู้ใช้คลิกวิดเจ็ต CardAction
Image
ImageButton
DecoratedText
TextButton
เฉพาะ Gmail ตั้งค่า Action ที่สร้างอีเมลฉบับร่าง แล้วแสดงร่างจดหมายนั้นแก่ผู้ใช้ใน หน้าต่างเขียน UI ของ Gmail คุณสามารถสร้างข้อความร่างเป็นข้อความใหม่ หรือ ตอบกลับข้อความที่เปิดอยู่ใน Gmail เมื่อเครื่องจัดการเรียกใช้ฟังก์ชัน ฟังก์ชันแบบร่าง-การสร้าง Callback จะส่ง event object ไปยังฟังก์ชัน Callback โปรดดู เขียนข้อความฉบับร่าง เพื่อดูรายละเอียดเพิ่มเติม
setOnClickOpenLinkAction() ผู้ใช้คลิกวิดเจ็ต CardAction
Image
ImageButton
DecoratedText
TextButton
ตั้งค่า Action เพื่อเปิด URL เมื่อผู้ใช้คลิกวิดเจ็ต ใช้เครื่องจัดการนี้เมื่อคุณ ต้องสร้าง URL มิเช่นนั้นจะดำเนินการอื่นๆ ก่อนลิงก์ เปิด; มิเช่นนั้น มักจะใช้ setOpenLink() ได้ง่ายกว่า คุณจะเปิด URL ได้ในหน้าต่างใหม่เท่านั้น เมื่อปิดแล้ว คุณสามารถทำให้ UI เพื่อโหลดส่วนเสริมซ้ำ
setOpenLink() ผู้ใช้คลิกวิดเจ็ต CardAction
Image
ImageButton
DecoratedText
TextButton
เปิด URL โดยตรงเมื่อผู้ใช้คลิกวิดเจ็ต ใช้ร่างคำตอบนี้ เมื่อคุณทราบ URL และต้องการเปิด URL เท่านั้น มิฉะนั้น ให้ใช้ setOnClickOpenLinkAction() คุณสามารถเปิด URL ในหน้าต่างใหม่หรือในโฆษณาซ้อนทับ เมื่อปิดแล้ว คุณ ทำให้ UI โหลดส่วนเสริมซ้ำได้
setSuggestionsAction() ผู้ใช้ป้อนข้อความลงในอินพุต TextInput ตั้งค่า Action ที่เรียกใช้ฟังก์ชัน Apps Script เมื่อผู้ใช้ป้อนข้อความลงใน วิดเจ็ตการป้อนข้อความ เครื่องจัดการจะส่ง eventobject ไปยังฟังก์ชันที่เรียกใช้ โปรดดู คำแนะนำที่เติมข้อความอัตโนมัติ สำหรับการป้อนข้อความเพื่อดูรายละเอียดเพิ่มเติม

ฟังก์ชัน Callback

ฟังก์ชัน Callback จะทำงานเมื่อ Action ทริกเกอร์ เนื่องจากฟังก์ชัน Callback เป็นฟังก์ชันของ Apps Script คุณจึงสามารถใช้ ทำงานเกือบทุกอย่างที่ฟังก์ชันของสคริปต์สามารถทำได้

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

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

พยายามดำเนินการแล้ว ฟังก์ชัน Callback ควรแสดงผล
ไปยังส่วนต่างๆ ระหว่างการ์ดต่างๆ ActionResponse
แสดงNotification ActionResponse
เปิดลิงก์โดยใช้ setOnClickOpenLinkAction() ActionResponse
แสดงคำแนะนำที่เติมข้อความอัตโนมัติ SuggestionResponse
ใช้การดําเนินการสากล UniversalActionResponse
การดำเนินการอื่นๆ Nothing

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

ออบเจ็กต์เหตุการณ์การดำเนินการ

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

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

ดูออบเจ็กต์เหตุการณ์สำหรับข้อมูล คำอธิบายโครงสร้างออบเจ็กต์เหตุการณ์