Method: runReport

Gibt einen benutzerdefinierten Bericht mit Ihren Google Analytics-Ereignisdaten zurück. Berichte enthalten Statistiken, die auf Daten basieren, die mit dem 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 einzelne Messungen der Nutzeraktivität in Ihrer Property, z. B. aktive Nutzer oder die Ereignisanzahl. Dimensionen schlüsseln Messwerte nach einigen gängigen Kriterien auf, z. B. 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)

Property, deren Ereignisse erfasst werden. In 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 Abmessungen.

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 aufgeführt. In einer Kohortenanfrage darf 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 Sie anfordern.

metricAggregations[]

enum (MetricAggregation)

Zusammenfassung von Messwerten Zusammengefasste Messwerte werden in Zeilen angezeigt, in denen „dimensionValues“ auf „RESERVED_(MesswertAggregation)“ festgelegt ist.

dimensionFilter

object (FilterExpression)

Die Filterklausel für Dimensionen. Dimensionen müssen angefordert werden, damit sie in diesem Filter verwendet werden können. Messwerte können in diesem Filter nicht verwendet werden.

metricFilter

object (FilterExpression)

Die Filterklausel für Messwerte. Wird in der Post-Aggregationsphase angewendet, ähnlich wie bei SQL mit Klausel. Messwerte müssen zur Verwendung in diesem Filter angefordert werden. In diesem Filter können keine Dimensionen verwendet werden.

orderBys[]

object (OrderBy)

Gibt an, wie Zeilen in der Antwort sortiert 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)

Die mit dieser Anfrage verknüpfte Kohortengruppe. Wenn die Anfrage eine Kohortengruppe enthält, muss die Dimension „Kohorte“ vorhanden sein.

keepEmptyRows

boolean

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, wenn sie nicht separat durch einen Filter entfernt werden.

returnPropertyQuota

boolean

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