Method: properties.batchRunReports

Gibt mehrere Berichte in einem Batch zurück. Alle Berichte müssen für dieselbe Google Analytics-Property sein.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
property

string

Die ID einer Google Analytics-Property, deren Ereignisse erfasst werden. Im URL-Pfad und nicht im Text angegeben. Weitere Informationen Diese Property muss für den Batch angegeben werden. Die Property in RunReportRequest kann entweder nicht angegeben oder mit dieser Property konsistent sein.

Beispiel: properties/1234

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

object (RunReportRequest)

Einzelne Anfragen Für jede Anfrage gibt es eine separate Antwort. 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
reports[]

object (RunReportResponse)

Einzelne Antworten. Für jede Antwort gibt es eine separate Berichtsabfrage.
kind

string

Gibt an, um welche Art von Ressource es sich bei dieser Nachricht handelt. kind ist immer der feste String „analyticsData#batchRunReports“. Nützlich, 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 Generieren eines Berichts.

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)
    }
  ]
}
Felder
property

string

Die ID einer Google Analytics-Property, deren Ereignisse erfasst werden. Im URL-Pfad und nicht im Text angegeben. Weitere Informationen In einer Batchanfrage sollte diese Property entweder nicht angegeben werden 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)

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, sind die Ereignisdaten für die überschneidenden Tage in den Antwortzeilen für beide Zeiträume enthalten. In einer Kohortenanfrage muss dateRanges nicht angegeben werden.
dimensionFilter

object (FilterExpression)

Mit Dimensionsfiltern können Sie nur bestimmte Dimensionswerte im Bericht anfordern. Weitere Informationen und Beispiele finden Sie unter Grundlagen von Dimensionsfiltern. Messwerte können in diesem Filter nicht verwendet werden.
metricFilter

object (FilterExpression)

Die Filterklausel für Messwerte. Wird nach dem Aggregieren der Zeilen des Berichts angewendet, ähnlich der 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.

Beim Paging 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. In der zweiten Anfrage wird der Offset auf limit der ersten Anfrage festgelegt. Die zweite Anfrage gibt die zweiten limit 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 Sie anfordern. limit muss positiv sein.

Die API kann auch weniger Zeilen als die angeforderten limit zurückgeben, wenn es nicht so viele Dimensionswerte wie die limit gibt. Für die Dimension country gibt es beispielsweise weniger als 300 mögliche Werte. Wenn Sie also nur Berichte zu country erstellen, können Sie nicht mehr als 300 Zeilen erhalten, auch wenn Sie limit auf 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 „dimensionValues“ auf „RESERVED_(MetricAggregation)“ festgelegt ist. Aggregate mit Vergleichen und mehreren Zeiträumen werden anhand der Zeiträume aggregiert.
orderBys[]

object (OrderBy)

Gibt an, wie Zeilen in der Antwort sortiert werden. Bei Anfragen mit Vergleichen und mehreren Zeiträumen werden die Vergleiche sortiert.
currencyCode

string

Ein Währungscode im ISO4217-Format, z. B. „AED“, „USD“ oder „JPY“. Wenn das Feld leer ist, wird die Standardwährung der Property verwendet.
cohortSpec

object (CohortSpec)

Die Kohortengruppe, die dieser Anfrage zugeordnet ist. Wenn in der Anfrage eine Kohortengruppe vorhanden ist, muss die Dimension „Kohorte“ vorhanden sein.
keepEmptyRows

boolean

Wenn „false“ oder nicht angegeben, wird jede Zeile mit allen Messwerten gleich 0 nicht zurückgegeben. Wenn „true“, werden diese Zeilen zurückgegeben, sofern sie nicht separat durch einen Filter entfernt werden.

Unabhängig von dieser keepEmptyRows-Einstellung können in einem Bericht nur Daten angezeigt werden, die von der Google Analytics-Property erfasst wurden.

Wenn für eine Property beispielsweise nie ein purchase-Ereignis protokolliert wird, enthält eine Abfrage für die Dimension eventName und den Messwert eventCount keine Zeile mit eventName: "purchase" und eventCount: 0.
returnPropertyQuota

boolean

Legt fest, 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.