Method: properties.runRealtimeReport

Zwraca niestandardowy raport z danymi o zdarzeniach w czasie rzeczywistym dotyczącymi Twojej usługi. Zdarzenia pojawiają się w raportach Czas rzeczywisty w kilka sekund po wysłaniu ich do Google Analytics. Raporty Czas rzeczywisty zawierają dane o zdarzeniach i użytkowaniu z okresu od bieżącej chwili do 30 minut wstecz (w przypadku usług w Google Analytics 360 – do 60 minut).

Aby dowiedzieć się, jak tworzyć żądania w czasie rzeczywistym i interpretować odpowiedzi, zapoznaj się z artykułem 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 Google Analytics, której zdarzenia są śledzone. Wskazuje się je w ścieżce adresu URL, a nie w treści. Więcej informacji znajdziesz w sekcji 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)

Wymiary żądane i wyświetlane.
metrics[]

object (Metric)

Dane, które mają być wyświetlane.
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

Klauzula filtra danych. Stosuje się go w fazie po agregacji, podobnie jak w przypadku klauzuli SQL having. W tym filtrze nie można używać wymiarów.
limit

string (int64 format)

Liczba wierszy do zwrócenia. Jeśli nie podasz tej wartości, zwróci się 10 tys. wierszy. Interfejs API zwraca maksymalnie 250 tys. wierszy na żądanie,niezależnie od tego, o ile prosisz. Wartość limit musi być dodatnia.

Interfejs API może też zwrócić mniej wierszy niż żądana liczba limit, jeśli nie ma tylu wartości wymiarów, ile wynosi parametr limit. Na przykład w przypadku wymiaru country jest mniej niż 300 możliwych wartości, więc w raportach dotyczących tylko wymiaru country nie możesz uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz większą wartość dla wymiaru limit.
metricAggregations[]

enum (MetricAggregation)

agregacja danych, Uwzględnione wartości danych będą wyświetlane w wierszach, w których wartości wymiarów mają ustawienie „RESERVED_(MetricAggregation)”.
orderBys[]

object (OrderBy)

Określa sposób sortowania wierszy w odpowiedzi.
returnPropertyQuota

boolean

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

object (MinuteRange)

Zakresy minutowe danych zdarzenia do odczytu. Jeśli nie zostanie podany, zostanie użyty zakres 1 minuty z ostatnich 30 minut. Jeśli żądasz zakresów minutowych, każdy wiersz odpowiedzi będzie zawierać indeks zakresu minutowego oparty na 0. Jeśli 2 zakresy minutowe się pokrywają, dane zdarzenia dotyczące pokrywających się minut są uwzględniane w wierszach odpowiedzi dla obu zakresów minut.

Treść odpowiedzi

Tabela odpowiedzi w raporcie w czasie rzeczywistym odpowiadająca żądaniu.

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 elementów DimensionHeaders i ich kolejność odpowiadają wymiarom obecnym we wierszach.
metricHeaders[]

object (MetricHeader)

Opisuje kolumny danych. Liczba nagłówków danych i ich kolejność odpowiadają danym w wierszach.
rows[]

object (Row)

wiersze z kombinacjami wartości wymiarów i wartości danych w raporcie.
totals[]

object (Row)

W razie potrzeby łączne wartości danych.
maximums[]

object (Row)

W razie potrzeby maksymalne wartości danych.
minimums[]

object (Row)

W razie potrzeby minimalne wartości danych.
rowCount

integer

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

object (PropertyQuota)

Stan limitu dotyczącego danych w czasie rzeczywistym w usłudze w Google Analytics, w tym w przypadku tej prośby.
kind

string

Określa rodzaj zasobu, do którego odnosi się wiadomość. Wartość kind to zawsze ustalony ciąg 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

MinuteRange

ciągły zbiór minut: startMinutesAgo, startMinutesAgo + 1, …, endMinutesAgo; Dozwolone są żądania o zakresie do 2 minut.

Zapis JSON 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
Pola
name

string

Przypisuje nazwę temu zakresowi minut. Wymiar dateRange ma w odpowiedzi na raport tę nazwę. Jeśli jest ustawiony, nie może się zaczynać od date_range_ ani RESERVED_. Jeśli nie są skonfigurowane, zakresy minut są nazywane w żądaniu według indeksu od 0 w górę: date_range_0, date_range_1 itd.
startMinutesAgo

integer

Minuta rozpoczęcia zapytania jako liczba minut przed bieżącą chwilą. Na przykład "startMinutesAgo": 29 określa, że raport powinien zawierać dane o zdarzeniach z ostatnich 29 minut. Nie może być późniejsza niż endMinutesAgo.

Jeśli nie podasz żadnej wartości, startMinutesAgo zostanie ustawione na 29. Usługi standardowe w Analytics mogą wysyłać żądania dotyczące danych zdarzeń z ostatnich 30 minut (startMinutesAgo <= 29), a usługi w Analytics 360 – z ostatnich 60 minut (startMinutesAgo <= 59).
endMinutesAgo

integer

Minuta końcowa zapytania jako liczba minut przed bieżącą chwilą. Nie może być wcześniejsza niż startMinutesAgo. Na przykład "endMinutesAgo": 15 określa, że raport powinien zawierać dane o zdarzeniach z okresu 15 minut wstecz.

Jeśli nie podasz wartości, endMinutesAgo przyjmie domyślnie wartość 0. Usługi standardowe w Analytics mogą wysyłać żądania dotyczące danych zdarzeń z dowolnej minuty w ciągu ostatnich 30 minut (endMinutesAgo <= 29), a usługi w Analytics 360 – z dowolnej minuty w ciągu ostatnich 60 minut (endMinutesAgo <= 59).