Diese Seite wurde von der Cloud Translation API übersetzt.

Method: properties.runReport

HTTP-Anfrage
Pfadparameter
Anfragetext
- JSON-Darstellung
Antworttext
Autorisierungsbereiche
Testen!

Gibt einen benutzerdefinierten Bericht mit Ihren Google Analytics-Ereignisdaten zurück. Die Berichte enthalten Statistiken, die aus Daten abgeleitet werden, die mit dem Google Analytics-Tracking-Code erfasst wurden. Von der API wird eine Tabelle mit Spalten für die angeforderten Dimensionen und Messwerte zurückgegeben. Messwerte sind individuelle Messwerte zur Nutzeraktivität in Ihrer Property, z. B. die Anzahl der aktiven Nutzer oder die Anzahl der Ereignisse. Mit Dimensionen werden Messwerte nach einigen gängigen Kriterien aufgeschlüsselt, z. B. nach Land oder Ereignisname.

Anleitung zum Erstellen von Anfragen und Informationen zu den 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

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 Ihre Property-ID finden Innerhalb einer Batchanfrage sollte dieses Attribut entweder nicht angegeben sein oder mit dem Attribut auf Batchebene übereinstimmen. Beispiel: properties/1234

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 Ihre Property-ID finden Innerhalb 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

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, "comparisons": [ { object (`Comparison`) } ] }

{
  "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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}

Felder
`dimensions[]`	`object (Dimension)` Die angeforderten und angezeigten Dimensionen.
`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 angezeigt. In einer Kohortenanfrage darf diese `dateRanges` nicht angegeben werden.
`dimensionFilter`	`object (FilterExpression)` Mit Dimensionsfiltern können Sie nur bestimmte Dimensionswerte im Bericht anfordern. Weitere Informationen finden Sie unter Grundlagen von Dimensionsfiltern. In diesem Filter können keine Messwerte verwendet werden.
`metricFilter`	`object (FilterExpression)` Die Filterklausel von Messwerten. Wird nach dem Aggregieren der Zeilen des Berichts angewendet, ähnlich wie bei der SQL-Anweisung „Lesen“. 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 mit der ersten Anfrage kein Offset angegeben. oder entsprechend setzt Offset auf 0; Die erste Anfrage gibt die ersten `limit` der Zeilen zurück. Die zweite Anfrage legt einen Offset auf den `limit` der ersten Anfrage fest. Die zweite Anfrage gibt die zweiten `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 nicht angegeben, 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 angeforderte `limit` zurückgeben, wenn nicht so viele Dimensionswerte wie der `limit` vorhanden sind. Für die Dimension `country` sind beispielsweise weniger als 300 Werte möglich. Wenn Sie also nur Daten für `country` erstellen, können Sie nicht mehr als 300 Zeilen abrufen, selbst wenn Sie für `limit` einen höheren Wert festlegen. Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung.
`metricAggregations[]`	`enum (MetricAggregation)` Aggregation von Messwerten. Aggregierte Messwerte werden in Zeilen angezeigt, in denen die DimensionValues auf „RESERVED_(MetricAggregation)“ 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)` Mit dieser Anfrage verknüpfte Kohortengruppe. Gibt es eine Kohortengruppe in der Anfrage, wird die „Kohorte“ Dimension vorhanden sein muss.
`keepEmptyRows`	`boolean` Wenn „false“ oder nicht angegeben, wird keine Zeile zurückgegeben, die alle Messwerte gleich 0 enthält. 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, hat eine Abfrage nach der Dimension `eventName` und dem Messwert `eventCount` keinen Zeilenereignisnamen „purchase“. und eventCount: 0.
`returnPropertyQuota`	`boolean` Mit dieser Option kann festgelegt werden, ob der aktuelle Status des Kontingents dieser Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyQuota zurückgegeben.
`comparisons[]`	`object (Comparison)` Optional. Die Konfiguration der angeforderten und angezeigten Vergleiche. Die Anfrage erfordert nur ein Vergleichsfeld, um eine Vergleichsspalte in der Antwort zu erhalten.

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