เมื่อสร้างส่วนเสริมใหม่ของ Google Workspace ให้ทำตามคำทั่วไปนี้ กระบวนการ:
- ตั้งค่าโปรเจ็กต์ของส่วนเสริมและเลือกเจ้าของและผู้ทำงานร่วมกัน
- ออกแบบลักษณะและลักษณะการทํางานของส่วนเสริม
- กำหนดค่าไฟล์ Manifest ของโปรเจ็กต์ของส่วนเสริม หรือ ทรัพยากรสำหรับการทำให้ใช้งานได้
- เขียนโค้ดเพื่อกำหนดรูปลักษณ์ของส่วนเสริมและ พฤติกรรมของคุณ
- ยืนยันขอบเขต OAuth ของส่วนเสริม
- ทดสอบส่วนเสริมภายในแอปพลิเคชันโฮสต์ที่ส่วนเสริมขยายการทำงาน
- เผยแพร่ส่วนเสริม
ตั้งค่าโปรเจ็กต์ของส่วนเสริมและเลือกเจ้าของและผู้ทำงานร่วมกัน
หากคุณสร้างส่วนเสริมใน 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 ไฟล์ Manifest ของส่วนเสริมใน Apps Script
เมื่อคุณเพิ่มโค้ดและฟีเจอร์ลงในส่วนเสริม ให้แก้ไข ไฟล์ Manifest ตามความจำเป็นในการสร้างส่วนเสริมที่จำเป็น ลักษณะและลักษณะการทำงาน
เขียนโค้ดส่วนเสริม
คุณต้องใช้อินเทอร์เฟซแบบการ์ดสำหรับ ส่วนเสริม ใช้ของ Apps Script บริการบัตร หรือหากคุณเขียนด้วยโค้ดภาษาอื่น ให้ส่งกลับ JSON ที่จัดรูปแบบอย่างเหมาะสมสำหรับอินเทอร์เฟซเพื่อแสดงผลเป็นการ์ด
นอกจากนี้ คุณยังต้องใช้ทริกเกอร์ ฟังก์ชันที่ระบุใน ไฟล์ Manifest ของส่วนเสริม หากส่วนเสริมเชื่อมต่อกับบริการของบุคคลที่สามที่ไม่ใช่ของ Google โดยใช้ OAuth คุณต้องกำหนดค่า OAuth สำหรับบริการนั้นด้วย
สร้างการ์ด
คุณกำหนดอินเทอร์เฟซผู้ใช้ของส่วนเสริมได้โดยการสร้างออบเจ็กต์ Card และเติมวิดเจ็ต ฟังก์ชันทริกเกอร์ที่ระบุใน
ไฟล์ Manifest ของคุณต้องแสดงผล
Card ของออบเจ็กต์หรืออาร์เรย์ของ
วัตถุ Card รายการที่แสดง
'หน้า' อื่น ของอินเทอร์เฟซส่วนเสริม นอกจากนี้ ส่วนเสริมยังสร้างและแสดงการ์ดใหม่เพื่อตอบสนองต่อการกระทำของผู้ใช้ได้ด้วย
ใน Apps Script คุณจะสร้างการ์ดโดยใช้
CardBuilder ชิ้น
บัตรต้องใช้ CardHeader
และอย่างน้อย 1 รายการ
CardSections คุณควรป้อนข้อมูลในส่วนการ์ดแต่ละส่วนด้วยวิดเจ็ตแต่ละรายการที่ประกอบกันเป็นอินเทอร์เฟซของส่วนเสริม วิดเจ็ตการโต้ตอบมักจะลิงก์กับการดําเนินการเพื่อกําหนดลักษณะการโต้ตอบ
หลังจากเพิ่มส่วนและวิดเจ็ตทั้งหมดลงในการ์ดผ่าน CardBuilder แล้ว คุณต้องเรียกใช้ CardBuilder.build() เพื่อสร้างออบเจ็กต์ Card ที่เกี่ยวข้อง
คุณสามารถใช้บริการ Apps Script ในตัวอื่นๆ เช่น CalendarApp เพื่อดึงข้อมูลมาแสดงในการ์ดส่วนเสริมที่คุณสร้าง
คุณใช้ข้อมูลที่ดึงมาจากบริการที่ไม่ใช่ของ Google ได้
หากส่วนเสริมของคุณจำเป็นต้องเข้าถึง API ที่ไม่ใช่ของ Google ซึ่ง ซึ่งต้องใช้ OAuth คุณต้องกำหนดค่าและเชื่อมต่อกับบริการดังกล่าว โปรดดู คู่มือการเชื่อมต่อกับบริการที่ไม่ใช่ของ Google เพื่อดูรายละเอียดเพิ่มเติม
คำสั่งสร้าง
เมื่อสร้างการ์ด คุณต้องสร้างจากด้านบนลงล่าง กล่าวคือ คุณต้องใช้ลำดับการสร้างต่อไปนี้
- สร้างวิดเจ็ต
- เพิ่มวิดเจ็ตลงในส่วนการ์ด
- ทำซ้ำจนกว่าส่วนการ์ดจะมีวิดเจ็ตทั้งหมด
- เพิ่มส่วนการ์ดลงในการ์ด
ซึ่งจำเป็นต้องทำเนื่องจากเมื่อคุณเพิ่มวิดเจ็ตลงในการ์ดหรือส่วนการ์ด คุณจะเพิ่มสำเนาของวิดเจ็ตนั้น การเปลี่ยนแปลงใดๆ ที่ทำกับวิดเจ็ต หลังจากเพิ่มไปแล้ว จะไม่แสดงในการ์ดสุดท้าย
การดำเนินการแบบสากล
คุณสามารถใช้การดําเนินการสากล เพื่อมอบฟังก์ชันการทำงานที่ไม่ขึ้นอยู่กับบริบท การดําเนินการแบบสากลคือรายการเมนูที่พร้อมใช้งานใน UI ของส่วนเสริม ไม่ว่าการ์ดใดจะแสดงอยู่ก็ตาม การดำเนินการทั่วไปที่กำหนดไว้ทั้งหมดจะปรากฏในส่วน เมนูการ์ดของส่วนเสริม
ดูรายละเอียดเพิ่มเติมได้ที่การกระทําแบบ Universal
ยืนยันขอบเขต OAuth ของส่วนเสริม
ขอบเขตจะกำหนดการดำเนินการที่ส่วนเสริมได้รับอนุญาตให้ดำเนินการในนามของผู้ใช้ แนวทางปฏิบัติแนะนำสำหรับส่วนเสริมคือให้มีขอบเขตสำหรับการดำเนินการที่จำเป็นเท่านั้น
ในโปรเจ็กต์ส่วนเสริม ให้ตั้งค่าพารามิเตอร์ ส่วนเสริม ขอบเขต เพื่อให้แน่ใจว่า ส่วนเสริมจะใช้ชุดขอบเขตที่อนุญาตน้อยที่สุด เท่าที่จะเป็นไปได้ คุณกำหนดขอบเขตที่ส่วนเสริมใช้ได้ในไฟล์ Manifest ของส่วนเสริม
ดูรายละเอียดเพิ่มเติมในขอบเขต
ทดสอบส่วนเสริม
คุณสามารถทดสอบส่วนเสริมที่ยังไม่ได้เผยแพร่ได้โดยติดตั้งส่วนเสริมที่ยังไม่ได้เผยแพร่ก่อน เมื่อติดตั้งและได้รับอนุญาตแล้ว คุณจะใช้ส่วนเสริมในบัญชีและทดสอบลักษณะที่ปรากฏและลักษณะการทํางานในแอปพลิเคชันโฮสต์ที่ส่วนเสริมขยายได้ คุณควรยืนยันว่าส่วนเสริมทำงานตาม ที่จำเป็นสำหรับบริบทและการกระทำของผู้ใช้
ดูรายละเอียดเพิ่มเติมได้ที่การทดสอบส่วนเสริมของ Google Workspace
เผยแพร่ส่วนเสริม
การเผยแพร่ส่วนเสริมทำให้ผู้อื่นใช้งานได้ แบบสาธารณะหรือเฉพาะผู้ใช้ในโดเมน ก่อนเผยแพร่ กระบวนการตรวจสอบ อย่าลืมทบทวนภาพรวมของสื่อเผยแพร่ การเผยแพร่เป็นกระบวนการที่ซับซ้อนซึ่งจำเป็นต้องใช้ การเตรียมพร้อมและเวลาที่จะดำเนินการให้เสร็จสมบูรณ์
ส่วนเสริมของ Google Workspace จะเผยแพร่ไปยัง Google Workspace Marketplace ส่วนเสริมที่พร้อมให้บริการแบบสาธารณะต้องผ่านการตรวจสอบแอปให้เสร็จสมบูรณ์ก่อนจึงจะเผยแพร่ได้
ดูการเผยแพร่ส่วนเสริม Google Workspace สำหรับ รายละเอียดเพิ่มเติม