Memanggil Data Portability API Menggunakan Python Script

Dalam panduan memulai ini, Anda akan mendapatkan token OAuth untuk akun Anda, dan mengirim permintaan ke endpoint Data Portability API menggunakan skrip Python.

Yang Anda pelajari

Dalam panduan memulai ini, Anda akan menggunakan skrip Python untuk:

  • Kirim permintaan yang diautentikasi ke endpoint InitiatePortabilityArchive dengan memberikan token OAuth yang valid. Responsnya adalah job_id yang valid.
  • Kirim permintaan yang diautentikasi ke endpoint GetPortabilityArchiveState dan download data. Respons harus berisi status tugas yang valid, dan saat tugas selesai, URL yang ditandatangani.
  • Menyimpan token OAuth dengan akses berbasis waktu untuk digunakan kembali nanti.
  • Kirim permintaan yang diautentikasi ke endpoint ResetAuthorization. Permintaan ini akan mencabut semua cakupan OAuth yang diberikan pengguna.
  • Kirim permintaan yang diautentikasi ke endpoint InitiatePortabilityArchive dengan memberikan token OAuth yang valid beserta start_time atau end_time untuk menerapkan filter waktu ke permintaan Anda.

Prasyarat

Untuk menjalankan quickstart ini, Anda harus:

  • Pastikan Data Portability API tersedia untuk Anda. Untuk mengetahui daftar negara dan wilayah yang didukung, lihat Pertanyaan Umum di halaman "Membagikan salinan data Anda kepada pihak ketiga".
  • Selesaikan langkah-langkah penyiapan untuk Data Portability API, dan pastikan Anda menggunakan project baru.
  • Mendapatkan akses ke akun yang dimiliki atau dikontrol oleh organisasi Anda. Data aktivitas penelusuran akun ini diekspor dalam panduan memulai ini.

Sebelum memulai panduan memulai ini, Anda juga perlu menyiapkan OAuth, Python, dan paket OAuth untuk library klien Python.

Menyiapkan OAuth

  • Ikuti langkah-langkah untuk mengonfigurasi OAuth bagi aplikasi yang diinstal. Alur ini mirip dengan alur OAuth untuk aplikasi server web. Saat Anda mengonfigurasi client ID OAuth:
    • Application type harus berupa Desktop app.
    • Setelah Anda membuat client ID, download secret klien dalam format JSON, dan beri nama file: client_secrets.json.
    • Saat Anda mengonfigurasi cakupan untuk Data Portability API, perhatikan bahwa quickstart ini menggunakan grup resource berikut:

Menyiapkan Python

Anda perlu menyiapkan Python di komputer lokal untuk menjalankan skrip yang digunakan dalam panduan memulai ini. Untuk menyiapkan Python:

  • Instal alat pengelolaan paket Pip dan Python 3.11 (atau yang lebih tinggi).
  • Instal Library Klien Google API untuk Python.

  • Instal paket google_auth_oauthlib untuk library klien Python dengan menjalankan perintah ini. Paket ini menyediakan integrasi oauthlib dengan google-auth—library autentikasi Google untuk Python.

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

Jalankan skrip:

Skrip ini menggunakan pengalihan localhost dalam alur OAuth. Opsi ini mengharuskan aplikasi memproses di port localhost, lalu membuka browser sistem untuk memulai alur otorisasi OAuth.

Klik link ini untuk membuka skrip, atau download salinan skrip dengan mengklik kanan link.

Skrip panduan memulai Python Data Portability API

Untuk menjalankan skrip dan mengekspor korpus data lengkap, masukkan perintah ini:

python3 data-portability-quickstart.py

Untuk menggunakan cakupan yang berbeda, tentukan cakupan menggunakan --resources, misalnya:

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

Untuk menerapkan pemfilteran waktu, gunakan skrip yang sama dengan flag start_time dan end_time. Contoh:

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

Tindakan yang dilakukan oleh skrip dijelaskan dalam komentar.