Panduan Developer Play Catalog API

Play Catalog API memungkinkan app store pihak ketiga (3PAS) yang terdaftar di Google Play untuk melakukan polling guna mendapatkan update pada katalog aplikasi Google Play. Pemanggil dapat mengambil detail katalog untuk aplikasi yang telah dimodifikasi atau dihapus sejak ekspor katalog harian terakhir.

Untuk mengetahui daftar lengkap endpoint, metode, dan skema resource, lihat Referensi Play Catalog API.

Sebelum Memulai

Anda harus menyelesaikan Panduan Memulai utama untuk menyiapkan akses API, kredensial layanan, dan project Google Cloud sebelum dapat melakukan panggilan ke Play Catalog API.


Desain & Arsitektur API

Ekspor Play Catalog dibuat setiap 24 jam. Play Catalog API menyediakan mekanisme polling intrahari untuk mengambil update yang terjadi sejak ekspor terakhir:

  1. Melakukan polling untuk peristiwa update: Anda membuat kueri appstorecatalog.recentUpdateEvents.list dengan jangka waktu startTime dan endTime untuk menemukan nama paket mana yang diubah atau dihapus.
  2. Mengambil tampilan mendetail: Untuk setiap nama paket yang diubah, Anda memanggil appstorecatalog.recentAppViews.get untuk mengambil metadata CatalogAppView yang mendetail.

API ini bersifat hanya baca dan dibatasi untuk menampilkan peristiwa yang terjadi dalam 36 jam terakhir. API ini memiliki batas QPS 2 yang dibagi antara kedua metode.


1. Polling untuk Peristiwa Update Katalog

Untuk mengambil daftar paket yang berubah dalam jangka waktu tertentu, panggil metode appstorecatalog.recentUpdateEvents.list.

Hanya peristiwa update untuk aplikasi yang memenuhi syarat yang ditampilkan. Aplikasi yang memenuhi syarat harus:

  • Dipilih untuk disertakan dalam katalog untuk app store yang membuat panggilan.
  • Dipublikasikan dan tersedia di Amerika Serikat (AS) di Google Play Store.

Memahami Jenis Update

  • MODIFICATION: Dipicu saat aplikasi yang memenuhi syarat diubah, dipublikasikan untuk pertama kalinya, mulai menargetkan AS, atau saat aplikasi baru saja dipilih untuk disertakan ke katalog Anda.
  • DELETION: Dipicu saat aplikasi dibatalkan publikasinya, dibatalkan pilihannya dalam penyertaan katalog, ditangguhkan atau diblokir, atau berhenti menargetkan AS.

2. Mengambil Tampilan Aplikasi Katalog

Untuk setiap paket yang ditampilkan dengan peristiwa MODIFICATION, Anda dapat mengambil detail katalog yang diperbarui dengan memanggil metode appstorecatalog.recentAppViews.get.


3. Praktik Terbaik & Sinkronisasi

Untuk mempertahankan konsistensi database katalog di app store Anda, ikuti panduan integrasi berikut:

  • Sinkronisasi ekspor harian: Impor daftar lengkap aplikasi yang memenuhi syarat menggunakan ekspor katalog harian.
  • (opsional) Sinkronisasi Intrahari: Lakukan polling endpoint appstorecatalog.recentUpdateEvents.list secara rutin (misalnya, setiap menit) dengan jangka waktu yang terus berubah. Pastikan Anda menangani penomoran halaman menggunakan nextPageToken.
    • Proses Update:
      • Untuk peristiwa MODIFICATION, ambil CatalogAppView yang diupdate menggunakan appstorecatalog.recentAppViews.get dan update database lokal Anda.
      • Untuk peristiwa DELETION, hapus aplikasi dari listingan app store Anda atau sembunyikan aplikasi dari pengguna.
    • Tangani Peristiwa Modifikasi Berulang: Anda mungkin melihat beberapa peristiwa MODIFICATION untuk aplikasi yang sama. Artinya, aplikasi dimodifikasi beberapa kali dalam jangka waktu yang dikueri. appstorecatalog.recentAppViews.get akan selalu menampilkan tampilan aplikasi dari modifikasi terbaru.