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

โปรดทำตามขั้นตอนทั่วไปต่อไปนี้เพื่อสร้างส่วนเสริมของ Google Workspace ใหม่

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

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

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

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

โปรเจ็กต์ Apps Script

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

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

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

โปรเจ็กต์ Google Cloud

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

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

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

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

โปรดดูคู่มือแนะนำการใช้งานส่วนเสริมของ Google Workspace เพื่อดูแนวทางการออกแบบประสบการณ์ของผู้ใช้ส่วนเสริม

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

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

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

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

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

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

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

สร้างการ์ด

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

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

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

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

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

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

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

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

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

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

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

ดูรายละเอียดเพิ่มเติมในการดำเนินการสากล

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

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

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

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

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

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

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

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

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

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

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