Wprowadzenie: programowanie aplikacji przy użyciu interfejsu Data Portability API

Interfejs Data Portability API umożliwia tworzenie aplikacji, które proszą użytkownika o autoryzację przeniesienia kopii danych z usług Google do Twojej aplikacji. Umożliwia to przenoszenie danych i ułatwia przełączanie usług.

Jeśli szukasz informacji o tym, jak użytkownicy udostępniają dane, zapoznaj się z artykułem Udostępnianie kopii swoich danych innej firmie.

Wymagania wstępne

Przed opublikowaniem aplikacji musi ona zostać zatwierdzona przez Google.

Sprawdź też, czy interfejs Data Portability API jest dostępny dla użytkowników w Twojej lokalizacji. Listę obsługiwanych krajów i regionów znajdziesz w sekcji Najczęstsze pytania na stronie „Udostępnianie kopii swoich danych innej firmie”.

Proces dla programistów

Aby utworzyć aplikację korzystającą z interfejsu Data Portability API, wykonaj te czynności.

1. Wdrożyć proces uzyskiwania zgody OAuth przez użytkownika. W tym przykładzie użytkownik udostępnia dane dotyczące filmów w YouTube.

   1. Użytkownik klika Importuj filmy z YouTube i loguje się na swoje konto Google.

   2. Aplikacja przekierowuje użytkownika pod adres URL zgody OAuth. Pamiętaj, że ten przykładowy adres URL jest uproszczony i nie zawiera niektórych parametrów:

      https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.googleapis.com/auth/dataportability.myactivity.youtube

   3. Użytkownik klika Dalej na ekranie zgody OAuth, zgadza się na udostępnienie danych i przekazuje dostęp do konta.

   4. Użytkownik zostaje przekierowany do aplikacji.

   5. Deweloper uzyskuje token OAuth dla użytkownika.

2. Aplikacja wywołuje InitiatePortabilityArchive(resources = ["myactivity.youtube"]) z dołączonym tokenem OAuth, który zawiera ten zakres protokołu OAuth:

   https://www.googleapis.com/auth/dataportability.myactivity.youtube

   To wywołanie inicjuje proces tworzenia archiwum danych. Należy rozpocząć archiwizację danych w ciągu 24 godzin od autoryzacji użytkownika.

3. Twoja aplikacja wywołuje funkcję GetPortabilityArchiveState(job_id) z dołączonym tokenem OAuth, który zawiera ten zakres OAuth:

   https://www.googleapis.com/auth/dataportability.myactivity.youtube

   Możesz wywołać tę metodę wiele razy, aby pobrać stan zadania archiwizacji. Metoda zwraca stan zadania. Jeśli stan to UKOŃCZONO, archiwum jest gotowe i dostępne są podpisane adresy URL Cloud Storage. Pamiętaj, że czas potrzebny na przetworzenie żądania archiwizacji może się różnić w zależności od rozmiaru danych (od kilku minut do kilku godzin).

4. Pobierz archiwum danych, używając podpisanych adresów URL.

5. Aby zresetować wyczerpane zasoby i usunąć wszystkie zgody OAuth, wywołaj funkcję ResetAuthorization() z dołączonym tokenem OAuth.

Więcej informacji o korzystaniu z metod interfejsu Data Portability API znajdziesz w artykule Call Data Portability API.

Jak użytkownicy korzystają z aplikacji korzystającej z interfejsu Data Portability API

Ten diagram pokazuje, jak użytkownicy wchodzą w interakcję z aplikacją zintegrowaną z interfejsem Data Portability API.

1. Najpierw użytkownikowi wyświetla się opcja pobrania danych.

2. Następnie użytkownik loguje się na swoje konto Google.

3. Następnie użytkownik klika Dalej, gdy zostanie poproszony o udostępnienie danych, i klika OK, gdy zostanie poproszony o zaakceptowanie polityki prywatności.

4. Następnie wyświetla się ekran zgody OAuth, który służy do zezwolenia aplikacji na dostęp do danych użytkownika. Dostępne opcje są zgodne ze skonfigurowanymi przez Ciebie zakresami protokołu OAuth.

5. Po udzieleniu dostępu rozpocznie się importowanie danych. W zależności od rozmiaru danych realizacja żądania może potrwać od kilku minut do kilku godzin.