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

בדף הזה מוסבר איך לתכנן, ליצור ולפרסם תוספים ל-Google Workspace. בסקירה הזו מוסברים השלבים הבאים:

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

אפשר ליצור תוסף באמצעות 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

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

הוראות ליצירת פרויקט ב-Google Cloud מופיעות במאמר יצירת פרויקט ב-Google Cloud.

תכנון והגדרה של המראה וההתנהגות של התוסף

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

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

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

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

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

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

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

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

יצירת התוסף

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

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

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

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

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

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

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

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

הזמנת בנייה

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

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

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

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

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

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

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

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

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

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

בדיקת התוסף

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

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

פרסום התוסף

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

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

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