Wywoływanie interfejsu Data Portability API przy użyciu skryptu Pythona

W tym krótkim wprowadzeniu uzyskasz token OAuth dla swojego konta i wyślesz żądania do punktów końcowych interfejsu Data Portability API za pomocą skryptu w Pythonie.

Czego się uczysz

W tym krótkim wprowadzeniu używasz skryptu Pythona, aby:

  • Wyślij uwierzytelnione żądanie do punktu końcowego InitiatePortabilityArchive, podając prawidłowy token OAuth. Odpowiedź jest prawidłową wartością pola job_id.
  • Wyślij uwierzytelnione żądanie do punktu końcowego GetPortabilityArchiveState i pobierz dane. Odpowiedź powinna zawierać prawidłowy stan zadania, a po jego zakończeniu – podpisany adres URL.
  • Wyślij uwierzytelnione żądanie do punktu końcowego ResetAuthorization. To żądanie anuluje wszystkie zakresy OAuth przyznane przez użytkowników.

Wymagania wstępne

Aby uruchomić to krótkie wprowadzenie, musisz:

  • Sprawdź, czy masz dostęp do interfejsu Data Portability API. Listę obsługiwanych krajów i regionów znajdziesz w sekcji Najczęstsze pytania na stronie „Udostępnianie kopii swoich danych firmie zewnętrznej”.
  • Wykonaj instrukcje konfiguracji interfejsu Data Portability API i sprawdź, czy używasz nowego projektu.
  • Uzyskaj dostęp do konta należącego do Twojej organizacji lub przez nią kontrolowane. Dane o aktywności związanej z wyszukiwaniem na tym koncie są eksportowane z tego krótkiego wprowadzenia.

Zanim zaczniesz korzystać z tego krótkiego wprowadzenia, musisz też skonfigurować OAuth, Pythona i pakiet OAuth dla bibliotek klienta Pythona.

Skonfiguruj OAuth

  • Postępuj zgodnie z instrukcjami konfigurowania protokołu OAuth dla zainstalowanych aplikacji. Przypomina to przepływ OAuth w przypadku aplikacji serwera WWW. Po skonfigurowaniu identyfikatora klienta OAuth:
    • Jako Typ aplikacji wybierz Aplikacja komputerowa.
    • Po utworzeniu identyfikatora klienta pobierz tajny klucz klienta w formacie JSON i nadaj plikowi nazwę: client_secrets.json.
    • Podczas konfigurowania zakresów dla interfejsu Data Portability API zwróć uwagę na te grupy zasobów:

Skonfiguruj Pythona

Aby uruchomić skrypt użyty w tym krótkim wprowadzeniu, musisz skonfigurować Pythona na komputerze lokalnym. Aby skonfigurować Pythona:

  • Zainstaluj narzędzie do zarządzania pakietami Pip oraz język Python 3.9 (lub nowszy).
  • Zainstaluj bibliotekę klienta interfejsów API Google dla języka Python.

  • Zainstaluj pakiet google_auth_oauthlib dla biblioteki klienta Pythona, uruchamiając to polecenie. Ten pakiet zapewnia integrację oauthlib z google-auth – biblioteką uwierzytelniania Google dla Pythona.

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

Uruchom skrypt

Ten skrypt korzysta z przekierowania lokalnego hosta w procesie OAuth. Ta opcja wymaga, aby aplikacja nasłuchiwała na porcie lokalnego hosta, a następnie otworzyła przeglądarkę systemową w celu zainicjowania procesu autoryzacji OAuth.

Kliknij ten link, aby otworzyć skrypt, lub kliknij go prawym przyciskiem myszy, aby pobrać kopię skryptu.

Skrypt krótkiego wprowadzenia do interfejsu Data Portability API w Pythonie

Aby uruchomić skrypt, wpisz to polecenie:

python3 data-portability-quickstart.py

Działania wykonywane przez skrypt są opisane w komentarzach.