แนวทางปฏิบัติแนะนำ

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

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

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

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

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

แนวทางปฏิบัติแนะนำสำหรับส่วนเสริมของเอดิเตอร์

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

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

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

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

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