Method: runReport

Gibt einen benutzerdefinierten Bericht mit Ihren Google Analytics-Ereignisdaten zurück. Die Berichte enthalten Statistiken, die aus Daten abgeleitet werden, die mit dem Google Analytics-Tracking-Code erfasst wurden. Von der API wird eine Tabelle mit Spalten für die angeforderten Dimensionen und Messwerte zurückgegeben. Messwerte sind individuelle Messwerte zur Nutzeraktivität in Ihrer Property, z. B. die Anzahl der aktiven Nutzer oder die Anzahl der Ereignisse. Mit Dimensionen werden Messwerte nach einigen gängigen Kriterien aufgeschlüsselt, z. B. nach Land oder Ereignisname.

HTTP-Anfrage

POST https://analyticsdata.googleapis.com/v1alpha:runReport

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Felder
entity

object (Entity)

Eine Property, deren Ereignisse erfasst werden. Innerhalb einer Batchanfrage sollte diese Entität entweder nicht angegeben sein oder mit der Entität auf Batchebene übereinstimmen.

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, werden die Ereignisdaten für die sich überschneidenden Tage in den Antwortzeilen für beide Zeiträume angezeigt. In einer Kohortenanfrage darf diese dateRanges nicht angegeben werden.

offset

string (int64 format)

Die Zeilenanzahl der Startzeile. Die erste Zeile wird als Zeile 0 gezählt.

limit

string (int64 format)

Die Anzahl der zurückzugebenden Zeilen. Wenn der Parameter limit nicht angegeben ist, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 100.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Zeilen angefordert werden.

metricAggregations[]

enum (MetricAggregation)

Aggregation von Messwerten. Aggregierte Messwerte werden in Zeilen angezeigt, in denen die DimensionValues auf „RESERVED_(MetricAggregation)“ festgelegt ist.

dimensionFilter

object (FilterExpression)

Die Filterklausel von Dimensionen. Dimensionen müssen angefordert werden, damit sie in diesem Filter verwendet werden können. In diesem Filter können keine Messwerte verwendet werden.

metricFilter

object (FilterExpression)

Die Filterklausel von Messwerten. Wird in der Post-Aggregationsphase angewendet, ähnlich der SQL-With-Klausel. Messwerte müssen angefordert werden, damit sie in diesem Filter verwendet werden können. In diesem Filter können keine Dimensionen verwendet werden.

orderBys[]

object (OrderBy)

Gibt an, wie Zeilen in der Antwort angeordnet werden.

currencyCode

string

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

cohortSpec

object (CohortSpec)

Mit dieser Anfrage verknüpfte Kohortengruppe. Gibt es eine Kohortengruppe in der Anfrage, wird die „Kohorte“ Dimension vorhanden sein muss.

keepEmptyRows

boolean

Wenn „false“ oder nicht angegeben, wird keine Zeile zurückgegeben, die alle Messwerte gleich 0 enthält. Bei „true“ werden diese Zeilen zurückgegeben, wenn sie nicht separat durch einen Filter entfernt werden.

returnPropertyQuota

boolean

Mit dieser Option kann festgelegt werden, 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