- Żą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 kilka sekund po wysłaniu ich do Google Analytics. Raporty Czas rzeczywisty zawierają zdarzenia i dane o korzystaniu z okresów od chwili obecnej do 30 minut wstecz (do 60 minut w przypadku usług w 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órej zdarzenia są śledzone. Jest określony w ścieżce adresu URL, a nie w treści. Dowiedz się, gdzie znaleźć identyfikator usługi. Przykład: właściwość/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 danych. 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 nie określono inaczej, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 000 wierszy na żądanie,niezależnie od tego, ile zażądasz. Interfejs API może też zwrócić mniej wierszy niż w żądaniu |
metricAggregations[] |
Agregacja danych. Zbiorcze wartości danych będą widoczne w wierszach, w których wymiar wymiarValues 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 ramach PropertyQuota. |
minuteRanges[] |
Zakresy danych zdarzenia do odczytu (w minutach). Jeśli nie określono inaczej, używany będzie zakres 1 minuty z ostatnich 30 minut. Jeśli zażądano zakresów obejmujących wiele minut, każdy wiersz odpowiedzi będzie zawierał indeks zakresu minut od zera. Jeśli zakresy 2 minut nakładają się na siebie, dane dotyczące zdarzeń dla pokrywających się minut są uwzględniane w wierszach odpowiedzi dla obu zakresów. |
Treść odpowiedzi
Tabela raportu czasu rzeczywistego odpowiedzi odpowiadająca żądaniu.
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ść są zgodne z wymiarami podanymi w wierszach. |
metricHeaders[] |
Opisuje kolumny danych. Liczba i kolejność nagłówków MetricHeaders 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 (w razie potrzeby). |
maximums[] |
Maksymalne wartości danych, jeśli jest to wymagane. |
minimums[] |
Minimalne wartości danych, jeśli są wymagane. |
rowCount |
Łączna liczba wierszy w wyniku zapytania. Funkcja |
propertyQuota |
Stan limitu w czasie rzeczywistym w tej usłudze Analytics uwzględniający to żądanie. |
kind |
Określa rodzaj zasobu tego komunikatu. Ten element |
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
MinuteRange
sąsiadujący zbiór minut: startMinutesAgo
, startMinutesAgo + 1
, ..., endMinutesAgo
; Żądania mogą trwać maksymalnie 2 minuty.
Zapis JSON |
---|
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer } |
Pola | |
---|---|
name |
Przypisuje nazwę do tego zakresu minut. Wymiar |
startMinutesAgo |
Minuta rozpoczęcia obowiązywania zapytania podana jako liczba minut poprzedzających tę datę. Na przykład Jeśli nie określono inaczej, |
endMinutesAgo |
Minuta końcowa zapytania włącznie z liczbą wcześniejszych minut. Nie może przypadać przed Jeśli nie określono inaczej, |