שיטות מומלצות

כדי לשפר את חוויית השימוש הכוללת של המשתמשים, כדאי לפעול לפי ההנחיות הבאות לגבי עיצוב התוספים.

שיטות מומלצות כלליות

מומלץ לפעול לפי השיטות המומלצות הבאות בכל התוספים שאתם מפתחים.

לפני שמתחילים, צריך לקבוע מי הבעלים של התוסף

התוספים מוגדרים באמצעות פרויקטים של 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 שמגדירים את סרגל הצד ואת תיבות הדו-שיח של התוסף בקובצי סקריפט ייעודיים.

בדיקה יסודית במצבי הרשאה שונים

כשבודקים את התוסף, חשוב לנסות הגדרות עם קבצים שונים ומצבי הרשאה שונים.