API Runtime SDK: panduan integrasi

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Saat Anda membaca dokumentasi Privacy Sandbox di Android, gunakan tombol Pratinjau Developer atau Beta untuk memilih versi program yang sedang Anda gunakan, karena petunjuknya dapat bervariasi.


Untuk membantu Anda merencanakan integrasi, panduan ini memberikan gambaran menyeluruh tentang proses integrasi, yang dapat mencakup fitur yang belum diimplementasikan pada tahap Privacy Sandbox pada Pratinjau Developer Android saat ini. Dalam kasus ini, panduan linimasa akan disediakan.

Diagram di bawah ini menampilkan alur kerja pengembangan yang telah diperbarui untuk integrasi Runtime SDK. Bagian yang tercantum dalam kolom yang sama dapat dikerjakan secara paralel; misalnya, Engagement Partner dapat dilakukan secara bersamaan dengan menyiapkan lingkungan pengujian.

Diagram visual alur kerja integrasi Runtime SDK.
Gambar 1: Alur kerja untuk integrasi Runtime SDK.

Prasyarat dan Penyiapan

Anda harus menyelesaikan bagian pra-pekerjaan ini untuk memastikan Anda telah memiliki pemahaman yang baik tentang Runtime SDK dan agar Anda bisa mendapatkan hasil yang bermanfaat saat menggunakan API dalam ekosistem teknologi iklan.

Memahami API

Mulailah dengan membaca Proposal Desain untuk memahami Runtime SDK beserta kemampuan dan batasannya.

Baca Panduan Developer untuk mempelajari cara menggabungkan kode dan panggilan API yang akan diperlukan untuk kasus penggunaan Anda.

Silakan kirim masukan yang Anda miliki untuk dokumentasi, terutama yang berkaitan dengan pertanyaan terbuka.

Daftar untuk menerima info terbaru terkait Privacy Sandbox di Android. Hal ini akan membantu Anda terus mendapatkan informasi terbaru tentang fitur baru yang diperkenalkan dalam rilis mendatang.

Menyiapkan dan menguji aplikasi contoh

Setelah Anda siap memulai integrasi, download Pratinjau Developer terbaru di Android Studio dengan mengikuti petunjuk yang tercantum di sini. Panduan ini memerlukan penggunaan Android Studio versi Canary terbaru. Anda dapat menjalankan versi Android Studio ini secara paralel dengan versi lain yang digunakan. Jadi, beri tahu kami jika persyaratan ini tidak berhasil untuk Anda.

Lakukan fork dan jalankan kode di aplikasi contoh agar Anda memahami cara penginstalan RE SDK yang disebut “example-sdk” dan aplikasi klien yang disebut “client-app” di perangkat atau emulator guna memastikan iklan contoh akan dimuat.

Menyesuaikan SDK yang ada dengan Runtime SDK

Tujuan dari bagian ini adalah untuk mengimplementasikan fungsi, seperti menampilkan iklan banner, dari SDK yang ada dalam SDK yang mendukung runtime (RE SDK), dan menyiapkan komunikasi antara aplikasi dan RE SDK.

  • Buat atau update contoh SDK dan implementasi SDK untuk mengimplementasikan fungsi di RE SDK.

  • Secara arsitektur, pertimbangkan untuk menambahkan RE SDK sebagai dependensi ke SDK yang ada, yang berfungsi sebagai wrapper. Dengan melakukan langkah ini, aplikasi klien dapat terus memanggil SDK yang ada, atau wrapper, secara langsung. SDK wrapper dapat merutekan panggilan API berdasarkan berbagai strategi yang diuraikan di bawah ini.

Diagram visual arsitektur Sistem setelah integrasi Runtime SDK.
Gambar 2: Arsitektur sistem setelah integrasi Runtime SDK.

Untuk kasus penggunaan yang memerlukan data kustom, seperti memanggil PPAPI, definisi API harus dibuat menggunakan IPC. Dengan menggunakan IBinder dan AIDL Android, buat protokol komunikasi untuk mengirim informasi ke SDK yang mendukung runtime guna mendapatkan informasi atau tindakan yang diperlukan. Informasi selengkapnya tersedia dalam panduan developer SDK Runtime di sini.

Merutekan traffic ke Runtime Enabled SDK

Strategi pemilihan rute untuk panggilan API

Sesuai dengan kasus penggunaan Anda, sebaiknya arahkan panggilan SDK melalui SDK yang ada dan jalur kode RE SDK. Hal ini akan membantu Anda menerapkan pengujian A/B di peluncuran awal. Untuk memudahkan integrasi aplikasi, maka panduan ini mempertimbangkan bahwa aplikasi akan bergantung pada RE SDK dan mendelegasikan ke SDK yang ada jika sesuai. Pertimbangkan strategi berikut:

Mengarahkan persentase panggilan SDK ke RE SDK

Hanya arahkan persentase panggilan SDK ke RE SDK. Arahkan sisanya ke jalur kode SDK yang ada. Misalnya, pertimbangkan strategi ini untuk kasus saat Anda harus memenuhi permintaan SDK sekali, seperti menampilkan iklan banner.

  • Ubah SDK yang sudah ada untuk mengarahkan persentase permintaan ke RE SDK. Misalnya, gunakan flag konfigurasi dinamis berbasis server, seperti Firebase Remote Config, untuk mengontrol kriteria pengalihan secara dinamis.
  • Hal ini pada dasarnya akan menjadikan SDK yang ada sebagai satu-satunya antarmuka yang berinteraksi dengan aplikasi dan bertanggung jawab untuk merutekan permintaan SDK ke RE SDK yang baru.
  • Kode Anda hanya boleh mengalihkan permintaan yang dapat ditangani oleh RE SDK. Misalnya, pastikan format iklan didukung oleh Runtime SDK.
  • Ikuti petunjuk ini untuk memperbarui kode SDK agar dapat berinteraksi dengan RE SDK.

Kode semu untuk logika perutean:

void showAd(AdRequest request) {
  if (request.isBannerAd() && enableRuntimeSdkDiversion() == true) {
    // Call showAd() from the RE SDK
  } else {
    // Call showAd() using the existing SDK code path
  }
}

Rutekan semua panggilan SDK ke SDK yang sudah ada dan RE SDK

Rutekan semua panggilan SDK ke jalur kode SDK yang sudah ada dan jalur kode RE SDK, di perangkat yang didukung. Pertimbangkan strategi ini untuk kasus-kasus saat Anda harus menjalankan jalur kode yang sudah ada dan jalur kode yang baru untuk tujuan perbandingan. Misalnya, bandingkan hasil pelaporan konversi.

  • Ubah kode Anda untuk merutekan semua panggilan SDK ke jalur kode SDK yang ada dan jalur kode RE SDK. Anda harus memastikan bahwa fungsi tersebut didukung oleh Runtime SDK dan RE SDK berhasil dimuat.

Kode semu untuk logika perutean:

void reportAttribution(AdRequest request) {
  if (request.isFeatureSupported() && isSdkLoaded() == true) {
    // Call RE SDK
  }

  // Call existing SDK code path
}

Program beta tertutup untuk distribusi SDK yang mendukung runtime

Google Play menawarkan program beta tertutup untuk SDK terkait iklan bagi developer yang mendaftar ke program Beta dan telah melakukan pengujian lokal. Jika Anda berminat untuk berpartisipasi, daftar di sini.