Penyiapan Topics API

Siapkan lingkungan Anda untuk menggunakan, menguji, dan mengembangkan aplikasi web dengan Topics API.

Membuat dan menguji secara lokal

Bagian ini menjelaskan cara menyiapkan lingkungan lokal untuk mencoba Topics API sebagai developer perorangan. Sebaiknya jelajahi demo untuk memahami cara kerja Topics sebelum mendalami penerapan.

Mengaktifkan Topics di browser Anda

Untuk mengaktifkan Topics API di instance Chrome Anda sendiri untuk pengujian lokal, Anda memiliki dua opsi:

  1. Aktifkan semua API Privasi iklan di bagian chrome://settings/adPrivacy.
  2. (Direkomendasikan) Jalankan Chrome dari command line dengan flag Chromium menggunakan parameter khusus Topics API untuk mengonfigurasi sesuai kebutuhan. Anda memiliki kontrol yang lebih mendetail atas fitur Topics dengan menjalankan Chrome dari command line. Misalnya, Anda dapat menetapkan epoch Topics (jangka waktu yang digunakan oleh API untuk menghitung minat pengguna) dan mengonfigurasi perilaku API sesuai kebutuhan Anda.

Rekomendasi utama

  1. Pastikan Anda menutup dan menghentikan semua proses Chrome sebelum memulai proses baru menggunakan flag.
  2. Pastikan semua API privasi iklan diaktifkan di chrome://settings/adPrivacy.
  3. Jika API tidak berfungsi seperti yang diharapkan, coba tips pemecahan masalah kami.
  4. Jika ada pertanyaan, lihat masalah GitHub untuk penjelasannya.

Mengontrol Topics API dengan flag Chrome

Tanda Chrome dapat mengubah perilaku Topics API. Jalankan Chrome dari command line dengan parameter yang ditentukan untuk memfasilitasi pengujian. Misalnya, demo header merekomendasikan penggunaan flag berikut:

--enable-features=BrowsingTopics,BrowsingTopicsParameters:time_period_per_epoch/15s/max_epoch_introduction_delay/3s,PrivacySandboxAdsAPIsOverride,PrivacySandboxSettings3,OverridePrivacySandboxSettingsLocalTesting

Tabel berikut menjelaskan setiap parameter, nilai defaultnya, dan tujuannya.

Nama bendera Nilai default Deskripsi
BrowsingTopics diaktifkan Apakah Topics API diaktifkan atau tidak.
PrivacySandboxAdsAPIsOverride diaktifkan Mengaktifkan API iklan: Attribution Reporting, Protected Audience, Topics, Fenced Frames.
PrivacySandboxSettings4 nonaktif Mengaktifkan rilis keempat setelan UI Privacy Sandbox.
OverridePrivacySandboxSettingsLocalTesting diaktifkan Jika diaktifkan, browser tidak lagi memerlukan setelan dasar untuk diaktifkan guna mengaktifkan fitur Privacy Sandbox.
BrowsingTopicsBypassIPIsPubliclyRoutableCheck nonaktif Jika diaktifkan, pemeriksaan apakah alamat IP dapat dirutekan secara publik akan diabaikan saat menentukan kelayakan halaman untuk disertakan dalam penghitungan topik.
BrowsingTopics:number_of_epochs_to_expose 3 Jumlah epoch yang digunakan untuk menghitung topik yang akan diberikan ke konteks permintaan. Browser akan menyimpan hingga epoch N+1 secara internal.
BrowsingTopics:time_period_per_epoch 7d-0j-0m-0d Durasi setiap epoch. Untuk proses debug, sebaiknya tetapkan ini ke (misalnya) 15 detik, bukan default tujuh hari.
BrowsingTopics:number_of_top_topics_per_epoch 5 Jumlah topik yang dihitung per epoch.
BrowsingTopics:use_random_topic_probability_percent 5 Probabilitas bahwa setiap topik dalam epoch adalah topik yang ditampilkan secara acak dari seluruh taksonomi topik. Keacakan melekat pada epoch dan situs.
BrowsingTopics:number_of_epochs_of_observation_data_to_use_for_filtering 3 Berapa banyak epoch data penggunaan API (yaitu pengamatan topik) yang akan digunakan untuk memfilter topik untuk konteks panggilan.
BrowsingTopics:max_number_of_api_usage_context_domains_to_keep_per_topic 1000 Jumlah maksimum domain konteks yang diamati untuk disimpan untuk setiap topik teratas. Tujuannya adalah untuk membatasi memori yang sedang digunakan.
BrowsingTopics:max_number_of_api_usage_context_entries_to_load_per_epoch 100000 Jumlah maksimum entri yang diizinkan untuk diambil dari database untuk setiap kueri dalam konteks penggunaan API. Kueri akan terjadi sekali per epoch pada waktu penghitungan topik. Tujuannya adalah untuk membatasi penggunaan memori puncak.
BrowsingTopics:max_number_of_api_usage_context_domains_to_store_per_page_load 30 Jumlah maksimum domain konteks penggunaan API yang diizinkan untuk disimpan per pemuatan halaman.
BrowsingTopics:config_version 1 Mengenkode parameter konfigurasi Topics API. Setiap nomor versi hanya boleh dipetakan ke satu set konfigurasi. Memperbarui parameter konfigurasi tanpa memperbarui config_version biasanya tidak masalah untuk pengujian lokal, tetapi dalam beberapa situasi dapat membuat browser dalam status yang tidak konsisten dan dapat menyebabkan error browser, misalnya memperbarui number_of_top_topics_per_epoch.
BrowsingTopics:taxonomy_version 1 Versi taksonomi yang digunakan oleh API.

Sebelum Anda mulai menerapkan

Sebelum memulai penerapan, sebaiknya tinjau referensi ini untuk memahami Topics API.

  1. Tinjau dokumen developer:
    1. Memahami tujuan Topics API dan perannya dalam periklanan menurut minat
    2. Pahami cara kerja Topics di Web.
    3. Coba demo dan tonton video panduan Topics, demo, kolaborasi, dan alat.
    4. Lakukan fork demo dan jalankan dari situs Anda sendiri.
    5. Baca penjelasan API untuk memahami detailnya lebih lanjut.
  2. Pahami peran API dalam mendukung relevansi iklan di masa mendatang, ketika cookie pihak ketiga tidak akan tersedia bagi peningkatan proporsi pengguna.
  3. Untuk mendapatkan notifikasi tentang perubahan status di API, gabung ke milis untuk developer dan nantikan pembaruan Topics terbaru.
  4. Berkontribusilah pada percakapan di masalah GitHub atau panggilan W3C.
  5. Jika Anda menemukan istilah yang tidak dikenal, tinjau glosarium Privacy Sandbox.
  6. Untuk informasi selengkapnya tentang konsep Chrome, seperti flag Chrome, tonton video singkat dan baca artikel yang tersedia di goo.gle/cc.

Langkah berikutnya

Lihat detail penerapan dan contoh kode bagi pemanggil untuk mengamati dan mengakses topik.
Pelajari cara men-deploy, menguji, dan menskalakan solusi berbasis Topics.