REST Resource: properties.reportTasks

Ressource: ReportTask

Eine bestimmte Berichtsaufgabenkonfiguration.

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

string

Nur Ausgabe. Kennung. Der Name der Berichtsaufgabe, der 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 in den Bericht aufgenommen werden, und die Kriterien, anhand derer die Daten gefiltert werden.

reportMetadata

object (ReportMetadata)

Nur Ausgabe. Die Berichtsmetadaten für eine bestimmte Berichtsaufgabe, die Informationen zu einem Bericht enthalten. Sie enthält in der Regel die folgenden Informationen: den Ressourcennamen des Berichts, den Status des Berichts, den Zeitstempel der Berichtserstellung usw.

ReportDefinition

Die Definition, wie ein Bericht erstellt 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 Index für den Zeitraum, der auf null basiert. Wenn sich zwei Zeiträume überschneiden, werden die Ereignisdaten für die überlappenden Tage in den Antwortzeilen für beide Zeiträume berücksichtigt. In einer Kohortenanfrage darf dieser dateRanges nicht angegeben sein.

dimensionFilter

object (FilterExpression)

Optional. Mit Dimensionsfiltern können Sie nur bestimmte Dimensionswerte im Bericht abrufen. Weitere Informationen finden Sie unter Grundlagen von Dimensionsfiltern. In diesem Filter können keine Messwerte verwendet werden.

metricFilter

object (FilterExpression)

Optional. Die Filterklausel der Messwerte. Wird nach der Aggregation der Zeilen des Berichts angewendet, ähnlich wie die SQL-Having-Klausel. Dimensionen können in diesem Filter nicht verwendet werden.

offset

string (int64 format)

Optional. Die Zeilenanzahl 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 sich beispielsweise insgesamt 300.000 Zeilen im Google Analytics-Speicher befinden, können die ersten 10.000 Zeilen mit einem Limit von 10.000 und einem Offset von 0 in der ersten Berichtsaufgabe enthalten sein. 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 keine Angabe gemacht wird, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 250.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Zeilen angefordert werden. limit muss positiv sein.

Die API kann auch weniger Zeilen als die angeforderte limit zurückgeben, wenn es nicht so viele Dimensionswerte wie die limit gibt. Wenn für die Dimension country beispielsweise weniger als 300 mögliche Werte vorhanden sind, können Sie in Berichten, die nur country enthalten, nicht mehr als 300 Zeilen sehen, auch wenn Sie limit auf einen höheren Wert festlegen.

metricAggregations[]

enum (MetricAggregation)

Optional. Aggregation von Messwerten. Aggregierte Messwertwerte werden in Zeilen angezeigt, in denen die Dimensionswerte auf „RESERVED_(MetricAggregation)“ festgelegt sind.

orderBys[]

object (OrderBy)

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

currencyCode

string

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

Optional. Wenn „false“ oder „unspecified“ festgelegt ist, werden Zeilen mit allen Nullwerten nicht zurückgegeben. Wenn diese Option aktiviert ist, werden diese Zeilen zurückgegeben, sofern sie nicht durch einen Filter separat entfernt werden.

Unabhängig von dieser keepEmptyRows-Einstellung können nur Daten in einem Bericht 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 nach der Dimension „eventName“ und dem Messwert „eventCount“ keine Zeile mit „eventName: „purchase““ und „eventCount: 0“.

samplingLevel

enum (SamplingLevel)

Optional. Die Stichprobenerhebungsebene 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. Die Stadt könnte beispielsweise „Berlin“ oder „München“ sein.

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

string

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

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

name verweist in dimensionFilter, orderBys, dimensionExpression und pivots auf die Dimensionen.

dimensionExpression

object (DimensionExpression)

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

DimensionExpression

Hiermit wird eine Dimension ausgedrückt, die das Ergebnis einer Formel mit mehreren Dimensionen ist. Anwendungsbeispiele: 1) lessCase(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)

Hiermit wird ein Dimensionswert in Kleinbuchstaben umgewandelt.

upperCase

object (CaseExpression)

Wandelt einen Dimensionswert in Großbuchstaben um.

concatenate

object (ConcatenateExpression)

Hiermit werden Dimensionswerte zu einer einzelnen Dimension kombiniert. Beispiel: Dimension „Land, Stadt“: concatenate(country, ", ", city).

CaseExpression

Wird verwendet, um einen Dimensionswert in einen einzelnen Fall umzuwandeln.

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

string

Name einer Dimension. Der Name muss sich auf einen Namen im Dimensions-Feld der Anfrage beziehen.

ConcatenateExpression

Hiermit werden Dimensionswerte zu einer einzelnen Dimension kombiniert.

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

string

Namen der Dimensionen. Die Namen müssen auf Namen im Dimensionsfeld der Anfrage verweisen.

delimiter

string

Das Trennzeichen zwischen den 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 enthalten, ohne dass sie unterschieden werden. Wenn der Wert für Dimension 1 beispielsweise „DE,FR“ und der Wert für Dimension 2 „JP“ ist und „,“ als Trennzeichen festgelegt ist, enthält die Antwort „DE,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 den wichtigsten Berichtsmethoden wie runReport und batchRunReports unterstützt werden, finden Sie unter API-Messwerte. Eine Liste der Messwertnamen, die von der Methode runRealtimeReport unterstützt werden, finden Sie unter Messwerte in Echtzeit. Eine Liste der von der Methode runFunnelReport unterstützten Messwertnamen finden Sie unter Trichtermesswerte.

Wenn expression angegeben ist, kann name beliebiger String innerhalb des zulässigen Zeichensatzes sein. Beispiel: Wenn expression den Wert screenPageViews/sessions hat, können Sie den Namen dieses Messwerts „viewsPerSession“ nennen. 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 durch name verwiesen.

expression

string

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

invisible

boolean

Gibt an, ob ein Messwert in der Berichtsantwort nicht sichtbar ist. Wenn ein Messwert nicht sichtbar ist, wird keine Spalte in der Antwort generiert, er kann aber in metricFilter, orderBys oder dem Messwert expression verwendet werden.

DateRange

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

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

string

Das Startdatum (einschließlich) für die Abfrage im Format YYYY-MM-DD. Darf nicht nach endDate liegen. Das Format NdaysAgo, yesterday oder today ist ebenfalls zulässig. In diesem Fall wird das Datum aus der Zeitzone für Berichte der Property abgeleitet.

endDate

string

Das Enddatum (letzter Tag eingeschlossen) der Abfrage im Format YYYY-MM-DD. Darf nicht vor dem startDate liegen. Das Format NdaysAgo, yesterday oder today ist ebenfalls zulässig. In diesem Fall wird das Datum anhand der Zeitzone der Property abgeleitet.

name

string

Diesem Zeitraum wird ein Name zugewiesen. Die Dimension „dateRange“ wird in einer Berichtsantwort auf diesen Namen geschätzt. Wenn festgelegt, darf nicht mit date_range_ oder RESERVED_ beginnen. Wenn sie nicht festgelegt sind, werden Datumsbereiche in der Anfrage anhand ihres Index (ab Null) benannt: date_range_0, date_range_1 usw.

FilterExpression

Für Dimensions- oder Messwertfilter. Die Felder in derselben FilterExpression müssen entweder alle Dimensionen oder alle Messwerte enthalten.

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 Filterausdruck für FilterExpression an. Für expr ist nur einer der folgenden Werte zulässig:
andGroup

object (FilterExpressionList)

Die Filterausdrücke in „andGroup“ haben eine AND-Beziehung.

orGroup

object (FilterExpressionList)

Die Filterausdrücke in „orGroup“ haben eine ODER-Beziehung.

notExpression

object (FilterExpression)

FilterExpression entspricht NICHT notExpression.

filter

object (Filter)

Ein primitiver Filter. Im selben Filterausdruck müssen alle Feldnamen des Filters entweder alle Dimensionen oder alle Messwerte sein.

FilterExpressionList

Eine Liste von Filterausdrücken.

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

object (FilterExpression)

Eine Liste von 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)
  }
  // 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 einer Liste.

numericFilter

object (NumericFilter)

Ein Filter für numerische oder Datumswerte.

betweenFilter

object (BetweenFilter)

Ein Filter für Werte zwischen zwei Werten.

StringFilter

Der Filter für Strings

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 die Übereinstimmung verwendet wird.

caseSensitive

boolean

Wenn diese Option aktiviert ist, wird beim Stringwert zwischen Groß- und Kleinschreibung unterschieden.

MatchType

Der Übereinstimmungstyp eines Stringfilters

Enums
MATCH_TYPE_UNSPECIFIED Ohne Angabe
EXACT Exakte Ü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 Teilweise Übereinstimmung des regulären Ausdrucks mit dem Stringwert.

InListFilter

Das Ergebnis muss in einer Liste von Stringwerten vorliegen.

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

string

Die Liste der Stringwerte. Das Feld darf nicht leer sein.

caseSensitive

boolean

Wenn diese Option aktiviert ist, wird beim Stringwert zwischen Groß- und Kleinschreibung unterschieden.

NumericFilter

Filtert 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)

Einen numerischen Wert oder einen 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

Um eine Zahl darzustellen.

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

Das Ergebnis muss zwischen zwei Zahlen liegen (einschließlich).

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

object (NumericValue)

Beginnt mit dieser Zahl.

toValue

object (NumericValue)

Endet mit dieser Zahl.

MetricAggregation

Stellt die Aggregation von Messwerten dar.

Enums
METRIC_AGGREGATION_UNSPECIFIED Nicht angegebener Operator.
TOTAL SUM-Operator
MINIMUM Mindestoperator.
MAXIMUM Maximaloperator.
COUNT Zähloperator

OrderBy

Mithilfe von „Order by“ wird festgelegt, wie Zeilen in der Antwort sortiert werden. Zeilen können beispielsweise nach absteigender Ereignisanzahl oder nach dem Ereignisnamen sortiert werden.

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

Wenn „wahr“ ist, wird in absteigender Reihenfolge sortiert.

Union-Feld one_order_by. Geben Sie für OrderBy einen Sortiertyp an. Für one_order_by ist nur einer der folgenden Werte zulässig:
metric

object (MetricOrderBy)

Die Ergebnisse werden nach den Werten eines Messwerts sortiert.

dimension

object (DimensionOrderBy)

Die Ergebnisse werden nach den Werten einer Dimension sortiert.

MetricOrderBy

Sortiert nach Messwert.

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

string

Der Name eines Messwerts 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 der sortiert werden soll.

orderType

enum (OrderType)

Hier legen Sie die Regel für die Sortierung von Dimensionswerten fest.

OrderType

Regel, nach der die Werte der Stringdimension sortiert werden sollen.

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ß- und Kleinschreibung nach dem Unicode-Codepunkt für Kleinbuchstaben. Beispiel: „2“ < „A“ < „b“ < „X“ < „z“.
NUMERIC Dimensionswerte werden vor dem Sortieren in Zahlen umgewandelt. Beispiel: NUMERIC-Sortierung: „25“ < „100“ und in ALPHANUMERIC die Sortierung „100“ < „25“. Nicht numerische Dimensionswerte haben alle denselben Sortierwert unter allen numerischen Werten.

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 der Nutzer auswählen, die in der ersten Septemberwoche gewonnen wurden, und diese Kohorte dann in den nächsten sechs Wochen beobachten. Die Auswahl der Nutzer, die in der ersten Septemberwoche gewonnen wurden, wird im cohort-Objekt angegeben. Die nachfolgende Kohorte für die nächsten sechs Wochen wird im cohortsRange-Objekt angegeben.

Beispiele finden Sie unter Beispiele für Kohortenberichte.

Die Berichtsantwort kann eine wöchentliche Zeitreihe enthalten, in der beispielsweise dargestellt wird, dass Ihre App nach drei Wochen 60% und nach sechs Wochen 25% dieser Kohorte beibehalten hat. Diese beiden Prozentsätze können mit dem Messwert cohortActiveUsers/cohortTotalUsers berechnet werden und werden im Bericht in separaten Zeilen aufgeführt.

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

object (Cohort)

Definiert die Auswahlkriterien für die Gruppierung von Nutzern in Kohorten.

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

cohortsRange

object (CohortsRange)

In Kohortenberichten werden Kohorten über einen erweiterten Berichtszeitraum beobachtet. In diesem Bereich wird ein Zeitversatz angegeben, über den die Kohorten beobachtet werden sollen.

cohortReportSettings

object (CohortReportSettings)

Optionale Einstellungen für einen Kohortenbericht.

Kohorte

Hier werden die Kriterien für die Kohortenauswahl definiert. 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 Berichtsantwort auf diesen Namen geschätzt. Wenn festgelegt, darf der Wert nicht mit cohort_ oder RESERVED_ beginnen. Wenn diese Option nicht festgelegt ist, werden Kohorten nach ihrem Index (cohort_0, cohort_1 usw.) benannt, der bei null beginnt.

dimension

string

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

dateRange

object (DateRange)

Für die Kohorte werden Nutzer ausgewählt, deren Datum der ersten Interaktion zwischen dem Start- und Enddatum liegt, das in der dateRange definiert ist. Diese dateRange gibt nicht den vollständigen Zeitraum der Ereignisdaten an, die in einem Kohortenbericht enthalten sind. In einem Kohortenbericht wird dieser dateRange um die Detaillierung und den Offset in der cohortsRange erweitert. Ereignisdaten für den erweiterten Berichtszeitraum sind in einem Kohortenbericht enthalten.

In einer Kohortenanfrage ist diese dateRange erforderlich und die dateRanges in der RunReportRequest oder RunPivotReportRequest darf nicht angegeben sein.

Diese dateRange sollte im Allgemeinen mit der Granularität der Kohorte übereinstimmen. Wenn für CohortsRange die tägliche Detaillierungsebene verwendet wird, kann dieser dateRange ein einzelner Tag sein. Wenn für CohortsRange die wöchentliche Granularität verwendet wird, kann dieser dateRange an einer Wochengrenze ausgerichtet werden, die am Sonntag beginnt und am Samstag endet. Wenn für CohortsRange die monatliche Detailebene verwendet wird, kann diese dateRange auf einen Monat ausgerichtet werden, der am ersten und am letzten Tag des Monats endet.

CohortsRange

Hiermit wird der erweiterte Berichtszeitraum für einen Kohortenbericht konfiguriert. Gibt eine Verzögerung an, über die die Kohorten beobachtet werden sollen.

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

enum (Granularity)

Erforderlich. Die Detaillierung, mit der startOffset und endOffset für den erweiterten Berichtszeitraum in einem Kohortenbericht interpretiert werden.

startOffset

integer

startOffset gibt das Startdatum des erweiterten Berichtszeitraums für einen Kohortenbericht an. startOffset ist normalerweise auf 0 gesetzt, sodass Berichte Daten ab der Akquisition der Kohorte enthalten.

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

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

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

endOffset

integer

Erforderlich. endOffset gibt das Enddatum des erweiterten Berichtszeitraums für einen Kohortenbericht an. 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 höherer Detaillierung enthalten.

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

Wenn granularity den Wert WEEKLY hat, beträgt der endDate des erweiterten Berichtszeitraums endDate der Kohorte plus endOffset * 7 Tage.

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

Detaillierungsgrad

Der Detaillierungsgrad, der zur Interpretation von startOffset und endOffset für den erweiterten Berichtszeitraum für einen Kohortenbericht verwendet wird.

Enums
GRANULARITY_UNSPECIFIED Sollte niemals angegeben werden.
DAILY Tägliche Granularität. Wird häufig verwendet, wenn die dateRange der Kohorte ein einzelner Tag ist und die Anfrage cohortNthDay enthält.
WEEKLY Wöchentliche Detaillierung. Wird häufig verwendet, wenn die dateRange der Kohorte eine Woche beträgt (beginnt am Sonntag und endet am Samstag) und die Anfrage cohortNthWeek enthält.
MONTHLY Monatliche Detaillierung. Wird häufig verwendet, wenn die dateRange der Kohorte einen Monat lang ist und die Anfrage cohortNthMonth enthält.

CohortReportSettings

Optionale Einstellungen für einen Kohortenbericht.

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

boolean

Wenn „wahr“ festgelegt ist, wird das Ergebnis vom Tag der ersten Interaktion bis zum Enddatum erfasst. Nicht unterstützt in RunReportRequest.

SamplingLevel

Kategorien von Stichprobenebenen für die Anfragen.

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

ReportMetadata

Die 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 gesamten Kontingenttokens, die bei der Erstellung des Berichts in Rechnung gestellt wurden. Da diese Tokenanzahl auf Aktivitäten im Status CREATING basiert, wird diese Tokenbelastung festgelegt, sobald eine Berichtsaufgabe den Status ACTIVE oder FAILED erreicht.

state

enum (State)

Nur Ausgabe. Der aktuelle Status dieser Berichtsaufgabe.

beginCreatingTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der reportTasks.create aufgerufen wurde und der Bericht den Status CREATING einnahm.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

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. Eine Fehlermeldung wird angezeigt, wenn eine Berichtsaufgabe beim Erstellen fehlschlägt.

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 diese eine neue Berichtsaufgabe auf der Grundlage von totalRowCount initiieren.

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 aus dem Google Analytics-Speicher umfasst.

Angenommen, taskRowCount des aktuellen Berichts ist 20. In diesem Fall werden die Daten aus den ersten 20 Zeilen angezeigt. Gleichzeitig ist totalRowCount = 30, was bedeutet, dass für alle 30 Zeilen Daten vorhanden sind. taskRowCount kann verwendet werden, um durch die ersten 20 Zeilen zu paginieren. Wenn Sie den Bericht erweitern und Daten aus allen 30 Zeilen einbeziehen möchten, können Sie mithilfe der Gesamtzeilenzahl eine neue Berichtsaufgabe erstellen, um auf alle 30 Zeilen zuzugreifen.

Status

Der Verarbeitungsstatus.

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

Methoden

create

Damit wird die Erstellung einer Berichtsaufgabe gestartet.

get

Ruft Metadaten zu einem Bericht zu einer bestimmten Berichtsaufgabe ab.

list

Hier werden alle Berichtsaufgaben für eine Property aufgelistet.

query

Ruft den Inhalt einer Berichtsaufgabe ab.