Odniesienie do platformy Measurement Protocol

Przegląd

Przesyłanie danych do Google Analytics za pomocą protokołu pomiarowego składa się z 2 etapów:

  1. Transport – gdzie i jak wysyłasz dane
  2. Ładunek – dane, które wysyłasz.

W tym dokumencie opisano format transportu i ładunku.

Transport

Punkt końcowy URL

Wysyłasz dane 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>

  • Wartość BODY żądania. Patrz Ładunek.

Kody odpowiedzi

Measurement Protocol zawsze zwraca kod stanu 2xx po otrzymaniu żądania HTTP. Measurement Protocol nie zwraca kodu błędu, jeśli dane ładunku mają nieprawidłowy format, są nieprawidłowe lub nie zostały przetworzone przez Google Analytics.

Ładunek

Dane są przesyłane do Google Analytics za pomocą platformy Measurement Protocol Data w 2 części:

  1. Parametry zapytania
  2. Treść JSON POST

parametry zapytania

Nazwa parametru Opis

api_secret

Wymagane. API Secret generowany za pomocą interfejsu Google Analytics.

Aby utworzyć nowy obiekt tajny, w interfejsie Google Analytics przejdź do:
Administracja > Strumienie danych > wybierz swój strumień > Measurement Protocol > Utwórz

Zalecamy zachowanie ich jako prywatnych. Jeśli wdrażasz platformę Measurement Protocol po stronie klienta, przeprowadzaj regularną rotację api_secret, aby uniknąć nadmiernego spamu.

firebase_app_id

 Wymagane. Identyfikator aplikacji Firebase. Identyfikator aplikacji Firebase. Znajdziesz go w konsoli Firebase tutaj:
Ustawienia projektu > Ogólne > Twoje aplikacje > Identyfikator aplikacji

measurement_id

 Identyfikator pomiaru. Identyfikator strumienia danych. W interfejsie Google Analytics kliknij kolejno:
Administracja > Strumienie danych > wybierz strumień > Identyfikator pomiaru.

Treść posta JSON

Klucz Typ Opis

app_instance_id

 string

Wymagane. Jednoznacznie identyfikuje konkretną instalację aplikacji Firebase. Wartość tę należy pobrać za pomocą pakietu SDK Firebase.

client_id

 string

Wymagane. Jednoznacznie identyfikuje wystąpienie użytkownika klienta internetowego. Zapoznaj się z sekcją o wysyłaniu zdarzenia do platformy Measurement Protocol.

user_id

 string

Opcjonalnie. Unikalny identyfikator użytkownika. Więcej informacji o tym identyfikatorze znajdziesz w sekcji Korzystanie z funkcji User-ID do analizy obejmującej wiele platform.

timestamp_micros

 number

Opcjonalnie. Sygnatura czasowa uniksowej (w mikrosekundach) czasu powiązania ze zdarzeniem. Należy to ustawić tak, aby rejestrować tylko zdarzenia z przeszłości. Tę wartość można zastąpić za pomocą właściwości user_property lub sygnatur czasowych zdarzenia. Wydarzenia mogą być przechowywane wstecznie 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 sekcji Właściwości użytkownika.
object Opcjonalnie. Określa ustawienia dotyczące uzyskiwania zgody dla żądania. Więcej informacji znajdziesz w sekcji dotyczącej zgody użytkownika.

non_personalized_ads

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

events[]

 array Wymagane. Tablica elementów zdarzenia. Na jedno żądanie można wysłać do 25 zdarzeń. Informacje o wszystkich prawidłowych zdarzeniach znajdziesz w dokumentacji zdarzeń.

events[].name

 string Wymagane. Nazwa zdarzenia. Wszystkie opcje znajdziesz w dokumentacji zdarzeń.

events[].params

 object Opcjonalnie. Parametry zdarzenia. Zalecane parametry każdego zdarzenia znajdziesz w sekcji Zdarzenia.

Atrybut consent konfiguruje typy i stany zgody użytkowników. Jeśli nie określisz funkcji consent, Google Analytics będzie korzystać z ustawień dotyczących zgody powiązanych z odpowiednimi interakcjami online w przypadku klienta lub instancji 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 żądania do Google w celach reklamowych.

Musi to być wartość 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 przewidzianych parametrów w ładunku Measurement Protocol możesz uwzględnić parametry niestandardowe o zakresie ograniczonym do użytkownika, zdarzenia i produktu.

  • Parametry niestandardowe ograniczone do użytkownika można umieścić w obiekcie user_properties ładunku.
  • Parametry niestandardowe ograniczone do zdarzenia można umieścić w obiekcie events[].params ładunku.
  • Parametry niestandardowe ograniczone do produktu możesz umieścić w tablicy items dla 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_