Method: properties.runRealtimeReport

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

string

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 (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean,
  "minuteRanges": [
    {
      object (MinuteRange)
    }
  ]
}
Pola
dimensions[]

object (Dimension)

Żądane i wyświetlane wymiary.
metrics[]

object (Metric)

Dane żądane i wyświetlone.
dimensionFilter

object (FilterExpression)

Klauzula filtrowania wymiarów. W tym filtrze nie można używać danych.
metricFilter

object (FilterExpression)

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

string (int64 format)

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ść limit musi być liczbą dodatnią.

Interfejs API może też zwrócić mniej wierszy niż żądane limit, jeśli nie ma tylu wartości wymiarów, co w polu limit. Wymiar country może mieć np. mniej niż 300 możliwych wartości, więc gdy raportujesz tylko element country, nie możesz uzyskać więcej niż 300 wierszy nawet wtedy, gdy ustawisz wyższą wartość w polu limit.
metricAggregations[]

enum (MetricAggregation)

Agregacja wskaźników. Zagregowane wartości danych będą widoczne w wierszach, w których wymiar wymiarValues ma wartość „RESERVED_(MetricAggregation)”.
orderBys[]

object (OrderBy)

Określa kolejność wierszy w odpowiedzi.
returnPropertyQuota

boolean

Określa, czy ma być zwracany bieżący stan limitu czasu rzeczywistego w tej usłudze Analytics. Limit jest zwracany w polu PropertyQuota.
minuteRanges[]

object (MinuteRange)

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 (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Pola
dimensionHeaders[]

object (DimensionHeader)

Opisuje kolumny wymiarów. Liczba nagłówków DimensionsHeaders i kolejność nagłówków Wymiarów jest zgodna z wymiarami w wierszach.
metricHeaders[]

object (MetricHeader)

Opisuje kolumny danych. Liczba nagłówków MetricHeaders i kolejność nagłówków MetricHeaders jest zgodna z danymi w wierszach.
rows[]

object (Row)

Wiersze kombinacji wartości wymiarów i wartości danych w raporcie.
totals[]

object (Row)

Łączne wartości danych, jeśli są wymagane.
maximums[]

object (Row)

Maksymalne wartości danych, jeśli są wymagane.
minimums[]

object (Row)

Minimalne wartości danych, jeśli są wymagane.
rowCount

integer

Łączna liczba wierszy w wyniku zapytania. Wartość rowCount jest niezależna od liczby wierszy zwróconych w odpowiedzi i parametru żądania limit. Jeśli na przykład zapytanie zwraca 175 wierszy i zawiera limit z 50 wierszy w żądaniu do interfejsu API, odpowiedź będzie zawierać rowCount z 175 wierszy, ale tylko 50 wierszy.
propertyQuota

object (PropertyQuota)

Stan limitu w czasie rzeczywistym w tej usłudze Analytics z uwzględnieniem tego żądania.
kind

string

Określa, jakiego rodzaju jest ten komunikat. Ten kind jest zawsze stałym ciągiem znaków „analyticsData#runRealtimeReport”. Przydatne do rozróżniania typów odpowiedzi w formacie JSON.

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

string

Powoduje przypisanie nazwy do tego zakresu minut. W odpowiedzi raportu wartość wymiaru dateRange jest przypisywana tej nazwie. Jeśli jest ustawiony, nie może zaczynać się od date_range_ ani RESERVED_. Jeśli nie jest ustawiona, zakresy minutowe są nazywane zgodnie z indeksem liczonym w żądaniu (date_range_0, date_range_1 itd.).
startMinutesAgo

integer

włącznie z minutą rozpoczęcia zapytania jako liczbę minut wcześniej. Na przykład "startMinutesAgo": 29 określa, że raport powinien zawierać dane zdarzenia sprzed 29 minut i później. Nie może przypadać po endMinutesAgo.

Jeśli nie określono inaczej, wartość domyślna startMinutesAgo to 29. Standardowe usługi w Analytics mogą żądać danych zdarzenia z ostatnich 30 minut (startMinutesAgo <= 29), a usługi w Analytics 360 mogą żądać danych zdarzenia z ostatnich 60 minut (startMinutesAgo <= 59).
endMinutesAgo

integer

Uwzględniająca minutę końcową dla zapytania wyrażona jako liczba minut wcześniej. Nie może przypadać przed startMinutesAgo. Na przykład "endMinutesAgo": 15 określa, że raport powinien zawierać dane zdarzenia sprzed 15 minut.

Jeśli nie określono inaczej, endMinutesAgo ma domyślną wartość 0. Standardowe usługi w Analytics mogą żądać danych zdarzenia z dowolnej minuty z ostatnich 30 minut (endMinutesAgo <= 29), a usługi Analytics 360 mogą zażądać danych zdarzenia z dowolnej minuty z ostatnich 60 minut (endMinutesAgo <= 59).