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

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

מה לומדים

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

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

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

על מנת להפעיל את המדריך למתחילים:

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

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

הגדרת OAuth

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

הגדרת Python

עליכם להגדיר את Python במכונה המקומית כדי להריץ את הסקריפט במדריך למתחילים. כדי להגדיר את Python:

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

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

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

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

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

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

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

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

python3 data-portability-quickstart.py

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