מבוא: פיתוח אפליקציות באמצעות Data Portability API

באמצעות Data Portability API אפשר ליצור אפליקציות שמבקשות מהמשתמשים הרשאה להעביר עותק של נתונים משירותי Google לאפליקציה. כך מתאפשרת ניידות הנתונים ומקל על מעבר בין שירותים.

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

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

לפני שמשיקים את האפליקציה, היא צריכה לקבל אישור מ-Google.

בנוסף, צריך לוודא ש-Data Portability API זמין למשתמשים במיקום שלכם. לרשימת המדינות והאזורים הנתמכים אפשר לעיין בשאלות נפוצות בדף 'שיתוף עותק של הנתונים עם צד שלישי'.

תהליך עבודה למפתחים

אלה השלבים ליצירת אפליקציה שמשתמשת ב-Data Portability API.

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

   1. המשתמש לוחץ על ייבוא סרטונים מ-YouTube ונכנס לחשבון Google שלו.

   2. האפליקציה מפנה את המשתמש לכתובת URL של הסכמה ל-OAuth. שימו לב שכתובת ה-URL לדוגמה הזו פשוטה יותר וחסרים בה כמה פרמטרים:

      https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.googleapis.com/auth/dataportability.myactivity.youtube

   3. המשתמש לוחץ על הבא במסך ההסכמה של OAuth, מסכים לשתף את הנתונים שלו ומספק גישה לחשבון.

   4. המשתמש יופנה לאפליקציה.

   5. המפתח מקבל אסימון OAuth עבור המשתמש.

2. האפליקציה קוראת ל-InitiatePortabilityArchive(resources = ["myactivity.youtube"]) עם אסימון OAuth מצורף שמכיל את היקף הרשאות ה-OAuth הזה:

   https://www.googleapis.com/auth/dataportability.myactivity.youtube

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

3. האפליקציה שלכם קוראת ל-GetPortabilityArchiveState(job_id) עם אסימון OAuth מצורף שמכיל את היקף ההרשאות הזה של OAuth:

   https://www.googleapis.com/auth/dataportability.myactivity.youtube

   אפשר לקרוא ל-method הזה כמה פעמים כדי לאחזר את הסטטוס של משימת הארכיון. השיטה מחזירה את מצב המשימה. אם המצב הוא COMPLETE, הארכיון מוכן ומוצגות כתובות URL חתומות של Cloud Storage. לתשומת ליבך, הזמן הנדרש להשלמת הבקשה להעברה לארכיון עשוי להשתנות מדקות לשעות, בהתאם לגודל הנתונים.

4. מורידים את הארכיון של הנתונים באמצעות כתובות ה-URL החתומות.

5. כדי לאפס משאבים שנגמרו ולהסיר את כל הסכמות ה-OAuth, צריך להפעיל את ResetAuthorization() עם אסימון OAuth מצורף.

מידע נוסף על השימוש בשיטות של Data Portability API זמין במאמר קריאה לשיטות של Data Portability API.

איך המשתמשים יוצרים אינטראקציה עם אפליקציה של Data Portability API

בתרשים הזה מוצגת האינטראקציה של המשתמשים עם אפליקציה שמשולבת עם Data Portability API.

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

2. לאחר מכן, המשתמש נכנס לחשבון Google שלו.

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

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

5. אחרי שמאשרים את הגישה, ייבוא הנתונים מתחיל. תהליך השלמת הבקשה עשוי להימשך כמה דקות עד כמה שעות, בהתאם לגודל הנתונים.