בדף הזה מוסבר איך להשתמש ב-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
אם הוא לא פתוח, פותחים את פרויקט בענן שבו רוצים להשתמש בדוגמה הזו:
- נכנסים לדף Select a project במסוף Google Cloud.
- בוחרים את הפרויקט בענן של Google שבו רוצים להשתמש. לחלופין, לוחצים על Create project ופועלים לפי ההוראות במסך. אם יוצרים פרויקט ב-Google Cloud, יכול להיות שיהיה צורך להפעיל את החיוב בפרויקט.
הפעלת Marketplace SDK
לפני שאתם משתמשים בממשקי Google API, אתם צריכים להפעיל אותם בפרויקט ב-Google Cloud. בכל פרויקט אפשר להפעיל ממשק API אחד או יותר.במסוף 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.
הגדרות החשיפה של האפליקציה
האפשרות App Visibility (חשיפת האפליקציה) מוצגת אם אתם משתמשים בחשבון 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. צריך לבחור לפחות אפשרות אחת. במקרים מסוימים, אפשר לכלול כמה שילובים של אפליקציות בדף האפליקציה. איך רואים את כל שילובי האפליקציות ביחד
לכל תוסף של Google Workspace, בדף מוצג הסטטוס של הפרסום לכל מוצר מארח שהוא תומך בו. כך תוכלו להבין אילו שילובים זמינים למשתמשים שלכם. אלו האפשרויות לסטטוסים של שילוב אפליקציות:
Unsaved: הוספתם שילוב או שיניתם אותו, אבל לא שמרתם את השינויים בכרטיסייה 'הגדרת אפליקציה'.-
Draft: השינויים נשמרו אבל לא פורסמו. Under review: שלחת את השילוב המעודכן של האפליקציה לבדיקה.-
Published: שילוב האפליקציה שלכם כלול בדף האפליקציה ב-Marketplace.
בהתאם לשילובי האפליקציות שתבחרו, יכול להיות שתצטרכו לספק מידע נוסף ולהפעיל ממשקי API רלוונטיים בפרויקט בענן שלכם ב-Google Cloud. בטבלה הבאה מתוארות ההגדרות הנוספות שצריך לבצע בכל אחד מהמקרים:
תוסף ל-Google Workspace
כדי לפרסם תוסף ל-Google Workspace, צריך לספק את מזהה הפריסה של התוסף.
כדי למצוא את מזהה הפריסה ב-Apps Script:
- פותחים את התוסף של Google Workspace בכלי העריכה של Apps Script.
- לוחצים על Deploy > Manage deployments (פריסה > ניהול פריסות).
- מתחת למזהה הפריסה, לוחצים על העתקה.
כדי למצוא את מזהה הפריסה של תוסף HTTP, פועלים לפי השלבים הבאים:
- בדף App Configuration (הגדרת האפליקציה), בקטע Google Workspace add-on (תוסף ל-Google Workspace), לוחצים על HTTP or other deployments (פריסות HTTP או פריסות אחרות) > Select Deployment (בחירת פריסה).
- בוחרים את הפריסה שרוצים לפרסם.
- לוחצים על בחירה.
תוסף לעורכים (Docs, Sheets, Slides, Forms)
כדי לפרסם תוסף ל-Editor, צריך לספק את מזהה הסקריפט של הפרויקט ואת הגרסה שרוצים לפרסם.
כדי למצוא את מזהה הסקריפט של הפרויקט:
- פותחים את התוסף בעורך Apps Script.
- בצד ימין, לוחצים על הגדרות הפרויקט .
- בקטע 'מזהים', מעתיקים את מזהה הסקריפט.
כדי למצוא את הגרסה, פועלים לפי השלבים הבאים:
- פותחים את התוסף בעורך Apps Script.
- בפינה השמאלית העליונה, לוחצים על פריסה > ניהול פריסות.
- מספר הגרסה מופיע בקטע 'הגדרה'.
אפליקציית Google Chat
כדי לפרסם אפליקציה אינטראקטיבית ל-Google Chat, אפשר לעיין במאמרי העזרה הבאים:
- אם יצרתם את אפליקציית Chat כתוסף, אתם צריכים להגדיר את הגדרות התוסף ב-Chat API. הוראות מפורטות זמינות במאמר בנושא הגדרת אפליקציית Chat במסמכי התיעוד של התוסף ל-Google Workspace.
- אם יצרתם את אפליקציית Chat באמצעות אירועי אינטראקציה, אתם צריכים להגדיר את ההגדרות של אירועי האינטראקציה ב-Chat API. הוראות מפורטות זמינות במאמר בנושא קבלת אירועי אינטראקציה והגבה לאירועים כאלה במסמכי התיעוד של Chat API.
- אם יצרתם את האפליקציה ל-Chat באמצעות ההגדרה האוטומטית של AppSheet, אתם יכולים לפרסם את האפליקציה ל-Chat באמצעות השלבים שמתוארים במסמכי AppSheet בנושא שיתוף האפליקציה ל-Chat באמצעות הגדרה אוטומטית.
אפליקציית Drive
כדי לפרסם אפליקציה ל-Drive, צריך להפעיל ולהגדיר את Google Drive API.
אפליקציית אינטרנט
כדי לפרסם אפליקציית אינטרנט, צריך לספק את כתובת ה-URL של הניווט האוניברסלי שלה, כתובת ה-URL שמפנה לאפליקציית האינטרנט מתפריט אפליקציות Google . אפליקציית האינטרנט צריכה להיות בשלב הייצור ולתפקד באופן מלא.
כשממלאים את דף האפליקציה בחנות, צריך לספק סמלים נוספים בגודל 96x96 ו-48x48 פיקסלים.
אם יצרתם את אפליקציית האינטרנט ב-Apps Script, פועלים לפי השלבים הבאים כדי לקבל את כתובת ה-URL של הניווט האוניברסלי:
- פותחים את התוסף של Google Workspace בכלי העריכה של Apps Script.
- לוחצים על פריסה > פריסה חדשה.
- בקטע 'בחירת סוג', לוחצים על אפליקציית אינטרנט.
- ממלאים את האפשרויות ולוחצים על פריסה.
- לוחצים על Copy.
מציינים את רמת הגישה שהאפליקציה דורשת
בקטע OAuth Scopes (היקפי הרשאות של OAuth), מציינים רשימה מלאה של היקפי ההרשאות של OAuth 2.0 שהאפליקציה דורשת. היקפי ההרשאות של OAuth שאתם מזינים כאן צריכים להיות זהים לאלה שמוצגים במסך ההסכמה ל-OAuth ובקובץ המניפסט של Apps Script, אם רלוונטי.
אם אתם כוללים יותר משילוב אפליקציה אחת, הקפידו להוסיף את היקפי ההרשאות מכל אחת מהן לדף 'הגדרת אפליקציה' ב-Marketplace SDK ולמסך ההסכמה ל-OAuth.
תמיד צריך להשתמש בהיקפים הכי מצומצמים שאפשר (לדוגמה, אל תכללו היקף מלא של Drive אם אתם צריכים רק היקף לקריאה בלבד).
לפרטים נוספים על פרויקטים של Apps Script, אפשר לעיין במאמר בנושא היקפי הרשאות.
מתן מידע על מפתח האפליקציה
בקטע פרטי המפתח, ממלאים את הפרטים ליצירת קשר ופרטים נוספים. השדות האלה מופיעים בדף האפליקציה בחנות.
| שדות | |
|---|---|
| סטטוס העסק |
עקב חוקים להגנת הצרכן, צרכנים שנמצאים באזור הכלכלי האירופי (EEA) צריכים לקבל מידע אם מוכר בזירת המסחר הוא עסק או לא עסק:
אם לא צוין סטטוס, התווית 'סטטוס הסוחר לא צוין' תופיע בדף האפליקציה בחנות. |
| שם המפתח | השם שיוצג כשם המחבר של האפליקציה. אם אתם סוחרים, צריך לציין את השם המסחרי או השם החוקי שלכם. |
| הכתובת למשלוח דואר של המפתח |
חובה לסוחרים. לא נאסף לגבי משתמשים שאינם עסק. המיקום של העסק. צריך להזין כתובת תקפה למשלוח דואר שאפשר ליצור איתך קשר באמצעותה. |
| כתובת האתר של המפתחים | האתר שבו אתם (או הארגון שלכם) מתוארים כמפתחים. |
| כתובת האימייל של המפתח |
כתובת האימייל שבה אפשר ליצור איתך קשר. היא לא נכללת בדף האפליקציה. חשוב לוודא שכתובת האימייל הזו מעודכנת, כי היא משמשת ל:
|
| כתובת האתר של האפליקציה | אופציונלי. האתר שבו יש תיאור נוסף של האפליקציה. |
שמירת הגדרות התצורה של האפליקציה ב-Marketplace SDK
בעזרת המידע מהקטע הקודם, שומרים את הגדרות האפליקציה ב-Marketplace SDK:
במסוף Google Cloud, נכנסים לדף App Configuration ב-Marketplace SDK:
ממלאים כל קטע לפי מה שקבעתם בקטע הקודם.
לוחצים על שמירת הטיוטה.
(אופציונלי) אתם יכולים לקבל ניתוח של השימוש באפליקציה ב-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. לאחר מכן, מקצים את התפקיד בהתאמה אישית לחשבון עם ההרשאות החסרות.
אפשר להשתמש ב-Primitive
roles/editorאו ב-roles/ownerלפרסום אפליקציות. עם זאת, במסמכי העזרה בנושא שימוש מאובטח ב-IAM, ההתנהלות הזו נחשבת לשיטה לא מומלצת כי אי אפשר להגביל בקלות את הרשאות העריכה למשאבים אחרים בפרויקט.