Method: properties.batchRunPivotReports

Gibt mehrere Pivot-Berichte in einem Batch zurück. Alle Berichte müssen sich auf dieselbe GA4-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

Eine Google Analytics GA4-Property-ID, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen dazu, wo Sie Ihre Property-ID finden Diese Eigenschaft muss für den Batch angegeben werden. Die Eigenschaft in RunPivotReportRequest kann entweder nicht angegeben oder mit dieser Eigenschaft konsistent sein.

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 Anforderung gibt es eine separate Pivot-Berichtsantwort. Für jede Batchanfrage sind bis zu fünf Anfragen zulässig.

Antworttext

Die Batch-Antwort, die mehrere Pivot-Berichte enthält.

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

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

object (RunPivotReportResponse)

Individuelle Antworten Für jede Antwort gibt es eine separate Pivot-Berichtsanfrage.
kind

string

Gibt an, um welche Art von Ressource diese Nachricht handelt. Dieser kind ist immer der feste String „analyticsData#batchRunPivotReports“. Nützlich, 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 Anforderung 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

Eine Google Analytics GA4-Property-ID, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen dazu, wo Sie Ihre Property-ID finden Innerhalb einer Batchanfrage sollte dieses Attribut entweder nicht angegeben sein oder mit dem Attribut auf Batchebene übereinstimmen.

Beispiel: properties/1234
dimensions[]

object (Dimension)

Die angeforderten Dimensionen. Alle definierten Dimensionen müssen in einem der folgenden Werte verwendet werden: DimensionExpression, dimensionFilter, pivots, orderBys.
metrics[]

object (Metric)

Die angeforderten Messwerte. Es muss mindestens ein Messwert angegeben werden. Alle definierten Messwerte müssen von einem der folgenden Elemente verwendet werden: metric_expression, metricFilter, orderBys.
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 jedem Zeitraum verwendet. Eine spezielle Dimension mit dem Feldnamen „dateRange“ kann in den Feldnamen eines Pivots enthalten sein; werden im Bericht die Zeiträume verglichen, sofern diese enthalten sind. In einer Kohortenanfrage darf dieser dateRanges nicht angegeben werden.
pivots[]

object (Pivot)

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

object (FilterExpression)

Die Filterklausel von Dimensionen. Dimensionen müssen angefordert werden, damit sie in diesem Filter verwendet werden können. In diesem Filter können keine Messwerte verwendet werden.
metricFilter

object (FilterExpression)

Die Filterklausel von Messwerten. Wird in der Post-Aggregationsphase angewendet, ähnlich der SQL-With-Klausel. Messwerte müssen angefordert werden, damit sie in diesem Filter verwendet werden können. In diesem Filter können keine Dimensionen verwendet 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 der Property verwendet.
cohortSpec

object (CohortSpec)

Mit dieser Anfrage verknüpfte Kohortengruppe. Gibt es eine Kohortengruppe in der Anfrage, wird die „Kohorte“ Dimension vorhanden sein muss.
keepEmptyRows

boolean

Wenn „false“ oder nicht angegeben, wird keine Zeile zurückgegeben, die alle Messwerte gleich 0 enthält. Bei „true“ werden diese Zeilen zurückgegeben, wenn sie nicht separat durch einen Filter entfernt werden.

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

Wenn für eine Property beispielsweise nie ein purchase-Ereignis protokolliert wird, hat eine Abfrage nach der Dimension eventName und dem Messwert eventCount keinen Zeilenereignisnamen „purchase“. und eventCount: 0.
returnPropertyQuota

boolean

Mit dieser Option kann festgelegt werden, ob der aktuelle Status des Kontingents dieser 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, damit in der Antwort eine Vergleichsspalte zurückgegeben wird.