בדף הזה מפורטת סקירה כללית על תכנון, פיתוח ופרסום של תוספים ל-Google Workspace. בסקירה הכללית הזו מוסבר על השלבים הבאים:
- בחירת האפליקציות של Google Workspace שבהן התוסף יהיה זמין למשתמשים.
- מגדירים את הפרויקטים של התוסף ובוחרים בעלים ושותפי עריכה.
- עיצוב המראה וההתנהגות של התוסף.
- מגדירים את המניפסט של הפרויקט או את משאב הפריסה של התוסף.
- כותבים קוד כדי להגדיר את המראה וההתנהגות של התוסף.
- מוודאים שהתוסף כולל את היקפי ההרשאות הנדרשים ב-OAuth.
- בודקים את התוסף באפליקציה אחת או יותר של Google Workspace.
- מפרסמים את התוסף.
בחירת אפליקציות מארח של Google Workspace
אתם יכולים להגדיר את התוספים ל-Google Workspace כך שיופיעו באפליקציות המארחות הבאות של Google Workspace:
- Gmail
- יומן Google
- 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 מפורטות הנחיות לעיצוב חוויית המשתמש של התוסף.
הגדרת המניפסט של פרויקט התוסף
בפרויקטים של Apps Script, מניפסט הפרויקט הוא קובץ JSON מיוחד. הוא מציין מגוון פרטים על הפרויקט, כמו יחסי התלות שלו בספריות. לתוספים ל-Google Workspace, המניפסט מספק גם את המידע הבסיסי שנדרש לאפליקציה המארחת כדי להציג אותו בצורה נכונה.
במאמר מניפסטים מוסבר איך להגדיר את המניפסט של התוסף ב-Apps Script.
כשמוסיפים קוד ותכונות לתוסף, עורכים את המניפסט לפי הצורך כדי ליצור את המראה וההתנהגות הנדרשים של התוסף.
כתיבת הקוד של התוסף
עליכם להטמיע ממשק מבוסס-כרטיס לתוסף. משתמשים בשירות הכרטיסים של Apps Script, או אם כותבים בשפת קוד אחרת, מחזירים קובץ JSON בפורמט תקין כדי שהממשק ידפיס כרטיסים.
בנוסף, צריך להטמיע את כל פונקציות הטריגר שצוינו במניפסט של התוסף. אם התוסף מתחבר לשירות של צד שלישי שאינו Google באמצעות OAuth, צריך גם להגדיר את OAuth לאותו שירות.
יצירת כרטיסים
כדי להגדיר ממשק משתמש של תוספים, יוצרים אובייקטים ב-Card וממלאים אותם בווידג'טים. פונקציות ההפעלה שצוינו במניפסט צריכות להחזיר אובייקט Card יחיד או מערך של אובייקטים מסוג Card שמייצגים 'דפים' שונים בממשק התוסף. התוסף יכול גם ליצור ולהציג כרטיסים חדשים בתגובה לפעולות של המשתמשים.
ב-Apps Script, יוצרים כרטיסים באמצעות הכיתה CardBuilder. לכל כרטיס נדרש CardHeader וCardSections אחד או יותר. צריך לאכלס כל קטע של כרטיס בווידג'טים נפרדים שמרכיבים את ממשק התוסף. הווידג'טים של אינטראקציה מקושרים בדרך כלל לפעולות כדי להגדיר את התנהגות האינטראקציה שלהם.
אחרי שמוסיפים את כל הקטעים והווידג'טים לכרטיס דרך CardBuilder שלו, צריך לבצע קריאה ל-CardBuilder.build() כדי ליצור את האובייקט Card התואם.
אפשר להשתמש בשירותים מובנים אחרים של Apps Script, כמו CalendarApp, כדי לאחזר מידע להצגה בכרטיסי התוספים שאתם יוצרים.
אפשר להשתמש בנתונים שאוחזרו משירותים שלא שייכים ל-Google.
אם לתוסף שלכם דרושה גישה ל-APIs שאינם של Google שמחייבים OAuth, עליכם להגדיר את השירות הזה ולהתחבר אליו. פרטים נוספים זמינים במדריך בנושא התחברות לשירותים שאינם של Google.
הזמנת בנייה
כשיוצרים כרטיס, צריך ליצור אותו מלמעלה למטה. כלומר, צריך להשתמש בסדר היצירה הבא:
- פיתוח הווידג'ט.
- מוסיפים את הווידג'ט לקטע הכרטיסים.
- חוזרים על הפעולה עד שכל הווידג'טים מופיעים בקטע הכרטיס.
- מוסיפים את הקטע של הכרטיס לכרטיס.
צריך לעשות זאת כי כשאתם מוסיפים ווידג'ט לכרטיס או לקטע של כרטיס, אתם למעשה מוסיפים עותק של הווידג'ט הזה. שינויים שתבצעו באובייקט הווידג'ט אחרי שתוסיפו אותו לא ישתקפו בכרטיס הסופי.
פעולות אוניברסליות
אפשר להשתמש בפעולות אוניברסליות כדי לספק פונקציונליות שלא תלויה בהקשר. פעולות אוניברסליות הן אפשרויות בתפריט שזמינות בממשק המשתמש של התוסף, בלי קשר לכרטיס שמוצג. כל הפעולות האוניברסליות שהוגדרו תמיד מופיעות בתפריט הכרטיסים של התוסף.
לפרטים נוספים, ראו פעולות אוניברסליות.
אימות היקפי ההרשאות של OAuth בתוסף
היקפים מגדירים אילו פעולות התוסף רשאי לבצע בשם המשתמש. מומלץ לתת לתוספים הרשאות רק לפעולות שהם צריכים כדי לפעול, ולא יותר.
בפרויקטים של תוספים, מגדירים במפורש את ההיקפים של התוספים כדי לוודא שהתוסף משתמש בקבוצת ההיקפים הכי מגבילה שאפשר. אתם מגדירים את ההיקפים שבהם התוסף משתמש במניפסט של התוסף.
פרטים נוספים זמינים במאמר היקפים.
בדיקת התוסף
כדי לבדוק תוספים שלא פורסמו, קודם צריך להתקין את התוסף. אחרי שמתקינים את התוסף ומקבלים הרשאה, אפשר להשתמש בו בחשבון ולבדוק את המראה וההתנהגות שלו באפליקציות המארחות שהוא מרחיב. עליכם לוודא שהתוסף פועל כצפוי בהקשרים ובפעולות של המשתמשים.
פרטים נוספים זמינים במאמר בדיקת תוספים ל-Google Workspace.
פרסום התוסף
פרסום התוסף מאפשר לכם להפוך אותו לזמין לאחרים, באופן ציבורי או רק למשתמשים בדומיין שלכם. לפני שמתחילים בתהליך הפרסום, חשוב לקרוא את הסקירה הכללית של אתר החדשות. פרסום הוא תהליך מורכב שדורש הכנה וזמן.
התוספים ל-Google Workspace פורסמו ב-Google Workspace Marketplace. תוספים שזמינים לכולם חייבים לעבור בדיקת אפליקציה לפני הפרסום שלהם.
למידע נוסף, ראו פרסום תוסף ל-Google Workspace.