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

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

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

ขณะที่คุณเพิ่มโค้ดและคุณลักษณะลงในส่วนเสริม ให้แก้ไขไฟล์ 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

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

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