שדרוג התוספים שפורסמו

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

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

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

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

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

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

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

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

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

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

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

אופן האחסון של פרטי התצורה במבנה המניפסט של תוספים ל-Google Workspace השתנה באופן משמעותי מהמבנה של התוספים ל-Gmail והתוספים של שיחות ועידה ביומן Google. במהלך השדרוג של התוסף, צריך לעדכן את שדות המניפסט של פרויקט 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. בקטע נכסים, לוחצים על הלחצן Upgrade to Google Workspace Add-on. בתיבת הטקסט שמופיעה, מזינים את מזהה הפריסה החדש שיצרתם לתוסף Google Workspace בשלב הקודם. אם מזהה הפריסה שלכם חוקי, תופיע רשימה של מארחים נתמכים.

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

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

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

שאלות נפוצות

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

האם אפשר לשדרג את תוסף העריכה?

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

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

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

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

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

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

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

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

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

האם אפשר לכלול בחבילה כמה תוספים יחד עם התוסף של Google Workspace?

מומלץ לעיין בפירוט שילובי אפליקציות יחד.