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

ดูวิธีออกแบบ สร้าง และเผยแพร่ส่วนเสริมของ Google Workspace

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

สร้างส่วนเสริมด้วย Apps Script หรือ HTTP หากต้องการเปรียบเทียบทั้ง 2 อย่าง ให้ดูวิดีโอ "Apps Script กับปลายทาง HTTP: คุณควรเลือกอะไร 🤔".

เลือกแอปพลิเคชันแบบโฮสต์ของ Google Workspace

คุณกำหนดค่าส่วนเสริมของ Google Workspace ให้ปรากฏในแอปพลิเคชันโฮสต์ของ Google Workspace ต่อไปนี้ได้

• Gmail
• Google ปฏิทิน
• Google Chat
• Google เอกสาร
• Google ไดรฟ์
• Google Meet
• Google ชีต
• Google สไลด์

หากต้องการสร้างแอปพลิเคชันสำหรับ Google Workspace โปรดดูหัวข้อขยาย UI ของ Google Workspace

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

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

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

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

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

โปรเจ็กต์ Apps Script

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

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

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

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

โปรเจ็กต์ Google Cloud

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

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

ออกแบบและกำหนดค่าลักษณะการทำงานและลักษณะที่ปรากฏของส่วนเสริม

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

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

ดูหลักเกณฑ์เกี่ยวกับวิธีออกแบบประสบการณ์ของผู้ใช้ส่วนเสริมได้ที่คู่มือรูปแบบส่วนเสริมของ Google Workspace

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

ใช้การออกแบบในไฟล์ Manifest ของส่วนเสริม กำหนดค่าลักษณะที่ปรากฏและลักษณะการทำงานของส่วนเสริมในไฟล์ Manifest รวมถึงแอปพลิเคชันโฮสต์ของ Google Workspace ที่ส่วนเสริมขยาย

โปรดดูรายละเอียดที่หัวข้อไฟล์ Manifest สำหรับ ส่วนเสริมของ Google Workspace

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

กำหนดค่าลักษณะที่ปรากฏและลักษณะการทำงานของแอป Google Chat

หากออกแบบส่วนเสริมที่ขยาย Google Chat ให้ใช้ Google Chat API เพื่อกำหนดค่าลักษณะที่ปรากฏและลักษณะการทำงานของแอป Chat โดยดูขั้นตอนได้ที่ใช้ Google Chat API

สร้างส่วนเสริม

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

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

การ์ดสิ่งก่อสร้าง

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

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

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

หมายเหตุ: การไม่เรียกใช้ build หลังจากใช้คลาส Builder ในบริการบัตรจะทําให้เกิดข้อผิดพลาดเกี่ยวกับประเภท ฟังก์ชันทริกเกอร์ต้องแสดงผลออบเจ็กต์ Card การส่งคืนออบเจ็กต์ CardBuilder จะทำให้เกิดข้อผิดพลาด

ใช้บริการ Apps Script ในตัว](/apps-script/guides/services/) เช่น CalendarApp เพื่อดึงข้อมูล มาแสดงในการ์ดส่วนเสริม ใช้ข้อมูล จากบริการที่ไม่ใช่ของ Google

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

ลำดับการสร้าง

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

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

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

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

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

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

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

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

ขอบเขตจะกำหนดการดำเนินการที่ส่วนเสริมสามารถทำในนามของผู้ใช้ ส่วนเสริมควรมีเฉพาะขอบเขตที่จำเป็นต่อการทำงานเท่านั้น

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

ดูรายละเอียดเพิ่มเติมได้ที่ขอบเขต

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

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

หากต้องการเริ่มทดสอบส่วนเสริม โปรดดูคำแนะนำต่อไปนี้

• ทดสอบและแก้ไขข้อบกพร่องของส่วนเสริม Apps Script สำหรับ Google Workspace
• ทดสอบและแก้ไขข้อบกพร่องของส่วนเสริม HTTP ของ Google Workspace
• ทดสอบฟีเจอร์แบบอินเทอร์แอกทีฟสำหรับแอป Google Chat

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

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

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

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