פיתוח תוספים ל-Google Workspace

איך מעצבים, בונים ומפרסמים תוספים ל-Google Workspace:

1. קובעים באילו אפליקציות של Google Workspace רוצים שהתוסף יהיה זמין למשתמשים.
2. מגדירים את הפרויקטים של התוסף ובוחרים בעלים ושותפים לעריכה.
3. מעצבים ומגדירים את המראה וההתנהגות של התוסף.
4. יוצרים את התוסף.
5. מאמתים את היקפי ההרשאות של OAuth בתוסף.
6. בודקים את התוסף באפליקציה אחת או יותר של Google Workspace.
7. מפרסמים את התוסף.

ליצור תוסף באמצעות Apps Script או HTTP. כדי להשוות בין השניים, כדאי לצפות בסרטון 'Apps Script לעומת נקודות קצה של HTTP: באיזו אפשרות כדאי לבחור?' 🤔".

בחירה של אפליקציות מארחות ב-Google Workspace

אתם יכולים להגדיר את התוספים ל-Google Workspace כך שיופיעו באפליקציות המארחות הבאות של Google Workspace:

• Gmail
• יומן Google
• Google Chat
• Google Docs
• Google Drive
• Google Meet
• Google Sheets
• Google Slides

כדי לפתח אפליקציות ל-Google Workspace, אפשר לעיין במאמר בנושא הרחבת ממשק המשתמש של Google Workspace.

הגדרת הפרויקטים של התוסף ובחירת בעלים ומשתפי פעולה

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

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

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

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

פרויקטים של Apps Script

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

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

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

מידע על יצירת פרויקט ב-Apps Script זמין במאמר בנושא פרויקטים של סקריפטים.

פרויקטים ב-Google Cloud

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

כדי ליצור פרויקט ב-Google Cloud, אפשר לעיין במאמר בנושא יצירת פרויקט ב-Google Cloud.

עיצוב והגדרה של המראה וההתנהגות של התוסף

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

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

הנחיות לעיצוב חוויית המשתמש בתוסף זמינות במדריך הסגנון של תוספים ל-Google Workspace.

הגדרת מניפסט התוסף

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

פרטים נוספים זמינים במאמר בנושא קבצי מניפסט לתוספים של Google Workspace.

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

הגדרת העיצוב וההתנהגות של אפליקציית Google Chat

אם אתם מתכננים תוסף שמרחיב את Google Chat, אתם יכולים להשתמש ב-Google Chat API כדי להגדיר את המראה וההתנהגות של אפליקציית Chat. במאמר שימוש ב-Google Chat API מוסבר איך עושים את זה.

יצירת התוסף

הטמעת ממשק מבוסס-כרטיסים לתוסף. משתמשים ב-Card service או, אם משתמשים בשפת קוד אחרת, מחזירים JSON מעוצב לממשק כדי להציג אותו ככרטיסים.

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

יצירת כרטיסים

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

ב-Apps Script, יוצרים כרטיסים באמצעות המחלקה CardBuilder. כל כרטיס דורש CardHeader אחד או יותר וCardSections אחד או יותר. מאכלסים כל קטע בכרטיס בווידג'טים שמרכיבים את הממשק. ווידג'טים של אינטראקציות מקושרים בדרך כלל לפעולות כדי להגדיר את התנהגות האינטראקציה שלהם.

אחרי שמוסיפים את כל הקטעים והווידג'טים לכרטיס באמצעות CardBuilder, קוראים ל-CardBuilder.build כדי ליצור את אובייקט Card המתאים.

הערה: אם לא קוראים ל-build אחרי שימוש במחלקות בונה בשירות הכרטיסים, מתקבלות שגיאות הקלדה. פונקציות של טריגרים צריכות להחזיר אובייקטים מסוג Card. החזרה של אובייקטים מסוג CardBuilder תוביל לשגיאה.

להשתמש בשירותים מובנים של Apps Script](/apps-script/guides/services/) כמו CalendarApp כדי לאחזר מידע להצגה בכרטיסי התוסף. שימוש בנתונים משירותים שלא שייכים ל-Google.

אם התוסף צריך גישה ל-Google APIs שאינם של Google ודורשים OAuth, צריך להגדיר את השירות הזה ולהתחבר אליו. אפשר לעיין במדריך חיבור לשירותים שאינם של Google.

הזמנת בנייה

כשיוצרים כרטיס, מתחילים מלמעלה. משתמשים בסדר הבנייה הזה:

1. יוצרים את הווידג'ט.
2. מוסיפים את הווידג'ט לקטע הכרטיסים.
3. חוזרים על הפעולה עד שכל הווידג'טים מופיעים בקטע הכרטיסים.
4. מוסיפים את קטע הכרטיס לכרטיס.

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

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

פעולות אוניברסליות

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

פרטים נוספים זמינים במאמר בנושא פעולות אוניברסליות.

אימות היקפי ההרשאות של OAuth בתוסף

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

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

פרטים נוספים מופיעים במאמר בנושא היקפים.

בדיקת התוסף

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

כדי להתחיל לבדוק את התוסף, אפשר לעיין במדריכים הבאים:

• בדיקה וניפוי באגים בתוספים של Google Workspace ב-Apps Script
• בדיקה וניפוי באגים של תוספים ל-Google Workspace עם HTTP
• בדיקת תכונות אינטראקטיביות באפליקציות ל-Google Chat

פרסום התוסף

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

תוספים ל-Google Workspace מתפרסמים ב-Google Workspace Marketplace. תוספים שזמינים לציבור צריכים לעבור בדיקת אפליקציה לפני שהם מתפרסמים.

פרטים נוספים זמינים במאמר בנושא פרסום תוסף ל-Google Workspace.