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

Interfejs Data Portability API umożliwia tworzenie aplikacji, które wymagają od użytkownika autoryzacji w celu przeniesienia kopii danych z usług Google do Twojej aplikacji. Ułatwia to przenoszenie danych i przełączanie usług.

Jeśli szukasz informacji o udostępnianiu danych przez użytkowników, przeczytaj artykuł Udostępnianie kopii swoich danych innej firmie.

Wymagania wstępne

Zanim opublikujesz aplikację, 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 firmom zewnętrznym”.

Przepływ pracy programisty

Poniżej znajdziesz instrukcje tworzenia aplikacji korzystającej z interfejsu Data Portability API.

1. Zaimplementuj proces uzyskiwania zgody OAuth dla użytkownika. W tym przykładzie użytkownik udostępnia dane o filmach 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. Zauważ, że ten przykładowy adres URL jest uproszczony i brakuje w nim 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 swoich danych i przyznaje dostęp do konta.

   4. Użytkownik zostanie przekierowany do aplikacji.

   5. Deweloper otrzymuje token OAuth dla użytkownika.

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

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

   Ta rozmowa rozpoczyna proces tworzenia archiwum danych. Tworzenie archiwum przenośności należy rozpocząć w ciągu 24 godzin od autoryzacji użytkownika.

3. Aplikacja wywołuje metodę GetPortabilityArchiveState(job_id) z załączonym tokenem OAuth, który zawiera ten zakres OAuth:

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

   Możesz wywoływać tę metodę wiele razy, aby pobrać stan zadania archiwizacji. Metoda zwraca stan zadania. Jeśli stan to ZAKOŃCZONO, archiwum jest gotowe i dostarczane są podpisane adresy URL Cloud Storage. Czas potrzebny na wykonanie żądania archiwizacji może wynosić od kilku minut do kilku godzin w zależności od ilości danych.

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

5. Wywołaj metodę ResetAuthorization() z dołączonym tokenem OAuth, aby zresetować wyczerpane zasoby i usunąć wszystkie zgody OAuth.

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

Jak użytkownicy korzystają z aplikacji Data Portability API

Ten diagram pokazuje, jak użytkownicy korzystają z aplikacji zintegrowanej z interfejsem Data Portability API.

1. Po pierwsze użytkownik ma możliwość odzyskania danych.

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

3. Gdy pojawi się prośba o udostępnienie danych, użytkownik klika Dalej, a gdy pojawi się prośba o zaakceptowanie polityki prywatności, klika OK.

4. Następnie wyświetla się ekran zgody OAuth, na którym aplikacja ma dostęp do swoich danych. Dostępne opcje pasują do skonfigurowanych zakresów OAuth.

5. Gdy zezwolisz na dostęp, rozpocznie się import danych. W zależności od ilości danych przetworzenie żądania może potrwać od kilku minut do kilku godzin.