Method: properties.batchRunPivotReports

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

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, deren Ereignisse erfasst werden. Sie wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen zum Ermitteln der Property-ID Diese Eigenschaft muss für den Batch angegeben werden. Die Property in RunPivotReportRequest kann entweder nicht angegeben sein 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. Jede Anfrage hat eine separate Pivot-Berichtantwort. 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)
    }
  ],
  "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 die Art der Ressource an. Diese kind ist immer der feste String "analyticsData#batchRunPivotReports". Nützlich, um zwischen JSON-Antworttypen 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 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, deren Ereignisse erfasst werden. Sie wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen zum Ermitteln der Property-ID Innerhalb einer Batchanfrage sollte diese Property entweder nicht angegeben sein oder mit der Batch-Property übereinstimmen.

Beispiel: properties/1234

dimensions[]

object (Dimension)

Die angeforderten Dimensionen. Alle definierten Dimensionen müssen in einem der folgenden Formate verwendet werden: dimensionsExpression, dimensionsFilter, pivots, orderBys.

metrics[]

object (Metric)

Es muss mindestens ein Messwert angegeben werden. Alle definierten Messwerte müssen von einem der folgenden Werte verwendet werden: Messwertausdruck, Messwertfilter, OrderBys.

dateRanges[]

object (DateRange)

Zeitraum zum Abrufen der Ereignisdaten für den Bericht Wenn mehrere Zeiträume angegeben sind, werden Ereignisdaten aus jedem Zeitraum im Bericht verwendet. Eine besondere Dimension mit dem Feldnamen "dateRange" kann in den Feldnamen eines Pivot-Felds enthalten sein. Ist dies der Fall, vergleicht der Bericht die Zeiträume. In einer Kohortenanfrage muss dateRanges angegeben werden.

pivots[]

object (Pivot)

Beschreibt das visuelle Format der Berichtsdimensionen in Spalten oder Zeilen. Die Vereinigung der Feldnamen (Dimensionsnamen) in allen Pivot-Tabellen muss eine Teilmenge der Dimensionsnamen sein, die in den Dimensionen definiert sind. Zwei Pivots können keine gemeinsame Dimension haben. Eine Dimension ist nur dann sichtbar, wenn sie in einem Pivot angezeigt wird.

dimensionFilter

object (FilterExpression)

Die Filterklausel mit den Dimensionen. Für diesen Filter müssen Dimensionen angefordert werden. In diesem Filter können keine Messwerte verwendet werden.

metricFilter

object (FilterExpression)

Die Filterklausel mit Messwerten. Wird nach der Zusammenfassung angewendet, ähnlich wie bei der SQL-Klausel. Zur Verwendung in diesem Filter müssen Messwerte angefordert werden. In diesem Filter können keine Dimensionen verwendet werden.

currencyCode

string

Ein Währungscode im ISO4217-Format, z. B. "AED", "USD", "JPY". Ist das Feld leer, wird im Bericht die Standardwährung der Property verwendet.

cohortSpec

object (CohortSpec)

Kohortengruppe, die dieser Anfrage zugeordnet ist. 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, deren Messwerte null 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 für diese Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyKontingent zurückgegeben.