Method: properties.batchRunPivotReports

Gibt mehrere Pivot-Berichte in einem Stapel 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 die Property-ID finden Diese Eigenschaft 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 auf 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-Berichtsanfrage.
kind

string

Gibt an, um welche Art von Ressource diese Nachricht geht. Diese kind ist immer der feste String "analyticsData#batchRunPivotReports". Dies ist 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 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
}
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 die Property-ID finden Innerhalb einer Batchanfrage sollte dieses Attribut entweder nicht angegeben werden 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 Dimensionen verwendet werden: dimensionsExpression, dimensionsFilter, pivots, orderBys.
metrics[]

object (Metric)

Die angeforderten Messwerte, mindestens ein Messwert muss angegeben werden. Alle definierten Messwerte müssen von einem der folgenden Messwerte verwendet werden: metric_expression, metricFilter, 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 enthalten sein. Sofern vorhanden, 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 aus „fieldNames“ (Dimensionsnamen) in allen Drehpunkten muss eine Teilmenge der in „Dimensionen“ definierten Dimensionsnamen sein. Zwei Drehpunkte können keine gemeinsame Dimension gemeinsam haben. Eine Dimension ist nur sichtbar, wenn sie in einem Pivot enthalten ist.
dimensionFilter

object (FilterExpression)

Die Filterklausel der 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 von Messwerten. Wird in der Post-Aggregationsphase angewendet, ähnlich wie bei SQL-Klauseln. Messwerte müssen angefordert werden, damit sie in diesem Filter verwendet werden können. Dimensionen können in diesem Filter nicht 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“ angegeben werden.
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 mit der Google Analytics-Property (GA4) erfasst wurden.

Wenn für eine Property beispielsweise nie ein purchase-Ereignis protokolliert wird, enthält eine Abfrage für die Dimension eventName und den Messwert eventCount nicht die 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.