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 Pythona.

Czego się nauczysz

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

  • Prześlij uwierzytelnione żądanie do punktu końcowego InitiatePortabilityArchive, podając prawidłowy token OAuth. Odpowiedź to prawidłowa 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.
  • przechowywać token OAuth z dostępem czasowym, aby można było go później ponownie wykorzystać;
  • Wyślij uwierzytelnione żądanie do punktu końcowego ResetAuthorization. Ta prośba powoduje unieważnienie wszystkich przyznanych przez użytkownika zakresów protokołu OAuth.
  • Aby zastosować filtr czasowy w żądaniu, wyślij uwierzytelnione żądanie do punktu końcowego InitiatePortabilityArchive, podając prawidłowy token OAuth wraz z wartością start_time lub end_time.

Wymagania wstępne

Aby uruchomić to krótkie wprowadzenie:

  • Sprawdź, czy interfejs Data Portability API jest dostępny. Listę obsługiwanych krajów i regionów znajdziesz w sekcji Najczęstsze pytania na stronie „Udostępnianie kopii swoich danych innej firmie”.
  • Wykonaj czynności konfiguracyjne interfejsu Data Portability API i sprawdź, czy używasz nowego projektu.
  • uzyskać dostęp do konta należącego do organizacji lub kontrolowanego przez nią. W tym samouczku dane o aktywności związanej z wyszukiwaniem na tym koncie są eksportowane.

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

Konfiguracja protokołu OAuth

  • Aby skonfigurować OAuth w zainstalowanych aplikacjach, wykonaj podane czynności. Ta procedura jest podobna do procedury OAuth w aplikacji serwera WWW. Podczas konfigurowania identyfikatora klienta OAuth:
    • Typ aplikacji powinien być ustawiony jako Aplikacja komputerowa.
    • Po utworzeniu identyfikatora klienta pobierz obiekt tajny klienta w formacie JSON i nazwij plik: client_secrets.json.
    • Podczas konfigurowania zakresów interfejsu Data Portability API pamiętaj, że ten przewodnik używa tych grup zasobów:

Konfigurowanie Pythona

Aby uruchomić skrypt użyty w tym samouczku, musisz skonfigurować Pythona na komputerze lokalnym. Aby skonfigurować Pythona:

  • Zainstaluj narzędzie do zarządzania pakietami Pip oraz Pythona 3.11 (lub nowszego).
  • Zainstaluj bibliotekę klienta interfejsu API Google dla języka Python.

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

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

Uruchamianie skryptu

Ten skrypt używa przekierowania do localhosta w procesie OAuth. Ta opcja wymaga, aby aplikacja nasłuchiwała na porcie localhost, a następnie otwierała przeglądarkę systemową, aby zainicjować proces autoryzacji OAuth.

Kliknij ten link, aby otworzyć skrypt, lub pobierz jego kopię, klikając go prawym przyciskiem myszy.

Skrypt Pythona do szybkiego rozpoczęcia pracy z interfejsem Data Portability API

Aby uruchomić skrypt i wyeksportować pełny korpus danych, wpisz to polecenie:

python3 data-portability-quickstart.py

Aby używać różnych zakresów, określ je za pomocą --resources, na przykład:

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

Aby zastosować filtrowanie czasowe, użyj tego samego skryptu z flagami start_time i end_time. Na przykład:

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

Szczegółowe informacje o działaniach wykonywanych przez skrypt znajdziesz w komentarzach.