Method: properties.batchRunPivotReports

Zwraca wiele raportów przestawnych w ramach zbiorczego żądania. Wszystkie raporty muszą dotyczyć tej samej usługi w Google Analytics.

Żądanie HTTP

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

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. Tę usługę należy określić w przypadku zbiorczego żądania. Usługa w RunPivotReportRequest może być nieokreślona lub zgodna z tą usługą.

Przykład: properties/1234

Treść żądania

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

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

object (RunPivotReportRequest)

Poszczególne żądania. Każde żądanie ma osobną odpowiedź z raportem przestawnym. Każde żądanie zbiorcze może zawierać maksymalnie 5 żądań.

Treść odpowiedzi

Odpowiedź zbiorcza zawierająca wiele raportów przestawnych.

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

Zapis JSON
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ],
  "kind": string
}
Pola
pivotReports[]

object (RunPivotReportResponse)

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

kind

string

Określa rodzaj danego zasobu. Ta wartość kind jest zawsze stałym ciągiem znaków „analyticsData#batchRunPivotReports”. 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

RunPivotReportRequest

Żądanie wygenerowania raportu przestawnego.

Zapis JSON
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "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 przypadku żądania zbiorczego ta usługa powinna być nieokreślona lub zgodna z usługą na poziomie zbiorczym.

Przykład: properties/1234

dimensions[]

object (Dimension)

Wymiary, o które prosisz. Wszystkie zdefiniowane wymiary muszą być używane w jednym z tych elementów: dimensionExpression, dimensionFilter, pivots, orderBys.

metrics[]

object (Metric)

Dane, o które prosisz. Musisz określić co najmniej 1 wskaźnik. Wszystkie zdefiniowane dane muszą być używane w jednym z tych elementów: metric_expression, metricFilter, orderBys.

dateRanges[]

object (DateRange)

Zakres dat, z którego mają być pobierane dane zdarzeń na potrzeby raportu. Jeśli określisz kilka zakresów dat, w raporcie zostaną użyte dane zdarzeń z każdego z nich. W nazwach pól obiektu Pivot można uwzględnić specjalny wymiar o nazwie „dateRange”. Jeśli go uwzględnisz, raport będzie porównywać zakresy dat. W przypadku żądania kohorty ten parametr dateRanges musi być nieokreślony.

pivots[]

object (Pivot)

Opisuje wizualny format wymiarów raportu w kolumnach lub wierszach. Suma nazw pól (nazw wymiarów) we wszystkich przestawnych musi być podzbiorem nazw wymiarów zdefiniowanych w wymiarach. Żadne 2 przestawne nie mogą współdzielić wymiaru. Wymiar jest widoczny tylko wtedy, gdy występuje w przestawnym.

dimensionFilter

object (FilterExpression)

Klauzula filtra wymiarów. Aby można było użyć wymiarów w tym filtrze, musisz o nie poprosić. W tym filtrze nie można używać danych.

metricFilter

object (FilterExpression)

Klauzula filtra danych. Stosowana w fazie po agregacji, podobnie jak klauzula SQL having. Aby można było użyć danych w tym filtrze, musisz o nie poprosić. W tym filtrze nie można używać wymiarów.

currencyCode

string

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

Jeśli wartość to false lub pole jest nieokreślone, wiersze, w których wszystkie dane są równe 0, nie będą zwracane. Jeśli wartość to true, te wiersze będą zwracane, o ile nie zostaną osobno usunięte przez filtr.

Niezależnie od tego ustawienia keepEmptyRows w raporcie mogą być wyświetlane 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 PropertyQuota.

comparisons[]

object (Comparison)

Opcjonalnie. Konfiguracja porównań, o które prosisz i które mają być wyświetlane. Aby otrzymać kolumnę porównania w odpowiedzi, żądanie musi zawierać zarówno pole porównania, jak i wymiar porównania.