Na tej stronie opisujemy mechanizm przesyłania i parametry danych w protokole pomiarowym.
Transport
Wszystkie dane muszą być wysyłane bezpiecznie za pomocą żądań HTTPSPOST
.
Wysyłaj żądania do tego punktu końcowego:
https://www.google-analytics.com/mp/collect
Jeśli chcesz, aby dane były zbierane w UE, użyj tego punktu końcowego:
https://region1.google-analytics.com/mp/collect
Oto przykładowe żądanie POST
:
POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
PAYLOAD_DATA
Zastąp PAYLOAD_DATA elementem Payload żądania.
Measurement Protocol zwraca kod stanu 2xx
, jeśli otrzyma żądanie HTTP
. Protokół pomiarowy nie zwraca kodu błędu, jeśli ładunek jest zniekształcony lub jeśli dane są nieprawidłowe albo nie są przetwarzane przez Google Analytics.
Ładunek
Ładunek składa się z 2 części:
- Parametry zapytania.
- Treść w formacie JSON
POST
.
Parametry zapytania
Nazwa parametru | Opis |
---|---|
|
Wymagany. Tajny klucz API z interfejsu Google Analytics.
Znajduje się w sekcji Administracja > Strumienie danych > Wybierz swój strumień > Measurement Protocol > Utwórz. prywatne dla Twojej organizacji. Powinna być regularnie aktualizowana, aby uniknąć nadmiernego spamu. |
Treść żądania POST w formacie JSON
Klucz | Typ | Opis |
---|---|---|
|
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 UTF-8. |
|
number |
Opcjonalnie. Sygnatura czasowa w formacie czasu uniksowego w mikrosekundach, a nie w milisekundach. Reprezentuje czas wydarzenia. Należy ustawić tylko w przypadku rejestrowania zdarzeń, które miały miejsce w przeszłości. Może zostać zastąpiony przez |
|
object |
Opcjonalnie. Właściwości użytkownika dla pomiaru. |
|
object |
Opcjonalnie. Dane przekazywane przez użytkowników. |
|
object |
Opcjonalnie. Ustawienia zgody w przypadku żądania. Więcej informacji znajdziesz w sekcji dotyczącej zgody. |
|
boolean |
Opcjonalny Ustaw wartość true , aby wskazać, że danych użytkownika nie należy używać do wyświetlania reklam spersonalizowanych.
|
|
object |
Opcjonalnie. Ustawia informacje geograficzne dotyczące żądania w formacie strukturalnym. |
|
string |
Opcjonalnie. Adres IP, którego Google Analytics używa do uzyskiwania informacji geograficznych na potrzeby żądania. |
|
object |
Opcjonalnie. Ustawia informacje o urządzeniu w żądaniu w formacie strukturalnym. |
|
array |
Wymagany. Tablica event elementów. W jednym żądaniu można wysłać maksymalnie 25 zdarzeń. Wszystkie prawidłowe zdarzenia znajdziesz w dokumentacji zdarzeń.
|
|
string |
Wymagany. Nazwa zdarzenia. Wszystkie opcje znajdziesz w sekcji Zdarzenia. |
|
object |
Opcjonalnie. Parametry zdarzenia. Sugerowane parametry poszczególnych zdarzeń znajdziesz w sekcji Zdarzenia, a parametry wspólne – w tym artykule. |
Typowe parametry zdarzenia
Measurement Protocol ma te wspólne parametry zdarzeń:
Klucz | Typ | Opis |
---|---|---|
|
number |
Liczba dodatnia, która identyfikuje sesję użytkownika. Wymagane w przypadku kilku typowych zastosowań.
Musi pasować do wyrażenia regularnego ^\d+$ .
|
|
number |
Czas trwania zaangażowania użytkownika w milisekundach w przypadku zdarzenia. Użyj wartości, która odzwierciedla czas zaangażowania użytkownika od poprzedniego zdarzenia. |
|
number |
czas od początku epoki uniksowej podawany w mikrosekundach w przypadku zdarzenia. Za pomocą tego parametru możesz zastąpić sygnaturę czasową zdarzenia. |
Zgoda
Atrybut consent
konfiguruje typy i stany zgody.
Jeśli nie określisz wartości parametru consent
, Google Analytics użyje ustawień zgody z odpowiednich interakcji online w przypadku klienta lub instancji aplikacji.
Klucz | Typ | Opis |
---|---|---|
|
string |
Opcjonalnie. Stan zgody na wysyłanie do Google danych użytkownika z wydarzeń i właściwości użytkownika w żądaniu w celach reklamowych. Może to być |
|
string |
Opcjonalnie. Stan zgody użytkownika na reklamy spersonalizowane. Może to być |
Informacje geograficzne
Atrybuty user_location
i ip_override
zawierają informacje geograficzne.
user_location
ma pierwszeństwo przed ip_override
.
Oto struktura pola user_location
. Podaj jak najwięcej atrybutów. Zalecamy co najmniej country_id
i region_id
.
Klucz | Typ | Opis |
---|---|---|
|
string |
Opcjonalnie. Nazwa miasta. Jeśli miasto znajduje się w Stanach Zjednoczonych, ustaw też country_id i region_id , aby Google Analytics mógł prawidłowo mapować nazwę miasta na identyfikator miasta.
|
|
string |
Opcjonalnie. Kraj i podział podrzędny w formacie ISO 3166. Przykłady: US-CA , US-AR , CA-BC , GB-LND , CN-HK .
|
|
string |
Opcjonalnie. Kraj w formacie ISO 3166-1 alfa-2. Na przykład: US , AU , ES , FR .
|
|
string |
Opcjonalnie. Subkontynent w formacie UN M49. Na przykład: 011 , 021 , 030 , 039 .
|
|
string |
Opcjonalnie. Kontynent w formacie UN M49. Na przykład: 002 , 019 , 142 , 150 .
|
Oto przykład 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 wygeneruje informacje geograficzne na podstawie adresu IP.
Jeśli wyślesz user_location
, Google Analytics zignoruje ip_override
.
Jeśli nie wysyłasz parametrów user_location
ani ip_override
, Google Analytics uzyskuje informacje geograficzne ze zdarzeń tagowania za pomocą parametrów
client_id
Google Analytics stosuje do żądania ustawienia szczegółowych danych o lokalizacji usługi, niezależnie od wysyłanych informacji geograficznych.
Informacje o urządzeniu
Aby wysłać informacje o urządzeniu, użyj pola
device
. Oto struktura pola device
. Podaj jak najwięcej atrybutów. Zalecamy co najmniej category
.
Klucz | Typ | Opis |
---|---|---|
|
string |
Opcjonalnie. Kategoria urządzenia. Na przykład: desktop , tablet , mobile , smart TV .
|
|
string |
Opcjonalnie. Język w formacie ISO 639-1. Na przykład: en , en-US .
|
|
string |
Opcjonalnie. Rozdzielczość urządzenia w formacie WIDTHxHEIGHT . Na przykład: 1280x2856 , 1080x2340 .
|
|
string |
Opcjonalnie. System operacyjny lub platforma. Na przykład: MacOS .
|
|
string |
Opcjonalnie. Wersja systemu operacyjnego lub platformy. Na przykład: 13.5 .
|
|
string |
Opcjonalnie. Model urządzenia. Na przykład: Pixel 9 Pro , Samsung Galaxy S24 .
|
|
string |
Opcjonalnie. Marka urządzenia. Na przykład: Google , Samsung .
|
|
string |
Opcjonalnie. Marka lub typ przeglądarki. Na przykład: Chrome , Firefox .
|
|
string |
Opcjonalnie. Wersja przeglądarki. Na przykład: 136.0.7103.60 , 5.0 .
|
Poniższy fragment kodu pokazuje przykład ustawień 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"
}
Niezależnie od tego, czy określisz Google Analytics zastosuje do żądania ustawienia usługi dotyczące szczegółowych danych o urządzeniach.
Parametry niestandardowe
W ładunku Measurement Protocol możesz uwzględniać niestandardowe parametry ograniczone do użytkownika, zdarzenia i produktu.
- Parametry niestandardowe ograniczone do użytkownika można uwzględnić w
user_properties
. - Parametry niestandardowe ograniczone do zdarzenia można uwzględnić w
events[].params
. - Parametry niestandardowe ograniczone do produktu można uwzględnić w
items
.
Zalecane wartości niektórych zdarzeń
Niektóre zdarzenia mają zalecane parametry. Zalecane parametry 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ą zaczynać się od tych znaków:
_ (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_