Method: properties.batchRunReports

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

Gibt mehrere 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/*}:batchRunReports

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 RunReportRequest 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 (RunReportRequest)
    }
  ]
}
Felder
requests[]

object (RunReportRequest)

Individuelle Anfragen. Jede Anfrage hat eine separate Berichtsantwort. 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 Berichten.

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

object (RunReportResponse)

Einzelne Antworten. Für jede Antwort wird eine separate Berichtsanfrage gesendet.
kind

string

Gibt die Art der Ressource an. Diese kind ist immer der feste String "analyticsData#batchRunReports". 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

RunReportRequest

Die Anfrage zum Erstellen eines Berichts

JSON-Darstellung 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "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 werden angezeigt.
metrics[]

object (Metric)

Die angeforderten und angezeigten Messwerte.
dateRanges[]

object (DateRange)

Zeiträume, die gelesen werden sollen. Wenn mehrere Zeiträume angefordert werden, enthält jede Antwortzeile einen nullbasierten Zeitraumindex. Falls sich zwei Zeiträume überschneiden, werden die Ereignisdaten für die sich überschneidenden Tage in die Antwortzeilen für beide Zeiträume aufgenommen. In einer Kohortenanfrage muss dateRanges angegeben werden.
dimensionFilter

object (FilterExpression)

Mit Dimensionsfiltern können Sie nur bestimmte Dimensionswerte im Bericht angeben. Weitere Informationen finden Sie unter Grundlagen von Dimensionsfiltern. In diesem Filter können keine Messwerte verwendet werden.
metricFilter

object (FilterExpression)

Die Filterklausel mit Messwerten. Wird nach der Zusammenfassung der Berichtszeilen angewendet, ähnlich wie bei der SQL-Klausel. In diesem Filter können keine Dimensionen verwendet werden.
offset

string (int64 format)

Die Zeilenanzahl der Startzeile. Die erste Zeile wird als Zeile 0 gezählt.

Beim Paginieren gibt die erste Anfrage keinen Offset an oder legt den Offset entsprechend auf 0 fest. Die erste Anfrage gibt die erste limit der Zeilen zurück. Die zweite Anfrage legt den Versatz auf den limit der ersten Anfrage fest. Die zweite Anfrage gibt die zweite limit der Zeilen zurück.

Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung.
limit

string (int64 format)

Die Anzahl der zurückzugebenden Zeilen. Wenn keine Angabe erfolgt, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 100.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Sie anfordern. limit muss positiv sein.

Die API kann auch weniger Zeilen als die angeforderte limit zurückgeben, wenn es nicht so viele Dimensionswerte wie limit gibt. Beispielsweise gibt es weniger als 300 mögliche Werte für die Dimension country. Wenn Sie also nur Berichte zu country erstellen, können Sie nicht mehr als 300 Zeilen erhalten, selbst wenn Sie für limit einen höheren Wert festlegen.

Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung.
metricAggregations[]

enum (MetricAggregation)

Zusammenfassung von Messwerten. Zusammengefasste Messwerte werden in Zeilen angezeigt, in denen „dimensionValues“ auf „RESERVED_(Messwertaggregation)“ gesetzt ist.
orderBys[]

object (OrderBy)

Gibt an, wie Zeilen in der Antwort angeordnet sind.
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.