מבוא: פיתוח אפליקציות באמצעות 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. המשתמש לוחץ על Next במסך ההסכמה של 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

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

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

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

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

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

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

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

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

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

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

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