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