הגדרת האפליקציה ב-Google Workspace Marketplace SDK

בדף הזה מוסבר איך להשתמש ב-Google Workspace Marketplace SDK כדי להגדיר ולנהל את האפליקציה ב-Google Workspace Marketplace.

כדי להפוך את האפליקציה לזמינה לשימוש, צריך להגדיר אותה ב-Marketplace SDK. ‫Marketplace SDK הוא ערכת כלים שמאפשרת לכם ליצור ולשלוט באפליקציה שלכם ב-Marketplace. אתם משתמשים ב-Marketplace SDK כדי לנהל הגדרות של Marketplace, כמו:

• האם האפליקציה זמינה לארגון ספציפי ב-Google Workspace (אפליקציה פרטית) או לכל המשתמשים ב-Marketplace (אפליקציה ציבורית)
• סוגי המשתמשים ב-Marketplace שיכולים להתקין את האפליקציה
• אילו אפליקציות של Google Workspace משולבות באפליקציה שלכם
• היקפי ההרשאות של OAuth שהאפליקציה דורשת
• מידע על מי שבנה את האפליקציה ומתחזק אותה

בין אם אתם מפרסמים את האפליקציה באופן פרטי או ציבורי, אתם חייבים להשתמש ב-Marketplace SDK כדי לנהל את האפליקציה ב-Marketplace.

הפעלת Marketplace SDK

אם עדיין לא עשיתם זאת, בפרויקט Google Cloud, מפעילים את Marketplace SDK.

פתיחת פרויקט בענן במסוף Google Cloud

אם הוא לא פתוח, פותחים את פרויקט בענן שרוצים להשתמש בו בדוגמה הזו:

1. נכנסים לדף Select a project במסוף Google Cloud.

   בחירת פרויקט בענן

2. בוחרים את הפרויקט בענן של Google שבו רוצים להשתמש. אפשר גם ללחוץ על Create project ולפעול לפי ההוראות במסך. אם אתם יוצרים פרויקט ב-Google Cloud, יכול להיות שתצטרכו להפעיל את החיוב בפרויקט.

הפעלת Marketplace SDK

לפני שאתם משתמשים בממשקי Google API, אתם צריכים להפעיל אותם בפרויקט ב-Google Cloud. בכל פרויקט אפשר להפעיל ממשק API אחד או יותר.

• במסוף Google Cloud, מפעילים את Google Workspace Marketplace SDK.

  הפעלת ה-SDK

אזהרה: חשוב לוודא שמפעילים את Google Workspace Marketplace SDK ולא את ה-API. ‫Google Workspace Marketplace API הוא כלי אחר שמשמש לשילוב עם שירותי הרישוי והחיוב של Google.

קביעת הגדרות האפליקציה

במאמר הזה מוסבר על ההגדרות שזמינות בדף App Configuration (הגדרת אפליקציה) ב-Marketplace SDK.

בחירת המשתמשים שיוכלו לראות ולהתקין את האפליקציה

כשמגדירים את האפליקציה, מציינים את המשתמשים שיכולים לגשת אליה באמצעות ההגדרות הבאות:

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

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

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

במאמר הזה מוסבר איך אדמינים מנהלים את הגישה ל-Marketplace.

הגדרות החשיפה של האפליקציה

אזהרה: אחרי שבוחרים אפשרות חשיפה ושומרים את הדף App Configuration, אי אפשר לשנות את הבחירה בהמשך.

האפשרות App Visibility (חשיפת האפליקציה) מופיעה אם אתם משתמשים בחשבון Google Workspace (חשבון שנוצר על ידי הארגון של מקום העבודה או מוסד הלימודים). אם אתם משתמשים בחשבון פרטי (חשבון שמסתיים ב-‎@gmail.com), אתם יכולים לפרסם רק באופן ציבורי.

• גלוי לכולם: אנשים מחוץ לדומיין יכולים למצוא את האפליקציה ולהתקין אותה. אם בוחרים בסטטוס 'גלוי לכולם', Google בודקת ומאשרת את דף האפליקציה לפני הפרסום.
• פרטי: רק אנשים בדומיין שלכם יכולים למצוא ולהתקין את האפליקציה.

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

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

הגדרות להתקנת אפליקציות

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

הערה: באפליקציות ל-Google Chat, אפשר לבחור רק באפשרות התקנה אישית + התקנת אדמין, כי משתמשים יכולים לגלות ולהתקין אפליקציות ל-Chat ישירות מ-Google Chat. לפרטים על אופן ההתקנה, אפשר לעיין במאמר איך משתמשים באפליקציות ל-Chat.

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

הגדרות נפוצות להתקנה ולחשיפה

בטבלה הבאה מפורטות כמה מהאפשרויות הנפוצות להגדרת אפליקציות לצורך התקנה וחשיפה:

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

איך אפליקציה משתלבת עם אפליקציות של Google Workspace

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

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

• ‫Unsaved: הוספתם שילוב או שיניתם אותו, אבל לא שמרתם את השינויים בכרטיסייה 'הגדרת אפליקציה'.
• ‫Draft: השינויים נשמרו אבל לא פורסמו.
• ‫Under review: שלחת את שילוב האפליקציה המעודכן לבדיקה.
• ‫Published: שילוב האפליקציה כלול בדף האפליקציה ב-Marketplace.

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

תוסף ל-Google Workspace

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

כדי למצוא את מזהה הפריסה ב-Apps Script:

1. פותחים את התוסף של Google Workspace בכלי העריכה של Apps Script.
2. לוחצים על פריסה > ניהול הפריסות.
3. מתחת למזהה הפריסה, לוחצים על העתקה.

כדי למצוא את מזהה הפריסה של תוסף HTTP, פועלים לפי השלבים הבאים:

1. בדף 'הגדרת אפליקציה', בקטע 'תוסף ל-Google Workspace', לוחצים על HTTP או פריסות אחרות > בחירת פריסה.
2. בוחרים את הפריסה שרוצים לפרסם.
3. לוחצים על בחירה.

הערה: אם התוסף מרחיב את Google Chat, צריך להגדיר גם את Google Chat API. הוראות מפורטות זמינות במאמר בנושא הגדרת Chat API.

תוסף לעורכים (Docs, ‏ Sheets, ‏ Slides, ‏ Forms)

כדי לפרסם תוסף ל-Editor, צריך לספק את מזהה הסקריפט של הפרויקט ואת הגרסה שרוצים לפרסם.

כדי למצוא את מזהה הסקריפט של הפרויקט:

1. פותחים את התוסף בעורך Apps Script.
2. בצד ימין, לוחצים על הגדרות הפרויקט .
3. בקטע 'מזהים', מעתיקים את מזהה הסקריפט.

כדי למצוא את הגרסה:

1. פותחים את התוסף בעורך Apps Script.
2. בפינה השמאלית העליונה, לוחצים על פריסה > ניהול פריסות.
3. מספר הגרסה מופיע בקטע 'הגדרה'.

אפליקציית Google Chat

כדי לפרסם אפליקציה אינטראקטיבית ל-Google Chat, אפשר לעיין במאמרי העזרה הבאים:

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

אפליקציית Drive

כדי לפרסם אפליקציה ל-Drive, צריך להפעיל ולהגדיר את Google Drive API.

אפליקציית אינטרנט

כדי לפרסם אפליקציית אינטרנט, צריך לספק את כתובת ה-URL של סרגל הניווט האוניברסלי, כתובת ה-URL שמפנה לאפליקציית האינטרנט מתפריט אפליקציות Google . אפליקציית האינטרנט צריכה להיות בסביבת ייצור ולתפקד באופן מלא.

כשממלאים את הדף 'דף האפליקציה בחנות', צריך לספק סמלים נוספים בגודל 96x96 ו-48x48 פיקסלים.

אם יצרתם את אפליקציית האינטרנט ב-Apps Script, אתם יכולים לפעול לפי השלבים הבאים כדי לקבל את כתובת ה-URL של הניווט האוניברסלי:

1. פותחים את התוסף של Google Workspace בכלי העריכה של Apps Script.
2. לוחצים על פריסה > פריסה חדשה.
3. בקטע 'בחירת סוג', לוחצים על אפליקציית אינטרנט.
4. ממלאים את האפשרויות ולוחצים על פריסה.
5. לוחצים על Copy.

מציינים את רמת הגישה שהאפליקציה דורשת

בקטע OAuth Scopes (היקפי הרשאות OAuth), מציינים רשימה מלאה של היקפי ההרשאות של OAuth 2.0 שהאפליקציה דורשת. היקפי ההרשאות של OAuth שאתם מזינים כאן צריכים להיות זהים לאלה שמוצגים במסך ההסכמה ל-OAuth ובקובץ המניפסט של Apps Script, אם רלוונטי.

אם אתם כוללים יותר משילוב אחד של אפליקציה, הקפידו להוסיף את היקפי ההרשאות מכל אחד מהם לדף 'הגדרת אפליקציה' ב-Marketplace SDK ולמסך ההסכמה ל-OAuth.

תמיד צריך להשתמש בהיקפי ההרשאות הכי מצומצמים שאפשר (לדוגמה, לא כדאי לכלול היקף הרשאות מלא של Drive אם צריך רק היקף הרשאות לקריאה בלבד).

לפרטים נוספים על פרויקטים של Apps Script, אפשר לעיין במאמר בנושא היקפי הרשאות.

מתן מידע על מפתח האפליקציה

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

שדות
סטטוס העסק	עקב חוקים להגנת הצרכן, חובה ליידע צרכנים שנמצאים באזור הכלכלי האירופי (EEA) אם מוכר בזירת המסחר הוא עסק או לא עסק: עסק: עסק הוא אדם שפועל למטרות שקשורות לתחום, לעסק, למיומנות או למקצוע שלו, או בשם עסק או מטעם עסק. לא עסק: לא עסק (צרכן) הוא אדם שפועל למטרות לא מקצועיות. אם לא מציינים סטטוס, בדף האפליקציה בחנות מופיע הכיתוב 'לא מצוין סטטוס העסק'.
שם המפתח	השם שיוצג כשם המחבר של האפליקציה. אם אתם סוחרים, צריך לציין את השם המסחרי או השם החוקי שלכם.
כתובת למשלוח דואר של המפתח	חובה למוכרים. לא נאסף לגבי לא עסק. המיקום של העסק. צריך להזין כתובת למשלוח דואר שאפשר ליצור איתך קשר דרכה.
כתובת האתר של המפתח	האתר שמתאר אתכם (או את הארגון שלכם) כמפתחים.
כתובת אימייל של מפתח	כתובת האימייל שדרכה נוכל ליצור איתך קשר. היא לא מופיעה בדף האפליקציה בחנות. חשוב לוודא שכתובת האימייל הזו מעודכנת, כי היא משמשת ל: אם Google צריכה ליצור קשר עם המפתח – למשל, במהלך תהליך בדיקת האפליקציה. כדי לשלוח משוב מתוספים של Editor אם לא צוין כתובת URL לדיווח על בעיה בדף של כרטיס המוצר בחנות.
כתובת האתר של האפליקציה	אופציונלי. האתר שבו יש תיאור נוסף של האפליקציה.

שמירת הגדרות התצורה של האפליקציה ב-Marketplace SDK

בעזרת המידע מהקטע הקודם, שומרים את הגדרות האפליקציה ב-Marketplace SDK:

1. במסוף Google Cloud, נכנסים לדף App Configuration ב-Marketplace SDK:

   מעבר לדף ההגדרות של Marketplace SDK

2. ממלאים כל קטע לפי מה שקבעתם בקטע הקודם.

3. לוחצים על שמירת הטיוטה.

4. (אופציונלי) אתם יכולים לקבל ניתוח נתונים על השימוש באפליקציה ב-Google Analytics. כדי לעשות זאת, מוסיפים מזהה של Google Analytics ב-Marketplace SDK.

   1. עוברים לכרטיסייה Analytics.
   2. מזינים את מזהה Google Analytics.
   3. לוחצים על שמירה.

פתרון בעיות

בקטע הזה מתוארות בעיות נפוצות שאתם עשויים להיתקל בהן.

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

אין לך אפשרות לפרסם אפליקציות ב-Marketplace כי ניסיונות להגדיר את האפליקציה בדף App Configuration (הגדרת אפליקציה) ב-Marketplace SDK נכשלים ומוצגת הודעת השגיאה הבאה:

You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update

השגיאה הזו מתרחשת כש-Marketplace SDK API מופעל וכשמשתמשים בתפקיד IAM שאינו Editor או Owner.

כדי לפתור את השגיאה, אפשר לנסות אחד מהפתרונות הבאים:

• צריך לבקש מבעלי הפרויקט להקצות את התפקיד roles/appmetadata.workspaceMarketplaceAppConfigurationAdmin לחשבון שחסרות לו הרשאות, כדי לאפשר לו להגדיר ולנהל את האפליקציה ב-Marketplace SDK.

• אפשר לבקש מבעלי הפרויקט להוסיף הרשאות חסרות לתפקיד מותאם אישית דרך הדף IAM & Admin > Roles במסוף Google Cloud. לאחר מכן, מקצים את התפקיד המותאם אישית לחשבון עם ההרשאות החסרות.

• אפשר להשתמש בפרימיטיב roles/editor או roles/owner לפרסום אפליקציות. עם זאת, במסמכי העזרה בנושא שימוש מאובטח ב-IAM, ההרשאה הזו נחשבת לשיטה לא מומלצת כי אי אפשר להגביל בקלות את הרשאת העריכה למשאבים אחרים בפרויקט.