Diese Seite wurde von der Cloud Translation API übersetzt.

Method: properties.batchRunReports

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

Hiermit werden mehrere Berichte in einem Batch zurückgegeben. Alle Berichte müssen sich auf dieselbe Google Analytics-Property beziehen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter

Parameter
`property`	`string` Die ID einer Google Analytics-Property, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen finden Sie unter Property-ID ermitteln. Dieses Attribut muss für den Batch angegeben werden. Die Property in „RunReportRequest“ kann entweder nicht angegeben oder mit dieser Property übereinstimmen. Beispiel: properties/1234

property

string

Die ID einer Google Analytics-Property, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen finden Sie unter Property-ID ermitteln. Dieses Attribut muss für den Batch angegeben werden. Die Property in „RunReportRequest“ kann entweder nicht angegeben oder mit dieser Property übereinstimmen.

Beispiel: properties/1234

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{ "requests": [ { object (`RunReportRequest`) } ] }

Felder

Felder
`requests[]`	`object (RunReportRequest)` Individuelle Anfragen Für jede Anfrage gibt es eine separate Berichtsantwort. Jede Batchanfrage darf bis zu fünf Anfragen enthalten.

requests[]

object (RunReportRequest)

Individuelle Anfragen Für jede Anfrage gibt es eine separate Berichtsantwort. Jede Batchanfrage darf bis zu fünf Anfragen enthalten.

Antworttext

Die Batchantwort mit mehreren Berichten.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{ "reports": [ { object (`RunReportResponse`) } ], "kind": string }

Felder

Felder
`reports[]`	`object (RunReportResponse)` Einzelne Antworten. Für jede Antwort gibt es einen separaten Berichtsantrag.
`kind`	`string` Gibt an, um welche Art von Ressource es sich bei dieser Nachricht handelt. Diese `kind` ist immer der feste String „analyticsData#batchRunReports“. Hilfreich, um zwischen Antworttypen in JSON zu unterscheiden.

reports[]

object (RunReportResponse)

Einzelne Antworten. Für jede Antwort gibt es einen separaten Berichtsantrag.

kind

string

Gibt an, um welche Art von Ressource es sich bei dieser Nachricht handelt. Diese kind ist immer der feste String „analyticsData#batchRunReports“. Hilfreich, um zwischen Antworttypen in JSON zu unterscheiden.

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

JSON-Darstellung
{ "property": string, "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`) } ] }

{
  "property": string,
  "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
`property`	`string` Die ID einer Google Analytics-Property, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen finden Sie unter Property-ID ermitteln. Innerhalb einer Batchanfrage sollte diese Property entweder nicht angegeben oder mit der Property auf Batchebene übereinstimmen. Beispiel: properties/1234
`dimensions[]`	`object (Dimension)` Die angeforderten und angezeigten Dimensionen.
`metrics[]`	`object (Metric)` Die angeforderten und angezeigten Messwerte.
`dateRanges[]`	`object (DateRange)` Datumsbereiche der zu lesenden Daten. Wenn mehrere Zeiträume angefordert werden, enthält jede Antwortzeile einen auf null basierenden Zeitrapindizes. Wenn sich zwei Zeiträume überschneiden, werden die Ereignisdaten für die überlappenden Tage in den Antwortzeilen für beide Zeiträume berücksichtigt. In einer Kohortenanfrage darf dieser `dateRanges` nicht angegeben sein.
`dimensionFilter`	`object (FilterExpression)` Mit Dimensionsfiltern können Sie nur bestimmte Dimensionswerte im Bericht abrufen. Weitere Informationen finden Sie unter Grundlagen von Dimensionsfiltern. In diesem Filter können keine Messwerte verwendet werden.
`metricFilter`	`object (FilterExpression)` Die Filterklausel für Messwerte. Wird nach der Aggregation der Zeilen des Berichts angewendet, ähnlich wie die SQL-Having-Klausel. Dimensionen können in diesem Filter nicht verwendet werden.
`offset`	`string (int64 format)` Die Zeilenanzahl der Startzeile. Die erste Zeile wird als Zeile 0 gezählt. Bei der Paginierung wird in der ersten Anfrage kein Offset angegeben oder der Offset wird auf 0 gesetzt. Die erste Anfrage gibt die ersten `limit` Zeilen zurück. Bei der zweiten Anfrage wird der Offset auf den `limit` der ersten Anfrage festgelegt. Die zweite Anfrage gibt die zweite `limit` von Zeilen zurück. Weitere Informationen zu diesem Parameter für die Paginierung finden Sie unter Paginierung.
`limit`	`string (int64 format)` Die Anzahl der zurückzugebenden Zeilen. Wenn keine Angabe gemacht wird, werden 10.000 Zeilen zurückgegeben. Die API gibt pro Anfrage maximal 250.000 Zeilen zurück,unabhängig davon, wie viele Sie anfordern. `limit` muss positiv sein. Die API kann auch weniger Zeilen als die angeforderte `limit` zurückgeben, wenn es nicht so viele Dimensionswerte wie die `limit` gibt. Wenn für die Dimension `country` beispielsweise weniger als 300 mögliche Werte vorhanden sind, können Sie in Berichten, die nur auf `country` basieren, nicht mehr als 300 Zeilen erhalten, auch wenn Sie `limit` auf einen höheren Wert festlegen. Weitere Informationen zu diesem Parameter für die Paginierung finden Sie unter Paginierung.
`metricAggregations[]`	`enum (MetricAggregation)` Aggregation von Messwerten. Aggregierte Messwertwerte werden in Zeilen angezeigt, in denen die Dimensionswerte auf „RESERVED_(MetricAggregation)“ festgelegt sind. Aggregate, die sowohl Vergleiche als auch mehrere Zeiträume enthalten, werden basierend auf den Zeiträumen zusammengefasst.
`orderBys[]`	`object (OrderBy)` Gibt an, wie Zeilen in der Antwort sortiert werden. Bei Anfragen, die sowohl Vergleiche als auch mehrere Zeiträume enthalten, werden die Vergleiche nach den angegebenen Kriterien sortiert.
`currencyCode`	`string` Ein Währungscode im ISO 4217-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 Kohortengruppe, die mit dieser Anfrage verknüpft ist. Wenn die Anfrage eine Kohortengruppe enthält, muss die Dimension „Kohorte“ vorhanden sein.
`keepEmptyRows`	`boolean` Wenn „false“ oder „unspecified“ festgelegt ist, werden Zeilen mit allen Nullwerten nicht zurückgegeben. Wenn diese Option aktiviert ist, werden diese Zeilen zurückgegeben, sofern sie nicht durch einen Filter separat entfernt werden. Unabhängig von dieser `keepEmptyRows`-Einstellung können in einem Bericht nur Daten angezeigt werden, die in der Google Analytics-Property erfasst wurden. Wenn in einer Property beispielsweise nie ein `purchase`-Ereignis protokolliert wird, enthält eine Abfrage für die Dimension `eventName` und den Messwert `eventCount` keine Zeile mit den Werten „eventName: purchase“ und „eventCount: 0“.
`returnPropertyQuota`	`boolean` Gibt an, ob der aktuelle Status des Kontingents dieser Google Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyQuota zurückgegeben.
`comparisons[]`	`object (Comparison)` Optional. Die Konfiguration der angeforderten und angezeigten Vergleiche. Für die Anfrage ist nur ein Vergleichsfeld erforderlich, um eine Vergleichsspalte in der Antwort zu erhalten.