Method: properties.runRealtimeReport

Zwraca niestandardowy raport zawierający dane o zdarzeniach w czasie rzeczywistym w Twojej usłudze. Zdarzenia pojawiają się w raportach w czasie rzeczywistym kilka sekund po wysłaniu do Google Analytics. Raporty w czasie rzeczywistym pokazują zdarzenia i dane o użytkowaniu z okresów od chwili obecnej do 30 minut wstecz (do 60 minut w przypadku usług Google Analytics 360).

Przewodnik po tworzeniu żądań w czasie rzeczywistym i interpretowaniu odpowiedzi znajdziesz w artykule Tworzenie raportu w czasie rzeczywistym.

Żą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. 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)

Wymiary, o które prosisz i które są wyświetlane.
metrics[]

object (Metric)

Dane, o które prosisz i które są wyświetlane.
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

Klauzula filtra danych. Stosowana w fazie po agregacji, podobnie jak klauzula having w SQL. W tym filtrze nie można używać wymiarów.
limit

string (int64 format)

Liczba wierszy do zwrócenia. Jeśli nie podasz tu żadnej wartości, zostanie zwróconych 10 tys. wierszy. Interfejs API zwraca maksymalnie 250 tys. wierszy na żądanie,niezależnie od tego, ile wierszy poprosisz. limit musi być liczbą dodatnią.

Interfejs API może też zwrócić mniej wierszy niż żądany limit, jeśli nie ma tylu wartości wymiarów.limit Na przykład wymiar country ma mniej niż 300 możliwych wartości, więc podczas raportowania tylko według tego wymiaru nie można uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz limit na wyższą wartość.country
metricAggregations[]

enum (MetricAggregation)

Agregacja danych. Zagregowane wartości danych będą wyświetlane w wierszach, w których wartości wymiarów są ustawione na „RESERVED_(MetricAggregation)”.
orderBys[]

object (OrderBy)

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

boolean

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

object (MinuteRange)

Zakresy minutowe danych o zdarzeniach do odczytu. Jeśli nie podasz tu żadnej wartości, zostanie użyty 1-minutowy zakres obejmujący ostatnie 30 minut. Jeśli poprosisz o kilka zakresów minutowych, każdy wiersz odpowiedzi będzie zawierał indeks zakresu minutowego liczony od zera. Jeśli 2 zakresy minutowe się pokrywają, dane o zdarzeniach z pokrywających się minut są uwzględniane w wierszach odpowiedzi dla obu zakresów minutowych.

Treść odpowiedzi

Tabela raportu 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 nagłówków wymiarów i ich kolejność odpowiadają wymiarom występującym w wierszach.
metricHeaders[]

object (MetricHeader)

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

object (Row)

Wiersze zawierające kombinacje wartości wymiarów i wartości danych w raporcie.
totals[]

object (Row)

Jeśli poprosisz o to, zagregowane wartości danych.
maximums[]

object (Row)

Jeśli poprosisz o to, maksymalne wartości danych.
minimums[]

object (Row)

Jeśli poprosisz o to, minimalne wartości danych.
rowCount

integer

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

object (PropertyQuota)

Stan limitu w czasie rzeczywistym w tej usłudze Google Analytics, w tym to żądanie.
kind

string

Określa rodzaj zasobu, jakim jest ta wiadomość. Wartość 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 OAuth:

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

MinuteRange

Ciągły zestaw minut: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Dozwolone są maksymalnie 2 zakresy minutowe w żądaniu.

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

string

Przypisuje nazwę do tego zakresu minutowego. W odpowiedzi na raport wymiar dateRange ma wartość tej nazwy. Jeśli jest ustawiony, nie może zaczynać się od date_range_ ani RESERVED_. Jeśli nie jest ustawiony, zakresy minutowe są nazywane według indeksu liczonego od zera w żądaniu: date_range_0, date_range_1 itp.
startMinutesAgo

integer

Włącznie początkowa minuta zapytania jako liczba minut przed obecną chwilą. Na przykład "startMinutesAgo": 29 oznacza, że raport powinien zawierać dane o zdarzeniach z ostatnich 29 minut. Nie może przypadać po endMinutesAgo.

Jeśli nie podasz tu żadnej wartości, startMinutesAgo przyjmie domyślnie wartość 29. Usługi standardowe Analytics mogą żądać danych o zdarzeniach z ostatnich 30 minut (startMinutesAgo <= 29), a usługi Analytics 360 – z ostatnich 60 minut (startMinutesAgo <= 59).
endMinutesAgo

integer

Włącznie końcowa minuta zapytania jako liczba minut przed obecną chwilą. Nie może przypadać przed startMinutesAgo. Na przykład "endMinutesAgo": 15 oznacza, że raport powinien zawierać dane zdarzeń sprzed 15 minut.

Jeśli nie podasz tu żadnej wartości, endMinutesAgo przyjmie domyślnie wartość 0. Usługi standardowe Analytics mogą żądać dowolnej minuty z ostatnich 30 minut danych o zdarzeniach (endMinutesAgo <= 29), a usługi Analytics 360 – dowolnej minuty z ostatnich 60 minut danych o zdarzeniach (endMinutesAgo <= 59).