Gibt einen benutzerdefinierten Bericht mit Ihren Google Analytics-Ereignisdaten zurück. Berichte enthalten Statistiken, die auf Daten basieren, die vom 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 individuelle Messungen der Nutzeraktivitäten in Ihrer Property, z. B. aktive Nutzer oder Ereignisanzahl. Dimensionen schlüsseln Messwerte nach einigen gängigen Kriterien auf, z. B. nach Land oder Ereignisname.
Eine Anleitung zur Erstellung von Anfragen und zur Auswertung der 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 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 |
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 entsprechenden Tage in den Antwortzeilen für beide Zeiträume aufgeführt. In einer Kohortenanfrage darf diese |
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 von Messwerten. Wird nach dem Aggregieren der Berichtszeilen angewendet, ähnlich wie bei SQL-Klauseln. 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 bzw. entsprechend wird Offset auf 0 gesetzt. Die erste Anfrage gibt den ersten 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 angefordert werden. Die API kann auch weniger Zeilen als die angefragte 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 angeordnet 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, sofern sie nicht separat durch einen Filter entfernt werden. Unabhängig von dieser Beispiel: Wenn für eine Property 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. |
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