Referensi Measurement Protocol

Halaman ini menjelaskan mekanisme transpor dan parameter data untuk Measurement Protocol.

Transpor

Semua data harus dikirim dengan aman menggunakan permintaan POST HTTPS.

Kirim permintaan ke endpoint berikut:

https://www.google-analytics.com/mp/collect

Jika Anda ingin data Anda diproses di Uni Eropa, gunakan endpoint berikut:

https://region1.google-analytics.com/mp/collect

Berikut adalah contoh permintaan POST:

POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
PAYLOAD_DATA

Ganti PAYLOAD_DATA dengan Payload permintaan.

Measurement Protocol menampilkan kode status 2xx jika permintaan HTTP diterima. Measurement Protocol tidak menampilkan kode error jika format payload salah, atau jika data salah atau tidak diproses oleh Google Analytics.

Payload

Payload memiliki dua bagian:

  1. Parameter kueri.
  2. Isi POST JSON.

Parameter kueri

Nama Parameter Deskripsi

api_secret

Wajib diisi. Rahasia API dari UI Google Analytics.

Dapat ditemukan di bagian Admin > Aliran Data > Pilih aliran data Anda > Measurement Protocol > Buat.

Pribadi untuk organisasi Anda. Harus diperbarui secara rutin untuk menghindari SPAM yang berlebihan.

Isi JSON POST

Kunci Jenis Deskripsi

user_id

string

Opsional. ID unik untuk pengguna. Lihat artikel User-ID untuk analisis lintas platform guna mendapatkan informasi lebih lanjut tentang ID ini. Hanya dapat menyertakan karakter utf-8.

timestamp_micros

number

Opsional. Stempel waktu Unix, mikrodetik, bukan milidetik. Merepresentasikan waktu peristiwa. Hanya boleh disetel untuk mencatat peristiwa yang terjadi di masa lalu. Dapat diganti oleh user_property atau stempel waktu peristiwa. Tanggal peristiwa dapat ditetapkan ke maksimal 3 hari kalender sebelumnya berdasarkan zona waktu properti.

user_properties

object Opsional. Properti pengguna untuk pengukuran.

user_data

object Opsional. Data yang disediakan pengguna.
object Opsional. Setelan izin untuk permintaan. Lihat bagian izin untuk mengetahui informasi selengkapnya.

non_personalized_ads

boolean Opsional. Tetapkan ke true untuk mengindikasikan bahwa data pengguna tidak boleh digunakan untuk iklan yang dipersonalisasi.

user_location

object Opsional. Menetapkan informasi geografis untuk permintaan dalam format terstruktur.

ip_override

string Opsional. Alamat IP yang digunakan Google Analytics untuk mendapatkan informasi geografis untuk permintaan.

device

object Opsional. Menetapkan informasi perangkat untuk permintaan dalam format terstruktur.

events[]

array Wajib diisi. Array item event. Maksimal 25 peristiwa dapat dikirim per permintaan. Lihat referensi peristiwa untuk semua peristiwa yang valid.

events[].name

string Wajib diisi. Nama peristiwa. Lihat Peristiwa untuk mengetahui semua opsi.

events[].params

object Opsional. Parameter untuk peristiwa. Lihat Peristiwa untuk mengetahui parameter yang disarankan untuk setiap peristiwa.

Atribut consent mengonfigurasi jenis dan status izin. Jika Anda tidak menentukan consent, Google Analytics akan menggunakan setelan izin dari interaksi online yang sesuai untuk instance aplikasi atau klien.

Kunci Jenis Deskripsi

ad_user_data

string

Opsional. Izin untuk mengirim data pengguna dari peristiwa dan properti pengguna permintaan ke Google untuk tujuan periklanan.

GRANTED atau DENIED.

ad_personalization

string

Opsional. Izin untuk iklan yang dipersonalisasi bagi pengguna.

GRANTED atau DENIED.

Informasi geografis

Atribut user_location dan ip_override memberikan informasi geografis. user_location lebih diutamakan daripada ip_override.

Berikut adalah struktur kolom user_location. Berikan sebanyak mungkin atribut. Sebaiknya gunakan country_id dan region_id minimal.

Kunci Jenis Deskripsi

city

string Opsional. Nama kota. Jika kota berada di Amerika Serikat, tetapkan juga country_id dan region_id agar Google Analytics dapat memetakan nama kota dengan benar ke ID kota.

region_id

string Opsional. Negara dan subdivisi ISO 3166. Misalnya, US-CA, US-AR, CA-BC, GB-LND, CN-HK.

country_id

string Opsional. Negara dalam format ISO 3166-1 alpha-2. Misalnya, US, AU, ES, FR.

subcontinent_id

string Opsional. Subbenua dalam format UN M49. Misalnya, 011, 021, 030, 039.

continent_id

string Opsional. Benua dalam format UN M49. Misalnya, 002, 019, 142, 150.

Berikut adalah contoh user_location:

"user_location:" {
  "city:" "Mountain View",
  "region_id:" "US-CA",
  "country_id:" "US",
  "subcontinent_id:" "021",
  "continent_id:" "019"
}

ip_override adalah alternatif untuk user_location. Jika Anda mengirim ip_override, Google Analytics akan memperoleh informasi geografis dari alamat IP. Jika Anda mengirim user_location, Google Analytics akan mengabaikan ip_override.

Jika Anda tidak mengirim user_location atau ip_override, Google Analytics akan memperoleh informasi geografis dari peristiwa pemberian tag menggunakan client_id.

Google Analytics menerapkan setelan data lokasi terperinci properti ke permintaan, terlepas dari informasi geografis yang dikirim.

Informasi perangkat

Untuk mengirim informasi perangkat, gunakan kolom device. Berikut adalah struktur kolom device. Berikan sebanyak mungkin atribut. Sebaiknya gunakan minimal category.

Kunci Jenis Deskripsi

category

string Opsional. Kategori perangkat. Misalnya, desktop, tablet, mobile, smart TV.

language

string Opsional. Bahasa dalam format ISO 639-1. Misalnya, en, en-US.

screen_resolution

string Opsional. Resolusi perangkat, diformat sebagai WIDTHxHEIGHT. Misalnya, 1280x2856, 1080x2340.

operating_system

string Opsional. Sistem operasi atau platform. Contoh, MacOS.

operating_system_version

string Opsional. Versi sistem operasi atau platform. Contohnya 13.5.

model

string Opsional. Model perangkat. Misalnya, Pixel 9 Pro, Samsung Galaxy S24.

brand

string Opsional. Merek perangkat. Misalnya, Google, Samsung.

browser

string Opsional. Merek atau jenis browser. Misalnya, Chrome, Firefox.

browser_version

string Opsional. Versi browser. Misalnya, 136.0.7103.60, 5.0.

Cuplikan berikut menunjukkan contoh setelan device:

"device:" {
  "category": "mobile",
  "language": "en",
  "screen_resolution": "1280x2856",
  "operating_system": "Android",
  "operating_system_version": "14",
  "model": "Pixel 9 Pro",
  "brand": "Google",
  "browser": "Chrome",
  "browser_version": "136.0.7103.60"
}

Terlepas dari apakah Anda menentukan , Google Analytics akan menerapkan setelan data perangkat mendetail properti ke permintaan.

Parameter kustom

Anda dapat menyertakan parameter kustom cakupan pengguna, cakupan peristiwa, dan cakupan item dalam payload Measurement Protocol.

  • Parameter kustom cakupan pengguna dapat disertakan dalam user_properties.
  • Parameter kustom cakupan peristiwa dapat disertakan dalam events[].params.
  • Parameter kustom cakupan item dapat disertakan dalam items.

Beberapa peristiwa memiliki parameter yang direkomendasikan. Lihat peristiwa untuk parameter yang direkomendasikan untuk semua peristiwa yang didukung.

Nama yang dicadangkan

Beberapa nama peristiwa, parameter, dan properti pengguna dicadangkan dan tidak dapat digunakan:

Nama peristiwa yang dicadangkan

Nama peristiwa berikut dicadangkan dan tidak dapat digunakan:

  • ad_activeview
  • ad_click
  • ad_exposure
  • ad_query
  • ad_reward
  • adunit_exposure
  • app_clear_data
  • app_exception
  • app_install
  • app_remove
  • app_store_refund
  • app_update
  • app_upgrade
  • dynamic_link_app_open
  • dynamic_link_app_update
  • dynamic_link_first_open
  • error
  • firebase_campaign
  • firebase_in_app_message_action
  • firebase_in_app_message_dismiss
  • firebase_in_app_message_impression
  • first_open
  • first_visit
  • in_app_purchase
  • notification_dismiss
  • notification_foreground
  • notification_open
  • notification_receive
  • notification_send
  • os_update
  • session_start
  • user_engagement

Nama parameter yang dicadangkan

Nama parameter berikut dicadangkan dan tidak dapat digunakan:

  • firebase_conversion

Nama parameter tidak boleh diawali dengan hal berikut:

  • _ (underscore)
  • firebase_
  • ga_
  • google_
  • gtag.

Nama properti pengguna yang dicadangkan

Nama properti pengguna berikut dicadangkan dan tidak dapat digunakan:

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

Selain itu, nama properti pengguna tidak dapat diawali dengan:

  • _ (underscore)
  • firebase_
  • ga_
  • google_