בדף הזה מוסבר איך להשתמש ב-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.
הפעלת ה-SDK של Marketplace
אם עדיין לא עשיתם זאת, מפעילים את Marketplace SDK בפרויקט ב-Google Cloud.
פותחים את פרויקט Cloud במסוף Google Cloud
אם הוא עדיין לא פתוח, פותחים את פרויקט Cloud שבו רוצים להשתמש לדוגמה הזו:
- נכנסים לדף Select a project במסוף Google Cloud.
- בוחרים את הפרויקט ב-Google Cloud שבו רוצים להשתמש. לחלופין, לוחצים על Create project (יצירת פרויקט) ופועלים לפי ההוראות במסך. אם יוצרים פרויקט ב-Google Cloud, יכול להיות שתצטרכו להפעיל את החיוב בפרויקט.
הפעלת ה-SDK של Marketplace
לפני שמשתמשים ב-Google APIs, צריך להפעיל אותם בפרויקט ב-Google Cloud. אפשר להפעיל ממשק API אחד או יותר בפרויקט אחד ב-Google Cloud.במסוף Google Cloud, מפעילים את Google Workspace Marketplace SDK.
קביעת הגדרות האישיות של האפליקציה
במסמך העזרה הבא מתוארות ההגדרות שזמינות בדף App Configuration ב-Marketplace SDK.
בחירת המשתמשים שיכולים לראות ולהתקין את האפליקציה
כשמגדירים את האפליקציה, מציינים את המשתמשים שיכולים לגשת אליה באמצעות ההגדרות הבאות:
- הרשאות הגישה לאפליקציה: אם אתם מפרסמים אפליקציה בארגון ב-Google Workspace, אתם יכולים לקבוע אם דף האפליקציה יהיה גלוי לכולם, רק למשתמשים בארגון או רק למשתמשים ב-Google Workspace.
- הגדרות ההתקנה: האם רק אדמינים ב-Google Workspace יכולים להתקין את האפליקציה.
ללא קשר להגדרות שציינתם בדף האפליקציה, יכול להיות שמשתמשים ששייכים לארגון ב-Google Workspace לא יוכלו למצוא את האפליקציה, להתקין אותה או להשתמש בה, בהתאם להגדרות שהאדמינים שלהם קבעו. אדמינים יכולים להשפיע על הזמינות של האפליקציה בדרכים הבאות:
- לקבוע אם המשתמשים שלהם יוכלו להציג אפליקציות ב-Marketplace ולהתקין אפליקציות בשמם.
- להשתמש ברשימת ההיתרים כדי לנהל ולבחור אפליקציות עבור הארגון. אם אתם מפתחים אפליקציה לארגון שמשתמש ברשימות היתרים, כדאי לפנות לאדמין כדי לברר איך מוסיפים את האפליקציה לרשימת ההיתרים.
- להשבית אפליקציות מסוימות של Google Workspace, למשל להסיר את הגישה ל-Google Chat, לאפליקציות של Google Chat או לשניהם. במקרים כאלה, המשתמשים לא יוכלו להתקין את האפליקציה שלכם מ-Marketplace.
במאמר מידע נוסף בנושא Marketplace לאדמינים מוסבר איך אדמינים מנהלים את הגישה ל-Marketplace.
הגדרות של הרשאות גישה לאפליקציה
האפשרות הרשאות גישה לאפליקציה מוצגת אם אתם משתמשים בחשבון Google Workspace (חשבון שנוצר על ידי הארגון שלכם בעבודה או במוסד הלימודים). אם אתם משתמשים בחשבון של צרכן (חשבון שמסתיים ב-@gmail.com), תוכלו לפרסם רק באופן ציבורי.
- גלויה לכולם: אנשים מחוץ לדומיין שלכם יכולים למצוא את האפליקציה ולהתקין אותה. אם בוחרים בסטטוס 'גלוי לכולם', Google בודקת ומאשרת את דף האפליקציה לפני שהוא יפורסם.
- פרטית: רק אנשים בדומיין שלכם יכולים למצוא את האפליקציה ולהתקין אותה.
אם בוחרים לפרסם את האפליקציה כלא רשומה, כרטיס האפליקציה לא יופיע בתוצאות החיפוש או בדף הבית. המשתמשים יכולים לגשת לדף האפליקציה בחנות רק באמצעות כתובת ה-URL הישירה.
אם רוצים להגביל את המדינות והאזורים שבהם האפליקציה זמינה, צריך להגדיר זאת בקטע הפצה כשיוצרים את דף המוצר בחנות.
הגדרות להתקנת אפליקציות
האפשרות הגדרות ההתקנה קובעת אם משתמשים או אדמינים ב-Google Workspace יוכלו להתקין את האפליקציה שלכם מדף המוצר בחנות ב-Marketplace.
- התקנה אישית והתקנה על ידי אדמין (ברירת המחדל): משתמשים ספציפיים או אדמינים יכולים להתקין את האפליקציה בדומיין, ביחידה הארגונית או בקבוצה שלהם. מדיניות הדומיין של המשתמש עשויה למנוע ממנו להתקין אפליקציה, גם אם ההתקנות הספציפיות מופעלות.
- התקנה על ידי אדמינים בלבד: רק אדמינים יכולים להתקין את האפליקציה בדומיין, ביחידה הארגונית או בקבוצת המשתמשים שלהם. האפליקציה שלכם תופיע בתוצאות החיפוש ב-Google Workspace Marketplace רק לאדמינים ולאנשים שלא מחוברים לחשבון Google שלהם. בוחרים באפשרות הזו אם האפליקציה שלכם דורשת התקנה בדומיין.
הגדרות נפוצות של התקנה וחשיפה
בטבלה הבאה מפורטות כמה מהאפשרויות הנפוצות להגדרת האפליקציה להתקנה ולחשיפה:
| משתמשי האפליקציה המיועדים | ההגדרה הרשאות גישה לאפליקציה | ההגדרה התקנת אפליקציה | מי יכול להתקין את האפליקציה שלי? | מי יכול להשתמש באפליקציה שלי? | |
|---|---|---|---|---|---|
| לאפליקציות שנוצרו לארגון ב-Google Workspace | |||||
| משתמשים ספציפיים בארגון | פרטי ולא רשום | התקנה של משתמש פרטי ושל אדמין | אם מותר, כל מי שבארגון שיש לו את כתובת ה-URL של דף האפליקציה. | אם מותר, כל מי שבארגון שיש לו את כתובת ה-URL של דף האפליקציה. | |
| הארגון שלך | פרטי | התקנה של משתמש פרטי ושל אדמין | אם מותר, כל מי שבארגון. | אם מותר, כל מי שבארגון. | |
| הארגון שלך | פרטי | אדמין בלבד | מנהלי מערכת | משתמשים שהאדמין שלהם התקין את האפליקציה. | |
| לאפליקציות שזמינות למשתמשים מחוץ לארגון ספציפי ב-Google Workspace | |||||
| משתמשים בארגונים ב-Google Workspace | גלוי לכולם | אדמין בלבד | מנהלי מערכת | משתמשים שהאדמין שלהם התקין את האפליקציה. | |
| כל משתמשי Google Workspace | גלוי לכולם | התקנה של משתמש פרטי ושל אדמין |
|
|
|
איך בודקים איך האפליקציה משתלבת עם אפליקציות Google Workspace
בוחרים את שירותי Google Workspace שהאפליקציה או התוסף מיועדים לפעול איתם, למשל תוסף ל-Google Workspace או אפליקציית Google Chat. חובה לבחור לפחות אפשרות אחת. במקרים מסוימים, אפשר לכלול כמה שילובי אפליקציות בדף המוצר של האפליקציה. רשימת השילובים של האפליקציות
בהתאם לשילובי האפליקציות שבחרתם, יכול להיות שתצטרכו לספק מידע נוסף ולהפעיל ממשקי API רלוונטיים בפרויקט שלכם ב-Google Cloud. בטבלה הבאה מפורטות ההגדרות הנוספות הנדרשות לכל אחת מהן:
כדי לפרסם תוסף ל-Google Workspace, צריך לספק את מזהה הפריסה של התוסף. כדי למצוא את מזהה הפריסה:
- פותחים את התוסף ל-Google Workspace בעורך של Apps Script.
- לוחצים על פריסה > ניהול הפריסות.
- מתחת למזהה הפריסה, לוחצים על העתקה.
אם פיתחתם את התוסף ל-Google Workspace באמצעות נקודות קצה של HTTP, עליכם לפעול לפי השלבים הבאים כדי לקבל את מזהה הפריסה ממשאב הפריסה ב-Google Cloud.
- בדף App Configuration (הגדרת האפליקציה), בקטע Google Workspace add-on (תוסף Google Workspace), לוחצים על HTTP or other deployments (פריסות HTTP או פריסות אחרות) > Select Deployment (בחירת פריסה).
- בוחרים את הפריסה שרוצים לפרסם.
- לוחצים על בחירה.
כדי לפרסם תוסף ל-Editor, צריך לציין את מזהה הסקריפט של הפרויקט ואת הגרסה שרוצים לפרסם.
כדי למצוא את מזהה הסקריפט של הפרויקט:
- פותחים את התוסף בעורך של Apps Script.
- בצד ימין, לוחצים על הגדרות הפרויקט .
- בקטע 'מזהים', מעתיקים את מזהה הסקריפט.
כדי למצוא את הגרסה:
- פותחים את התוסף בעורך של Apps Script.
- בפינה השמאלית העליונה, לוחצים על פריסה > ניהול הפריסות.
- מספר הגרסה מופיע בקטע 'הגדרה'.
כדי לפרסם אפליקציית Google Chat, צריך להגדיר את Google Chat API. פרסום אפליקציות ב-Google Chat
כדי לפרסם אפליקציה ל-Drive, צריך להפעיל ולהגדיר את Google Drive API.
כדי לפרסם אפליקציית אינטרנט, צריך לספק את כתובת ה-URL הניווטית האוניברסלית שלה, כלומר כתובת ה-URL שמפנה לאפליקציית האינטרנט מתפריט האפליקציות של Google . אפליקציית האינטרנט צריכה להיות מופעלת בסביבת הייצור ופועלת באופן מלא.
כשממלאים את הדף של דף האפליקציה בחנות, צריך לספק סמלים נוספים בגודל 96x96 פיקסלים ו-48x48 פיקסלים.
אם פיתחתם את אפליקציית האינטרנט ב-Apps Script, עליכם לפעול לפי השלבים הבאים כדי לקבל את כתובת ה-URL הגלובלית של הניווט:
- פותחים את התוסף ל-Google Workspace בעורך של Apps Script.
- לוחצים על פריסה > פריסה חדשה.
- בקטע 'בחירת סוג', לוחצים על אפליקציית אינטרנט.
- ממלאים את האפשרויות ולוחצים על פריסה.
- לוחצים על Copy.
מציינים את רמת הגישה שנדרשת לאפליקציה
בקטע OAuth Scopes, מספקים רשימה מלאה של היקפי ההרשאות של OAuth 2.0 שנדרשים לאפליקציה. היקפי ההרשאות של OAuth שתזינו כאן צריכים להתאים למה שמוצג במסך ההסכמה של OAuth, ואם רלוונטי, למניפסט של Apps Script.
אם אתם כוללים יותר משילוב אפליקציה אחד, חשוב להוסיף את היקפי ההרשאות של כל אחד מהם לדף ההגדרות של אפליקציית Marketplace SDK ולמסך ההסכמה של OAuth.
תמיד כדאי להשתמש בהיקפים הצרים ביותר האפשריים (לדוגמה, לא לכלול היקף מלא של Drive אם אתם צריכים רק היקף לקריאה בלבד).
לפרטים נוספים על פרויקטים ב-Apps Script, ראו היקפי הרשאה.
מתן מידע על מפתח האפליקציה
בקטע פרטי המפתח, ממלאים את הפרטים ליצירת קשר ופרטים נוספים. השדות האלה מופיעים בדף האפליקציה בחנות.
| שדות | |
|---|---|
| סטטוס העסק |
עקב חוקים להגנת הצרכן, צרכנים שנמצאים באזור הכלכלי האירופי (EEA) צריכים לדעת אם מוכר בזירת המסחר הוא עסק או לא עסק:
אם לא יצוין סטטוס, יופיע הכיתוב 'לא מצוין סטטוס העסק' בדף האפליקציה בחנות. |
| שם המפתח | השם שיוצג ככותב האפליקציה. אם אתם סוחרים, עליכם לציין את השם המסחרי או את השם החוקי שלכם. |
| כתובת למשלוח דואר של המפתח |
חובה למוכרים. לא נאסף מאנשים שלא עסקו במסחר. המיקום של העסק. מזינים כתובת למשלוח דואר שבה אפשר ליצור איתך קשר. |
| כתובת ה-URL של האתר למפתחים | האתר שמתאר אותך (או את הארגון שלך) כמפתח. |
| כתובת האימייל של המפתח |
כתובת האימייל שתשמש כאיש קשר. הוא לא נכלל בדף האפליקציה. חשוב לוודא שכתובת האימייל הזו מעודכנת, כי היא משמשת:
|
| כתובת ה-URL של אתר האפליקציה | זה שינוי אופציונלי. האתר שבו מופיע תיאור נוסף של האפליקציה. |
שמירת הגדרות התצורה של האפליקציה ב-Marketplace SDK
על סמך המידע שמופיע בקטע הקודם, שומרים את הגדרות האפליקציה ב-Marketplace SDK:
נכנסים לדף Configuration של Marketplace SDK במסוף Google Cloud:
ממלאים כל סעיף על סמך מה שקבעתם בסעיף הקודם.
לוחצים על שמירה.
(אופציונלי) אתם יכולים לקבל ניתוח נתונים על השימוש באפליקציה ב-Google Analytics. לשם כך, מוסיפים מזהה Google Analytics ב-Marketplace SDK.
- עוברים לכרטיסייה Analytics.
- מזינים את מזהה Google Analytics.
- לוחצים על שמירה.
פתרון בעיות
בקטע הזה מתוארות בעיות נפוצות שעשויות להתרחש.
חסרות הרשאות נדרשות כשמפרסמים אפליקציות ב-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 נאמר שזו שיטה לא טובה, כי אי אפשר להגביל בקלות את הגישה לעריכה של משאבים אחרים בפרויקט.