Attribution Reporting API: panduan integrasi

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.


Attribution Reporting API dirancang untuk mendukung kasus penggunaan utama untuk pengukuran atribusi dan konversi di seluruh aplikasi dan web tanpa mengandalkan ID pengguna lintas pihak. Dibandingkan dengan desain umum saat ini, pengimplementasi Attribution Reporting API harus mempertimbangkan beberapa pertimbangan tingkat tinggi yang penting:

  • Laporan tingkat peristiwa menyertakan data konversi fidelitas rendah. Sejumlah kecil nilai konversi berfungsi dengan baik.
  • Laporan gabungan menyertakan data konversi fidelitas lebih tinggi. Solusi Anda harus mendesain kunci agregasi berdasarkan persyaratan bisnis dan batas 128-bit.
  • Model data dan pemrosesan solusi Anda harus memperhitungkan pembatasan kapasitas untuk pemicu yang tersedia, penundaan waktu untuk mengirim peristiwa pemicu, dan derau yang diterapkan oleh API.

Untuk membantu Anda terkait perencanaan integrasi, panduan ini menyediakan tampilan komprehensif, yang mungkin mencakup fitur yang belum diimplementasikan pada tahap Privacy Sandbox di Pratinjau Developer Android. Dalam kasus ini, panduan linimasa disediakan.

Di halaman ini, kami menggunakan sumber untuk mewakili klik atau tampilan, dan pemicu untuk mewakili konversi.

Diagram di bawah ini menampilkan berbagai opsi alur kerja untuk integrasi atribusi. Bagian yang tercantum dalam kolom yang sama (dilingkari dengan warna hijau) dapat dikerjakan secara paralel; misalnya, engagement partner dapat dilakukan secara bersamaan dengan atribusi tingkat peristiwa aplikasi ke aplikasi.

Diagram alur kerja integrasi atribusi

Gambar 1. Alur kerja integrasi atribusi.

Prasyarat dan penyiapan

Selesaikan langkah-langkah di bagian ini untuk meningkatkan pemahaman Anda tentang Attribution Reporting API. Langkah-langkah ini akan menyiapkan Anda untuk mengumpulkan hasil yang bermakna saat menggunakan API dalam ekosistem teknologi iklan.

Memahami API

  1. Baca proposal desain untuk memahami Attribution Reporting API dan kemampuannya.
  2. Baca panduan developer untuk mempelajari cara menggabungkan kode dan panggilan API yang diperlukan untuk kasus penggunaan Anda.
  3. Kirim masukan yang Anda miliki untuk dokumentasi, terutama terkait dengan pertanyaan terbuka.
  4. Daftar untuk menerima update tentang Attribution Reporting API. Hal ini akan membantu Anda terus mendapatkan informasi terbaru tentang fitur baru yang diperkenalkan dalam rilis mendatang.

Menyiapkan dan menguji aplikasi contoh

  1. Setelah Anda siap memulai integrasi, siapkan Pratinjau Developer terbaru di Android Studio.
  2. Siapkan endpoint server tiruan untuk pendaftaran peristiwa dan pengiriman laporan. Kami telah menyediakan tiruan yang dapat Anda gunakan bersama dengan alat yang tersedia secara online.
  3. Download dan jalankan kode di aplikasi contoh untuk memahami cara mendaftarkan sumber dan pemicu.
    1. Menetapkan periode waktu untuk mengirim laporan. API mendukung periode 2 hari, 7 hari, atau periode kustom antara 2 hingga 30 hari.
    2. Setelah mendaftarkan sumber dan pemicu dengan menjalankan dan menggunakan aplikasi contoh, dan jangka waktu yang ditetapkan telah berlalu, pastikan Anda telah menerima laporan tingkat peristiwa dan laporan gabungan terenkripsi. Jika perlu men-debug laporan, Anda dapat membuatnya lebih cepat dengan tugas pelaporan yang berjalan otomatis.
    3. Meninjau hasil atribusi aplikasi ke aplikasi. Konfirmasi bahwa data dalam hasil ini sesuai harapan untuk kasus kontak terakhir dan pasca-penginstalan.

  4. Setelah Anda memahami cara kerja API klien dan server, gunakan aplikasi contoh sebagai contoh untuk memandu integrasi Anda sendiri. Siapkan server produksi Anda sendiri dan tambahkan panggilan pendaftaran peristiwa ke aplikasi Anda.

Pra-integrasi

Daftarkan organisasi Anda dengan Privacy Sandbox di Android. Pendaftaran ini dirancang untuk mencegah duplikasi platform teknologi iklan yang tidak perlu, yang akan memungkinkan akses ke lebih banyak informasi daripada yang diperlukan pada aktivitas pengguna.

Interaksi partner

Partner teknologi iklan (MMP/SSP/DSP) sering membuat solusi atribusi terintegrasi. Langkah-langkah di bagian ini membantu Anda bersiap untuk meraih kesuksesan dalam berinteraksi dengan partner teknologi iklan.

  1. Jadwalkan diskusi dengan partner pengukuran teratas Anda untuk membahas pengujian dan penggunaan Attribution Reporting API. Partner pengukuran dapat menyertakan jaringan teknologi iklan, SSP, DSP, pengiklan, atau partner lain yang saat ini bekerja sama dengan Anda atau ingin bekerja sama dengan Anda.
  2. Berkolaborasi dengan partner pengukuran untuk menentukan linimasa integrasi, dari pengujian awal hingga penggunaan.
  3. Jelaskan kepada partner pengukuran Anda area mana yang akan Anda bahas dalam desain atribusi.
  4. Membuat saluran komunikasi di antara partner pengukuran untuk disinkronkan pada linimasa dan pengujian menyeluruh.
  5. Mendesain aliran data tingkat tinggi di seluruh partner pengukuran. Pertimbangan utamanya meliputi hal berikut:
    • Bagaimana cara partner pengukuran mendaftarkan sumber atribusi dengan Attribution Reporting API?
    • Bagaimana jaringan teknologi iklan akan mendaftarkan pemicu dengan Attribution Reporting API?
    • Bagaimana cara setiap teknologi iklan memvalidasi permintaan API dan menampilkan respons untuk menyelesaikan pendaftaran sumber dan pemicu?
    • Apakah ada laporan yang perlu dibagikan kepada partner di luar Attribution Reporting API?
    • Apakah ada poin integrasi atau keselarasan lain yang diperlukan di seluruh partner? Misalnya, apakah Anda dan partner perlu mengerjakan konversi penghapusan duplikat atau menyelaraskan kunci agregasi?
  6. Jika atribusi aplikasi ke web berlaku, jadwalkan diskusi dengan partner pengukuran di web untuk membahas desain, pengujian, dan penggunaan Attribution Reporting API. Lihat pertanyaan di langkah sebelumnya saat Anda memulai percakapan dengan partner web.

Membuat prototipe atribusi tingkat peristiwa aplikasi ke aplikasi

Bagian ini membantu Anda menyiapkan atribusi aplikasi-ke-aplikasi dasar dengan laporan tingkat peristiwa di aplikasi atau SDK. Anda wajib menyelesaikan bagian ini sebelum dapat memulai pembuatan prototipe atribusi server agregasi.

  1. Siapkan server pengumpulan untuk data peristiwa. Anda dapat melakukannya dengan menggunakan spesifikasi yang diberikan untuk membuat server tiruan, atau menyiapkan server Anda sendiri dengan kode server contoh.
  2. Tambahkan daftarkan panggilan peristiwa sumber ke SDK atau aplikasi Anda saat iklan ditampilkan.
    • Pertimbangan penting mencakup:
      • Pastikan ID peristiwa sumber tersedia dan diteruskan dengan benar ke panggilan API pendaftaran sumber.
      • Pastikan Anda juga meneruskan `InputEvent` untuk mendaftarkan sumber klik.
      • Tentukan cara mengonfigurasi prioritas sumber untuk berbagai jenis peristiwa. Misalnya, tetapkan prioritas tinggi pada peristiwa yang dianggap bernilai tinggi, seperti klik daripada tampilan.
      • Nilai default masa berakhir dapat digunakan untuk pengujian. Atau, periode habis masa berlaku yang berbeda dapat dikonfigurasi.
      • Filter dan periode atribusi dapat dibiarkan sebagai default untuk pengujian.
    • Pertimbangan opsional mencakup hal-hal berikut:
      • Desain kunci agregasi jika Anda sudah siap.
      • Pertimbangkan strategi pengalihan saat Anda menentukan cara bekerja sama dengan partner pengukuran lain.
  3. Tambahkan daftarkan peristiwa pemicu ke SDK atau aplikasi Anda untuk mencatat peristiwa konversi.
    • Pertimbangan penting mencakup:
    • Pertimbangan opsional mencakup hal-hal berikut:
      • Lewati pembuatan kunci penghapusan duplikat hingga Anda melakukan pengujian akurasi.
      • Lewati pembuatan kunci dan nilai agregasi hingga dukungan pengujian simulasi siap.
      • Lewati pengalihan hingga Anda menentukan cara bekerja sama dengan partner pengukuran lainnya.
      • Prioritas pemicu tidak penting untuk pengujian.
      • Filter mungkin dapat diabaikan untuk pengujian awal.
  4. Uji apakah peristiwa sumber dibuat untuk iklan dan pemicunya adalah untuk pembuatan laporan peristiwa.

Pengujian simulasi

Bagian ini akan memandu Anda dalam menguji dampak pemindahan konversi saat ini ke peristiwa dan laporan gabungan yang kemungkinan akan berdampak pada sistem pelaporan dan pengoptimalan. Langkah ini akan memungkinkan Anda memulai pengujian dampak sebelum menyelesaikan integrasi.

Pengujian dilakukan dengan menyimulasikan pembuatan laporan peristiwa dan laporan gabungan berdasarkan data konversi historis yang Anda miliki, lalu mendapatkan hasil gabungan dari simulasi server agregasi. Hasil ini dapat dibandingkan dengan jumlah konversi historis untuk melihat bagaimana akurasi pelaporan akan berubah.

Model pengoptimalan, seperti perhitungan prediksi rasio konversi, dapat dilatih dalam laporan ini untuk membandingkan akurasi model tersebut dibandingkan dengan model yang dibuat berdasarkan data saat ini. Ini juga merupakan kesempatan untuk bereksperimen dengan struktur kunci agregasi yang berbeda dan dampaknya terhadap hasil.

  1. Siapkan Library Simulasi Pengukuran di komputer lokal.
  2. Baca spec tentang cara memformat data konversi agar kompatibel dengan generator laporan simulasi.
  3. Desain kunci agregasi Anda berdasarkan persyaratan bisnis.
    • Pertimbangan penting mencakup:
      • Pertimbangkan dimensi penting yang harus digabungkan oleh klien atau partner dan fokuskan klien Anda atau partner ke dimensi tersebut.
      • Tentukan jumlah minimum dimensi gabungan dan kardinalitas yang diperlukan untuk persyaratan Anda.
      • Pastikan potongan kunci sisi sumber dan pemicu tidak melebihi 128 bit.
      • Jika solusi Anda melibatkan kontribusi ke beberapa nilai per peristiwa pemicu, pastikan untuk menskalakan nilai terhadap anggaran kontribusi maksimum, L1. Tindakan ini akan membantu meminimalkan dampak derau.
      • Berikut adalah contoh yang menjelaskan setelan kunci untuk mengumpulkan jumlah konversi agregat di tingkat kampanye, dan kunci untuk mengumpulkan nilai pembelian agregat di tingkat geografis.
  4. Jalankan generator laporan untuk membuat laporan peristiwa dan laporan yang dapat digabung.
  5. Jalankan laporan yang dapat digabung melalui server agregasi yang disimulasikan untuk mendapatkan laporan ringkasan.
  6. Melakukan eksperimen utilitas:
    • Bandingkan total konversi dari laporan tingkat peristiwa dan ringkasan dengan data konversi historis untuk menentukan akurasi pelaporan konversi. Untuk mendapatkan hasil terbaik, jalankan pengujian pelaporan dan perbandingan pada porsi yang luas dan representatif dari basis pengiklan.
    • Melatih ulang model Anda berdasarkan data laporan tingkat peristiwa, dan mungkin ringkasan data laporan. Bandingkan akurasi dengan model yang dibuat berdasarkan data pelatihan historis.
    • Coba berbagai strategi pengelompokan dan lihat bagaimana strategi tersebut memengaruhi hasil Anda.
      • Pertimbangan penting mencakup:
      • Ketepatan waktu dalam laporan ringkasan untuk menyesuaikan bid.
      • Frekuensi rata-rata peristiwa yang dapat diatribusikan di perangkat. Misalnya, pengguna yang kembali akan kembali berdasarkan data peristiwa pembelian historis.
      • Level derau. Lebih banyak batch berarti agregasi yang lebih kecil, dan agregasi yang lebih kecil berarti lebih banyak derau yang diterapkan.

Atribusi server agregasi prototipe: Penyiapan

Langkah-langkah ini akan memastikan Anda dapat menerima laporan gabungan sumber dan peristiwa pemicu.

  1. Siapkan server agregasi Anda:
    • Siapkan akun AWS Anda.
    • Daftar ke layanan agregasi bersama koordinator Anda.
    • Siapkan server agregasi di AWS dari biner yang disediakan.
  2. Desain kunci agregasi Anda berdasarkan persyaratan bisnis. Jika sudah menyelesaikan tugas di bagian tingkat peristiwa aplikasi ke aplikasi, Anda dapat melewati langkah ini.
  3. Siapkan server pengumpulan untuk laporan agregat. Jika sudah membuatnya di bagian tingkat peristiwa aplikasi ke aplikasi, Anda dapat menggunakannya kembali.

Atribusi server agregasi prototipe: Integrasi

Untuk melanjutkan setelah tahap ini, Anda harus menyelesaikan bagian Atribusi server agregasi prototipe: Penyiapan, atau bagian Atribusi Tingkat Peristiwa Aplikasi ke Aplikasi Prototipe**.

  1. Tambahkan data kunci agregasi ke sumber dan peristiwa pemicu. Hal ini mungkin memerlukan penerusan lebih banyak data tentang peristiwa iklan, seperti ID kampanye, ke SDK atau aplikasi Anda agar disertakan dalam kunci agregasi.
  2. Kumpulkan laporan agregat aplikasi ke aplikasi dari sumber dan peristiwa pemicu yang Anda daftarkan dengan data kunci agregasi.
  3. Uji berbagai strategi pengelompokan saat Anda menjalankan laporan agregat ini melalui server agregasi, dan lihat bagaimana dampaknya terhadap hasil Anda.

Melakukan iterasi desain dengan fitur opsional

Berikut adalah fitur tambahan yang dapat Anda sertakan dalam solusi pengukuran Anda.

  1. Dengan menetapkan kunci debug, Anda dapat menerima laporan yang tidak diubah dari peristiwa sumber atau pemicu bersama dengan laporan yang dihasilkan oleh Attribution Reporting API. Anda dapat menggunakan kunci debug untuk membandingkan laporan dan menemukan bug selama integrasi.

Menyesuaikan perilaku atribusi

  1. Atribusi untuk pemicu pascapenginstalan
    • Fitur ini dapat digunakan jika pemicu pascapenginstalan perlu diatribusikan ke sumber atribusi yang sama yang mendorong penginstalan, meskipun ada sumber atribusi lain yang memenuhi syarat dan muncul baru-baru ini.
    • Misalnya, mungkin ada kasus saat pengguna mengklik iklan yang mendorong penginstalan. Setelah diinstal, pengguna mengklik iklan lain dan melakukan pembelian. Dalam hal ini, perusahaan teknologi iklan mungkin ingin pembelian tersebut diatribusikan ke klik pertama, bukan klik re-engagement.
  2. Menggunakan filter untuk menyesuaikan data dalam laporan tingkat peristiwa
    • Filter konversi dapat ditetapkan untuk mengabaikan pemicu yang dipilih dan mengecualikannya dari laporan peristiwa. Karena ada batasan jumlah pemicu per sumber atribusi, filter memungkinkan Anda untuk hanya menyertakan pemicu yang memberikan informasi yang paling berguna dalam laporan peristiwa.
    • Filter juga dapat digunakan untuk memfilter beberapa pemicu secara selektif, yang secara efektif mengabaikannya. Misalnya, jika Anda memiliki kampanye yang menargetkan penginstalan aplikasi, sebaiknya filter pemicu pascapenginstalan agar tidak diatribusikan ke sumber kampanye tersebut.
    • Filter juga dapat digunakan untuk menyesuaikan data pemicu berdasarkan data sumber. Misalnya, sumber dapat menentukan "product" : ["1234"] dengan product adalah kunci filter dan 1234 adalah nilainya. Setiap pemicu yang memiliki kunci filter "produk" yang memiliki nilai selain "1234" akan diabaikan.
  3. Prioritas sumber dan pemicu yang disesuaikan
    • Jika beberapa sumber atribusi dapat dikaitkan dengan pemicu, atau beberapa pemicu dapat diatribusikan ke sumber, Anda dapat menggunakan bilangan bulat 64-bit yang ditandatangani untuk memprioritaskan atribusi sumber/pemicu tertentu daripada lainnya.

Bekerja dengan MMP dan lainnya

  1. Pengalihan ke pihak ketiga lain untuk peristiwa sumber dan pemicu
    • Anda dapat menetapkan URL alihan untuk mengizinkan beberapa platform teknologi iklan untuk mendaftarkan permintaan. Ini dapat digunakan untuk mengaktifkan penghapusan duplikat lintas jaringan dalam atribusi.
  2. Kunci penghapusan duplikat
    • Jika pengiklan menggunakan beberapa platform teknologi iklan untuk mendaftarkan peristiwa pemicu yang sama, kunci penghapusan duplikat dapat digunakan untuk membedakan laporan berulang ini. Jika kunci penghapusan duplikat tidak diberikan, pemicu duplikat dapat dilaporkan kembali ke setiap platform teknologi iklan sebagai satu-satunya.

Bekerja dengan pengukuran lintas platform

  1. Atribusi lintas aplikasi dan web (tersedia di akhir Kuartal 4)
    • Mendukung kasus penggunaan ketika pengguna melihat iklan di aplikasi, lalu melakukan konversi di browser seluler atau aplikasi, atau sebaliknya.