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

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

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

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

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

  • Gmail
  • יומן Google
  • Google Chat (תצוגה מקדימה למפתחים)
  • Google Docs
  • Google Drive
  • Google Sheets
  • Google Slides

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

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

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

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

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

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

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

במאמר פרויקטים של סקריפט מוסבר איך יוצרים פרויקט ב-Apps Script.

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

מומלץ להוסיף שותפים לפרויקט 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.

הזמנת בנייה

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

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

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

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

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

לפרטים נוספים, ראו פעולות אוניברסליות.

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

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

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

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

בדיקת התוסף

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

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

פרסום התוסף

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

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

למידע נוסף, אפשר לעיין במאמר פרסום תוסף ל-Google Workspace.