สร้างส่วนเสริม 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 ของส่วนเสริมในไดรฟ์ที่แชร์เพื่อไม่ให้มีเพียงบัญชีเดียวที่มีการเป็นเจ้าของ การวางไฟล์สคริปต์ส่วนเสริมในไดรฟ์ที่แชร์ช่วยให้มั่นใจได้ว่าผู้ทํางานร่วมกันหลายคนจะมีสิทธิ์เข้าถึงโปรเจ็กต์สคริปต์นี้ได้เสมอ

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

โปรเจ็กต์ Google Cloud

เราขอแนะนําให้คุณเพิ่มผู้ทํางานร่วมกันในโปรเจ็กต์ 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 ที่แสดง "หน้า" ที่แตกต่างกันของอินเทอร์เฟซส่วนเสริม ส่วนเสริมยังสร้างและแสดงการ์ดใหม่ตามการดําเนินการของผู้ใช้ได้ด้วย

ในสคริปต์แอป คุณจะสร้างการ์ดโดยใช้คลาส 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 ส่วนเสริม

Google Workspace ตัวอย่างส่วนเสริม

 แถบด้านข้างสําหรับส่วนเสริมGoogle Workspace

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