Method: properties.runReport

Gibt einen benutzerdefinierten Bericht Ihrer Google Analytics-Ereignisdaten zurück. Berichte enthalten Statistiken, die aus Daten abgeleitet werden, 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. Mit Dimensionen lassen sich Messwerte anhand gängiger Kriterien wie Land oder Ereignisname aufschlüsseln.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
property

string

Erforderlich. 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

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)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
Felder
dimensions[]

object (Dimension)

Optional. Die angeforderten und angezeigten Dimensionen.
metrics[]

object (Metric)

Optional. Die angeforderten und angezeigten Messwerte.
dateRanges[]

object (DateRange)

Optional. 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)

Optional. 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)

Optional. 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)

Optional. 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)

Optional. Die maximale 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)

Optional. 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)

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

string

Optional. 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)

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

boolean

Optional. 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

Optional. 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.
conversionSpec

object (ConversionSpec)

Optional. Steuert die Berichterstellung für Conversions. Dieses Feld ist optional. Wenn dieses Feld festgelegt ist oder Conversion-Messwerte angefordert werden, ist der Bericht ein Conversion-Bericht.

Antworttext

Die Antwortberichtstabelle, die einer Anfrage entspricht.

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

JSON-Darstellung 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": string
}
Felder
dimensionHeaders[]

object (DimensionHeader)

Beschreibt Dimensionsspalten. Die Anzahl der DimensionHeaders und die Reihenfolge der DimensionHeaders stimmen mit den Dimensionen in den Zeilen überein.
metricHeaders[]

object (MetricHeader)

Beschreibt Messwertspalten. Die Anzahl der MetricHeaders und die Reihenfolge der MetricHeaders stimmen mit den Messwerten in den Zeilen überein.
rows[]

object (Row)

Zeilen mit Kombinationen aus Dimensionswerten und Messwerten im Bericht.
totals[]

object (Row)

Die Summenwerte der Messwerte, falls angefordert.
maximums[]

object (Row)

Falls angefordert, die Höchstwerte von Messwerten.
minimums[]

object (Row)

Falls angefordert, die Mindestwerte von Messwerten.
rowCount

integer

Die Gesamtzahl der Zeilen im Abfrageergebnis, unabhängig von der Anzahl der Zeilen, die in der Antwort zurückgegeben werden. Wenn bei einer Abfrage beispielsweise 175 Zeilen zurückgegeben werden und die API-Anfrage „limit = 50“ enthält, enthält die Antwort „rowCount = 175“, aber nur 50 Zeilen.

Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung.
metadata

object (ResponseMetaData)

Metadaten für den Bericht.
propertyQuota

object (PropertyQuota)

Der Kontingentstatus dieser Analytics-Property, einschließlich dieser Anfrage.
kind

string

Gibt an, um welche Art von Ressource es sich bei dieser Nachricht handelt. kind ist immer der feste String „analyticsData#runReport“. Nützlich, um zwischen Antworttypen in JSON zu unterscheiden.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

Vergleich

Definiert einen einzelnen Vergleich. Die meisten Anfragen enthalten mehrere Vergleiche, sodass im Bericht die Vergleiche miteinander verglichen werden.

JSON-Darstellung 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
Felder
name

string

Für jeden Vergleich werden separate Zeilen in der Antwort generiert. In der Antwort wird dieser Vergleich anhand dieses Namens identifiziert. Wenn kein Name angegeben ist, wird der Anzeigename der gespeicherten Vergleiche verwendet.

Union-Feld one_comparison.

Für one_comparison ist nur einer der folgenden Werte zulässig:
dimensionFilter

object (FilterExpression)

Ein einfacher Vergleich.
comparison

string

Ein gespeicherter Vergleich, der anhand des Ressourcennamens des Vergleichs identifiziert wird. Beispiel: „comparisons/1234“.

ConversionSpec

Steuert die Berichterstellung für Conversions.

JSON-Darstellung 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
Felder
conversionActions[]

string

Die IDs der Conversion-Aktionen, die im Bericht enthalten sein sollen. Wenn leer, werden alle Conversions berücksichtigt. Gültige Conversion-Aktions-IDs können aus dem Feld conversionAction in der Liste conversions in der Antwort der Methode properties.getMetadata abgerufen werden. Beispiel: „conversionActions/1234“.
attributionModel

enum (AttributionModel)

Das Attributionsmodell, das im Conversion-Bericht verwendet werden soll. Wenn nichts angegeben ist, wird DATA_DRIVEN verwendet.

AttributionModel

Attributionsmodell für den Conversion-Bericht

Enums
ATTRIBUTION_MODEL_UNSPECIFIED Attributionsmodell nicht angegeben.
DATA_DRIVEN Die Attribution basierte auf dem datengetriebenen Modell für bezahlte und Daten zu organischen Aufrufen.
LAST_CLICK Die Attribution erfolgte auf Grundlage des Modells „Letzter Klick (bezahlte und organische Channels)“