Method: batchRunReports

Zwraca wiele raportów zbiorczo. Wszystkie raporty muszą dotyczyć tego samego elementu.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Treść żądania

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

Zapis JSON 
{
  "entity": {
    object (Entity)
  },
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
Pola
entity

object (Entity)

Usługa, której zdarzenia są śledzone. Tę encję należy określić na potrzeby wsadu. Encja w elemencie RunReportRequest może być nieokreślona lub zgodna z tą encją.
requests[]

object (RunReportRequest)

Indywidualne prośby. Każde żądanie ma osobną odpowiedź na raport. Każde żądanie zbiorcze może zawierać maksymalnie 5 żądań.

Treść odpowiedzi

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

Odpowiedź zbiorcza zawierająca wiele raportów.

Zapis JSON 
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ]
}
Pola
reports[]

object (RunReportResponse)

Indywidualne odpowiedzi. Każda odpowiedź zawiera osobne żądanie raportu.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

RunReportRequest

Żądanie wygenerowania raportu.

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 encją na poziomie wsadu.
dimensions[]

object (Dimension)

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

object (Metric)

Żądane i wyświetlone wskaźniki.
dateRanges[]

object (DateRange)

Zakresy dat danych do odczytania. Jeśli zażądasz kilku zakresów dat, każdy wiersz odpowiedzi będzie zawierał indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat się pokrywają, dane zdarzeń z pokrywających się dni znajdą się w wierszach odpowiedzi dla obu zakresów dat. W żądaniu dotyczącym kohorty pole dateRanges musi być nieokreślone.
offset

string (int64 format)

Liczba wierszy wiersza początkowego. 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 tys. wierszy na żądanie,niezależnie od tego, ile zażądasz.
metricAggregations[]

enum (MetricAggregation)

Agregacja danych. Zbiorcze wartości danych będą widoczne w wierszach, w których wymiar wymiarValues ma wartość „RESERVED_(MetricAggregation)”.
dimensionFilter

object (FilterExpression)

Klauzula filtra wymiarów. Aby można było użyć wymiarów w tym filtrze, trzeba poprosić o ich zastosowanie. 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. Aby można było użyć danych w tym filtrze, należy poprosić o dane. 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”, „JPY”. Jeśli to pole jest puste, raport używa domyślnej waluty elementu.
cohortSpec

object (CohortSpec)

Grupa kohorty powiązana z tym żądaniem. Jeśli żądanie zawiera grupę kohorty, musi być obecny wymiar „kohorta”.
keepEmptyRows

boolean

Jeśli wartość fałsz lub nieokreślona, żaden wiersz ze wszystkimi danymi równymi 0 nie zostanie zwrócony. Jeśli ma wartość true (prawda), te wiersze zostaną zwrócone, jeśli nie zostaną usunięte oddzielnie przez filtr.
returnPropertyQuota

boolean

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