อภิธานศัพท์

ข้อกําหนดต่อไปนี้ใช้ทั่วทั้งเอกสารนี้

ส่วนเสริมการประชุมในปฏิทิน

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

โปรดดูข้อมูลเพิ่มเติมที่ส่วนเสริมการประชุมในปฏิทิน และดูการอัปเกรดส่วนเสริมที่เผยแพร่ สําหรับข้อมูลเกี่ยวกับวิธีเปลี่ยนส่วนเสริมการประชุมในปฏิทินเป็นส่วนเสริมของ Google Workspace

Card

"หน้า" เดียวของ UI ส่วนเสริม การ์ดประกอบด้วยออบเจ็กต์วิดเจ็ตต่างๆ (ปุ่ม ช่องข้อความ ส่วนหัว และอื่นๆ)

ดูข้อมูลเพิ่มเติมที่การ์ด

ตามการ์ด

ส่วนเสริมที่มีอินเทอร์เฟซผู้ใช้ปรากฏเป็นแผงในแถบด้านข้าง (หรือในอุปกรณ์เคลื่อนที่ เป็นหน้าต่างกิจกรรมอื่นที่เข้าถึงได้ผ่านเมนู) ส่วนเสริมจะมีแถบเครื่องมือยอดนิยมที่ระบุส่วนเสริมและแสดงการ์ด โดยเฉพาะอย่างยิ่ง "หน้า" ใน UI ของส่วนเสริม

ส่วนเสริมของ Google Workspace จะอิงตามการ์ด

ข้อมูลการประชุม

ชุดข้อมูลที่ Google ปฏิทินต้องการเพื่ออนุญาตให้ผู้ใช้สร้างและเข้าร่วมการประชุมของบุคคลที่สามที่เปิดใช้ส่วนเสริมของ Google Workspace หรือส่วนเสริมการประชุมในปฏิทิน

ดูข้อมูลเพิ่มเติมได้ที่ข้อมูลการประชุม

โซลูชันการประชุม

การนําเสนอการประชุมของบุคคลที่สามซึ่งสร้างจาก Google ปฏิทินได้โดยใช้ส่วนเสริมของ Google Workspace หรือส่วนเสริมการประชุมในปฏิทิน

โปรดดูข้อมูลเพิ่มเติมที่โซลูชันการประชุม

บริบท

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

การเรียกตามบริบท

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

ส่วนเสริมเอดิเตอร์

ชุดประเภทส่วนเสริมเดิมซึ่งอนุญาตให้ใช้เฉพาะส่วนขยายของ Google เอกสาร ชีต ฟอร์ม หรือสไลด์ ส่วนเสริมเครื่องมือแก้ไขไม่ใช่แบบการ์ด แต่เป็นนักพัฒนาซอฟต์แวร์ซึ่งจําเป็นในการสร้าง UI จาก HTML และ CSS ดิบ ส่วนเสริมเครื่องมือแก้ไขแต่ละรายการ ขยายแอปพลิเคชันโฮสต์ได้เพียงรายการเดียวเท่านั้น

ดูรายละเอียดเพิ่มเติมได้ที่ส่วนเสริมของเอดิเตอร์

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

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

ดูรายละเอียดเพิ่มเติมได้ในออบเจ็กต์เหตุการณ์

ส่วนเสริมของ Gmail

ส่วนเสริมที่ขยาย Gmail เท่านั้น ส่วนเสริม Gmail ทํางานแบบการ์ด รายละเอียดฟังก์ชัน พฤติกรรม และรายละเอียดการพัฒนาส่วนใหญ่ที่ใช้ในการสร้างส่วนเสริม Gmail จะเหมือนกับรายละเอียดที่ใช้สร้างส่วนเสริม Google Workspace

โปรดดูข้อมูลเพิ่มเติมที่ส่วนเสริมของ Gmail และดูการอัปเกรดส่วนเสริมที่เผยแพร่แล้วเพื่อดูข้อมูลเกี่ยวกับวิธีแปลงส่วนเสริม Gmail เป็นส่วนเสริม Google Workspace

หน้าแรก

การ์ด UI รูทของส่วนเสริม หน้าแรกจะแสดงเมื่อผู้ใช้เปิดส่วนเสริมและอนุญาตให้ส่วนเสริมแสดงเนื้อหานอกบริบทที่เฉพาะเจาะจง (เช่น เมื่อผู้ใช้ดูชุดข้อความอีเมลใน Gmail แต่ไม่ได้เปิด) คุณสามารถกําหนดลักษณะและลักษณะการทํางานของหน้าแรกของส่วนเสริมได้เหมือนกับการ์ดอื่นๆ

ดูข้อมูลเพิ่มเติมได้ที่หน้าแรก

โฮสต์หรือแอปพลิเคชันโฮสต์

แอปพลิเคชัน Google Workspace ที่ใช้ส่วนเสริม Google Workspace เช่น Gmail หรือ Google ปฏิทิน

ตาม HTML

ส่วนเสริมที่กําหนดอินเทอร์เฟซผู้ใช้โดยใช้ HTML และ CSS แทนบริการการ์ดในตัวของ Apps Script เฉพาะส่วนเสริมเอดิเตอร์เวอร์ชันเก่าเท่านั้น ที่ใช้ HTML ได้

ทริกเกอร์ตัวอย่างลิงก์

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

ดูข้อมูลเพิ่มเติมได้ที่แสดงตัวอย่างลิงก์ใน Google เอกสาร

ไฟล์ Manifest

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

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

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

ทริกเกอร์ไฟล์ Manifest แตกต่างจากทริกเกอร์อื่นๆ ใน Apps Script เนื่องจากในตัวไม่ได้ (เช่น ทริกเกอร์แบบง่าย) และไม่สามารถสร้างแบบเป็นโปรแกรมด้วยบริการสคริปต์ Apps Script (เช่น ทริกเกอร์ที่ติดตั้ง)

การ์ดที่ไม่ใช่บริบท

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

แถบด้านข้าง

ส่วนทางด้านขวาของ UI โฮสต์ที่ UI ของส่วนเสริม Google Workspace ปรากฏขึ้น ส่วนเสริม Gmail และ Editor จะกําหนดแถบด้านข้างได้ด้วยเช่นกัน

ชิปอัจฉริยะ

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

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

ทริกเกอร์

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

ดูข้อมูลเพิ่มเติมในทริกเกอร์ส่วนเสริม

ฟังก์ชันทริกเกอร์

ฟังก์ชัน Apps Script ในโปรเจ็กต์ที่เริ่มทํางานเพื่อตอบสนองต่อทริกเกอร์ที่เริ่มทํางาน

วิดเจ็ต

องค์ประกอบ UI เช่น ปุ่ม ช่องข้อความ หรือช่องทําเครื่องหมาย การ์ดสร้างขึ้นจากลําดับของออบเจ็กต์วิดเจ็ตซึ่งกําหนดโดยบริการการ์ดในตัวของ Apps Script

ดูข้อมูลเพิ่มเติมที่วิดเจ็ต

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

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

ดูฟังก์ชันตัวแฮนเดิลวิดเจ็ตสําหรับข้อมูลเพิ่มเติม