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 |
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 ( |
Felder | |
---|---|
dimensions[] |
Die angeforderten und angezeigten Abmessungen. |
metrics[] |
Die angeforderten und angezeigten Messwerte. |
dateRanges[] |
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 |
dimensionFilter |
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 |
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 |
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 Weitere Informationen zu diesem Parameter finden Sie unter Paginierung. |
limit |
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. Die API kann auch weniger Zeilen als vom angeforderten Weitere Informationen zu diesem Parameter finden Sie unter Paginierung. |
metricAggregations[] |
Zusammenfassung von Messwerten Zusammengefasste Messwerte werden in Zeilen angezeigt, in denen „dimensionValues“ auf „RESERVED_(MesswertAggregation)“ festgelegt ist. |
orderBys[] |
Gibt an, wie Zeilen in der Antwort sortiert werden. |
currencyCode |
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 |
Die mit dieser Anfrage verknüpfte Kohortengruppe. Wenn die Anfrage eine Kohortengruppe enthält, muss die Dimension „Kohorte“ vorhanden sein. |
keepEmptyRows |
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 Wenn für eine Property beispielsweise nie ein |
returnPropertyQuota |
Gibt an, ob der aktuelle Status des Kontingents dieser Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyQuota zurückgegeben. |
comparisons[] |
Optional. Die Konfiguration der angeforderten und angezeigten Vergleiche. Für die Anfrage ist nur ein Vergleichsfeld erforderlich, um in der Antwort eine Vergleichsspalte 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