สร้างส่วนเสริมของ 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

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

คุณสามารถสร้างการ์ดโดยใช้ชั้นเรียน CardBuilder ใน Apps Script การ์ดแต่ละใบต้องมี 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