Method: properties.runRealtimeReport

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

string

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 (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świetlone wymiary.

metrics[]

object (Metric)

Żądane i wyświetlone wskaźniki.

dimensionFilter

object (FilterExpression)

Klauzula filtra 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 przypadku klauzuli SQL. W tym filtrze nie można używać wymiarów.

limit

string (int64 format)

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

Interfejs API może też zwrócić mniej wierszy niż żądany element limit, jeśli nie ma tylu wartości wymiarów co limit. Na przykład w wymiarze country możliwych jest mniej niż 300 wartości, więc w raportach tylko dla wymiaru country nie można uzyskać więcej niż 300 wierszy, nawet jeśli w polu limit ustawisz wyższą wartość.

metricAggregations[]

enum (MetricAggregation)

Agregacja danych. Połączone wartości danych będą wyświetlane w wierszach, w których parametr parametrValues ma wartość „RESERVED_(MetricAggregation)”.

orderBys[]

object (OrderBy)

Określa kolejność wierszy w odpowiedzi.

returnPropertyQuota

boolean

Określa, czy zwracać bieżący stan limitu usługi Analytics w czasie rzeczywistym. Limit jest zwracany w metodzie PropertyQuota.

minuteRanges[]

object (MinuteRange)

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 (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 wymiarów i ich kolejność odpowiada wymiarom w wierszach.

metricHeaders[]

object (MetricHeader)

Opisuje kolumny danych. Liczba nagłówków MetricHeaders i ich kolejność są zgodne z danymi w wierszach.

rows[]

object (Row)

Wiersze z kombinacjami wartości wymiarów i wartościami danych w raporcie.

totals[]

object (Row)

Zsumowane wartości danych (jeśli będzie to 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. rowCount jest niezależne od liczby wierszy zwracanych w odpowiedzi i od parametru żądania limit. Jeśli na przykład zapytanie zwróci 175 wierszy i zawiera limit z 50 w żądaniu do interfejsu API, odpowiedź będzie zawierać rowCount ze 175 wierszy, ale tylko 50 wierszy.

propertyQuota

object (PropertyQuota)

Stan limitu w usłudze Analytics w czasie rzeczywistym, łącznie z tą prośbą.

kind

string

Określa rodzaj zasobu. Ten komunikat kind jest zawsze stałym ciągiem znaków „analyticsData#runRealtimeReport”. Przydaje się do rozróżniania typów odpowiedzi w formacie JSON.

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

string

Przypisuje nazwę do tego zakresu minut. Wymiar dateRange ma taką nazwę w odpowiedzi na żądanie raportu. Jeśli jest skonfigurowana, nie może zaczynać się od date_range_ ani RESERVED_. Jeśli zakres nie jest ustawiony, zakresy minut są nazwane w żądaniu: date_range_0, date_range_1 itd.

startMinutesAgo

integer

Minuta rozpoczęcia włącznie z minutą rozpoczęcia zapytania przedstawiona w przeliczeniu na wcześniejsze minuty. Na przykład "startMinutesAgo": 29 określa, że raport powinien zawierać dane zdarzeń sprzed 29 minut i później. Nie może przypadać po endMinutesAgo.

Jeśli nie określono inaczej, startMinutesAgo przyjmuje domyślnie wartość 29. Standardowe usługi 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

Minuta końcowa zapytania (włącznie) podana w ciągu poprzednich minut. 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ślnie wartość 0. Standardowe usługi Analytics mogą żądać danych zdarzenia z dowolnej minuty z ostatnich 30 minut (endMinutesAgo <= 29), a usługi w Analytics 360 mogą żądać danych zdarzenia z dowolnej minuty z ostatnich 60 minut (endMinutesAgo <= 59).