สร้างส่วนเสริมของ 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 ของโปรเจ็กต์ส่วนเสริม

ในโปรเจ็กต์ 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 ได้

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

คำสั่งสร้าง

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

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

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

การดำเนินการส่วนกลาง

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

ดูการดำเนินการส่วนกลางสำหรับข้อมูลเพิ่มเติม รายละเอียด

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

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

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

ดูรายละเอียดเพิ่มเติมในขอบเขต

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

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

โปรดดูรายละเอียดเพิ่มเติมที่หัวข้อการทดสอบส่วนเสริมของ Google Workspace

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

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

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

ดูการเผยแพร่ส่วนเสริม Google Workspace สำหรับ รายละเอียดเพิ่มเติม