Pengantar: Mengembangkan aplikasi menggunakan Data Portability API

Data Portability API memungkinkan Anda membangun aplikasi yang meminta otorisasi dari pengguna untuk memindahkan salinan data dari layanan Google ke aplikasi Anda. Hal ini memungkinkan portabilitas data dan memfasilitasi peralihan layanan.

Jika Anda mencari informasi tentang cara pengguna berbagi data, lihat Membagikan salinan data Anda kepada pihak ketiga.

Prasyarat

Sebelum merilis aplikasi, aplikasi harus disetujui oleh Google.

Anda juga harus memverifikasi bahwa Data Portability API tersedia untuk pengguna di lokasi Anda. Untuk mengetahui daftar negara dan wilayah yang didukung, lihat Pertanyaan Umum di halaman "Membagikan salinan data Anda kepada pihak ketiga".

Alur kerja developer

Berikut adalah langkah-langkah yang Anda ikuti untuk membuat aplikasi yang menggunakan Data Portability API.

Langkah-langkah yang diikuti developer untuk membuat aplikasi menggunakan Data Portability API

  1. Terapkan alur izin OAuth untuk pengguna. Dalam contoh ini, pengguna memberikan akses ke data video YouTube.

    1. Pengguna mengklik Impor Video YouTube dan login ke Akun Google-nya.

    2. Aplikasi akan meneruskan pengguna ke URL izin OAuth. Perlu diperhatikan bahwa contoh URL ini disederhanakan dan tidak memiliki beberapa parameter:

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

    3. Pengguna mengklik Berikutnya di layar izin OAuth, setuju untuk membagikan data mereka, dan memberikan akses akun.

    4. Pengguna dialihkan ke aplikasi.

    5. Developer mendapatkan token OAuth untuk pengguna.

  2. Aplikasi Anda memanggil InitiatePortabilityArchive(resources = ["myactivity.youtube"]) dengan token OAuth terlampir yang berisi cakupan OAuth ini:

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

    Panggilan ini akan memulai proses pembuatan arsip data. Anda harus memulai arsip portabilitas dalam waktu 24 jam setelah otorisasi pengguna.

  3. Aplikasi Anda memanggil GetPortabilityArchiveState(job_id) dengan token OAuth terlampir yang berisi cakupan OAuth ini:

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

    Anda dapat memanggil metode ini beberapa kali untuk mengambil status tugas arsip. Metode ini akan menampilkan status tugas. Jika statusnya SELESAI, berarti arsip sudah siap, dan URL Cloud Storage yang ditandatangani akan diberikan. Perhatikan bahwa waktu yang diperlukan untuk menyelesaikan permintaan arsip dapat bervariasi dari menit hingga jam, bergantung pada ukuran data.

  4. Download arsip data menggunakan URL yang ditandatangani.

  5. Panggil ResetAuthorization() dengan token OAuth terlampir untuk mereset resource yang habis dan menghapus semua izin OAuth.

Untuk informasi selengkapnya tentang penggunaan metode Data Portability API, lihat metode Call Data Portability API.

Cara pengguna berinteraksi dengan aplikasi Data Portability API

Diagram ini menunjukkan cara pengguna berinteraksi dengan aplikasi yang terintegrasi dengan Data Portability API.

Langkah-langkah yang diambil pengguna untuk mengekspor data mereka

  1. Pertama, pengguna diberi opsi untuk mengambil data mereka.

  2. Berikutnya, pengguna login ke Akun Google-nya.

  3. Kemudian, pengguna akan mengklik Berikutnya saat diminta untuk membagikan data, dan mengklik Oke saat diminta untuk menyetujui kebijakan privasi.

  4. Kemudian, layar izin OAuth yang digunakan untuk mengizinkan aplikasi mengakses data mereka akan ditampilkan kepada pengguna. Opsi di sini cocok dengan cakupan OAuth yang Anda konfigurasi.

  5. Setelah mengizinkan akses, impor data dimulai. Bergantung pada ukuran data, penyelesaian permintaan dapat memerlukan waktu beberapa menit hingga beberapa jam.