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

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

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

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

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

תוספים מוגדרים על ידי פרויקטים של Apps Script, והם חייבים להיות בבעלות של חשבון מסוים או שנמצאים באחסון שיתופי. לפני שאתם מתכנתים תוסף, חשוב לקבוע איזה חשבון צריך להיות הבעלים של הפרויקט ואיזה חשבון ישמש כיצרן התוכן שלו. כמו כן, צריך לקבוע אילו חשבונות ישמשו כשותפי עריכה, ולוודא שלחשבונות האלה יש גישה לפרויקט הסקריפט ולפרויקט ב-Cloud Platform המשויך אליו.

הערה: חשוב לתכנן בעלות על תוספים. אם הבעלים של התוסף עוזב את הארגון, חשוב לוודא שהבעלות עליו הועברה. אחרת, יכול להיות שתאבדו את היכולת לעדכן ולנהל את התוסף. לכן, ייתכן שמומלץ ליצור חשבון ארגוני במיוחד כדי להיות הבעלים ולפרסם את התוספים של הארגון. אפשר גם להשתמש באחסון שיתופי בתור הבעלים של הפרויקט בסקריפט, אבל חשבון ספציפי צריך לפעול בתור בעל האפליקציה של התוסף.

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

ביצוע בדיקות בהצלחה במצבי הרשאה שונים

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