แนวทางปฏิบัติที่ดี

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

แนวทางปฏิบัติแนะนำโดยทั่วไป

เราขอแนะนำให้ทำตามแนวทางปฏิบัติแนะนำต่อไปนี้สำหรับส่วนเสริมทั้งหมดที่คุณพัฒนา

ตรวจสอบความเป็นเจ้าของส่วนเสริมก่อนเริ่มต้น

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

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

ขยายการใช้งาน Google Workspace แทนการจําลอง

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

กำหนดขอบเขตให้แคบ

เมื่อกำหนดขอบเขตอย่างชัดเจน ให้เลือกใช้ชุดขอบเขตที่อนุญาตน้อยที่สุดเสมอ เช่น อย่าให้ส่วนเสริมขอสิทธิ์เข้าถึงแบบเต็มในปฏิทินของผู้ใช้ด้วยขอบเขต https://www.googleapis.com/auth/calendar หากต้องการสิทธิ์เข้าถึงแบบอ่านอย่างเดียว สําหรับสิทธิ์เข้าถึงระดับอ่านอย่างเดียว ให้ใช้ขอบเขต https://www.googleapis.com/auth/calendar.readonly

หลีกเลี่ยงการพึ่งพาไลบรารีมากเกินไป

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

เวลาในการตอบสนองที่อธิบายข้างต้นจะมีผลกับโปรเจ็กต์ Apps Script ที่ใช้เป็นไลบรารีฝั่งเซิร์ฟเวอร์เท่านั้น คุณสามารถใช้ไลบรารี JavaScript ฝั่งไคลเอ็นต์อย่าง jQuery ได้อย่างอิสระโดยไม่พบเวลาในการตอบสนองนี้

แนวทางปฏิบัติแนะนำสำหรับส่วนเสริมตัวแก้ไข

แนวทางปฏิบัติแนะนำต่อไปนี้ใช้กับส่วนเสริม Editor เท่านั้น}

วาง HTML ของอินเทอร์เฟซและ JavaScript ฝั่งไคลเอ็นต์ไว้ในไฟล์สคริปต์ของตัวเอง

คุณสร้างไฟล์สคริปต์หลายไฟล์ในโปรเจ็กต์ Apps Script ได้ การจัดการส่วนเสริมที่ซับซ้อนจะง่ายขึ้นหากคุณวาง HTML และ JavaScript ที่กําหนดแถบด้านข้างและกล่องโต้ตอบของส่วนเสริมไว้ในไฟล์สคริปต์เฉพาะ

ทดสอบอย่างละเอียดในโหมดการให้สิทธิ์ต่างๆ

เมื่อทดสอบส่วนเสริม อย่าลืมลองใช้การกำหนดค่าที่มีไฟล์และสถานะการให้สิทธิ์ที่แตกต่างกัน