הגדרת OAuth לאפליקציה

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

הגדרת תהליך עבודה של OAuth

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

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

היקפי הרשאות OAuth של Data Portability API

כשמגדירים את האפליקציה של Data Portability API ל-OAuth, צריך להפעיל את היקפי הרשאות ה-OAuth של Data Portability API שרלוונטיים לאפליקציה. יש היקפים מסוימים שהם sensitive ו-restricted, והם כפופים לדרישות נוספות.

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

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

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

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

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

הגבלות היקף

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

היקפים מעורבים

אי אפשר לשלב בקשות להיקפי Data Portability API (כמו https://www.googleapis.com/auth/dataportability.*) עם היקפים אחרים (כמו https://www.googleapis.com/auth/userinfo.email). זו דוגמה לבקשה שגויה, שבה החלק המוגבל מודגש:

https://accounts.google.com/o/oauth2/v2/auth?
client_id=client_id&
redirect_uri=redirect_uri&
response_type=token&
scope=https://www.googleapis.com/auth/dataportability.myactivity.search+https://www.googleapis.com/auth/userinfo.email&
include_granted_scopes=false

היקפי הרשאות שהוענקו בעבר

אף פעם לא צריך להגדיר את include_granted_scopes=true כשמבקשים היקפי DPAPI. דוגמה לבקשה לא תקינה, שבה החלק המוגבל מודגש:

https://accounts.google.com/o/oauth2/v2/auth?
client_id=client_id&
redirect_uri=redirect_uri&
response_type=token&
scope=https://www.googleapis.com/auth/dataportability.myactivity.search&
include_granted_scopes=true

קטגוריות של היקפים

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