הגדרת האפליקציה ב-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.

פותחים את פרויקט Cloud במסוף Google Cloud

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

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

    בוחרים פרויקט ב-Cloud

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

הפעלת Marketplace SDK

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

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

    הפעלת ה-SDK

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

במאמר הזה מפורטות ההגדרות שזמינות בדף App Configuration ב-Marketplace SDK.

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

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

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

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

  • לשלוט אם המשתמשים יכולים לראות אפליקציות ב-Marketplace ולהתקין אפליקציות בשם המשתמשים שלהם.
  • להשתמש ברשימת היתרים כדי לנהל ולבחור אפליקציות לארגון. אם אתם מפתחים אפליקציה לארגון שמשתמש ברשימות היתרים, כדאי לבדוק עם האדמין אם אפשר להוסיף את האפליקציה לרשימת ההיתרים.
  • להשבית אפליקציות מסוימות של Google Workspace, למשל להסיר את הגישה ל-Google Chat, לאפליקציות של Google Chat או לשניהם. במקרים האלה, המשתמשים לא יוכלו להתקין את האפליקציה מ-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 Workspace.

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

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

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

תוסף ל-Google Workspace

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

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

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

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

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

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

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

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

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

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

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

אפליקציית Google Chat

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

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

אפליקציית 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, אם רלוונטי.

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

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

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

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

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

שדות
סטטוס העסק

עקב חוקים להגנת הצרכן, צרכנים שנמצאים באזור הכלכלי האירופי (EEA) צריכים לקבל מידע אם מוכר בזירת המסחר הוא עסק או לא עסק:

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

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

שם המפתח השם שיוצג כשם המחבר של האפליקציה. אם אתם סוחרים, צריך לציין את השם המסחרי או השם החוקי שלכם.
הכתובת למשלוח דואר של המפתח

חובה לסוחרים. לא נאספים נתונים לגבי משתמשים שאינם עסק.

המיקום של העסק. צריך להזין כתובת תקפה למשלוח דואר שאפשר ליצור איתך קשר דרכה.

כתובת האתר של המפתח האתר שבו אתם (או הארגון שלכם) מתוארים כמפתחים.
כתובת האימייל של המפתח

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

  • אם Google צריכה ליצור קשר עם המפתח – למשל, במהלך תהליך בדיקת האפליקציה.
  • כדי לשלוח משוב מתוספי Editor אם כתובת האתר של הדף 'דיווח על בעיה' לא מופיעה בדף של כרטיס המוצר בחנות.
כתובת האתר של האפליקציה אופציונלי. האתר שבו יש תיאור נוסף של האפליקציה.

שמירת הגדרות התצורה של האפליקציה ב-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, ההרשאה הזו נחשבת לשיטה לא מומלצת כי אי אפשר להגביל בקלות את הרשאת העריכה למשאבים אחרים בפרויקט.