Method: properties.runRealtimeReport

Interfejs Google Analytics Realtime API zwraca niestandardowy raport z danymi o zdarzeniach w czasie rzeczywistym w przypadku Twojej usługi. Raporty te zawierają zdarzenia i informacje o wykorzystaniu z ostatnich 30 minut.

Żądanie HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{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ó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 (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
Pola
dimensions[]

object (Dimension)

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

object (Metric)

Żądane i wyświetlone wskaźniki.
limit

string (int64 format)

Liczba wierszy do zwrócenia. Jeśli parametr limit nie jest określony, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 100 tys. wierszy na żądanie,niezależnie od tego, ile zażądasz.
dimensionFilter

object (FilterExpression)

Klauzula filtra wymiarów. Aby można było użyć wymiarów w tym filtrze, trzeba poprosić o ich zastosowanie. W tym filtrze nie można używać danych.
metricFilter

object (FilterExpression)

Klauzula filtra danych. Stosowane na etapie po agregacji, podobnie jak w przypadku klauzuli SQL. Aby można było użyć danych w tym filtrze, należy poprosić o dane. W tym filtrze nie można używać wymiarów.
metricAggregations[]

enum (MetricAggregation)

Agregacja danych. Zbiorcze 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 zwracać bieżący stan limitu usługi Analytics w czasie rzeczywistym. Limit jest zwracany w ramach PropertyQuota.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Tabela raportu czasu rzeczywistego odpowiedzi odpowiadająca żądaniu.

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)
  }
}
Pola
dimensionHeaders[]

object (DimensionHeader)

Opisuje kolumny wymiarów. Liczba nagłówków wymiarów i ich kolejność są zgodne z wymiarami podanymi w wierszach.
metricHeaders[]

object (MetricHeader)

Opisuje kolumny danych. Liczba i kolejność nagłówków MetricHeaders 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 (w razie potrzeby).
maximums[]

object (Row)

Maksymalne wartości danych, jeśli jest to wymagane.
minimums[]

object (Row)

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

integer

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

object (PropertyQuota)

Stan limitu w czasie rzeczywistym w tej usłudze Analytics uwzględniający to żądanie.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics