สร้างส่วนเสริมของ Google Workspace

หน้านี้จะแสดงภาพรวมเกี่ยวกับวิธีออกแบบ สร้าง และเผยแพร่ส่วนเสริมของ Google Workspace ภาพรวมนี้จะอธิบายขั้นตอนต่อไปนี้

1. ระบุแอปพลิเคชัน Google Workspace ที่ต้องการให้ผู้ใช้ใช้งานส่วนเสริมได้
2. ตั้งค่าโปรเจ็กต์ของส่วนเสริมและเลือกเจ้าของและผู้ทำงานร่วมกัน
3. ออกแบบลักษณะและลักษณะการทํางานของส่วนเสริม
4. กำหนดค่าไฟล์ Manifest ของโปรเจ็กต์หรือแหล่งข้อมูลสำหรับการติดตั้งใช้งานของส่วนเสริม
5. เขียนโค้ดเพื่อกำหนดลักษณะที่ปรากฏและลักษณะการทํางานของส่วนเสริม
6. ยืนยันขอบเขต OAuth ของส่วนเสริม
7. ทดสอบส่วนเสริมภายในแอปพลิเคชัน Google Workspace อย่างน้อย 1 แอป
8. เผยแพร่ส่วนเสริม

เลือกแอปพลิเคชันสำหรับโฮสต์ของ Google Workspace

คุณสามารถกำหนดค่าส่วนเสริมของ Google Workspace ให้ปรากฏในแอปพลิเคชันโฮสต์ Google Workspace ต่อไปนี้ได้

• Gmail
• Google ปฏิทิน
• Google เอกสาร
• Google ไดรฟ์
• Google ชีต
• Google สไลด์

ดูข้อมูลเกี่ยวกับวิธีการสร้างสำหรับแอปพลิเคชัน Google Workspace ได้ที่ขยาย UI ของ Google Workspace

ตั้งค่าโปรเจ็กต์ของส่วนเสริมและเลือกเจ้าของและผู้ทำงานร่วมกัน

หากสร้างส่วนเสริมใน Apps Script คุณจะสร้างทั้งโปรเจ็กต์ Apps Script และโปรเจ็กต์ Google Cloud หากสร้างส่วนเสริมเป็นภาษาอื่นที่ไม่ใช่ Apps Script คุณก็สร้างโปรเจ็กต์ Google Cloud ได้เลย

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

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

โปรเจ็กต์ Apps Script

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

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

หากต้องการสร้างโปรเจ็กต์ Apps Script โปรดดูโปรเจ็กต์สคริปต์

โปรเจ็กต์ Google Cloud

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

หากต้องการสร้างโปรเจ็กต์ Google Cloud โปรดดูหัวข้อสร้างโปรเจ็กต์ Google Cloud

ออกแบบลักษณะที่ปรากฏและลักษณะการทํางานของส่วนเสริม

ตัดสินใจว่าต้องการให้ส่วนเสริมมีลักษณะอย่างไรและควรทํางานอย่างไรก่อนที่จะเริ่มสร้าง พิจารณากรณีการใช้งานที่ส่วนเสริมควรพยายามหาวิธีแก้ปัญหา เริ่มต้นด้วยการออกแบบที่เรียบง่ายเพื่อเริ่มทํางานก่อน แล้วค่อยเพิ่มการปรับแต่ง

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

โปรดดูหลักเกณฑ์เกี่ยวกับวิธีออกแบบประสบการณ์การใช้งานส่วนเสริมในคู่มือสไตล์สำหรับส่วนเสริมของ Google Workspace

กำหนดค่าไฟล์ Manifest ของโปรเจ็กต์ส่วนเสริม

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

โปรดดูรายละเอียดเกี่ยวกับวิธีกำหนดค่าไฟล์ Manifest ของส่วนเสริมใน Apps Script ที่หัวข้อไฟล์ Manifest

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

เขียนโค้ดส่วนเสริม

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

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

สร้างการ์ด

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

คุณสามารถสร้างการ์ดโดยใช้ชั้นเรียน CardBuilder ใน Apps Script การ์ดแต่ละใบต้องมี CardHeader และ CardSections อย่างน้อย 1 รายการ คุณควรป้อนข้อมูลในส่วนการ์ดแต่ละส่วนด้วยวิดเจ็ตแต่ละรายการที่ประกอบกันเป็นอินเทอร์เฟซของส่วนเสริม วิดเจ็ตการโต้ตอบมักจะลิงก์กับการดําเนินการเพื่อกําหนดลักษณะการโต้ตอบ

หลังจากเพิ่มส่วนและวิดเจ็ตทั้งหมดลงในการ์ดผ่าน CardBuilder แล้ว คุณต้องเรียกใช้ CardBuilder.build()เพื่อสร้างออบเจ็กต์ Card ที่เกี่ยวข้อง

หมายเหตุ: การไม่เรียกใช้ build() หลังจากใช้คลาสบิลเดอร์ในบริการการ์ดจะทำให้เกิดข้อผิดพลาดเกี่ยวกับประเภท เช่น ฟังก์ชันทริกเกอร์ต้องแสดงผลออบเจ็กต์ Card การคืนค่าออบเจ็กต์ CardBuilderแทนจะทำให้เกิดข้อผิดพลาด

คุณสามารถใช้บริการ Apps Script ในตัวอื่นๆ เช่น CalendarApp เพื่อดึงข้อมูลมาแสดงในการ์ดส่วนเสริมที่คุณสร้าง คุณใช้ข้อมูลที่ดึงมาจากบริการที่ไม่ใช่ของ Google ได้

หากส่วนเสริมต้องการเข้าถึง API ที่ไม่ใช่ของ Google ซึ่งต้องใช้ OAuth คุณต้องกำหนดค่าและเชื่อมต่อกับบริการนั้น ดูรายละเอียดเพิ่มเติมได้ที่คู่มือการเชื่อมต่อกับบริการที่ไม่ใช่ของ Google

คำสั่งก่อสร้าง

เมื่อสร้างการ์ด คุณต้องสร้างจากด้านบนลงล่าง กล่าวคือ คุณต้องใช้ลำดับการสร้างต่อไปนี้

1. สร้างวิดเจ็ต
2. เพิ่มวิดเจ็ตลงในส่วนการ์ด
3. ทำซ้ำจนกว่าส่วนการ์ดจะมีวิดเจ็ตทั้งหมด
4. เพิ่มส่วนการ์ดลงในการ์ด

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

คำเตือน: เพิ่มวิดเจ็ตลงในการ์ดหรือส่วนการ์ดหลังจากสร้างเสร็จแล้วเท่านั้น เพิ่มส่วนการ์ดลงในการ์ดหลังจากที่กรอกข้อมูลวิดเจ็ตแล้วเท่านั้น อย่าเปลี่ยนวิดเจ็ตหรือส่วนต่างๆ หลังจากเพิ่มแล้ว หากต้องการทำการเปลี่ยนแปลงวิดเจ็ตที่เพิ่มแล้ว คุณต้องสร้างส่วนหรือการ์ดที่เพิ่มวิดเจ็ตนั้นขึ้นมาใหม่

การดำเนินการส่วนกลาง

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

ดูการดำเนินการส่วนกลางสำหรับรายละเอียดเพิ่มเติม

ยืนยันขอบเขต OAuth ของส่วนเสริม

ขอบเขตจะกำหนดการดำเนินการที่ส่วนเสริมได้รับอนุญาตให้ดำเนินการในนามของผู้ใช้ แนวทางปฏิบัติแนะนำสำหรับส่วนเสริมคือให้มีขอบเขตสำหรับการดำเนินการที่จำเป็นเท่านั้น

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

ดูรายละเอียดเพิ่มเติมที่ขอบเขต

ทดสอบส่วนเสริม

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

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

เผยแพร่ส่วนเสริม

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

ส่วนเสริม Google Workspace จะเผยแพร่ใน Google Workspace Marketplace ส่วนเสริมที่พร้อมให้บริการแบบสาธารณะต้องผ่านการตรวจสอบแอปให้เสร็จสมบูรณ์ก่อนจึงจะเผยแพร่ได้

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