Method: runReport

Zwraca niestandardowy raport zawierający dane o zdarzeniach z Google Analytics. Raporty zawierają statystyki pozyskane na podstawie danych zebranych przez kod śledzenia Google Analytics. Dane zwracane przez interfejs API mają postać tabeli z kolumnami dotyczącymi żądanych wymiarów i danych. Dane to indywidualne pomiary aktywności użytkowników w Twojej usłudze, np. liczba aktywnych użytkowników lub zdarzeń. Wymiary dzielą dane według typowych kryteriów, np. kraju czy nazwy zdarzenia.

Żądanie HTTP

POST https://analyticsdata.googleapis.com/v1alpha:runReport

Adres URL używa składni transkodowania gRPC.

Treść żądania

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

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

object (Entity)

Usługa, której zdarzenia są śledzone. W żądaniu zbiorczym ta encja powinna być nieokreślona lub zgodna z elementem na poziomie wsadu.
dimensions[]

object (Dimension)

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

object (Metric)

Dane żądane i wyświetlone.
dateRanges[]

object (DateRange)

Zakresy dat danych do odczytu. Jeśli zażądasz wielu zakresów dat, każdy wiersz odpowiedzi będzie zawierał indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat się nakładają, dane o zdarzeniach z pokrywających się dni są uwzględniane w wierszach odpowiedzi dotyczących obu zakresów dat. W żądaniu dotyczącym kohorty wartość dateRanges musi być nieokreślona.
offset

string (int64 format)

Liczba wierszy w wierszu początkowym. Pierwszy wiersz jest liczony jako wiersz 0.
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.
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)”.
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.
orderBys[]

object (OrderBy)

Określa kolejność wierszy w odpowiedzi.
currencyCode

string

Kod waluty w formacie ISO4217, np. „AED”, „USD” lub „JPY”. Jeśli to pole jest puste, raport używa domyślnej waluty elementu.
cohortSpec

object (CohortSpec)

Grupa kohort powiązana z tym żądaniem. Jeśli w żądaniu znajduje się grupa kohortowa, „kohorta” wymiar musi być podany.
keepEmptyRows

boolean

Jeśli wartość to fałsz lub nieokreślona wartość, nie zostaną zwrócone żadne wiersze z żadnymi danymi równymi 0. Jeśli tak, wiersze te zostaną zwrócone, jeśli nie zostały usunięte osobno przez filtr.
returnPropertyQuota

boolean

Określa, czy ma być zwracany bieżący stan limitu tej usługi w Analytics. Limit jest zwracany w polu PropertyQuota.

Treść odpowiedzi

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

Zakresy autoryzacji

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

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