לפני שמשיקים למשתמשים חיצוניים אפליקציה שמבקשת פרטי כניסה של משתמשים ל-Data Manager API, הפרויקט ב-Google Cloud צריך לעבור אימות של אפליקציית Google OAuth.
במדריך הזה מוסבר איך להגדיר את הקהל במהלך הפיתוח ואיך להשלים את אימות האפליקציה ב-Google OAuth.
שלבים של קהל באפליקציה
בהתאם לשלב הפיתוח, מגדירים את הדף Audience במסוף Google Cloud עם הגדרות שונות של User type ו-Publishing status. כדי שהמעבר מהבדיקה הראשונית להשקה בסביבת הייצור יהיה חלק, כדאי לפעול לפי השלבים הבאים.
שלב 1: פיתוח ראשוני (בדיקה)
כשמתחילים לפתח ולבדוק בקשות API בסיסיות:
סטטוס הפרסום: מוגדר לבדיקה.
סוג המשתמש:
אם פרויקט בענן ב-Google Cloud שייך לארגון ב-Google Workspace ורק משתמשים בארגון משתמשים באפליקציה, בוחרים באפשרות Internal.
אחרת, בוחרים באפשרות חיצוני.
משתמשי בדיקה: אם הגדרתם את סוג המשתמש ל-חיצוני, לחצו על הוספת משתמשים כדי להוסיף באופן ידני את חשבונות Google שבהם אתם משתמשים כדי ליצור פרטי כניסה. רק חשבונות Google שמופיעים ברשימה יכולים לאשר את האפליקציה, וחלים מגבלות בדיקה וכללים לתפוגת תוקף של טוקנים.
לא נדרש אימות במהלך הבדיקה. אם אתם משתמשים באפשרות חיצוני, למשתמשי הבדיקה יוצג מסך אזהרה שמאשר שיש להם גישת בדיקה לאפליקציה לא מאומתת לפני שהם ממשיכים למסך ההסכמה.
שלב 2: לקראת ההשקה (שליחת בקשת אימות)
כשהשילוב הושלם, ממשק המשתמש נבנה ואתם מתכננים להשיק את האפליקציה בחודש הקרוב:
מעדכנים את ההגדרות בדף הקהל:
סטטוס הפרסום: עובר לסטטוס בייצור.
סוג המשתמש: אם האפליקציה משרתת לקוחות מחוץ לארגון, כמו לקוחות של מפרסמים, צריך להגדיר את סוג המשתמש כ-External.
שולחים את האפליקציה לאימות. תהליך האימות של אפליקציית Google OAuth יכול להימשך כמה שבועות, לכן כדאי לשלוח את הבקשה כמה שיותר מוקדם אחרי שממשק המשתמש מוכן.
הדרישות לאימות האפליקציה
כדי לשלוח את האפליקציה לאימות במרכז האימות, צריך לקבוע את ההגדרות של פלטפורמת האימות של Google ולהכין את החומרים הנדרשים לאימות.
מיתוג ומדיניות פרטיות
בדף המיתוג במסוף Google Cloud, בודקים את הפרטים הבאים לפני ששולחים את הבקשה:
דף הבית של האפליקציה: דף הבית צריך להיות נגיש לכולם ולכלול קישור גלוי למדיניות הפרטיות של האפליקציה.
קישור למדיניות הפרטיות: כתובת ה-URL של מדיניות הפרטיות שמוגדרת בדף המיתוג צריכה להיות זהה לכתובת ה-URL של מדיניות הפרטיות שמקושרת לדף הבית של האפליקציה.
היקפי הרשאות לאימות
בדף Data Access, מבקשים רק את היקפי ההרשאות שהאפליקציה צריכה. Data Manager API משתמש בהיקפי הרשאות רגישים:
https://www.googleapis.com/auth/datamanager(היקף ראשי)
https://www.googleapis.com/auth/datamanager.partnerlink(לקישורים של שותפים)
בבקשת האימות, צריך לספק הסבר מפורט בכתב למה האפליקציה צריכה גישה להיקפים המבוקשים.
פרטים ליצירת קשר
צוות האימות של Google OAuth שולח את כל ההודעות לבעלי הפרויקט ולעורכי הפרויקט שמוגדרים בפרויקט ב-Google Cloud. חשוב לעדכן את הפרטים ליצירת קשר במסוף Google Cloud כדי לא לפספס בקשות למידע.
אם צוות האימות שולח שאלות המשך או מבקש עדכונים (כמו שינויים בסרטון ההדגמה או בהגדרות של מסך ההסכמה), הבדיקה מושהית עד שתגיבו. אם הבקשה שלכם ממתינה יותר מכמה שבועות בלי עדכון, בדקו את תיבות הדואר הנכנס (כולל תיקיות הספאם והדואר הזבל) של כל Project Owner ובעלי הרשאות העריכה בפרויקט.
סרטון הדגמה
צריך לספק קישור לסרטון הדגמה שגלוי לכולם (למשל, סרטון לא רשום ב-YouTube או קישור ציבורי ל-Google Drive) שמראה איך האפליקציה משתמשת בהיקפי ההרשאות המבוקשים.
חשוב לוודא שהסרטון עומד בכל הדרישות לסרטון הדגמה של תכונות האפליקציה, כולל הבדיקות הבאות של Data Manager API:
התהליך המלא שעובר המשתמש והרשאת OAuth: הציגו את התהליך המלא שעובר המשתמש באפליקציה, החל מהשלב שבו המשתמש מתחיל את תהליך הכניסה או האימות ועד להשלמת תהליך הרשאת ה-OAuth.
זהות האפליקציה תואמת: ודאו שהשם, הלוגו והמיתוג של האפליקציה שמוצגים בסרטון תואמים להגדרות בדף המיתוג במסוף Google Cloud.
מסך הסכמה מלא ל-OAuth באנגלית: צריך להציג את כל מסך ההסכמה ל-OAuth, כשבורר השפה בפינה הימנית התחתונה מוגדר לאנגלית. חשוב לוודא שבמסך מוצגים בדיוק ההיקפים של Data Manager API שהאפליקציה מבקשת.
השימוש בהיקף ההרשאות בממשק המשתמש של האפליקציה: צריך להדגים את התכונות באפליקציה שמשתמשות בהיקפי ההרשאות המבוקשים (לדוגמה, יצירת קישור לשותף, יצירת רשימת קהלים או הגדרת הטמעת נתונים בממשק המשתמש של האפליקציה).
שלב 3: מוכן להפעלה (מאומת)
אחרי שצוות האימות של Google OAuth יודיע לכם שבקשת אימות האפליקציה אושרה, לא תצטרכו לעשות שום דבר. האפליקציה מאומתת עכשיו, ומשתמשים חיצוניים יכולים לאשר אותה בלי שיוצג להם מסך האזהרה לגבי אפליקציה לא מאומתת.