הגדרת OAuth

כשמפרסמים אפליקציה, יש 4 משימות עיקריות שצריך להשלים כדי לבצע אימות והרשאה:

  1. ממלאים את מסך ההסכמה של OAuth.
  2. יוצרים את פרטי הכניסה ל-OAuth 2.0.
  3. הגדרת כל ההיקפים הנדרשים להפעלת האפליקציה ב-Google Workspace Marketplace SDK
  4. שליחת האפליקציה לאימות OAuth.

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

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

לדוגמה, אם מפרסמים אפליקציה שכוללת תוסף ל-Google Sheets ותוסף ל-Google Docs, המניפסט של כל תוסף ב-Apps Script יכלול רק את ההיקפים הספציפיים לתוסף. בפרויקט ב-Google Cloud, מסך ההסכמה ל-OAuth ו-Google Workspace Marketplace SDK כוללים את ההיקפים של שני התוספים.

דרישות מוקדמות

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

  1. במסוף Google Cloud, נכנסים לתפריט > APIs & Services > OAuth consent screen.

    מעבר למסך ההסכמה של OAuth

  2. בוחרים את סוג המשתמש באפליקציה ולוחצים על Create.
  3. ממלאים את טופס הרישום של האפליקציה ולוחצים על שמירה והמשך.

  4. אם אתם יוצרים אפליקציה לשימוש מחוץ לארגון שלכם ב-Google Workspace, לוחצים על Add or Remove Scopes. מומלץ להשתמש בשיטות המומלצות הבאות בבחירת ההיקפים:

    • בוחרים את היקפי ההרשאות שמספקים את רמת הגישה המינימלית שנדרשת לאפליקציה. רשימה של היקפי ההרשאות הזמינים מופיעה במאמר היקפי OAuth 2.0 ל-Google APIs.
    • בודקים את ההיקפים שמפורטים בכל אחד משלושת הקטעים: היקפים לא רגישים, היקפים רגישים והיקפים מוגבלים. לגבי כל ההיקפים שמפורטים בקטעים 'ההיקפים הרגישים שלך' או 'ההיקפים המוגבלים שלך', נסו לזהות היקפים חלופיים שאינם רגישים כדי למנוע בדיקות נוספות מיותרות.
    • לחלק מההיקפים נדרשות בדיקות נוספות מצד Google. באפליקציות שמשמשות רק באופן פנימי בארגון שלכם ב-Google Workspace, ההיקפים לא מופיעים במסך ההסכמה, והשימוש בהיקפים מוגבלים או רגישים לא מחייב בדיקה נוספת על ידי Google. מידע נוסף זמין במאמר קטגוריות היקף.
  5. אחרי שבוחרים את ההיקפים הנדרשים לאפליקציה, לוחצים על Save and Continue (שמירה והמשך).
  6. אם בחרתם באפשרות חיצוני לסוג המשתמש, מוסיפים משתמשי בדיקה:
    1. בקטע משתמשי בדיקה, לוחצים על הוספת משתמשים.
    2. מזינים את כתובת האימייל שלכם ואת כתובות האימייל של כל משתמשי הבדיקה המורשים האחרים, ולוחצים על Save and Continue (שמירה והמשך).
  7. בודקים את סיכום רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם הרשמת האפליקציה נראית תקינה, לוחצים על Back to Dashboard.

2. יצירת פרטי הכניסה ל-OAuth 2.0

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

אם פיתחתם את האפליקציה ב-Apps Script

מעבירים את הפרויקט של Apps Script מפרויקט ברירת המחדל ב-Google Cloud לפרויקט החדש הרגיל. למידע נוסף, ראו מעבר לפרויקט רגיל אחר.

אחרי שמקשרים את הפרויקט ב-Apps Script לפרויקט ב-Google Cloud, פרטי הכניסה ל-OAuth 2.0 נוצרים באופן אוטומטי.

אם לא השתמשתם ב-Apps Script כדי לפתח את האפליקציה

במאמר פרטי כניסה של מזהה לקוח OAuth מוסבר איך יוצרים את פרטי הכניסה ל-OAuth 2.0.

3. הגדרת היקפי הרשאות

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

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

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

4. שליחת בקשה לאימות OAuth (אפליקציות ציבוריות בלבד)

אם אפליקציה ציבורית משתמשת בהיקפים רגישים או מוגבלים, היא צריכה לעבור תהליך בדיקה לאימות ב-OAuth.

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

כדי לשלוח את הבקשה לאימות:

  1. במסוף Google Cloud, נכנסים לתפריט > APIs & Services > OAuth consent screen.

    מעבר למסך ההסכמה של OAuth

  2. לוחצים על Project selector ובוחרים את הפרויקט הרצוי.
  3. לוחצים על עריכת האפליקציה.
  4. מזינים את הפרטים הנדרשים ולוחצים על שליחה לאימות.
  5. בתיבת הדו-שיח Verification required, מזינים את נימוקי ההצדקה המתאימים ולוחצים על Submit כדי להתחיל את תהליך האימות.

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

מה ההבדל בין אימות OAuth לבין בדיקת אפליקציות

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

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