REST Resource: properties.reportTasks

Ressource: ReportTask

Eine bestimmte Berichtskonfiguration.

JSON-Darstellung
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
Felder
name

string

Nur Ausgabe. ID. Der Name der Berichtsaufgabenressource, die bei der Erstellung zugewiesen wurde. Format: „properties/{property}/reportTasks/{reportTask}“

reportDefinition

object (ReportDefinition)

Optional. Eine Berichtsdefinition zum Abrufen von Berichtsdaten, die die Struktur eines Berichts beschreibt. Sie enthält in der Regel die Felder, die im Bericht enthalten sein sollen, und die Kriterien, mit denen die Daten gefiltert werden.

reportMetadata

object (ReportMetadata)

Nur Ausgabe. Die Bericht-Metadaten für eine bestimmte Berichtsaufgabe, die Informationen zu einem Bericht enthalten. Er enthält in der Regel die folgenden Informationen: den Ressourcennamen des Berichts, den Status des Berichts, den Zeitstempel, zu dem der Bericht erstellt wurde usw.

ReportDefinition

Die Definition, wie ein Bericht ausgeführt werden soll.

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,
  "samplingLevel": enum (SamplingLevel)
}
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 Anzahl der Zeilen der Startzeile aus dem Google Analytics-Speicher. Die erste Zeile wird als Zeile 0 gezählt.

Beim Erstellen einer Berichtsaufgabe definieren die Parameter offset und limit die Teilmenge der Datenzeilen aus dem Google Analytics-Speicher, die in den generierten Bericht aufgenommen werden sollen. Wenn beispielsweise insgesamt 300.000 Zeilen im Google Analytics-Speicher vorhanden sind, enthält die erste Berichtsaufgabe möglicherweise die ersten 10.000 Zeilen mit einem Limit von 10.000 und einem Offset von 0. Anschließend könnte eine weitere Berichtsaufgabe die nächsten 10.000 Zeilen mit einem Limit von 10.000 und einem Offset von 10.000 abdecken.

limit

string (int64 format)

Optional. Die Anzahl der Zeilen, die im Bericht zurückgegeben werden sollen. 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.

metricAggregations[]

enum (MetricAggregation)

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

orderBys[]

object (OrderBy)

Optional. Gibt an, wie Zeilen in der Antwort sortiert werden.

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 erfasst wird, enthält eine Abfrage für die Dimension eventName und den Messwert eventCount keine Zeile mit eventName: "purchase" und eventCount: 0.

samplingLevel

enum (SamplingLevel)

Optional. Die Stichprobenebene des Berichts.

Dimension

Dimensionen sind Attribute Ihrer Daten. So gibt die Dimension „Stadt“ beispielsweise den Ort an, von dem ein Ereignis stammt. Dimensionswerte in Berichtsantworten sind Strings, z. B. „Berlin“ oder „München“.

JSON-Darstellung
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
Felder
name

string

Der Name der Dimension. Eine Liste der von den wichtigsten Berichtsmethoden wie runReport und batchRunReports unterstützten Dimensionsnamen finden Sie unter API-Dimensionen. Eine Liste der von der Methode runRealtimeReport unterstützten Dimensionsnamen finden Sie unter Echtzeitdimensionen. Eine Liste der von der runFunnelReport-Methode unterstützten Dimensionsnamen finden Sie unter Trichterdimensionen.

Wenn dimensionExpression angegeben ist, kann name ein beliebiger String innerhalb des zulässigen Zeichensatzes sein. Wenn beispielsweise mit dimensionExpression die Werte von country und city zusammengeführt werden, können Sie diese Dimension countryAndCity nennen. Die von Ihnen ausgewählten Dimensionsnamen müssen dem regulären Ausdruck ^[a-zA-Z0-9_]$ entsprechen.

Auf Dimensionen wird in dimensionFilter, orderBys, dimensionExpression und pivots mit name verwiesen.

dimensionExpression

object (DimensionExpression)

Eine Dimension kann das Ergebnis eines Ausdrucks aus mehreren Dimensionen sein. Beispiel: Dimension „Land, Stadt“: concatenate(country, „, “, city).

DimensionExpression

Wird verwendet, um eine Dimension auszudrücken, die das Ergebnis einer Formel mit mehreren Dimensionen ist. Beispiele für die Verwendung: 1) lowerCase(dimension) 2) concatenate(dimension1, symbol, dimension2).

JSON-Darstellung
{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}
Felder
Union-Feld one_expression. Geben Sie einen Typ von Dimensionsausdruck für DimensionExpression an. Für one_expression ist nur einer der folgenden Werte zulässig:
lowerCase

object (CaseExpression)

Wird verwendet, um einen Dimensionswert in Kleinbuchstaben zu konvertieren.

upperCase

object (CaseExpression)

Wird verwendet, um einen Dimensionswert in Großbuchstaben umzuwandeln.

concatenate

object (ConcatenateExpression)

Wird verwendet, um Dimensionswerte zu einer einzelnen Dimension zu kombinieren. Beispiel: Dimension „Land, Stadt“: concatenate(country, „, “, city).

CaseExpression

Wird verwendet, um einen Dimensionswert in einen einzelnen Fall zu konvertieren.

JSON-Darstellung
{
  "dimensionName": string
}
Felder
dimensionName

string

Name einer Dimension. Der Name muss sich auf einen Namen im Feld „dimensions“ der Anfrage beziehen.

ConcatenateExpression

Wird verwendet, um Dimensionswerte zu einer einzelnen Dimension zu kombinieren.

JSON-Darstellung
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Felder
dimensionNames[]

string

Namen der Dimensionen. Die Namen müssen sich auf Namen im Feld „dimensions“ der Anfrage beziehen.

delimiter

string

Das Trennzeichen zwischen Dimensionsnamen.

Trennzeichen sind oft einzelne Zeichen wie „|“ oder „,“, können aber auch längere Strings sein. Wenn ein Dimensionswert das Trennzeichen enthält, sind beide in der Antwort vorhanden, ohne dass eine Unterscheidung erfolgt. Wenn beispielsweise der Wert für Dimension 1 „US,FR“, der Wert für Dimension 2 „JP“ und das Trennzeichen „,“ ist, enthält die Antwort „US,FR,JP“.

Messwert

Die quantitativen Messungen eines Berichts. Der Messwert eventCount gibt beispielsweise die Gesamtzahl der Ereignisse an. Anfragen dürfen bis zu 10 Messwerte enthalten.

JSON-Darstellung
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Felder
name

string

Der Name des Messwerts. Eine Liste der Messwertnamen, die von Core Reporting-Methoden wie runReport und batchRunReports unterstützt werden, finden Sie unter API-Messwerte. Eine Liste der von der Methode runRealtimeReport unterstützten Messwertnamen finden Sie unter Echtzeitmesswerte. Eine Liste der von der runFunnelReport-Methode unterstützten Messwertnamen finden Sie unter Trichtermesswerte.

Wenn expression angegeben ist, kann name ein beliebiger String innerhalb des zulässigen Zeichensatzes sein. Wenn expression beispielsweise screenPageViews/sessions ist, könnte der Name des Messwerts viewsPerSession lauten. Die von Ihnen ausgewählten Messwertnamen müssen dem regulären Ausdruck ^[a-zA-Z0-9_]$ entsprechen.

Auf Messwerte wird in metricFilter, orderBys und Messwert expression über name verwiesen.

expression

string

Ein mathematischer Ausdruck für abgeleitete Messwerte. Der Messwert „Ereignisanzahl pro Nutzer“ ist beispielsweise eventCount/totalUsers.

invisible

boolean

Gibt an, ob ein Messwert in der Berichtsantwort unsichtbar ist. Wenn ein Messwert unsichtbar ist, wird in der Antwort keine Spalte für ihn erstellt. Er kann aber in metricFilter, orderBys oder einem Messwert expression verwendet werden.

DateRange

Eine zusammenhängende Gruppe von Tagen: startDate, startDate + 1, ..., endDate. Es sind bis zu vier Zeiträume in Anfragen zulässig.

JSON-Darstellung
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Felder
startDate

string

Das Startdatum (angegebener Tag ist eingeschlossen) für die Abfrage im Format YYYY-MM-DD. Darf nicht nach dem endDate liegen. Das Format NdaysAgo, yesterday oder today wird ebenfalls akzeptiert. In diesem Fall wird das Datum anhand der Berichtszeitzone der Property abgeleitet.

endDate

string

Das Enddatum (letzter Tag eingeschlossen) für die Abfrage im Format YYYY-MM-DD. Darf nicht vor dem startDate liegen. Das Format NdaysAgo, yesterday oder today wird ebenfalls akzeptiert. In diesem Fall wird das Datum anhand der Berichtszeitzone der Property abgeleitet.

name

string

Weist diesem Zeitraum einen Namen zu. Die Dimension dateRange wird in einer Antwort auf einen Bericht auf diesen Namen festgelegt. Wenn festgelegt, darf der Wert nicht mit date_range_ oder RESERVED_ beginnen. Wenn sie nicht festgelegt sind, werden Zeiträume anhand ihres nullbasierten Index in der Anfrage benannt: date_range_0, date_range_1 usw.

FilterExpression

Zum Ausdrücken von Dimensions- oder Messwertfiltern. Die Felder in demselben FilterExpression müssen entweder alle Dimensionen oder alle Messwerte sein.

JSON-Darstellung
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}
Felder
Union-Feld expr. Geben Sie einen Filterausdruckstyp für FilterExpression an. Für expr ist nur einer der folgenden Werte zulässig:
andGroup

object (FilterExpressionList)

Die FilterExpressions in andGroup haben eine AND-Beziehung.

orGroup

object (FilterExpressionList)

Die FilterExpressions in orGroup haben eine ODER-Beziehung.

notExpression

object (FilterExpression)

Der FilterExpression ist NICHT vom Typ „notExpression“.

filter

object (Filter)

Ein einfacher Filter. In derselben FilterExpression müssen alle Feldnamen des Filters entweder alle Dimensionen oder alle Messwerte sein.

FilterExpressionList

Eine Liste mit Filterausdrücken.

JSON-Darstellung
{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}
Felder
expressions[]

object (FilterExpression)

Eine Liste mit Filterausdrücken.

Filter

Ein Ausdruck zum Filtern von Dimensions- oder Messwerten.

JSON-Darstellung
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of list of possible types for union field one_filter.
}
Felder
fieldName

string

Der Name der Dimension oder des Messwerts. Muss ein Name sein, der in Dimensionen oder Messwerten definiert ist.

Union-Feld one_filter. Geben Sie einen Filtertyp für Filter an. Für one_filter ist nur einer der folgenden Werte zulässig:
stringFilter

object (StringFilter)

Filter für Strings.

inListFilter

object (InListFilter)

Ein Filter für Werte in der Liste.

numericFilter

object (NumericFilter)

Ein Filter für numerische Werte oder Datumswerte.

betweenFilter

object (BetweenFilter)

Ein Filter für einen Bereich zwischen zwei Werten.

emptyFilter

object (EmptyFilter)

Ein Filter für leere Werte wie „(not set)“ und „“.

StringFilter

Der Filter für String

JSON-Darstellung
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Felder
matchType

enum (MatchType)

Der Übereinstimmungstyp für diesen Filter.

value

string

Der Stringwert, der für den Abgleich verwendet wird.

caseSensitive

boolean

Wenn „true“, wird bei der Suche nach dem Stringwert die Groß-/Kleinschreibung beachtet.

MatchType

Der Übereinstimmungstyp eines String-Filters

Enums
MATCH_TYPE_UNSPECIFIED Ohne Angabe
EXACT Genaue Übereinstimmung des Stringwerts.
BEGINS_WITH Beginnt mit dem Stringwert.
ENDS_WITH Endet mit dem Stringwert.
CONTAINS Enthält den Stringwert.
FULL_REGEXP Vollständige Übereinstimmung des regulären Ausdrucks mit dem Stringwert.
PARTIAL_REGEXP Partielle Übereinstimmung des regulären Ausdrucks mit dem Stringwert.

InListFilter

Das Ergebnis muss in einer Liste von Stringwerten enthalten sein.

JSON-Darstellung
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Felder
values[]

string

Die Liste der Stringwerte. Darf nicht leer sein.

caseSensitive

boolean

Wenn „true“, wird bei der Suche nach dem Stringwert die Groß-/Kleinschreibung beachtet.

NumericFilter

Filter für numerische Werte oder Datumswerte.

JSON-Darstellung
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Felder
operation

enum (Operation)

Der Vorgangstyp für diesen Filter.

value

object (NumericValue)

Ein numerischer Wert oder ein Datumswert.

Vorgang

Der Vorgang, der auf einen numerischen Filter angewendet wird

Enums
OPERATION_UNSPECIFIED Nicht angegeben
EQUAL Gleich
LESS_THAN Weniger als
LESS_THAN_OR_EQUAL kleiner als oder gleich
GREATER_THAN größer als
GREATER_THAN_OR_EQUAL größer als oder gleich

NumericValue

Eine Zahl darstellen.

JSON-Darstellung
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
Felder
Union-Feld one_value. Einer der numerischen Werte one_value kann nur einer der folgenden Werte sein:
int64Value

string (int64 format)

Ganzzahlwert

doubleValue

number

Doppelter Wert

BetweenFilter

Um anzugeben, dass das Ergebnis zwischen zwei Zahlen (einschließlich) liegen muss.

JSON-Darstellung
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Felder
fromValue

object (NumericValue)

Beginnt mit dieser Zahl.

toValue

object (NumericValue)

Endet mit dieser Nummer.

EmptyFilter

Dieser Typ hat keine Felder.

Nach leeren Werten filtern

MetricAggregation

Stellt die Aggregation von Messwerten dar.

Enums
METRIC_AGGREGATION_UNSPECIFIED Nicht angegebener Operator.
TOTAL SUM-Operator.
MINIMUM Minimum-Operator.
MAXIMUM Maximaler Operator.
COUNT Count-Operator.

OrderBy

Mit „Order bys“ wird definiert, wie Zeilen in der Antwort sortiert werden. Wenn Sie Zeilen beispielsweise nach absteigender Ereignisanzahl sortieren, ist das eine andere Sortierung als wenn Sie Zeilen nach dem Ereignisnamen sortieren.

JSON-Darstellung
{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}
Felder
desc

boolean

Bei „true“ wird in absteigender Reihenfolge sortiert.

Union-Feld one_order_by. Geben Sie einen Typ von „order by“ für OrderBy an. Für one_order_by ist nur einer der folgenden Werte zulässig:
metric

object (MetricOrderBy)

Sortiert Ergebnisse nach den Werten eines Messwerts.

dimension

object (DimensionOrderBy)

Sortiert Ergebnisse nach den Werten einer Dimension.

MetricOrderBy

Sortiert nach Messwerten.

JSON-Darstellung
{
  "metricName": string
}
Felder
metricName

string

Ein Messwertname in der Anfrage, nach dem sortiert werden soll.

DimensionOrderBy

Sortiert nach Dimensionswerten.

JSON-Darstellung
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
Felder
dimensionName

string

Ein Dimensionsname in der Anfrage, nach dem sortiert werden soll.

orderType

enum (OrderType)

Steuert die Regel für die Sortierung von Dimensionswerten.

OrderType

Regel zum Sortieren der String-Dimensionswerte.

Enums
ORDER_TYPE_UNSPECIFIED Nicht angegeben
ALPHANUMERIC Alphanumerische Sortierung nach Unicode-Codepunkt. Beispiel: „2“ < „A“ < „X“ < „b“ < „z“.
CASE_INSENSITIVE_ALPHANUMERIC Alphanumerische Sortierung ohne Berücksichtigung der Groß-/Kleinschreibung nach Unicode-Codepunkt in Kleinbuchstaben. Beispiel: „2“ < „A“ < „b“ < „X“ < „z“.
NUMERIC Dimensionswerte werden vor dem Sortieren in Zahlen konvertiert. Bei der numerischen Sortierung gilt beispielsweise „25“ < „100“, bei der ALPHANUMERIC-Sortierung „100“ < „25“. Nicht numerische Dimensionswerte haben alle den gleichen Ordnungswert, der unter allen numerischen Werten liegt.

CohortSpec

Die Spezifikation von Kohorten für einen Kohortenbericht.

In Kohortenberichten wird eine Zeitreihe der Nutzerbindung für die Kohorte erstellt. Sie können beispielsweise die Kohorte von Nutzern auswählen, die in der ersten Septemberwoche gewonnen wurden, und diese Kohorte in den nächsten sechs Wochen beobachten. Die Auswahl der Nutzer, die in der ersten Septemberwoche gewonnen wurden, wird im cohort-Objekt angegeben. Die Beobachtung dieser Kohorte in den nächsten sechs Wochen wird im cohortsRange-Objekt angegeben.

Beispiele finden Sie unter Beispiele für Kohortenberichte.

In der Antwort auf den Bericht könnte eine wöchentliche Zeitreihe angezeigt werden, in der beispielsweise zu sehen ist, dass 60% dieser Kohorte nach drei Wochen und 25% nach sechs Wochen in Ihrer App aktiv sind. Diese beiden Prozentsätze können mit dem Messwert cohortActiveUsers/cohortTotalUsers berechnet werden und werden in separaten Zeilen im Bericht angezeigt.

JSON-Darstellung
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Felder
cohorts[]

object (Cohort)

Definiert die Auswahlkriterien, um Nutzer in Kohorten zu gruppieren.

In den meisten Kohortenberichten wird nur eine Kohorte definiert. Wenn mehrere Kohorten angegeben sind, können Sie sie im Bericht anhand ihres Namens erkennen.

cohortsRange

object (CohortsRange)

In Kohortenberichten werden Kohorten über einen längeren Berichtszeitraum hinweg beobachtet. Mit diesem Bereich wird eine Offset-Dauer angegeben, über die die Kohorten beobachtet werden sollen.

cohortReportSettings

object (CohortReportSettings)

Optionale Einstellungen für einen Kohortenbericht.

Kohorte

Definiert ein Kohortenauswahlkriterium. Eine Kohorte ist eine Gruppe von Nutzern mit einem gemeinsamen Merkmal. Beispielsweise gehören Nutzer mit demselben firstSessionDate zur selben Kohorte.

JSON-Darstellung
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
Felder
name

string

Weist dieser Kohorte einen Namen zu. Die Dimension cohort wird in einer Antwort auf einen Bericht auf diesen Namen festgelegt. Wenn festgelegt, darf der Wert nicht mit cohort_ oder RESERVED_ beginnen. Wenn nicht festgelegt, werden Kohorten nach ihrem nullbasierten Index benannt: cohort_0, cohort_1 usw.

dimension

string

Von der Kohorte verwendete Dimension. Erforderlich und unterstützt nur firstSessionDate.

dateRange

object (DateRange)

Die Kohorte umfasst Nutzer, deren erstes Touchpoint-Datum zwischen dem Start- und Enddatum liegt, das in dateRange definiert ist. dateRange gibt nicht den vollständigen Zeitraum der Ereignisdaten an, die in einem Kohortenbericht enthalten sind. In einem Kohortenbericht wird dateRange durch die Granularität und den Offset in cohortsRange erweitert. Ereignisdaten für den erweiterten Berichtszeitraum sind in einem Kohortenbericht verfügbar.

In einer Kohortenanfrage ist dateRange erforderlich und dateRanges in RunReportRequest oder RunPivotReportRequest muss nicht angegeben werden.

Dieser dateRange sollte in der Regel auf die Granularität der Kohorte abgestimmt sein. Wenn für CohortsRange die tägliche Granularität verwendet wird, kann dateRange ein einzelner Tag sein. Wenn für CohortsRange die wöchentliche Granularität verwendet wird, kann dateRange an einer Woche ausgerichtet werden, die am Sonntag beginnt und am Samstag endet. Wenn CohortsRange eine monatliche Granularität verwendet, kann dateRange an einen Monat angepasst werden, beginnend am ersten und endend am letzten Tag des Monats.

CohortsRange

Konfiguriert den erweiterten Zeitraum für einen Kohortenbericht. Gibt eine Offset-Dauer an, über die die Kohorten beobachtet werden sollen.

JSON-Darstellung
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Felder
granularity

enum (Granularity)

Erforderlich. Der Detaillierungsgrad, der zum Interpretieren von startOffset und endOffset für den erweiterten Berichtszeitraum eines Kohortenberichts verwendet wird.

startOffset

integer

Mit startOffset wird das Startdatum des erweiterten Berichtszeitraums für einen Kohortenbericht angegeben. startOffset wird in der Regel auf 0 gesetzt, damit Berichte Daten ab dem Zeitpunkt der Akquisition der Kohorte enthalten.

Wenn granularity gleich DAILY ist, ist das startDate des erweiterten Berichtszeitraums das startDate der Kohorte plus startOffset Tage.

Wenn granularity gleich WEEKLY ist, ist das startDate des erweiterten Berichtszeitraums das startDate der Kohorte plus startOffset * 7 Tage.

Wenn granularity gleich MONTHLY ist, ist das startDate des erweiterten Berichtszeitraums das startDate der Kohorte plus startOffset * 30 Tage.

endOffset

integer

Erforderlich. Mit endOffset wird das Enddatum des erweiterten Berichtszeitraums für einen Kohortenbericht angegeben. endOffset kann eine beliebige positive Ganzzahl sein, wird aber in der Regel auf 5 bis 10 festgelegt, damit Berichte Daten zur Kohorte für die nächsten Zeiträume mit der entsprechenden Granularität enthalten.

Wenn granularity gleich DAILY ist, ist das endDate des erweiterten Berichtszeitraums das endDate der Kohorte plus endOffset Tage.

Wenn granularity gleich WEEKLY ist, ist das endDate des erweiterten Berichtszeitraums das endDate der Kohorte plus endOffset * 7 Tage.

Wenn granularity gleich MONTHLY ist, ist das endDate des erweiterten Berichtszeitraums das endDate der Kohorte plus endOffset * 30 Tage.

Detaillierungsgrad

Der Detaillierungsgrad, der zum Interpretieren von startOffset und endOffset für den erweiterten Berichtszeitraum eines Kohortenberichts verwendet wird.

Enums
GRANULARITY_UNSPECIFIED Sollte nie angegeben werden.
DAILY Tagesgenauigkeit Wird häufig verwendet, wenn dateRange der Kohorte ein einzelner Tag ist und die Anfrage cohortNthDay enthält.
WEEKLY Wöchentliche Detaillierung. Wird häufig verwendet, wenn der dateRange der Kohorte eine Woche dauert (beginnend am Sonntag und endend am Samstag) und die Anfrage cohortNthWeek enthält.
MONTHLY Monatlicher Detaillierungsgrad. Wird häufig verwendet, wenn die dateRange der Kohorte einen Monat lang ist und die Anfrage cohortNthMonth enthält.

CohortReportSettings

Optionale Einstellungen eines Kohortenberichts.

JSON-Darstellung
{
  "accumulate": boolean
}
Felder
accumulate

boolean

Wenn „true“, wird das Ergebnis vom Tag des ersten Kontakts bis zum Enddatum kumuliert. Nicht unterstützt in RunReportRequest.

SamplingLevel

Kategorien von Stichprobenebenen für die Anfragen.

Enums
SAMPLING_LEVEL_UNSPECIFIED Nicht definierter Typ.
LOW Wendet eine Stichprobenebene von 10 Millionen auf Standard-Properties und 100 Millionen auf Google Analytics 360-Properties an.
MEDIUM Exklusiv für Google Analytics 360-Properties mit einem Stichprobenniveau von 1 Milliarde.
UNSAMPLED Nur für Google Analytics 360-Properties verfügbar. Explorative Gesamtdatenanalysen sind genauer und können Informationen aufdecken, die bei standardmäßigen Verfahren nicht verfügbar sind. Weitere Informationen finden Sie unter https://support.google.com/analytics/answer/10896953.

ReportMetadata

Die Bericht-Metadaten für eine bestimmte Berichtsaufgabe.

JSON-Darstellung
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
Felder
creationQuotaTokensCharged

integer

Nur Ausgabe. Die Gesamtzahl der Kontingent-Tokens, die bei der Erstellung des Berichts berechnet wurden. Da diese Anzahl von Tokens auf Aktivitäten im Status CREATING basiert, ist die Gebühr für diese Tokens festgelegt, sobald eine Berichtsaufgabe in den Status ACTIVE oder FAILED wechselt.

state

enum (State)

Nur Ausgabe. Der aktuelle Status dieser Berichtsaufgabe.

beginCreatingTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem reportTasks.create aufgerufen wurde und der Bericht den Status CREATING erreicht hat.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

taskRowCount

integer

Nur Ausgabe. Die Gesamtzahl der Zeilen im Berichtsergebnis. Dieses Feld wird ausgefüllt, wenn der Status aktiv ist. Sie können taskRowCount für die Paginierung innerhalb des vorhandenen Berichts verwenden.

errorMessage

string

Nur Ausgabe. Fehlermeldung, die angezeigt wird, wenn beim Erstellen einer Berichtsaufgabe ein Fehler auftritt.

totalRowCount

integer

Nur Ausgabe. Die Gesamtzahl der Zeilen im Google Analytics-Speicher. Wenn Sie zusätzliche Datenzeilen abfragen möchten, die über den aktuellen Bericht hinausgehen, können Sie einen neuen Berichts-Task auf Grundlage von totalRowCount starten.

taskRowCount steht für die Anzahl der Zeilen, die sich speziell auf den aktuellen Bericht beziehen, während totalRowCount die Gesamtzahl der Zeilen für alle Daten umfasst, die aus dem Google Analytics-Speicher abgerufen werden.

Angenommen, der aktuelle Bericht hat einen taskRowCount-Wert von 20. Dann werden die Daten aus den ersten 20 Zeilen angezeigt. Gleichzeitig ist totalRowCount = 30, was darauf hinweist, dass Daten für alle 30 Zeilen vorhanden sind. Mit taskRowCount können Sie durch die ersten 20 Zeilen blättern. Um den Bericht zu erweitern und Daten aus allen 30 Zeilen einzubeziehen, kann mit totalRowCount eine neue Berichtsaufgabe erstellt werden, um auf den vollständigen Datensatz mit 30 Zeilen zuzugreifen.

Bundesland

Der Verarbeitungsstatus.

Enums
STATE_UNSPECIFIED Der nicht angegebene Status wird nie verwendet.
CREATING Der Bericht wird gerade erstellt und ist in Zukunft verfügbar. Die Erstellung erfolgt unmittelbar nach dem Aufruf von „CreateReport“.
ACTIVE Der Bericht wurde vollständig erstellt und kann abgefragt werden.
FAILED Der Bericht konnte nicht erstellt werden.

Methoden

create

Leitet die Erstellung einer Berichtsaufgabe ein.

get

Ruft Bericht-Metadaten zu einer bestimmten Berichtsaufgabe ab.

list

Listet alle Berichtsaufgaben für eine Property auf.

query

Ruft den Inhalt einer Berichtsaufgabe ab.