Method: properties.runReport

Gibt einen benutzerdefinierten Bericht Ihrer Google Analytics-Ereignisdaten zurück. Berichte enthalten Statistiken, die aus Daten abgeleitet wurden, die vom Google Analytics-Tracking-Code erfasst wurden. Die von der API zurückgegebenen Daten liegen als 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 Anzahl der Ereignisse. Dimensionen unterteilen Messwerte nach allgemeinen Kriterien wie Land oder Ereignisname.

Eine Anleitung zum Erstellen von Anfragen und zum Interpretieren von Antworten finden Sie unter Bericht erstellen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
property

string

Eine Google Analytics-Property-ID, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen finden Sie unter Property-ID ermitteln. In einer Batchanfrage sollte diese Property entweder nicht angegeben werden oder mit der Property auf Batch-Ebene übereinstimmen.

Beispiel: properties/1234

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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
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 der 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 Zeilennummer 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 den limit der ersten Anfrage gesetzt. Die zweite Anfrage gibt die zweiten limit Zeilen zurück.

Weitere Informationen zu diesem Paging-Parameter finden Sie unter Paging.
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 der angeforderte limit zurückgeben, wenn es nicht so viele Dimensionswerte wie der 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 setzen.

Weitere Informationen zu diesem Paging-Parameter finden Sie unter Paging.
metricAggregations[]

enum (MetricAggregation)

Aggregation von Messwerten. Aggregierte Messwerte werden in Zeilen angezeigt, in denen die DimensionValues auf „RESERVED_(MetricAggregation)“ gesetzt sind. Aggregate, die sowohl Vergleiche als auch mehrere Zeiträume enthalten, werden anhand der Zeiträume aggregiert.
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 Sortierungen auf die Vergleiche angewendet.
currencyCode

string

Ein Währungscode im ISO 4217-Format, z. B. „AED“, „USD“ oder „JPY“. Wenn das Feld leer ist, wird die Standardwährung der Property für den Bericht verwendet.
cohortSpec

object (CohortSpec)

Kohortengruppe, die dieser Anfrage zugeordnet ist. Wenn die Anfrage eine Kohortengruppe enthält, muss die Dimension „cohort“ vorhanden sein.
keepEmptyRows

boolean

Wenn „false“ oder nicht angegeben, werden Zeilen, in denen alle Messwerte gleich 0 sind, 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 beispielsweise in einer Property 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 Feld für Vergleiche erforderlich, um eine Vergleichsspalte in der Antwort zu erhalten.

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