Method: properties.runRealtimeReport

Interfejs Google Analytics Realtime API zwraca niestandardowy raport zawierający dane o zdarzeniach w czasie rzeczywistym dotyczące Twojej usługi. Raporty te pokazują zdarzenia i wykorzystanie 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ó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)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
Pola
dimensions[]

object (Dimension)

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

object (Metric)

Dane żądane i wyświetlone.
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 000 wierszy na żądanie bez względu na to, o ile prosisz.
dimensionFilter

object (FilterExpression)

Klauzula filtrowania wymiarów. Użycie wymiarów w tym filtrze wymaga wysłania prośby o przesłanie prośby. 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. Aby ich używać w tym filtrze, musisz poprosić o ich użycie. W tym filtrze nie można używać wymiarów.
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.

Treść odpowiedzi

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

Tabela raportu w czasie rzeczywistym odpowiedzi na żądanie.

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 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 niezależnie od liczby wierszy zwróconych w odpowiedzi. Jeśli na przykład zapytanie zwraca 175 wierszy, a w żądaniu do interfejsu API zawiera ono limit = 50, odpowiedź będzie zawierać wartość rowCount = 175, ale tylko 50 wierszy.
propertyQuota

object (PropertyQuota)

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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