Method: batchRunPivotReports

Gibt mehrere Pivot-Berichte in einem Batch zurück. Alle Berichte müssen sich auf dieselbe Entität beziehen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "entity": {
    object (Entity)
  },
  "requests": [
    {
      object (RunPivotReportRequest)
    }
  ]
}
Felder
entity

object (Entity)

Property, deren Ereignisse erfasst werden. Diese Entität muss für den Batch angegeben werden. Die Entität in „RunPivotReportRequest“ ist entweder nicht angegeben oder mit dieser Entität konsistent.

requests[]

object (RunPivotReportRequest)

Einzelne Anfragen. Für jede Anfrage gibt es eine separate Antwort für einen Pivot-Bericht. Für jede Batchanfrage sind bis zu fünf Anfragen zulässig.

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Die Batchantwort mit mehreren Pivot-Berichten.

JSON-Darstellung
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ]
}
Felder
pivotReports[]

object (RunPivotReportResponse)

Einzelne Antworten: Für jede Antwort gibt es eine separate Pivot-Berichtsanfrage.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

RunPivotReportRequest

Die Anfrage zum Erstellen eines Pivot-Berichts.

JSON-Darstellung
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Felder
entity

object (Entity)

Property, deren Ereignisse erfasst werden. In einer Batchanfrage sollte diese Entität entweder nicht angegeben sein oder mit der Entität auf Batchebene übereinstimmen.

dimensions[]

object (Dimension)

Die angeforderten Abmessungen. Alle definierten Dimensionen müssen mit einem der folgenden Werte verwendet werden: „dimensionExpression“, „dimensionFilter“, „Pivots“ oder „orderBys“.

metrics[]

object (Metric)

Die angeforderten Messwerte. Es muss mindestens ein Messwert angegeben werden. Alle definierten Messwerte müssen von einem der folgenden Messwerte verwendet werden: metric_expression, metricFilter, orderBys.

dimensionFilter

object (FilterExpression)

Die Filterklausel für Dimensionen. Dimensionen müssen angefordert werden, damit sie in diesem Filter verwendet werden können. Messwerte können in diesem Filter nicht verwendet werden.

metricFilter

object (FilterExpression)

Die Filterklausel für Messwerte. Wird in der Post-Aggregationsphase angewendet, ähnlich wie bei SQL mit Klausel. Messwerte müssen zur Verwendung in diesem Filter angefordert werden. In diesem Filter können keine Dimensionen verwendet werden.

pivots[]

object (Pivot)

Beschreibt das visuelle Format der Berichtsdimensionen in Spalten oder Zeilen. Die Zusammenführung der „fieldNames“ (Dimensionsnamen) in allen Pivots muss eine Teilmenge der in „Dimensionen“ definierten Dimensionsnamen sein. Zwei Pivots können keine gemeinsame Dimension haben. Eine Dimension ist nur sichtbar, wenn sie in einem Pivot enthalten ist.

dateRanges[]

object (DateRange)

Der Zeitraum, in dem Ereignisdaten für den Bericht abgerufen werden. Wenn mehrere Zeiträume angegeben sind, werden im Bericht Ereignisdaten aus den einzelnen Zeiträumen verwendet. Eine spezielle Dimension mit dem Feldnamen „dateRange“ kann in die Feldnamen eines Pivots aufgenommen werden. Sofern vorhanden, werden die Zeiträume im Bericht verglichen. In einer Kohortenanfrage darf dateRanges nicht angegeben werden.

currencyCode

string

Ein Währungscode im ISO4217-Format, z. B. „AED“, „USD“ oder „JPY“. Wenn das Feld leer ist, wird im Bericht die Standardwährung des Elements verwendet.

cohortSpec

object (CohortSpec)

Die mit dieser Anfrage verknüpfte Kohortengruppe. Wenn die Anfrage eine Kohortengruppe enthält, muss die Dimension „Kohorte“ vorhanden sein.

keepEmptyRows

boolean

Wenn „false“ oder nicht angegeben, wird nicht jede Zeile zurückgegeben, bei der alle Messwerte gleich 0 sind. Bei „true“ werden diese Zeilen zurückgegeben, wenn sie nicht separat durch einen Filter entfernt werden.

returnPropertyQuota

boolean

Gibt an, ob der aktuelle Status des Kontingents dieser Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyQuota zurückgegeben.