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

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

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

คุณสร้างส่วนเสริมด้วย Apps Script หรือ HTTP ได้ หากต้องการเปรียบเทียบ โปรดดูวิดีโอ "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 Cloud เท่านั้น

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

โปรเจ็กต์ Apps Script

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

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

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

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

โปรเจ็กต์ Google Cloud

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

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

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

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

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

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

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

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

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

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

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

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

คุณต้องใช้การ์ดเป็นอินเทอร์เฟซสำหรับ ส่วนเสริม ใช้ Card Service ของ Apps Script หรือหากเขียนในภาษาโค้ดอื่น ให้ส่งคืน JSON ที่จัดรูปแบบอย่างถูกต้องเพื่อให้อินเทอร์เฟซแสดงผลเป็น Card

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

สร้างการ์ด

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

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

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

คุณสามารถใช้บริการ Apps Script ในตัวอื่นๆ เช่น CalendarApp เพื่อดึงข้อมูล มาแสดงในการ์ดส่วนเสริมที่คุณสร้าง คุณใช้ข้อมูลที่ดึงมาจากบริการที่ไม่ใช่ของ Google ได้

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

คำสั่งซื้อการก่อสร้าง

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

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

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

Universal Action

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

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

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

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

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

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

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

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

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

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

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

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

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