REST Resource: properties.reportTasks

Ressource: ReportTask

Eine bestimmte Konfiguration der Berichtsaufgabe.

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

string

Nur Ausgabe. Kennung. Der Ressourcenname der Berichtaufgabe, 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. Er enthält normalerweise die Felder, die im Bericht enthalten sein werden, und die Kriterien zum Filtern der Daten.

reportMetadata

object (ReportMetadata)

Nur Ausgabe. Die Metadaten für eine bestimmte Berichtsaufgabe, die Informationen zu einem Bericht liefern. Er enthält normalerweise die folgenden Informationen: den Ressourcennamen des Berichts, den Status des Berichts, den Zeitstempel der Erstellung des Berichts 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
}
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, werden die Ereignisdaten für die sich überschneidenden Tage in den Antwortzeilen für beide Zeiträume angezeigt. In einer Kohortenanfrage darf diese dateRanges nicht angegeben werden.

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

Optional. Die Filterklausel von Messwerten. Wird nach dem Aggregieren der Zeilen des Berichts angewendet, ähnlich wie bei der SQL-Anweisung „Lesen“. In diesem Filter können keine Dimensionen 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. Beispiel: Wenn der Google Analytics-Speicher insgesamt 300.000 Zeilen umfasst, kann die erste Berichtsaufgabe die ersten 10.000 Zeilen umfassen. Der Grenzwert liegt bei 10.000 und der Offset ist 0. Anschließend könnte eine andere Berichtaufgabe 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 Zeilen angefordert werden. limit muss positiv sein.

Die API kann auch weniger Zeilen als die angeforderte limit zurückgeben, wenn nicht so viele Dimensionswerte wie der limit vorhanden sind. Für die Dimension country sind beispielsweise weniger als 300 Werte möglich. Wenn Sie also nur Daten für country erstellen, können Sie nicht mehr als 300 Zeilen abrufen, selbst wenn Sie für limit einen höheren Wert festlegen.

metricAggregations[]

enum (MetricAggregation)

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

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. Mit dieser Anfrage verknüpfte Kohortengruppe. Gibt es eine Kohortengruppe in der Anfrage, wird die „Kohorte“ Dimension vorhanden sein muss.

keepEmptyRows

boolean

Optional. Wenn „false“ oder nicht angegeben, wird keine Zeile zurückgegeben, die alle Messwerte gleich 0 enthält. Bei „true“ werden diese Zeilen zurückgegeben, wenn sie nicht separat durch einen Filter entfernt werden.

Unabhängig von dieser keepEmptyRows-Einstellung können nur Daten in einem Bericht angezeigt werden, die von der Google Analytics-Property (GA4) 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 dem Ereignisnamen „purchase“. und eventCount: 0.

Dimension

Dimensionen sind Attribute Ihrer Daten. Die Dimension „Stadt“ gibt beispielsweise die Stadt an, von der ein Ereignis ausgeht. Dimensionswerte in Berichtsantworten sind Strings. z. B. „Paris“. oder "New York".

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

string

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

Wenn dimensionExpression angegeben ist, kann name ein 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 mit 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)

Wird verwendet, um einen Dimensionswert in Kleinbuchstaben umzuwandeln.

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 Einzelfall umzuwandeln.

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

string

Name einer Dimension. Der Name muss sich auf einen Namen im Dimensionsfeld 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 auf Namen im Dimensionsfeld der Anfrage verweisen.

delimiter

string

Das Trennzeichen zwischen Dimensionsnamen.

Trennzeichen bestehen oft aus einzelnen Zeichen wie „|“ oder "," können aber auch längere Zeichenfolgen sein. Wenn ein Dimensionswert das Trennzeichen enthält, sind beide unverändert in der Antwort vorhanden. Beispiel: Wert für Dimension 1 = „US,FR“, Wert für Dimension 2 = „JP“ und Trennzeichen = „,“, dann enthält die Antwort „US,FR,JP“.

Messwert

Die quantitativen Messungen eines Berichts. Der Messwert eventCount gibt beispielsweise die Gesamtzahl der Ereignisse an. Für Anfragen sind bis zu zehn Messwerte zulässig.

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

string

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

Wenn expression angegeben ist, kann name ein 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.

Messwerte werden von name in metricFilter, orderBys und Messwert expression referenziert.

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 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. Anfragen können aus bis zu vier Zeiträumen bestehen.

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

string

Das Startdatum der 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 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 aus der Zeitzone für Berichte der Property abgeleitet.

name

string

Weist diesem Zeitraum einen Namen zu. Die Dimension „dateRange“ wird in einer Berichtsantwort auf diesen Namen gewertet. Wenn festgelegt, darf nicht mit date_range_ oder RESERVED_ beginnen. Wenn nicht festgelegt, werden Zeiträume nach ihrem nullbasierten Index in der Anfrage 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 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 OR-Beziehung.

notExpression

object (FilterExpression)

FilterExpression entspricht NICHT notExpression.

filter

object (Filter)

Ein primitiver Filter. In derselben FilterExpression 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 in Dimensionen oder Messwerten definierter Name sein.

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)

Stringbezogener Filter.

inListFilter

object (InListFilter)

Ein Filter für In-Listen-Werte.

numericFilter

object (NumericFilter)

Ein Filter für numerische Werte oder Datumswerte.

betweenFilter

object (BetweenFilter)

Ein Filter für zwei Werte.

StringFilter

Der Filter für den String

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

enum (MatchType)

Der Übereinstimmungstyp für diesen Filter.

value

string

Der für den Abgleich verwendete Stringwert.

caseSensitive

boolean

Falls wahr, wird beim Stringwert zwischen Groß- und Kleinschreibung unterschieden.

MatchType

Der Übereinstimmungstyp eines Stringfilters

Enums
MATCH_TYPE_UNSPECIFIED Ohne Angabe
EXACT Genaue Übereinstimmung mit dem Stringwert.
BEGINS_WITH Beginnt mit dem Stringwert.
ENDS_WITH Endet mit dem Stringwert.
CONTAINS Enthält den Stringwert.
FULL_REGEXP Vollständige Übereinstimmung für den regulären Ausdruck mit dem Stringwert.
PARTIAL_REGEXP Teilweise Übereinstimmung für den regulären Ausdruck 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. Das Feld darf nicht leer sein.

caseSensitive

boolean

Falls wahr, 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)

Ein numerischer Wert oder ein Datumswert.

Vorgang

Der auf einen numerischen Filter angewendete Vorgang

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

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

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

object (NumericValue)

Beginnt mit dieser Zahl.

toValue

object (NumericValue)

Endet mit dieser Nummer.

MetricAggregation

Stellt die Aggregation von Messwerten dar.

Enums
METRIC_AGGREGATION_UNSPECIFIED Der Operator ist nicht angegeben.
TOTAL SUMME-Operator.
MINIMUM Minimum-Operator.
MAXIMUM Maximum-Operator.
COUNT Operator "Count".

OrderBy

Mit „Order by“ (Sortieren nach) wird definiert, wie Zeilen in der Antwort sortiert werden. Beispielsweise hat das Sortieren von Zeilen nach der absteigenden Ereignisanzahl nur eine Sortierung und das Sortieren der Zeilen nach dem Ereignisnamen-String hat eine andere Reihenfolge.

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 Einstellung auf "true" wird in absteigender Reihenfolge sortiert.

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

object (MetricOrderBy)

Sortiert die Ergebnisse nach den Werten eines Messwerts.

dimension

object (DimensionOrderBy)

Sortiert die Ergebnisse nach den Werten einer Dimension.

MetricOrderBy

Sortiert nach Messwerten.

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

string

Ein Messwertname in der Sortieranfrage.

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)

Steuert die Regel für die Sortierung der Dimensionswerte.

OrderType

Regel, nach der die Stringdimensionswerte sortiert werden.

Enums
ORDER_TYPE_UNSPECIFIED Nicht angegeben
ALPHANUMERIC Alphanumerische Sortierung nach Unicode-Codepunkt. Beispiel: „2“ < „A“ < „X“ < „b“ < „z“.
CASE_INSENSITIVE_ALPHANUMERIC alphanumerische Sortierung in Unicode-Kleinschreibung in Kleinbuchstaben wird nicht berücksichtigt. Beispiel: „2“ < „A“ < „b“ < „X“ < „z“.
NUMERIC Dimensionswerte werden vor dem Sortieren in Zahlen umgewandelt. Beispiel: NUMERIC Sortierung: „25“ < „100“ und bei Sortierung nach ALPHANUMERIC „100“ < „25“. Nicht numerische Dimensionswerte haben unter allen numerischen Werten denselben Sortierungswert.

CohortSpec

Die Spezifikation von Kohorten für einen Kohortenbericht.

Kohortenberichte erstellen eine Zeitreihe zur Nutzerbindung für die Kohorte. Sie können beispielsweise die Kohorte der Nutzer auswählen, die in der ersten Septemberwoche akquiriert wurden, und dieser Kohorte in den nächsten sechs Wochen folgen. Die Auswahl der Nutzer, die in der ersten Septemberwoche akquiriert wurden, wird im cohort-Objekt festgelegt. Die nachfolgende Kohorte für die nächsten sechs Wochen wird im cohortsRange-Objekt angegeben.

Beispiele finden Sie unter Beispiele für Kohortenberichte.

Die Antwort im Bericht könnte eine wöchentliche Zeitreihe enthalten, bei der beispielsweise 60% der Kohorte nach drei Wochen und 25% nach sechs Wochen festgehalten sind. Diese beiden Prozentsätze können mit dem Messwert cohortActiveUsers/cohortTotalUsers berechnet werden und sind im Bericht separate Zeilen.

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.

Die meisten Kohortenberichte definieren nur eine einzelne Kohorte. Wenn mehrere Kohorten angegeben sind, kann jede Kohorte im Bericht anhand ihres Namens erkannt werden.

cohortsRange

object (CohortsRange)

Kohortenberichte beziehen sich auf Kohorten über einen längeren Berichtszeitraum. Dieser Bereich gibt einen Versatzzeitraum für die Kohorten an.

cohortReportSettings

object (CohortReportSettings)

Optionale Einstellungen für einen Kohortenbericht.

Kohorte

Definiert ein Auswahlkriterium für die Kohorte. Eine Kohorte ist eine Gruppe von Nutzern mit einem gemeinsamen Merkmal. Beispielsweise gehören Nutzer mit derselben 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 gewertet. Wenn festgelegt, darf nicht mit cohort_ oder RESERVED_ beginnen. Wenn nicht festgelegt, werden Kohorten nach ihrem nullbasierten Index cohort_0, cohort_1 usw. benannt.

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 in der dateRange definierten Start- und dem Enddatum liegt. Mit dateRange wird nicht der gesamte Zeitraum der Ereignisdaten in einem Kohortenbericht angegeben. In einem Kohortenbericht wird dieser dateRange um den Detaillierungsgrad und den Offset in der cohortsRange erweitert. Kohortenbericht enthält Ereignisdaten für den erweiterten Berichtzeitraum.

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

Dieser Wert (dateRange) sollte sich im Allgemeinen auf den Detaillierungsgrad der Kohorte beziehen. Wenn CohortsRange den Detaillierungsgrad auf Tagesbasis verwendet, kann diese dateRange ein einzelner Tag sein. Wenn CohortsRange einen wöchentlichen Detaillierungsgrad verwendet, kann dieser dateRange auf eine Wochengrenze ausgerichtet werden, die am Sonntag beginnt und am Samstag endet. Wenn CohortsRange einen monatlichen Detaillierungsgrad verwendet, kann diese dateRange auf einen Monat ausgerichtet werden, beginnend am ersten Tag und endet am letzten Tag des Monats.

CohortsRange

Mit dieser Richtlinie wird der erweiterte Berichtszeitraum für einen Kohortenbericht konfiguriert. Gibt die Abweichungsdauer für die Kohorten an.

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

enum (Granularity)

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

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 den Wert DAILY hat, beträgt der startDate des erweiterten Berichtszeitraums startDate der Kohorte plus startOffset Tage.

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

Wenn granularity den Wert MONTHLY hat, beträgt der startDate des erweiterten Berichtszeitraums 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 normalerweise auf 5 bis 10 festgelegt, sodass Berichte Daten zur Kohorte für die nächsten Detaillierungszeiträume enthalten.

Wenn granularity den Wert DAILY hat, beträgt der endDate des erweiterten Berichtszeitraums 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 den Wert MONTHLY hat, beträgt der endDate des erweiterten Berichtszeitraums 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 nie angegeben werden.
DAILY Täglicher Detaillierungsgrad. Wird häufig verwendet, wenn die dateRange der Kohorte ein einzelner Tag ist und die Anfrage cohortNthDay enthält.
WEEKLY Wöchentlicher Detaillierungsgrad. 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 Monatlicher Detaillierungsgrad. Wird häufig verwendet, wenn die dateRange der Kohorte einen Monat umfasst und die Anfrage cohortNthMonth enthält.

CohortReportSettings

Optionale Einstellungen eines Kohortenberichts.

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

boolean

Falls wahr, wird das Ergebnis vom ersten Berührungstag bis zum Endtag erfasst. Wird in RunReportRequest nicht unterstützt.

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 der Aktivität mit dem Status CREATING basiert, wird diese Tokengebühr 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 und der Bericht den Status CREATING ausgelöst hat.

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 der Grenzen des vorhandenen Berichts verwenden.

errorMessage

string

Nur Ausgabe. Es wird eine Fehlermeldung angezeigt, 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 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 aus dem Google Analytics-Speicher abgerufenen Daten umfasst.

Angenommen, der taskRowCount-Wert des aktuellen Berichts beträgt 20 und es werden die Daten aus den ersten 20 Zeilen angezeigt. Gleichzeitig beträgt der 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. Um den Bericht zu erweitern und Daten aus allen 30 Zeilen einzuschließen, kann mit totalRowCount eine neue Berichtsaufgabe erstellt werden, um auf den gesamten Satz von 30 Zeilen zuzugreifen. an Daten zu liefern.

Status

Der Verarbeitungsstatus.

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

Methoden

create

Initiiert das Erstellen einer Berichtsaufgabe.

get

Ruft Metadaten zu einer bestimmten Berichtsaufgabe ab.

list

Listet alle Berichtsaufgaben für eine Property auf.

query

Ruft den Inhalt einer Berichtsaufgabe ab.