כשרוצים ליצור תוסף חדש ל-Google Workspace, צריך לבצע את התהליך הכללי הבא:
- מגדירים את הפרויקטים של התוסף ובוחרים בעלים ושותפי עריכה.
- כדאי לעצב את המראה וההתנהגות של התוסף.
- מגדירים את מניפסט הפרויקט או את משאב הפריסה של התוסף.
- אתם יכולים לכתוב קוד כדי להגדיר את המראה וההתנהגות של התוסף.
- מאמתים את היקפי ה-OAuth של התוסף.
- בדיקת התוסף בתוך האפליקציות המארחות שהוא מורחב.
- מפרסמים את התוסף.
הגדרת הפרויקטים של התוסף ובחירת בעלים ושותפי עריכה
אם אתם יוצרים את התוסף ב-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.
אם לתוספים שלכם ל-Google Workspace נדרשת גישה לממשקי API שאינם של Google שמחייבים שימוש ב-OAuth, תצטרכו להגדיר את השירות ולהתחבר אליו. לפרטים נוספים, תוכלו לעיין במדריך בנושא התחברות לשירותים שאינם של Google.
הזמנת בנייה
כשבונים כרטיס, צריך לבנות את הכרטיס מחדש. כלומר צריך להשתמש בסדר הבנייה הבא:
- יצירת הווידג'ט.
- מוסיפים את הווידג'ט לקטע הכרטיסים.
- חוזרים על הפעולה עד שכל הווידג'טים יופיעו בקטע הכרטיסים.
- מוסיפים את הקטע של הכרטיס לכרטיס.
הסיבה לכך היא שכשמוסיפים ווידג'ט לכרטיס או לקטע בכרטיס, למעשה מוסיפים עותק שלו. שינויים שמבצעים באובייקט הווידג'ט אחרי שמוסיפים אותו לא מוצגים בכרטיס הסופי.
פעולות אוניברסליות
אפשר להשתמש בפעולות אוניברסליות כדי לספק פונקציונליות בלתי תלויה בהקשר. פעולות אוניברסליות הן אפשרויות בתפריט שזמינות בממשק המשתמש של התוסף, ללא קשר לכרטיס שמוצג. כל הפעולות האוניברסליות המוגדרות תמיד מופיעות בתפריט הכרטיסים של התוסף.
לפרטים נוספים, ראו פעולות אוניברסליות.
אימות היקפי ההרשאות של OAuth לתוסף
היקפים מגדירים אילו פעולות התוסף מורשה לבצע בשם המשתמש. מומלץ להגדיר לתוספים רק היקפי פעולות שחייבים להיות להם לפי סדר הפעולה.
בפרויקטים של תוספים, יש להגדיר באופן מפורש את היקף ההרשאות כדי להבטיח שהתוסף ישתמש בקבוצת היקפי הרשאות הפחות מגבילה ככל האפשר. אתם מגדירים אילו היקפים התוסף ישתמש במניפסט של התוסף.
פרטים נוספים זמינים בהיקפים.
בדיקת התוסף
כדי לבדוק תוספים שלא פורסמו, קודם צריך להתקין את התוסף שלא פורסם. אחרי ההתקנה והאישור, תוכלו להשתמש בתוסף בחשבון ולבדוק את המראה וההתנהגות שלו באפליקציות המארחות שהוא מרחיב. עליכם לוודא שהתוסף מתנהג כמצופה בהתאם להקשרים ולפעולות משתמשים.
לפרטים נוספים אפשר לעיין בבדיקת תוספים ל-Google Workspace.
פרסום התוסף
פרסום התוסף יהיה זמין לאחרים, באופן ציבורי או רק למשתמשים בדומיין. לפני שתתחילו את תהליך הפרסום, הקפידו לקרוא את הסקירה הכללית של אתר החדשות. פרסום הוא תהליך מורכב שכדי להשלים אותו צריך הכנה וזמן.
תוספי Google Workspace מפורסמים ב-Google Workspace Marketplace. תוספים שזמינים באופן גלוי לכולם צריכים להשלים את בדיקת האפליקציה לפני הפרסום שלהם.
לפרטים נוספים, ראו פרסום תוסף Google Workspace.