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 GA4-Property-ID in Google Analytics, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen zum Ermitteln der Property-ID Dieses Attribut muss für den Batch angegeben werden. Die Eigenschaft in RunPivotReportRequest ist entweder nicht angegeben oder entspricht dieser Eigenschaft.

Beispiel: properties/1234

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "requests": [
    {
      object (RunPivotReportRequest)
    }
  ]
}
Felder
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

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 Pivot-Berichtanforderung.

kind

string

Gibt an, welche Art von Ressource diese Nachricht ist. Diese 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 Erstellen 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
}
Felder
property

string

Eine GA4-Property-ID in Google Analytics, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen zum Ermitteln der Property-ID Dieses Attribut sollte in einer Batchanfrage entweder nicht angegeben sein oder mit dem Attribut auf Batchebene übereinstimmen.

Beispiel: properties/1234

dimensions[]

object (Dimension)

Die angeforderten Abmessungen. Alle definierten Dimensionen müssen von einem der folgenden Elemente verwendet werden: dimensionExpression, dimensionFilter, pivots, orderBys.

metrics[]

object (Metric)

Die angeforderten Messwerte. Es muss mindestens ein Messwert angegeben werden. Alle definierten Messwerte müssen für einen der folgenden Werte verwendet werden: Messwertausdruck, Messwertfilter, orderBys.

dateRanges[]

object (DateRange)

Der Zeitraum, in dem Ereignisdaten für den Bericht abgerufen werden sollen. 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 eingefügt werden. Ist dies der Fall, werden im Bericht Zeiträume verglichen. In einer Kohortenanfrage darf diese dateRanges nicht angegeben werden.

pivots[]

object (Pivot)

Beschreibt das visuelle Format der Berichtsdimensionen in Spalten oder Zeilen Die Kombination der „fieldNames“ (Dimensionsnamen) in allen Drehpunkten muss eine Teilmenge der Dimensionsnamen sein, die in „Dimensionen“ definiert sind. Zwei Pivots können keine gemeinsame Dimension gemeinsam haben. Eine Dimension ist nur sichtbar, wenn sie in einem Pivot verwendet wird.

dimensionFilter

object (FilterExpression)

Die Filterklausel der Dimensionen. Die Verwendung von Dimensionen in diesem Filter muss angefordert werden. Messwerte können in diesem Filter nicht verwendet werden.

metricFilter

object (FilterExpression)

Die Filterklausel von Messwerten. Wird in der Post-Aggregationsphase angewendet, ähnlich wie bei SQL-Klauseln. Messwerte müssen zur Verwendung in diesem Filter angefordert werden. 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)

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, sofern 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.

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

returnPropertyQuota

boolean

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