Method: properties.batchRunReports

Zwraca wiele raportów w partii. Wszystkie raporty muszą dotyczyć tej samej usługi w Google Analytics.

Żądanie HTTP

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

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. Ta właściwość musi być określona w przypadku pakietu. Właściwość w RunReportRequest może być nieokreślona lub zgodna z tą właściwością.

Przykład: properties/1234

Treść żądania

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

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

object (RunReportRequest)

Prośby indywidualne. Każde żądanie ma osobną odpowiedź raportu. Każde żądanie zbiorcze może zawierać maksymalnie 5 żądań.

Treść odpowiedzi

Odpowiedź zbiorcza zawierająca wiele raportów.

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

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

object (RunReportResponse)

Poszczególne odpowiedzi. Każda odpowiedź ma osobne żądanie raportu.
kind

string

Określa rodzaj danego zasobu. Wartość kind to zawsze ustalony ciąg znaków „analyticsData#batchRunReports”. 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

RunReportRequest

Prośba o wygenerowanie raportu.

Zapis JSON 
{
  "property": string,
  "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
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. W ramach żądania zbiorczego ta właściwość powinna być nieokreślona lub zgodna z właściwością na poziomie zbiorczym.

Przykład: properties/1234
dimensions[]

object (Dimension)

Wymiary, o które poproszono i które zostały wyświetlone.
metrics[]

object (Metric)

Żądane i wyświetlane dane.
dateRanges[]

object (DateRange)

Zakresy dat danych do odczytania. Jeśli zostanie wysłana prośba o wiele zakresów dat, każdy wiersz odpowiedzi będzie zawierać indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat pokrywają się, dane o zdarzeniach z dni, w których się pokrywają, są uwzględniane w wierszach odpowiedzi dla obu zakresów dat. W przypadku prośby dotyczącej kohorty ten parametr dateRanges musi być nieokreślony.
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

Klauzula filtra danych. Stosowany po agregacji wierszy raportu, podobnie jak klauzula HAVING w SQL-u. 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.

Podczas stronicowania pierwsze żądanie nie określa przesunięcia lub ustawia przesunięcie na 0. Pierwsze żądanie zwraca pierwsze limit wierszy. Drugie żądanie ustawia przesunięcie na limit pierwszego żądania, a drugie żądanie zwraca drugi limit wierszy.

Więcej informacji o tym parametrze stronicowania znajdziesz w sekcji Stronicowanie.
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 tys. wierszy na żądanie,niezależnie od tego, ile wierszy zażądasz. limit musi być liczbą dodatnią.

Interfejs API może też zwracać mniej wierszy niż żądana wartość limit, jeśli nie ma tylu wartości wymiarów, ile wynosi limit. Na przykład wymiar country ma mniej niż 300 możliwych wartości, więc podczas generowania raportu tylko na podstawie tego wymiaru nie możesz uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz wartość limit na wyższą.country

Więcej informacji o tym parametrze stronicowania znajdziesz w sekcji Stronicowanie.
metricAggregations[]

enum (MetricAggregation)

Agregacja danych. Zagregowane wartości danych będą wyświetlane w wierszach, w których parametr dimensionValues ma wartość „RESERVED_(MetricAggregation)”. Agregacje obejmujące zarówno porównania, jak i wiele zakresów dat będą agregowane na podstawie zakresów dat.
orderBys[]

object (OrderBy)

Określa kolejność wierszy w odpowiedzi. W przypadku żądań obejmujących zarówno porównania, jak i wiele zakresów dat klauzule ORDER BY będą stosowane do porównań.
currencyCode

string

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

object (CohortSpec)

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

boolean

Jeśli wartość jest fałszywa lub nieokreślona, każdy wiersz, w którym wszystkie dane mają wartość 0, nie zostanie zwrócony. Jeśli ma wartość „true”, te wiersze zostaną zwrócone, o ile nie zostaną osobno usunięte przez filtr.

Niezależnie od tego ustawienia keepEmptyRows w raporcie można wyświetlać tylko dane zarejestrowane przez usługę w 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” i eventCount: 0.
returnPropertyQuota

boolean

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

object (Comparison)

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