Odniesienie do platformy Measurement Protocol

Na tej stronie opisujemy mechanizm transportu i parametry danych protokołu Measurement Protocol.

Transport

Wszystkie dane muszą być przesyłane w bezpieczny sposób za pomocą żądań HTTPS POST.

Wysyłaj żądania do tego punktu końcowego:

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

Jeśli chcesz, aby Twoje dane były przetwarzane w UE, użyj tego punktu końcowego:

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

Oto przykładowa prośba POST:

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

Zastąp PAYLOAD_DATA ładunkiem żądania.

Jeśli otrzymane zostanie żądanie HTTP, Measurement Protocol zwróci kod stanu 2xx. Measurement Protocol nie zwraca kodu błędu, jeśli ładunek jest zniekształcony, dane są nieprawidłowe lub nie są przetwarzane przez Google Analytics.

Ładunek

Ładunek składa się z 2 części:

  1. Parametry zapytania.
  2. Treść POST w formacie JSON.

Parametry zapytania

Nazwa parametru Opis

api_secret

Wymagany. Tajny klucz API z interfejsu Google Analytics.

Znajdziesz je w sekcji Administracja > Strumienie danych > Wybierz strumień > Measurement Protocol > Utwórz.

Prywatne w organizacji. Powinny być regularnie aktualizowane, aby uniknąć nadmiernego spamu.

Treść żądania POST 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. Może zawierać tylko znaki w kodowaniu utf-8.

timestamp_micros

number

Opcjonalnie. Sygnatura czasowa w mikrosekundach, a nie milisekundach. Reprezentuje czas zdarzenia. Powinien być ustawiony tylko do rejestrowania zdarzeń, które miały miejsce w przeszłości. Może zostać zastąpiony przez user_property lub sygnaturę czasową zdarzenia. 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 związane z danymi pomiarowymi.

user_data

object Opcjonalnie. Dane przekazywane przez użytkowników.
object Opcjonalnie. Ustawienia zgody dotyczące prośby. Więcej informacji znajdziesz w sekcji dotyczącej zgody.

non_personalized_ads

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

user_location

object Opcjonalnie. Ustawia informacje geograficzne dotyczące prośby w uporządkowanym formacie.

ip_override

string Opcjonalnie. Adres IP, którego Google Analytics używa do określania informacji geograficznych dotyczących żądania.

events[]

array Wymagany. Tablica elementów event. W ramach jednej prośby można wysłać maksymalnie 25 zdarzeń. Informacje o wszystkich prawidłowych zdarzeniach znajdziesz w sekcji Zdarzenia.

events[].name

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

events[].params

object Opcjonalnie. Parametry zdarzenia. Sugerowane parametry poszczególnych zdarzeń znajdziesz w sekcji Zdarzenia.

Atrybut consent konfiguruje typy i stany zgody. Jeśli nie podasz wartości parametru consent, Google Analytics użyje ustawień dotyczących zgody z odpowiednich interakcji online na kliencie lub w instancji aplikacji.

Klucz Typ Opis

ad_user_data

string

Opcjonalnie. zgoda na wysyłanie do Google danych użytkownika z zdarzeń i właściwości użytkownika zawartych w żądaniu na potrzeby reklam;

Może to być GRANTED lub DENIED.

ad_personalization

string

Opcjonalnie. zgoda użytkownika na wyświetlanie reklam spersonalizowanych;

Może to być GRANTED lub DENIED.

Informacje geograficzne

Atrybuty user_location i ip_override zawierają informacje geograficzne. Zasada user_location ma pierwszeństwo przed zasadą ip_override.

Oto struktura pola user_location. Podaj jak najwięcej atrybutów. Zalecamy co najmniej country_id i region_id.

Klucz Typ Opis

city

string Opcjonalnie. nazwa miasta,

region_id

string Opcjonalnie. Kraj i podział podrzędny w ISO 3166. Przykłady: US-CA, US-AR, CA-BC, GB-LND, CN-HK.

country_id

string Opcjonalnie. Kod kraju w formacie ISO 3166-1 alfa-2. Przykłady: US, AU, ES, FR.

subcontinent_id

string Opcjonalnie. Subkontynent w formacie UN M49. Przykłady: 011, 021, 030, 039.

continent_id

string Opcjonalnie. Kontynent w formacie UN M49. Przykłady: 002, 019, 142, 150.

Oto przykładowa user_location:

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

ip_override to alternatywa dla user_location. Jeśli zamiast tego wyślesz ip_override, Google Analytics uzyska informacje geograficzne na podstawie adresu IP. Jeśli wyślesz user_location, Google Analytics zignoruje ip_override.

Jeśli nie wysyłasz zdarzeń user_location ani ip_override, Google Analytics uzyskuje informacje geograficzne na podstawie zdarzeń tagowania za pomocą tagu client_id.

Google Analytics stosuje do żądania ustawienia szczegółowe dotyczące danych o lokalizacji usługi niezależnie od wysłanych informacji geograficznych.

Parametry niestandardowe

W danych Measurement Protocol możesz uwzględniać parametry niestandardowe ograniczone do użytkownika, zdarzenia lub produktu.

  • user_properties może zawierać parametry niestandardowe ograniczone do użytkownika.
  • events[].params może zawierać parametry niestandardowe ograniczone do zdarzenia.
  • Parametry niestandardowe ograniczone do produktu można uwzględnić w pliku items.

Niektóre zdarzenia mają zalecane parametry. Informacje o zalecanych parametrach wszystkich obsługiwanych zdarzeń znajdziesz w sekcji Zdarzenia.

Zarezerwowane nazwy

Niektóre nazwy zdarzeń, parametrów i właściwości użytkownika są zarezerwowane i nie można ich używać:

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

Te nazwy parametrów są zarezerwowane i nie można ich używać:

  • firebase_conversion

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_