Method: properties.batchRunReports

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 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. Das Attribut in „RunReportRequest“ ist entweder nicht angegeben oder entspricht diesem Attribut.

Beispiel: properties/1234

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
Felder
requests[]

object (RunReportRequest)

Einzelne Anfragen. Für jede Anfrage gibt es eine separate Berichtsantwort. Für jede Batchanfrage sind bis zu fünf Anfragen zulässig.

Antworttext

Die Batchantwort mit mehreren Berichten.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

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

object (RunReportResponse)

Einzelne Antworten. Für jede Antwort gibt es eine eigene Berichtsanfrage.

kind

string

Gibt an, welche Art von Ressource diese Nachricht ist. Diese kind ist immer der feste String „analyticsData#batchRunReports“. 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

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 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 und angezeigten Abmessungen.

metrics[]

object (Metric)

Die angeforderten und angezeigten Messwerte.

dateRanges[]

object (DateRange)

Zeiträume der zu lesenden Daten. Wenn mehrere Zeiträume angefordert werden, enthält jede Antwortzeile einen nullbasierten Zeitraumindex. Wenn sich zwei Zeiträume überschneiden, werden die Ereignisdaten für die entsprechenden Tage in den Antwortzeilen für beide Zeiträume aufgeführt. In einer Kohortenanfrage darf diese dateRanges nicht angegeben werden.

dimensionFilter

object (FilterExpression)

Mit Dimensionsfiltern können Sie im Bericht nur nach bestimmten Dimensionswerten fragen. Weitere Beispiele finden Sie unter Grundlagen von Dimensionsfiltern. Messwerte können in diesem Filter nicht verwendet werden.

metricFilter

object (FilterExpression)

Die Filterklausel von Messwerten. Wird nach dem Aggregieren der Berichtszeilen angewendet, ähnlich wie bei SQL-Klauseln. 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 Paging wird in der ersten Anfrage kein Offset angegeben bzw. entsprechend wird Offset auf 0 gesetzt. Die erste Anfrage gibt den ersten limit der Zeilen zurück. Die zweite Anfrage legt den Offset auf den limit der ersten Anfrage fest. Die zweite Anfrage gibt die zweite limit an Zeilen zurück.

Weitere Informationen zu diesem Parameter finden Sie unter Paginierung.

limit

string (int64 format)

Die Anzahl der zurückzugebenden Zeilen. Wenn kein Wert angegeben ist, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 250.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Zeilen angefordert werden. limit muss positiv sein.

Die API kann auch weniger Zeilen als die angefragte limit zurückgeben, wenn nicht so viele Dimensionswerte wie limit vorhanden sind. Für die Dimension "country" sind beispielsweise weniger als 300 Werte möglich. Wenn Sie also nur einen Bericht für "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 Parameter finden Sie unter Paginierung.

metricAggregations[]

enum (MetricAggregation)

Zusammenfassung von Messwerten Zusammengefasste Messwerte werden in Zeilen angezeigt, in denen „dimensionValues“ auf „RESERVED_(MesswertAggregation)“ festgelegt ist.

orderBys[]

object (OrderBy)

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