Ta strona została przetłumaczona przez Cloud Translation API.

Method: properties.runRealtimeReport

Żądanie HTTP
Parametry ścieżki
Treść żądania
- Zapis JSON
Treść odpowiedzi
- Zapis JSON
Zakresy autoryzacji
MinuteRange
- Zapis JSON
Wypróbuj

Zwraca niestandardowy raport z danymi zdarzeń w czasie rzeczywistym dla Twojej usługi. Zdarzenia pojawiają się w raportach w czasie rzeczywistym kilka sekund po wysłaniu ich do Google Analytics. Raporty Czas rzeczywisty zawierają zdarzenia i dane o korzystaniu z okresów od chwili obecnej do 30 minut wstecz (do 60 minut w przypadku usług w 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

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

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

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`) } ] }

{
  "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 danych. 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 nie określono inaczej, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 000 wierszy na żądanie,niezależnie od tego, ile zażądasz. `limit` musi być liczbą dodatnią. Interfejs API może też zwrócić mniej wierszy niż w żądaniu `limit`, jeśli nie ma tylu wartości wymiarów co `limit`. Na przykład możliwych wartości wymiaru `country` jest mniej niż 300, więc w raporcie tylko dla wymiaru `country` nie możesz uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz w polu `limit` wyższą wartość.
`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.
`minuteRanges[]`	`object (MinuteRange)` Zakresy danych zdarzenia do odczytu (w minutach). Jeśli nie określono inaczej, używany będzie zakres 1 minuty z ostatnich 30 minut. Jeśli zażądano zakresów obejmujących wiele minut, każdy wiersz odpowiedzi będzie zawierał indeks zakresu minut od zera. Jeśli zakresy 2 minut nakładają się na siebie, dane dotyczące zdarzeń dla pokrywających się minut są uwzględniane w wierszach odpowiedzi dla obu zakresów.

Treść odpowiedzi

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

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

Zapis JSON

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 }

{
  "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ść 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. Funkcja `rowCount` jest niezależna od liczby wierszy zwracanych w odpowiedzi i parametru żądania `limit`. Jeśli na przykład zapytanie zwróci 175 wierszy i zawiera w żądaniu do interfejsu API `limit` z 50, odpowiedź będzie zawierała `rowCount` ze 175, ale tylko 50 wierszy.
`propertyQuota`	`object (PropertyQuota)` Stan limitu w czasie rzeczywistym w tej usłudze Analytics uwzględniający to żądanie.
`kind`	`string` Określa rodzaj zasobu tego komunikatu. Ten element `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

MinuteRange

sąsiadujący zbiór minut: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo; Żądania mogą trwać maksymalnie 2 minuty.

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

Pola

Pola
`name`	`string` Przypisuje nazwę do tego zakresu minut. Wymiar `dateRange` otrzymuje tę nazwę w odpowiedzi na raport. Jeśli jest ustawione, nie może zaczynać się od `date_range_` ani `RESERVED_`. Jeśli nie jest ustawiony, zakresy minut są nazwane w żądaniu w postaci indeksu liczonego od zera: `date_range_0`, `date_range_1` itd.
`startMinutesAgo`	`integer` Minuta rozpoczęcia obowiązywania zapytania podana jako liczba minut poprzedzających tę datę. Na przykład `"startMinutesAgo": 29` określa, że raport powinien zawierać dane zdarzenia sprzed 29 minut i później. Nie może przypadać po `endMinutesAgo`. Jeśli nie określono inaczej, `startMinutesAgo` ma domyślnie wartość 29. Usługi standardowe w Analytics mogą prosić o dane zdarzenia z ostatnich 30 minut (`startMinutesAgo <= 29`), a usługi w Analytics 360 mogą prosić o dane zdarzenia z ostatnich 60 minut (`startMinutesAgo <= 59`).
`endMinutesAgo`	`integer` Minuta końcowa zapytania włącznie z liczbą wcześniejszych 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` przyjmuje domyślnie wartość 0. Usługi standardowe w Analytics mogą wysyłać żądanie danych zdarzenia z ostatnich 30 minut (`endMinutesAgo <= 29`), a usługi w Analytics 360 mogą prosić o dostęp do danych zdarzenia z ostatnich 60 minut (`endMinutesAgo <= 59`).

name

string

Przypisuje nazwę do tego zakresu minut. Wymiar dateRange otrzymuje tę nazwę w odpowiedzi na raport. Jeśli jest ustawione, nie może zaczynać się od date_range_ ani RESERVED_. Jeśli nie jest ustawiony, zakresy minut są nazwane w żądaniu w postaci indeksu liczonego od zera: date_range_0, date_range_1 itd.

startMinutesAgo

integer

Minuta rozpoczęcia obowiązywania zapytania podana jako liczba minut poprzedzających tę datę. Na przykład "startMinutesAgo": 29 określa, że raport powinien zawierać dane zdarzenia sprzed 29 minut i później. Nie może przypadać po endMinutesAgo.

Jeśli nie określono inaczej, startMinutesAgo ma domyślnie wartość 29. Usługi standardowe w Analytics mogą prosić o dane zdarzenia z ostatnich 30 minut (startMinutesAgo <= 29), a usługi w Analytics 360 mogą prosić o dane zdarzenia z ostatnich 60 minut (startMinutesAgo <= 59).

endMinutesAgo

integer

Minuta końcowa zapytania włącznie z liczbą wcześniejszych 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 przyjmuje domyślnie wartość 0. Usługi standardowe w Analytics mogą wysyłać żądanie danych zdarzenia z ostatnich 30 minut (endMinutesAgo <= 29), a usługi w Analytics 360 mogą prosić o dostęp do danych zdarzenia z ostatnich 60 minut (endMinutesAgo <= 59).