- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- MinuteRange
- Wypróbuj
Zwraca niestandardowy raport z danymi zdarzeń w czasie rzeczywistym dla Twojej usługi. Zdarzenia pojawiają się w raportach w czasie rzeczywistym w kilka sekund po wysłaniu ich do Google Analytics. Raporty Czas rzeczywisty zawierają zdarzenia i dane o korzystaniu z okresu od chwili obecnej do 30 minut wstecz (do 60 minut w przypadku usług Google Analytics 360).
Wskazówki dotyczące tworzenia żądań w czasie rzeczywistym i interpretowania odpowiedzi znajdziesz w artykule Tworzenie raportu Czas rzeczywisty.
Żądanie HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
property |
Identyfikator usługi w GA4 w Google Analytics, którego zdarzenia są śledzone. Określana w ścieżce adresu URL, a nie w treści. Dowiedz się, gdzie znajdziesz identyfikator usługi. Przykład: properties/1234 |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "dimensions": [ { object ( |
Pola | |
---|---|
dimensions[] |
Żądane i wyświetlone wymiary. |
metrics[] |
Żądane i wyświetlone wskaźniki. |
dimensionFilter |
Klauzula filtra wymiarów. W tym filtrze nie można używać danych. |
metricFilter |
Klauzula filtra wskaźników. Stosowane na etapie po agregacji, podobnie jak w przypadku klauzuli SQL. W tym filtrze nie można używać wymiarów. |
limit |
Liczba wierszy do zwrócenia. Jeśli wartość ta nie zostanie określona, zostanie zwróconych 10 000 wierszy. Interfejs API zwraca maksymalnie 250 000 wierszy na żądanie,niezależnie od tego, ile z nich poprosisz. Interfejs API może też zwrócić mniej wierszy niż żądany element |
metricAggregations[] |
Agregacja danych. Połączone wartości danych będą wyświetlane w wierszach, w których parametr parametrValues ma wartość „RESERVED_(MetricAggregation)”. |
orderBys[] |
Określa kolejność wierszy w odpowiedzi. |
returnPropertyQuota |
Określa, czy zwracać bieżący stan limitu usługi Analytics w czasie rzeczywistym. Limit jest zwracany w metodzie PropertyQuota. |
minuteRanges[] |
Minutowe zakresy danych zdarzenia do odczytu. Jeśli nie określono inaczej, zostanie użyty zakres 1 minuty z ostatnich 30 minut. Jeśli zażądano zakresów z wielu minut, każdy wiersz odpowiedzi będzie zawierał indeks zakresu minut liczony od zera. Jeśli zakresy 2-minutowe się pokrywają, dane dotyczące zdarzeń z pokrywających się minut zostaną uwzględnione w wierszach odpowiedzi dla obu zakresów minut. |
Treść odpowiedzi
Tabela raportu w czasie rzeczywistym z odpowiedzią, której dotyczy żądanie.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "dimensionHeaders": [ { object ( |
Pola | |
---|---|
dimensionHeaders[] |
Opisuje kolumny wymiarów. Liczba nagłówków wymiarów i ich kolejność odpowiada wymiarom w wierszach. |
metricHeaders[] |
Opisuje kolumny danych. Liczba nagłówków MetricHeaders i ich kolejność są zgodne z danymi w wierszach. |
rows[] |
Wiersze z kombinacjami wartości wymiarów i wartościami danych w raporcie. |
totals[] |
Zsumowane wartości danych (jeśli będzie to wymagane). |
maximums[] |
Maksymalne wartości danych (jeśli są wymagane). |
minimums[] |
Minimalne wartości danych (jeśli są wymagane). |
rowCount |
Łączna liczba wierszy w wyniku zapytania. |
propertyQuota |
Stan limitu w usłudze Analytics w czasie rzeczywistym, łącznie z tą prośbą. |
kind |
Określa rodzaj zasobu. Ten komunikat |
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
Zakres minut
sąsiadujący zestaw minut: startMinutesAgo
, startMinutesAgo + 1
, ..., endMinutesAgo
; Zakres żądań może wynosić do 2 minut.
Zapis JSON |
---|
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer } |
Pola | |
---|---|
name |
Przypisuje nazwę do tego zakresu minut. Wymiar |
startMinutesAgo |
Minuta rozpoczęcia włącznie z minutą rozpoczęcia zapytania przedstawiona w przeliczeniu na wcześniejsze minuty. Na przykład Jeśli nie określono inaczej, |
endMinutesAgo |
Minuta końcowa zapytania (włącznie) podana w ciągu poprzednich minut. Nie może przypadać przed Jeśli nie określono inaczej, |