שדרוג תוספים מדור קודם ל-Gmail וליומן Google

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

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

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

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

שלב 1: יצירת עותק של פרויקט Apps Script של התוסף

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

1. פותחים את פרויקט Apps Script של התוסף הקיים ל-Gmail או של התוסף לשיחות ועידה ביומן Google.
2. בצד ימין, לוחצים על סקירה כללית .
3. בצד שמאל, לוחצים על הסמל 'יצירת עותק' .
4. בצד ימין, לוחצים על הגדרות הפרויקט > שינוי הפרויקט.
5. לוחצים על GCP Project Number.
6. צריך להזין את אותו מספר פרויקט שמשויך לפרויקט Apps Script של התוסף הקיים שפורסם.
7. לוחצים על Set project (הגדרת פרויקט).

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

שלב 2: משלבים את התוסף של Google Workspace

אתם צריכים לתכנן ולהטמיע את כל התכונות של התוסף של Google Workspace שאתם רוצים להוסיף לתוסף.

1. אפשר לתכנן איזה תוכן להציג בכרטיסים בדף הבית של התוסף ואם הם צריכים להופיע ב-Gmail, ביומן, ב-Drive או בכל שילוב של שלושת המארחים. אם אתם רוצים דף בית ביותר ממארח אחד, מחליטים אם הוא יכול להיות אותו דף בית או אם רוצים כרטיסים מותאמים אישית של דף הבית לכל מארח.
2. בפרויקט Apps Script של התוסף שהועתק, יוצרים את הכרטיסים בדף הבית באמצעות הפונקציות homepageTrigger. הקפידו לכלול פונקציות או לוגיקה תומכות שנדרשים כדי לשלוט בממשקים החדשים בדף הבית.

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

   אזהרה: תוספים משודרגים מקבלים מזהה שונה בהודעות Gmail מזה שמקבלים תוספים ל-Gmail. השינוי הזה משפיע רק על תוספים משודרגים שמשתמשים ב-messageId כמפתח באחסון קבוע. במקרה הצורך, עדיין תוכלו לקבל את ערכי המזהה הישנים באמצעות ה-API של Gmail. השיטה messages().get() ב-Gmail API מקבלת גם את ערכי המזהים החדשים וגם את ערכי המזהים הישנים, אבל מחזירה רק את ערכי המזהה הישנים.

4. מעדכנים את הגישה לאובייקטים של אירועים בתוסף (בפונקציות קריאה חוזרת של ווידג'ט או בפונקציות טריגר לפי הקשר) כדי להשתמש במבנה המעודכן של אובייקטי אירוע. המבנה החדש עדיין מכיל את אותם שדות של אובייקטי אירוע שמשמשים את התוספים לשיחות ועידה ביומן ב-Gmail וביומן, אבל השדות המקוריים האלה הוצאו משימוש ובסופו של דבר יוסרו.

שלב 3: עדכון המניפסט של התוסף

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

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

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

תוספים ל-Gmail

שדה המניפסט המקורי	נדרשת פעולה
gmail.composeTrigger	העברה אל addOns.gmail.composeTrigger.
gmail.contextualTriggers[]	מעבירים את הרשימה אל addOns.gmail.contextualTriggers[].
gmail.logoUrl	העברה אל addOns.common.logoUrl.
gmail.name	העברה אל addOns.common.name.
gmail.openLinkUrlPrefixes[]	מעבירים את הרשימה אל addOns.common.openLinkUrlPrefixes[].
gmail.primaryColor	העברה אל addOns.common.layoutProperties.primaryColor.
gmail.secondaryColor	העברה אל addOns.common.layoutProperties.secondaryColor.
gmail.universalActions[]	מעבירים את הרשימה אל addOns.common.universalActions[].
gmail.universalActions[].text	מעבירים כל שדה gmail.universalActions[].text לשדה addOns.common.universalActions[].label תואם.
gmail.useLocalFromApp	העברה אל addOns.common.useLocaleFromApp.

תוספים לשיחות ועידה ביומן

שדה המניפסט המקורי	נדרשת פעולה
calendar.createSettingsUrlFunction	העברה אל addOns.calendar.createSettingsUrlFunction.
calendar.conferenceSolution[]	העברה אל addOns.calendar.conferenceSolution[].
calendar.logoUrl	העברה אל addOns.common.logoUrl.
calendar.name	העברה אל addOns.common.name.

שלב 4: בודקים את התוסף המשודרג

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

שלב 5: מבקשים לבדוק את התוסף המשודרג

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

כדי לשלוח את התוסף לבדיקה:

1. חשוב לוודא שהתוסף עומד בכל הדרישות לפרסום תוספים.

2. יצירת פריסה עם גרסאות של תוסף Google Workspace (בפרויקט Apps Script החדש) באמצעות גרסת הקוד שרוצים לפרסם. אל תנסו לפרסם באמצעות פריסת ראש.

3. אם הוספתם היקפי הרשאות חדשים במהלך השדרוג של התוסף, צריך לשלוח בקשה לאימות OAuth. לדוגמה, אם בתוסף ל-Gmail נעשה שימוש בהיקפים חדשים ב-Drive או ביומן Google בגרסת התוסף של Google Workspace, אתם צריכים לשלוח את היקפי ההרשאות החדשים האלה לאימות. בדרך כלל תהליך האימות נמשך כמה ימים, לכן כדאי להתחיל אותו בהקדם האפשרי. ודאו שהתוסף מאומת לפני שממשיכים לשלב 6.

שלב 6: הגדרת התוסף המשודרג כזמין

1. פותחים את Google Workspace Marketplace SDK.

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

3. מעדכנים את התיאור הקצר, התיאור המפורט וצילומי המסך של כרטיס המוצר כך שישקפו את הפונקציונליות החדשה של התוסף ל-Google Workspace.

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

   זהירות: שדרוג התוסף ל-Google Workspace בדרך הזו הוא תהליך חד-פעמי שאי אפשר לבטל.

5. אם הוספתם היקפי הרשאות חדשים לתוסף Google Workspace, חשוב לוודא שהוספתם אותם לקטע היקפי OAuth 2.0 בדף Configuration. ההיקפים שמופיעים בקטע הזה צריכים להיות זהים להיקפים שמופיעים במניפסט של התוסף.

6. ודאו שהפרטים שהזנתם בטופס נכונים. לאחר מכן לוחצים על Save changes.

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

שאלות נפוצות

שאלות נפוצות לגבי שדרוגים של תוספים:

האם אפשר לשדרג את תוסף Editor?

את רוב התוספים של Editor אפשר להעביר לתוספים של Google Workspace. עם זאת, אי אפשר לשדרג אותם לתוספים של Google Workspace באותה קלות כמו תוספים ל-Gmail וליומן Google.

אם תרצו להעביר תוסף של Editor לתוסף של Google Workspace, תצטרכו לשכתב את ממשק המשתמש של התוסף מ-HTML לממשק מבוסס כרטיס, ולעדכן את הטיפול ב-JavaScript לשירות הכרטיסים.

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

אפשר ליצור תוסף נפרד ל-Google Workspace ולהשאיר את התוסף הקיים?

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

האם המשתמשים יצטרכו לאשר מחדש את התוסף אחרי השדרוג?

כל עוד התוסף ל-Google Workspace משתמש באותו פרויקט ב-Cloud Platform (GCP) עם מזהה לקוח ב-OAuth משויך, המשתמשים שלכם לא יצטרכו לאשר מחדש את ההרשאות שהם אישרו בעבר לתוסף המקורי. עם זאת, אם מוסיפים היקפי הרשאות חדשים בתהליך השדרוג, המשתמשים יצטרכו לאשר את היקפי ההרשאות החדשים בפעם הראשונה שהם משתמשים בגרסת Google Workspace של התוסף.

אפשר לשדרג את התוסף ל-Chrome לתוסף של Google Workspace ולהעביר משתמשים?

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

האם אפשר לצרף כמה תוספים ל-Google Workspace?

מידע נוסף על הצגת רשימה של שילובי אפליקציות