בדף הזה מוסבר איך להשתמש ב-Google Workspace Marketplace SDK כדי להגדיר ולנהל את האפליקציה ב-Google Workspace Marketplace.
כדי שהאפליקציה תהיה זמינה לשימוש, צריך להגדיר אותה ב-Marketplace SDK. Marketplace SDK הוא ערכת כלים שמאפשרת ליצור אפליקציה ולשלוט בה ב-Google Workspace Marketplace. אפשר להשתמש ב-Marketplace SDK כדי לנהל את ההגדרות של Marketplace, למשל:
- האם האפליקציה זמינה לארגון ספציפי ב-Google Workspace (אפליקציה פרטית) או לכל המשתמשים ב-Marketplace (אפליקציה ציבורית)
- סוגי המשתמשים ב-Marketplace שיכולים להתקין את האפליקציה
- אילו אפליקציות של Google Workspace האפליקציה שלכם משלבת
- היקפי ההרשאות של OAuth שהאפליקציה שלך דורשת
- מידע על מי פיתח את האפליקציה ומטפל בה
לא משנה אם אתם מפרסמים את האפליקציה באופן פרטי או ציבורי, עליכם להשתמש ב-Marketplace SDK כדי לנהל את האפליקציה ב-Marketplace.
הפעלת ה-SDK של Marketplace
אם עדיין לא עשיתם זאת, מפעילים את Google Workspace Marketplace SDK בפרויקט ב-Google Cloud.
פתיחת הפרויקט ב-Cloud במסוף Google Cloud
אם הוא עדיין לא פתוח, פותחים את פרויקט Cloud שבו רוצים להשתמש לדוגמה הזו:
- נכנסים לדף Select a project במסוף Google Cloud.
- בוחרים את הפרויקט ב-Google Cloud שבו רוצים להשתמש. לחלופין, לוחצים על Create project (יצירת פרויקט) ופועלים לפי ההוראות במסך. אם יוצרים פרויקט ב-Google Cloud, יכול להיות שתצטרכו להפעיל את החיוב בפרויקט.
הפעלת Google Workspace Marketplace SDK
לפני שמשתמשים ב-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 יוכלו להתקין את האפליקציה מדף המוצר בחנות ב-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 (Apps Script)
כדי לפרסם תוסף ל-Google Workspace, צריך לספק את מזהה הפריסה של התוסף. כדי למצוא את מזהה הפריסה:
- פותחים את התוסף ל-Google Workspace בעורך של Apps Script.
- לוחצים על Deploy(פריסה) > ניהול הפריסות.
- מתחת למזהה הפריסה, לוחצים על העתקה.
תוסף ל-Google Workspace (פריסות HTTP)
אם יצרתם את התוסף ל-Google Workspace באמצעות נקודות קצה (endpoint) של HTTP, תצטרכו לפעול לפי השלבים הבאים כדי לקבל את מזהה הפריסה ממשאב הפריסה של Google Cloud.
- בדף 'הגדרת האפליקציה', בקטע 'תוסף Google Workspace', לוחצים על HTTP או פריסות אחרות > Select Deployment (פריסה).
- בוחרים את הפריסה שרוצים לפרסם.
- לוחצים על בחירה.
תוסף לעריכה (Docs, Sheets, Slides, Forms)
כדי לפרסם תוסף Editor, צריך לציין את מזהה הסקריפט של הפרויקט ואת הגרסה שרוצים לפרסם.
כדי למצוא את מזהה הסקריפט של הפרויקט, פועלים לפי השלבים הבאים:
- פותחים את התוסף בעורך של Apps Script.
- בצד ימין, לוחצים על Project settings (הגדרות הפרויקט) .
- בקטע 'מזהים', מעתיקים את מזהה הסקריפט.
כדי למצוא את הגרסה, צריך לפעול לפי השלבים הבאים:
- פותחים את התוסף בעורך Apps Script.
- בפינה השמאלית העליונה, לוחצים על פריסה > ניהול הפריסות.
- מספר הגרסה מופיע בקטע 'הגדרה'.
אפליקציית Google Chat
כדי לפרסם אפליקציית Google Chat, צריך להגדיר את Google Chat API. פרסום אפליקציות ב-Google Chat
אפליקציית Drive
כדי לפרסם אפליקציית Drive, צריך להפעיל ולהגדיר את Google Drive API.
אפליקציית אינטרנט
כדי לפרסם אפליקציית אינטרנט, צריך לספק את כתובת ה-URL הניווטית האוניברסלית שלה, כלומר כתובת ה-URL שמפנה לאפליקציית האינטרנט מתפריט האפליקציות של Google
. אפליקציית האינטרנט צריכה להיות מופעלת בסביבת הייצור ופועלת באופן מלא.כשממלאים את דף האפליקציה בחנות, צריך לספק סמלים נוספים בגודל 96x96 ו-48x48 פיקסלים.
אם פיתחתם את אפליקציית האינטרנט ב-Apps Script, עליכם לפעול לפי השלבים הבאים כדי לקבל את כתובת ה-URL הגלובלית של הניווט:
- פותחים את התוסף ל-Google Workspace בעורך של Apps Script.
- לוחצים על Deploy(פריסה) > NewDeploy (פריסה חדשה).
- בקטע 'בחירת סוג', לוחצים על אפליקציית אינטרנט.
- ממלאים את האפשרויות ולוחצים על פריסה.
- לוחצים על Copy.
מציינים את רמת הגישה שנדרשת לאפליקציה
בקטע OAuth Scopes, מספקים רשימה מלאה של היקפי ההרשאות של OAuth 2.0 שנדרשים לאפליקציה. היקפי ההרשאות של OAuth שתזינו כאן צריכים להתאים לאלה שמוצגים במסך ההסכמה ל-OAuth, ואם רלוונטי, גם למניפסט של Apps Script.
אם אתם כוללים יותר משילוב אפליקציה אחד, חשוב להוסיף את ההיקפים של כל אחד מהם לדף ההגדרות של אפליקציית Marketplace SDK ולמסך ההסכמה של OAuth.
כדאי להשתמש תמיד בהיקפים המצומצמים ביותר (למשל, לא כדאי לכלול היקף מלא ב-Drive אם אתם צריכים רק היקף לקריאה בלבד).
לפרטים נוספים על פרויקטים ב-Apps Script, ראו היקפי הרשאה.
מתן מידע על מפתח האפליקציה
בקטע פרטים למפתחים, ממלאים את הפרטים ליצירת קשר ופרטים נוספים. השדות האלה מופיעים בדף האפליקציה בחנות.
שדות | |
---|---|
סטטוס העסק |
עקב חוקים להגנת הצרכן, עלינו ליידע צרכנים שנמצאים באזור הכלכלי האירופי (EEA) אם מוכר ב-Google Workspace Marketplace הוא עסק או לא עסק:
אם לא יצוין סטטוס, יופיע הכיתוב 'לא מצוין סטטוס העסק' בדף האפליקציה בחנות. |
שם המפתח | השם שיוצג ככותב האפליקציה. אם אתם סוחרים, עליכם לציין את השם המסחרי או את השם החוקי שלכם. |
כתובת למשלוח דואר של המפתח |
חובה למוכרים. לא נאספים ממשתמשים שאינם עסקים. המיקום של העסק. צריך להזין כתובת תקינה למשלוח דואר שבה אפשר ליצור איתך קשר. |
כתובת ה-URL של אתר המפתח | האתר שמתאר אותך (או את הארגון שלך) כמפתח. |
כתובת אימייל למפתחים |
כתובת האימייל שתשמש כאיש קשר. הוא לא נכלל בדף האפליקציה. חשוב לוודא שכתובת האימייל הזו מתעדכנת כי נעשה בה שימוש:
|
כתובת האתר של האפליקציה | זה שינוי אופציונלי. האתר שמכיל תיאור נוסף של האפליקציה. |
שמירת ההגדרות של האפליקציה ב-Marketplace SDK
בעזרת המידע מהקטע הקודם, שומרים את הגדרות האפליקציה ב-Marketplace SDK:
נכנסים לדף Configuration של Marketplace SDK במסוף Google Cloud:
ממלאים כל סעיף על סמך מה שקבעתם בסעיף הקודם.
לוחצים על שמירה.
(אופציונלי) אתם יכולים לקבל ניתוח נתונים על השימוש באפליקציה ב-Google Analytics. לשם כך, מוסיפים מזהה Google Analytics ב-Marketplace SDK.
- עוברים לכרטיסייה Analytics.
- מזינים את מזהה Google Analytics.
- לוחצים על שמירה.