Method: properties.batchRunPivotReports

Hiermit werden mehrere Pivot-Berichte in einem Batch zurückgegeben. Alle Berichte müssen sich auf dieselbe Google Analytics-Property beziehen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
property

string

Die ID einer Google Analytics-Property, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen finden Sie unter Property-ID ermitteln. Dieses Attribut muss für den Batch angegeben werden. Die Property in „RunPivotReportRequest“ kann entweder nicht angegeben oder mit dieser Property übereinstimmen.

Beispiel: properties/1234

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

object (RunPivotReportRequest)

Individuelle Anfragen Für jede Anfrage gibt es eine separate Antwort für den Pivot-Bericht. Jede Batchanfrage darf bis zu fünf Anfragen enthalten.

Antworttext

Die Batchantwort mit mehreren Pivot-Berichten.

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

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

object (RunPivotReportResponse)

Einzelne Antworten. Für jede Antwort gibt es eine separate Anfrage für einen Pivot-Bericht.
kind

string

Gibt an, um welche Art von Ressource es sich bei dieser Nachricht handelt. Diese kind ist immer der feste String „analyticsData#batchRunPivotReports“. Hilfreich, um zwischen Antworttypen in JSON zu unterscheiden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

RunPivotReportRequest

Die Anfrage zum Generieren eines Pivot-Berichts.

JSON-Darstellung 
{
  "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)
    }
  ]
}
Felder
property

string

Die ID einer Google Analytics-Property, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen finden Sie unter Property-ID ermitteln. Innerhalb einer Batchanfrage sollte diese Property entweder nicht angegeben oder mit der Property auf Batchebene übereinstimmen.

Beispiel: properties/1234
dimensions[]

object (Dimension)

Die angeforderten Abmessungen. Alle definierten Dimensionen müssen von einer der folgenden Funktionen verwendet werden: „dimensionExpression“, „dimensionFilter“, „pivots“ oder „orderBys“.
metrics[]

object (Metric)

Von den angeforderten Messwerten muss mindestens einer angegeben werden. Alle definierten Messwerte müssen von einer der folgenden Optionen verwendet werden: „metric_expression“, „metricFilter“ oder „orderBys“.
dateRanges[]

object (DateRange)

Der Zeitraum, in dem Ereignisdaten für den Bericht abgerufen werden sollen. Wenn mehrere Zeiträume angegeben werden, werden im Bericht Ereignisdaten aus jedem Zeitraum verwendet. In den Feldnamen einer Pivot-Tabelle kann eine spezielle Dimension mit dem Feldnamen „Zeitraum“ eingefügt werden. In diesem Fall werden im Bericht Zeiträume verglichen. In einer Kohortenanfrage darf dieser dateRanges nicht angegeben sein.
pivots[]

object (Pivot)

Beschreibt das visuelle Format der Dimensionen des Berichts in Spalten oder Zeilen. Die Vereinigung der Feldnamen (Dimensionenamen) in allen Pivot-Tabellen muss eine Teilmenge der in „Dimensionen“ definierten Dimensionennamen sein. Keine zwei Pivot-Tabellen können dieselbe Dimension haben. Eine Dimension ist nur sichtbar, wenn sie in einer Pivot-Tabelle enthalten ist.
dimensionFilter

object (FilterExpression)

Die Filterklausel der Dimensionen. Dimensionen müssen angefordert werden, um in diesem Filter verwendet zu werden. In diesem Filter können keine Messwerte verwendet werden.
metricFilter

object (FilterExpression)

Die Filterklausel für Messwerte. Wird nach der Aggregationsphase angewendet, ähnlich wie die SQL-Having-Klausel. Messwerte müssen angefordert werden, um in diesem Filter verwendet werden zu können. Dimensionen können in diesem Filter nicht verwendet werden.
currencyCode

string

Ein Währungscode im ISO 4217-Format, z. B. „AED“, „USD“ oder „JPY“. Wenn das Feld leer ist, wird im Bericht die Standardwährung der Property verwendet.
cohortSpec

object (CohortSpec)

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

boolean

Wenn „false“ oder „unspecified“ festgelegt ist, werden Zeilen mit allen Nullwerten nicht zurückgegeben. Wenn diese Option aktiviert ist, werden diese Zeilen zurückgegeben, sofern sie nicht durch einen Filter separat entfernt werden.

Unabhängig von dieser keepEmptyRows-Einstellung können in einem Bericht nur Daten angezeigt werden, die in der Google Analytics-Property erfasst wurden.

Wenn in einer Property beispielsweise nie ein purchase-Ereignis protokolliert wird, enthält eine Abfrage für die Dimension eventName und den Messwert eventCount keine Zeile mit den Werten „eventName: purchase“ und „eventCount: 0“.
returnPropertyQuota

boolean

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

object (Comparison)

Optional. Die Konfiguration der angeforderten und angezeigten Vergleiche. Für die Anfrage sind sowohl ein Vergleichsfeld als auch eine Vergleichsdimension erforderlich, um eine Vergleichsspalte in der Antwort zu erhalten.