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 |
Eine GA4-Property-ID, deren Ereignisse erfasst werden. Sie wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen zum Ermitteln der Property-ID Diese Eigenschaft muss für den Batch angegeben werden. Die Property in RunReportRequest kann entweder nicht angegeben sein oder mit dieser Property übereinstimmen. Beispiel: properties/1234 |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{
"requests": [
{
object ( |
Felder | |
---|---|
requests[] |
Individuelle Anfragen. Jede Anfrage hat eine separate Berichtsantwort. Für jede Batchanfrage sind bis zu fünf Anfragen zulässig. |
Antworttext
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
Die Batchantwort mit mehreren Berichten.
JSON-Darstellung |
---|
{
"reports": [
{
object ( |
Felder | |
---|---|
reports[] |
Einzelne Antworten. Für jede Antwort wird eine separate Berichtsanfrage gesendet. |
kind |
Gibt die Art der Ressource an. Diese |
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 ( |
Felder | |
---|---|
property |
Eine GA4-Property-ID, deren Ereignisse erfasst werden. Sie wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen zum Ermitteln der Property-ID Innerhalb einer Batchanfrage sollte diese Property entweder nicht angegeben sein oder mit der Batch-Property übereinstimmen. Beispiel: properties/1234 |
dimensions[] |
Die angeforderten Dimensionen werden angezeigt. |
metrics[] |
Die angeforderten und angezeigten Messwerte. |
dateRanges[] |
Zeiträume, die gelesen werden sollen. Wenn mehrere Zeiträume angefordert werden, enthält jede Antwortzeile einen nullbasierten Zeitraumindex. Falls sich zwei Zeiträume überschneiden, werden die Ereignisdaten für die sich überschneidenden Tage in die Antwortzeilen für beide Zeiträume aufgenommen. In einer Kohortenanfrage muss |
dimensionFilter |
Mit Dimensionsfiltern können Sie nur bestimmte Dimensionswerte im Bericht angeben. Weitere Informationen finden Sie unter Grundlagen von Dimensionsfiltern. In diesem Filter können keine Messwerte verwendet werden. |
metricFilter |
Die Filterklausel mit Messwerten. Wird nach der Zusammenfassung der Berichtszeilen angewendet, ähnlich wie bei der SQL-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 Paginieren gibt die erste Anfrage keinen Offset an oder legt den Offset entsprechend auf 0 fest. Die erste Anfrage gibt die erste Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung. |
limit |
Die Anzahl der zurückzugebenden Zeilen. Wenn keine Angabe erfolgt, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 100.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Sie anfordern. Die API kann auch weniger Zeilen als die angeforderte Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung. |
metricAggregations[] |
Zusammenfassung von Messwerten. Zusammengefasste Messwerte werden in Zeilen angezeigt, in denen „dimensionValues“ auf „RESERVED_(Messwertaggregation)“ gesetzt ist. |
orderBys[] |
Gibt an, wie Zeilen in der Antwort angeordnet sind. |
currencyCode |
Ein Währungscode im ISO4217-Format, z. B. "AED", "USD", "JPY". Ist das Feld leer, wird im Bericht die Standardwährung der Property verwendet. |
cohortSpec |
Kohortengruppe, die dieser Anfrage zugeordnet ist. 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, deren Messwerte null sind. Bei „true“ werden diese Zeilen zurückgegeben, wenn sie nicht separat durch einen Filter entfernt werden. |
returnPropertyQuota |
Gibt an, ob der aktuelle Status des Kontingents für diese Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyKontingent zurückgegeben. |