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