Method: properties.runReport

Zwraca niestandardowy raport z danymi zdarzeń z Google Analytics. Raporty zawierają statystyki utworzone na podstawie danych zebranych przez kod śledzenia Google Analytics. Dane zwracane przez interfejs API są w postaci tabeli z kolumnami dla żądanych wymiarów i danych. Dane to poszczególne pomiary aktywności użytkowników w Twojej usłudze, np. liczba aktywnych użytkowników lub liczba zdarzeń. Wymiary dzielą dane według niektórych typowych kryteriów, np. kraju lub nazwy zdarzenia.

Więcej informacji o składaniu żądań i interpretowaniu odpowiedzi znajdziesz w artykule Tworzenie raportu.

Żądanie HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

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. W żądaniu zbiorczym ta właściwość powinna być nieokreślona lub zgodna z właściwością na poziomie zbiorczego.

Przykład: properties/1234

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
Pola
dimensions[]

object (Dimension)

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

object (Metric)

Dane, które mają być wyświetlane.
dateRanges[]

object (DateRange)

Zakresy dat danych do odczytu. Jeśli zostanie podany zakres dat, każdy wiersz odpowiedzi będzie zawierać indeks zakresu dat oparty na 0. Jeśli 2 zakresy dat się pokrywają, dane o zdarzeniach z nachodzących na siebie dni są uwzględniane w wierszach odpowiedzi dla obu zakresów dat. W prośbie o dane dotyczące kohorty nie można podać wartości parametru dateRanges.
dimensionFilter

object (FilterExpression)

Filtry wymiarów umożliwiają wyświetlanie w raporcie tylko określonych wartości wymiarów. Więcej informacji i przykłady znajdziesz w artykule Podstawy filtrów wymiarów. W tym filtrze nie można używać danych.
metricFilter

object (FilterExpression)

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

string (int64 format)

Liczba wierszy w wierszu początkowym. Pierwszy wiersz jest liczony jako wiersz 0.

W przypadku pobierania stron pierwsze żądanie nie określa przesunięcia, czyli jest ustawione na 0. Pierwsze żądanie zwraca pierwsze limit wierszy. Drugie żądanie ustawia offset na limit pierwszego żądania; zwraca drugi limit wierszy.

Więcej informacji o tym parametrze podziału znajdziesz w sekcji Podział na strony.
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.

Więcej informacji o tym parametrze podziału znajdziesz w sekcji Podział na strony.
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)”. Dane zbiorcze obejmujące porównania i wiele zakresów dat będą sumowane na podstawie zakresów dat.
orderBys[]

object (OrderBy)

Określa sposób sortowania wierszy w odpowiedzi. W przypadku żądań zawierających porównania i kilka zakresów dat porównania będą podlegać sortowaniu.
currencyCode

string

Kod waluty w formacie ISO 4217, np. „AED”, „USD” lub „JPY”. Jeśli pole jest puste, raport używa domyślnej waluty usługi.
cohortSpec

object (CohortSpec)

Grupa kohorty powiązana z tym żądaniem. Jeśli w żądaniu występuje grupa kohorty, musi być podany wymiar „cohorta”.
keepEmptyRows

boolean

Jeśli wartość jest równa fałsz lub nie jest określona, nie zostanie zwrócony żaden wiersz, w którym wszystkie dane mają wartość 0. Jeśli to pole ma wartość Prawda, zwrócone zostaną te wiersze, które nie zostały usunięte przez filtr.

Niezależnie od tego ustawienia keepEmptyRows w raporcie mogą być wyświetlane tylko dane zarejestrowane przez usługę Google Analytics.

Jeśli np. usługa nigdy nie rejestruje zdarzenia purchase, zapytanie o wymiar eventName i dane eventCount nie będzie zawierać wiersza eventName: „purchase” ani eventCount: 0.
returnPropertyQuota

boolean

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

object (Comparison)

Opcjonalnie: Konfiguracja żądanych i wyświetlanych porównań. Aby otrzymać w odpowiedzi kolumnę porównań, żądanie musi zawierać tylko pole porównań.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu RunReportResponse.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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