קריאה ל-Data Portability API באמצעות סקריפט של Python

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

מה תלמדו

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

  • שולחים בקשה מאומתת לנקודת הקצה InitiatePortabilityArchive על ידי הצגת אסימון OAuth תקף. התגובה היא job_id תקין.
  • שולחים בקשה מאומתת לנקודת הקצה GetPortabilityArchiveState ומורידים את הנתונים. התגובה צריכה לכלול מצב עבודה תקין, וכשהמשימה תושלם, כתובת URL חתומה.
  • אחסון של אסימון OAuth עם גישה מבוססת-זמן לשימוש חוזר מאוחר יותר.
  • שולחים בקשה מאומתת לנקודת הקצה ResetAuthorization. הבקשה הזו מבטלת את כל היקפי ה-OAuth שהמשתמשים העניקו.
  • כדי להחיל מסנן זמן על הבקשה, שולחים בקשה מאומתת לנקודת הקצה InitiatePortabilityArchive ומספקים טוקן OAuth תקף יחד עם start_time או end_time.

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

כדי להריץ את המדריך למתחילים הזה, צריך:

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

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

הגדרת OAuth

  • פועלים לפי השלבים כדי להגדיר את OAuth לאפליקציות מותקנות. התהליך הזה דומה לתהליך OAuth באפליקציות של שרת אינטרנט. כשמגדירים את מזהה הלקוח ב-OAuth:
    • הערך של Application type צריך להיות Desktop app.
    • אחרי שיוצרים את מזהה הלקוח, מורידים את הסוד של הלקוח בפורמט JSON ומעניקים לקובץ את השם: client_secrets.json.
    • כשמגדירים היקפים ל-Data Portability API, חשוב לזכור שבמדריך למתחילים הזה נעשה שימוש בקבוצות המשאבים הבאות:

הגדרת Python

כדי להריץ את הסקריפט שמשמש במדריך למתחילים הזה, צריך להגדיר את Python במחשב המקומי. כדי להגדיר את Python:

  • מתקינים את הכלי לניהול חבילות Pip ואת Python 3.11 (או גרסה מתקדמת יותר).
  • מתקינים את ספריית הלקוח של Google API ל-Python.

  • מריצים את הפקודה הבאה כדי להתקין את החבילה google_auth_oauthlib של ספריית הלקוח של Python. החבילה הזו מספקת שילוב של oauthlib עם google-auth – ספריית האימות של Google ל-Python.

    pip install google-auth-oauthlib google-api-python-client --upgrade

מריצים את הסקריפט

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

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

סקריפט למתחילים ב-Python ל-Data Portability API

כדי להריץ את הסקריפט ולייצא את מאגר הנתונים המלא, מזינים את הפקודה הבאה:

python3 data-portability-quickstart.py

כדי להשתמש בהיקפים שונים, מציינים אותם באמצעות --resources, לדוגמה:

python3 data-portability-quickstart.py --resources myactivity.shopping myactivity.play

כדי להחיל סינון לפי זמן, משתמשים באותו סקריפט עם הדגלים start_time ו-end_time. לדוגמה:

python3 data-portability-quickstart.py --start_time 2023-01-01T12:00:00Z --end_time 2024-01-01T12:00:00Z

הפעולות שהסקריפט ביצע מפורטות בתגובות.