Odniesienie do platformy Measurement Protocol

Omówienie

Wysyłanie danych do Google Analytics za pomocą Measurement Protocol składa się z 2 części:

  1. Transport – gdzie i jak wysyłane są dane
  2. Ładunek – wysyłane dane

W tym dokumencie opisano formatowanie transportu i ładunku.

Transport

Punkt końcowy URL

Dane wysyłasz za pomocą Measurement Protocol, wysyłając żądania HTTP POST do tego punktu końcowego:

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

Aby wysłać zdarzenie, prześlij tę prośbę POST:

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

Kody odpowiedzi

Jeśli otrzymano żądanie HTTP, protokół Measurement Protocol zawsze zwraca kod stanu 2xx. Platforma Measurement Protocol nie zwraca kodu błędu, jeśli dane ładunku są nieprawidłowe lub nie zostały przetworzone przez Google Analytics.

Ładunek

Dane są wysyłane do Google Analytics za pomocą danych Measurement Protocol w 2 częściach:

  1. Parametry zapytania
  2. Treść JSON POST

parametry zapytania,

Nazwa parametru Opis

api_secret

Wymagany. API Secret generowany w interfejsie Google Analytics.

Aby utworzyć nowy obiekt tajny, w interfejsie Google Analytics kliknij:
Administracja > Strumienie danych > wybierz strumień > Measurement Protocol > Utwórz.

Zalecamy, aby te informacje były dostępne tylko dla Twojej organizacji. Jeśli wdrażasz protokół pomiarowy po stronie klienta, powinieneś regularnie zmieniać api_secret, aby uniknąć nadmiernego spamu.

Treść żądania w formacie JSON

Klucz Typ Opis

user_id

 string

Opcjonalnie: Unikalny identyfikator użytkownika. Więcej informacji o tym identyfikatorze znajdziesz w artykule Używanie funkcji User-ID do analizy obejmującej wiele platform.

timestamp_micros

 number

Opcjonalnie: Sygnatura czasowa systemu UNIX (w mikrosekundach) czasu do powiązania z zdarzeniem. Ta opcja powinna być ustawiona tylko do rejestrowania zdarzeń, które miały miejsce w przeszłości. Tę wartość można zastąpić za pomocą parametru user_property lub sygnatur czasowych zdarzeń. Zdarzenia można datować wstecz do 3 dni kalendarzowych w zależności od strefy czasowej usługi.

user_properties

 object Opcjonalnie: Właściwości użytkownika na potrzeby pomiaru. Więcej informacji znajdziesz w artykule Właściwości użytkownika.

user_data

 object Opcjonalnie: dane przekazywane przez użytkowników; Więcej informacji znajdziesz w przewodniku dotyczącym danych użytkownika.
object Opcjonalnie: Określa ustawienia dotyczące zgody dla danego żądania. Więcej informacji znajdziesz w sekcji dotyczącej zgody.

non_personalized_ads

 boolean Opcjonalnie: Ustaw na true, aby wskazać, że dane użytkownika nie powinny być używane do wyświetlania reklam spersonalizowanych.

events[]

 array Wymagany. Tablica elementów zdarzenia. W ramach jednej prośby można wysłać maksymalnie 25 zdarzeń. Wszystkie prawidłowe zdarzenia znajdziesz w dokumentacji zdarzeń.

events[].name

 string Wymagany. Nazwa zdarzenia. Wszystkie opcje znajdziesz w dokumentacji Zdarzenia.

events[].params

 object Opcjonalnie: Parametry zdarzenia. Aby poznać sugerowane parametry dla poszczególnych zdarzeń, przejdź do sekcji Zdarzenia.

Atrybut consent konfiguruje typy i stany zgody. Jeśli nie określisz parametru consent, Google Analytics użyje ustawień uzyskiwania zgody pochodzących z odpowiednich interakcji online z klientem lub wystąpieniem aplikacji.

Klucz Typ Opis

ad_user_data

 string

Opcjonalne. Określa stan zgody na wysyłanie do Google danych użytkownika ze zdarzeń i właściwości użytkownika w celach reklamowych.

Musi to być GRANTED lub DENIED.

ad_personalization

 string

Opcjonalne. Określa stan zgody użytkownika na reklamy spersonalizowane.

Musi to być wartość GRANTED lub DENIED.

Parametry niestandardowe

Oprócz parametrów przewidzianych w protokole Measurement Protocol możesz dodawać parametry niestandardowe ograniczone do użytkownika, zdarzenia lub produktu.

  • Parametry niestandardowe ograniczone do użytkownika można umieścić w obiekcie user_properties ładunku.
  • Parametry niestandardowe ograniczone do zdarzenia można uwzględnić w obiekcie events[].params ładunku.
  • Parametry niestandardowe ograniczone do produktu możesz uwzględnić w tablicy items w przypadku każdego zdarzenia.

Niektóre zdarzenia mają zalecane parametry. Zalecane parametry wszystkich obsługiwanych zdarzeń znajdziesz w zdarzeniach.

Zarezerwowane nazwy

Zarezerwowane nazwy zdarzeń

Te nazwy zdarzeń są zarezerwowane i nie można ich używać:

  • 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

Zastrzeżone nazwy parametrów

Ta nazwa parametru jest zarezerwowana i nie można jej używać:

  • firebase_conversion

Poza tym nazwy parametrów nie mogą się zaczynać od:

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

Zarezerwowane nazwy właściwości użytkownika

Te nazwy właściwości użytkownika są zarezerwowane i nie można ich używać:

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

Oprócz tego nazwy właściwości użytkownika nie mogą się zaczynać od:

  • _ (underscore)
  • firebase_
  • ga_
  • google_