Method: properties.runReport

Gibt einen benutzerdefinierten Bericht mit Ihren Google Analytics-Ereignisdaten zurück. Berichte enthalten Statistiken, die auf Daten basieren, die mit dem Google Analytics-Tracking-Code erfasst werden. Die von der API zurückgegebenen Daten liegen in einer Tabelle mit Spalten für die angeforderten Dimensionen und Messwerte vor. Messwerte sind einzelne Messungen der Nutzeraktivität in Ihrer Property, z. B. aktive Nutzer oder die Ereignisanzahl. Dimensionen schlüsseln Messwerte nach einigen gängigen Kriterien auf, z. B. Land oder Ereignisname.

Eine Anleitung zum Erstellen von Anfragen und zum Verständnis von Antworten finden Sie unter Bericht erstellen.

HTTP-Anfrage

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

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 In einer Batchanfrage sollte dieses Attribut entweder nicht angegeben sein oder mit dem Attribut auf Batchebene übereinstimmen.

Beispiel: properties/1234

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "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
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 sich überschneidenden Tage in den Antwortzeilen für beide Zeiträume aufgeführt. In einer Kohortenanfrage darf 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 für Messwerte. Wird nach dem Zusammenfassen der Berichtszeilen angewendet, ähnlich wie bei SQL mit 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 Paging wird in der ersten Anfrage kein „offset“ angegeben oder entsprechend „offset“ auf 0. Die erste Anfrage gibt die erste limit der Zeilen zurück. Die zweite Anfrage legt „Offset“ auf den limit der ersten Anfrage fest. Die zweite Anfrage gibt die zweite limit der 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 Sie anfordern. limit muss positiv sein.

Die API kann auch weniger Zeilen als vom angeforderten limit zurückgeben, wenn nicht so viele Dimensionswerte wie limit vorhanden sind. Wenn beispielsweise für die Dimension „country“ weniger als 300 Werte möglich sind, können Sie bei Berichten nur für country maximal 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 sortiert 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, wenn 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.

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 „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.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von RunReportResponse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics