Method: properties.batchRunPivotReports

Gibt mehrere Pivot-Berichte in einem Batch zurück. Alle Berichte müssen für dieselbe Google Analytics-Property sein.

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. Im URL-Pfad und nicht im Text angegeben. Weitere Informationen Diese Property muss für den Batch angegeben werden. Die Property in RunPivotReportRequest kann entweder nicht angegeben werden oder muss 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)

Einzelne Anfragen Für jede Anfrage gibt es eine separate Pivot-Berichtsantwort. 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, welche Art von Ressource diese Nachricht ist. 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 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. Im URL-Pfad und nicht im Text angegeben. Weitere Informationen In einer Batchanfrage sollte diese Property entweder nicht angegeben werden oder mit der Property 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 von einem der folgenden Elemente verwendet werden: „metric_expression“, „metricFilter“, „orderBys“.
dateRanges[]

object (DateRange)

Der Zeitraum, für den Ereignisdaten für den Bericht abgerufen werden sollen. Wenn mehrere Zeiträume angegeben sind, werden Ereignisdaten aus jedem Zeitraum im Bericht verwendet. Eine spezielle Dimension mit dem Feldnamen „dateRange“ kann in den Feldnamen eines Pivot-Berichts enthalten sein. Wenn sie enthalten ist, werden die Zeiträume im Bericht verglichen. In einer Kohortenanfrage muss dateRanges nicht angegeben werden.
pivots[]

object (Pivot)

Beschreibt das visuelle Format der Dimensionen des Berichts in Spalten oder Zeilen. Die Vereinigung der „fieldNames“ (Dimensionsnamen) in allen Pivots muss eine Teilmenge der in „Dimensions“ definierten Dimensionsnamen sein. Zwei Pivots können nicht dieselbe Dimension haben. Eine Dimension ist nur sichtbar, wenn sie in einem Pivot enthalten ist.
dimensionFilter

object (FilterExpression)

Die Filterklausel für Dimensionen. Dimensionen müssen angefordert werden, um in diesem Filter verwendet zu werden. Messwerte können in diesem Filter nicht verwendet werden.
metricFilter

object (FilterExpression)

Die Filterklausel für Messwerte. Wird in der Phase nach der Aggregation angewendet, ähnlich der HAVING-Klausel in SQL. 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 die Standardwährung der Property verwendet.
cohortSpec

object (CohortSpec)

Die Kohortengruppe, die dieser Anfrage zugeordnet ist. Wenn in der Anfrage eine Kohortengruppe vorhanden ist, muss die Dimension „Kohorte“ vorhanden sein.
keepEmptyRows

boolean

Wenn „false“ oder nicht angegeben, wird jede Zeile mit allen Messwerten gleich 0 nicht zurückgegeben. Wenn „true“, werden diese Zeilen zurückgegeben, sofern sie nicht separat durch einen Filter entfernt werden.

Unabhängig von dieser keepEmptyRows-Einstellung können in einem Bericht nur Daten angezeigt werden, die von der Google Analytics-Property 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 keine Zeile mit eventName: "purchase" und eventCount: 0.
returnPropertyQuota

boolean

Legt fest, 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, damit in der Antwort eine Vergleichsspalte enthalten ist.