- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- MinuteRange
- Wypróbuj
Zwraca niestandardowy raport zawierający dane o zdarzeniach w czasie rzeczywistym dotyczące Twojej usługi. Zdarzenia pojawiają się w raportach w czasie rzeczywistym w kilka sekund po przesłaniu do Google Analytics. Raporty w czasie rzeczywistym zawierają zdarzenia i dane o korzystaniu z okresów od chwili obecnej do 30 minut temu (do 60 minut w przypadku usług w Google Analytics 360).
Przewodnik po tworzeniu żądań w czasie rzeczywistym zapoznaj się z sekcją 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. Jest określony w ścieżce adresu URL, a nie w treści. Więcej informacji znajdziesz w artykule, gdzie znaleźć 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świetlane wymiary. |
metrics[] |
Dane żądane i wyświetlone. |
dimensionFilter |
Klauzula filtrowania 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 klauzuli SQL. W tym filtrze nie można używać wymiarów. |
limit |
Liczba wierszy do zwrócenia. Jeśli wartość nie jest określona, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 000 wierszy na żądanie bez względu na to, o ile prosisz. Wartość Interfejs API może też zwrócić mniej wierszy niż żądane |
metricAggregations[] |
Agregacja wskaźników. Zagregowane 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 ma być zwracany bieżący stan limitu czasu rzeczywistego w tej usłudze Analytics. Limit jest zwracany w polu PropertyQuota. |
minuteRanges[] |
Zakresy minutowe danych zdarzenia do odczytu. Jeśli nie określono zakresu, zostanie zastosowany zakres jednominutowy z ostatnich 30 minut. Jeśli zażądasz zakresów wielominutowych, każdy wiersz odpowiedzi będzie zawierał indeks zakresu liczony od zera minut. Jeśli zakresy 2-minutowe nakładają się, dane zdarzeń dotyczące nakładających się minut są uwzględniane w wierszach odpowiedzi dla obu zakresów minut. |
Treść odpowiedzi
Tabela raportu w czasie rzeczywistym odpowiedzi na żą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 DimensionsHeaders i kolejność nagłówków Wymiarów jest zgodna z wymiarami w wierszach. |
metricHeaders[] |
Opisuje kolumny danych. Liczba nagłówków MetricHeaders i kolejność nagłówków MetricHeaders jest zgodna z danymi w wierszach. |
rows[] |
Wiersze kombinacji wartości wymiarów i wartości danych w raporcie. |
totals[] |
Łączne wartości danych, jeśli są 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. Wartość |
propertyQuota |
Stan limitu w czasie rzeczywistym w tej usłudze Analytics z uwzględnieniem tego żądania. |
kind |
Określa, jakiego rodzaju jest ten komunikat. Ten |
Zakresy autoryzacji
Wymaga jednego z tych zakresów protokołu OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
MinuteRange
Przylegający zestaw minut: startMinutesAgo
, startMinutesAgo + 1
, ..., endMinutesAgo
. Żądania mogą mieć zakresy o długości do 2 minut.
Zapis JSON |
---|
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer } |
Pola | |
---|---|
name |
Powoduje przypisanie nazwy do tego zakresu minut. W odpowiedzi raportu wartość wymiaru |
startMinutesAgo |
włącznie z minutą rozpoczęcia zapytania jako liczbę minut wcześniej. Na przykład Jeśli nie określono inaczej, wartość domyślna |
endMinutesAgo |
Uwzględniająca minutę końcową dla zapytania wyrażona jako liczba minut wcześniej. Nie może przypadać przed Jeśli nie określono inaczej, |