כדי לשפר את חוויית השימוש הכוללת של המשתמשים, כדאי לפעול לפי ההנחיות הבאות לעיצוב תוספים.
שיטות מומלצות כלליות
מומלץ להשתמש בשיטות המומלצות הבאות בכל התוספים שאתם מפתחים.
קובעים את הבעלות על התוסף לפני שמתחילים
תוספים מוגדרים באמצעות פרויקטים של 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 ללא בעיות של זמן אחזור.
שיטות מומלצות לשימוש בתוספים לעריכה
השיטות המומלצות הבאות רלוונטיות רק לתוסף ל-Editor.
הצבתם של HTML לממשק ו-JavaScript מצד הלקוח בקובצי סקריפט משלהם
אפשר ליצור כמה קובצי סקריפט בפרויקט Apps Script. קל יותר לנהל תוסף מורכב אם ממוקמים את קודי ה-HTML ו-JavaScript שמגדירים את תיבת הצד והתיבות של התוסף בקובצי סקריפט ייעודיים.
בדיקה יסודית במצבי הרשאה שונים
כשבודקים את התוסף, חשוב לנסות הגדרות עם קבצים שונים ומצבי הרשאה שונים.