REST Resource: properties.reportTasks

{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}

string

Nur Ausgabe. Kennung. Der Ressourcenname der Berichtsaufgabe, der bei der Erstellung zugewiesen wurde. Format: „properties/{property}/reportTasks/{reportTask}“

object (ReportDefinition)

Optional. Eine Berichtsdefinition zum Abrufen von Berichtsdaten, die die Struktur eines Berichts beschreiben. Sie enthält normalerweise die Felder, die in den Bericht aufgenommen werden, und die Kriterien zum Filtern der Daten.

object (ReportMetadata)

Nur Ausgabe. Die Berichtsmetadaten 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 der Berichterstellung usw.

{
  "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
}

object (Dimension)

Optional. Die angeforderten und angezeigten Abmessungen.

object (Metric)

Optional. Die angeforderten und angezeigten Messwerte.

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 aufgeführt. In einer Kohortenanfrage darf dateRanges nicht angegeben werden.

object (FilterExpression)

Optional. Mit Dimensionsfiltern können Sie im Bericht nur nach bestimmten Dimensionswerten fragen. Weitere Beispiele finden Sie unter Grundlagen von Dimensionsfiltern. Messwerte können in diesem Filter nicht verwendet werden.

object (FilterExpression)

Optional. Die Filterklausel für Messwerte. Wird nach dem Zusammenfassen der Berichtszeilen angewendet, ähnlich wie bei SQL mit Klausel. In diesem Filter können keine Dimensionen verwendet werden.

string (int64 format)

Optional. Die Zeilenanzahl der Startzeile aus Google Analytics-Speicher. Die erste Zeile wird als Zeile 0 gezählt.

Beim Erstellen einer Berichtsaufgabe definieren Sie mit den Parametern offset und limit die Teilmenge der Datenzeilen aus dem Google Analytics-Speicher, die in den generierten Bericht aufgenommen werden sollen. Wenn beispielsweise der Google Analytics-Speicher insgesamt 300.000 Zeilen umfasst, enthält die ursprüngliche Berichtsaufgabe möglicherweise die ersten 10.000 Zeilen mit einem Limit von 10.000 und einem Offset von 0. Danach könnte eine andere Berichtsaufgabe die nächsten 10.000 Zeilen mit einem Limit von 10.000 und einem Offset von 10.000 abdecken.

string (int64 format)

Optional. Die Anzahl der Zeilen, die im Bericht zurückgegeben werden sollen. Wenn kein Wert angegeben ist, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 250.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Zeilen Sie anfordern. limit muss positiv sein.

Die API kann auch weniger Zeilen als vom angeforderten limit zurückgeben, wenn nicht so viele Dimensionswerte wie limit vorhanden sind. Wenn beispielsweise für die Dimension „country“ weniger als 300 Werte möglich sind, können Sie bei Berichten nur für country maximal 300 Zeilen erhalten, selbst wenn Sie für limit einen höheren Wert festlegen.

enum (MetricAggregation)

Optional. Zusammenfassung von Messwerten Zusammengefasste Messwerte werden in Zeilen angezeigt, in denen „dimensionValues“ auf „RESERVED_(MesswertAggregation)“ festgelegt ist.

object (OrderBy)

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

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.

object (CohortSpec)

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

boolean

Optional. Wenn „false“ oder nicht angegeben, wird nicht jede Zeile zurückgegeben, bei der alle Messwerte gleich 0 sind. 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 für die Dimension eventName und den Messwert eventCount keine Zeile mit „eventName: „purchase““ und „eventCount: 0“.

{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}

string

Der Name der Dimension. Unter API-Dimensionen finden Sie eine Liste der Dimensionsnamen, die von wichtigen Berichtsmethoden wie runReport und batchRunReports unterstützt werden. Eine Liste der von der runRealtimeReport-Methode 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 dimensionExpression country und city verkettet, könnten Sie diese Dimension countryAndCity nennen. Die von Ihnen ausgewählten Dimensionsnamen müssen dem regulären Ausdruck ^[a-zA-Z0-9_]$ entsprechen.

In dimensionFilter, orderBys, dimensionExpression und pivots wird von name auf die Dimensionen verwiesen.

object (DimensionExpression)

Eine Dimension kann das Ergebnis eines Ausdrucks mehrerer Dimensionen sein. Beispiel: Die Dimension „Land, Stadt“: verketten(Land, ", ", Stadt).

{

  // 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.
}

object (CaseExpression)

Damit wird ein Dimensionswert in Kleinbuchstaben umgewandelt.

object (CaseExpression)

Damit wird ein Dimensionswert in Großbuchstaben umgewandelt.

object (ConcatenateExpression)

Damit werden Dimensionswerte zu einer einzelnen Dimension kombiniert. Beispiel: Die Dimension „Land, Stadt“: verketten(Land, ", ", Stadt).

{
  "dimensionName": string
}

string

Name einer Dimension. Der Name muss sich auf einen Namen im Dimensionsfeld der Anfrage beziehen.

{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}

string

Namen von Dimensionen. Die Namen müssen sich auf die Namen im Dimensionsfeld der Anfrage beziehen.

string

Das Trennzeichen zwischen den Dimensionsnamen.

Trennzeichen sind häufig einzelne Zeichen wie „|“ oder „“, können aber auch längere Strings sein. Wenn ein Dimensionswert das Trennzeichen enthält, werden beide als Antwort ohne Unterscheidung angezeigt. Beispiel: Wenn der Wert der Dimension 1 „US,FR“, der Wert der Dimension 2 „JP“ und das Trennzeichen „,“ ist, enthält die Antwort „US,FR,JP“.

{
  "name": string,
  "expression": string,
  "invisible": boolean
}

string

Der Name des Messwerts. Unter API-Messwerte finden Sie eine Liste der Messwertnamen, die von wichtigen Berichtsmethoden wie runReport und batchRunReports unterstützt werden. Eine Liste der von der runRealtimeReport-Methode 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önnen Sie den Namen dieses Messwerts als viewsPerSession bezeichnen. Die von Ihnen ausgewählten Messwertnamen müssen dem regulären Ausdruck ^[a-zA-Z0-9_]$ entsprechen.

Auf Messwerte wird von name in metricFilter, orderBys und im Messwert expression verwiesen.

string

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

boolean

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

{
  "startDate": string,
  "endDate": string,
  "name": string
}

string

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

string

Das einschließende Enddatum 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 aus der Zeitzone für Berichte der Property abgeleitet.

string

Weist diesem Zeitraum einen Namen zu. Die Dimension „dateRange“ wird in einer Berichtsantwort mit diesem Namen bewertet. Wenn festgelegt, darf sie 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.

{

  // 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.
}

object (FilterExpressionList)

Die FilterExpressions in andGroup haben eine AND-Beziehung.

object (FilterExpressionList)

Die FilterExpressions in orGroup haben eine OR-Beziehung.

object (FilterExpression)

FilterExpression ist NICHT auf notExpression.

object (Filter)

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

{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}

object (FilterExpression)

Eine Liste mit Filterausdrücken.

{
  "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.
}

string

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

object (StringFilter)

Filter zum Thema Strings.

object (InListFilter)

Ein Filter für in Listenwerten.

object (NumericFilter)

Ein Filter für numerische Werte oder Datumswerte.

object (BetweenFilter)

Ein Filter für zwischen zwei Werten.

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

Die Keyword-Option für diesen Filter.

string

Der für den Abgleich verwendete Stringwert.

boolean

Bei „true“ wird die Groß- und Kleinschreibung beim Stringwert beachtet.

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

Die Liste der Stringwerte. Darf nicht leer sein.

boolean

Bei „true“ wird die Groß- und Kleinschreibung beim Stringwert beachtet.

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

Der Vorgangstyp für diesen Filter.

object (NumericValue)

Ein numerischer Wert oder ein Datumswert.

{

  // 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.
}

string (int64 format)

Ganzzahlwert

number

Doppelter Wert

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

Beginnt mit dieser Zahl

object (NumericValue)

Endet mit dieser Nummer.

{
  "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.
}

boolean

Bei „true“ wird in absteigender Reihenfolge sortiert.

object (MetricOrderBy)

Sortiert die Ergebnisse nach den Werten eines Messwerts.

object (DimensionOrderBy)

Sortiert die Ergebnisse nach den Werten einer Dimension.

{
  "metricName": string
}

string

Ein Messwertname in der Sortieranfrage.

{
  "dimensionName": string,
  "orderType": enum (OrderType)
}

string

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

enum (OrderType)

Steuert die Regel für die Sortierung der Dimensionswerte.

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

object (Cohort)

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

In den meisten Kohortenberichten wird nur eine Kohorte definiert. Wenn mehrere Kohorten angegeben sind, kann jede im Bericht anhand ihres Namens erkannt werden.

object (CohortsRange)

Kohortenberichte folgen Kohorten über einen längeren Berichtszeitraum. Dieser Bereich gibt einen Versatzzeitraum an, der auf die Kohorten angewendet wird.

object (CohortReportSettings)

Optionale Einstellungen für einen Kohortenbericht.

{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}

string

Weist dieser Kohorte einen Namen zu. Die Dimension „cohort“ wird in einer Berichtsantwort mit diesem Namen bewertet. Wenn festgelegt, darf sie nicht mit cohort_ oder RESERVED_ beginnen. Wenn nicht festgelegt, werden Kohorten nach ihrem nullbasierten Index cohort_0, cohort_1 usw. benannt.

string

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

object (DateRange)

Für die Kohorte werden Nutzer ausgewählt, deren Datum des ersten Kontakts zwischen dem in der dateRange festgelegten Start- und dem Enddatum liegt. Dieses dateRange gibt nicht den gesamten Zeitraum der Ereignisdaten an, die in einem Kohortenbericht enthalten sind. In einem Kohortenbericht wird diese dateRange durch den Detaillierungsgrad und den Versatz der cohortsRange erweitert. Ereignisdaten für den erweiterten Berichtszeitraum sind in einem Kohortenbericht enthalten.

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

Der Messwert „dateRange“ sollte im Allgemeinen am Detaillierungsgrad der Kohorte angepasst werden. Wenn CohortsRange die tägliche Granularität verwendet, kann die dateRange ein einzelner Tag sein. Wenn CohortsRange den wöchentlichen Detaillierungsgrad verwendet, kann diese dateRange an eine Wochengrenze ausgerichtet werden, von Sonntag bis Samstag. Wenn für CohortsRange der Detaillierungsgrad auf Monatsbasis verwendet wird, kann die dateRange auf einen Monat ausgerichtet werden, beginnend am ersten Tag bis zum letzten Tag des Monats.

{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}

enum (Granularity)

Erforderlich. Der Detaillierungsgrad, mit dem startOffset und endOffset für den erweiterten Berichtszeitraum für einen Kohortenbericht interpretiert werden.

integer

startOffset gibt das Startdatum des erweiterten Berichtszeitraums für einen Kohortenbericht an. startOffset ist häufig auf 0 gesetzt, damit Berichte Daten ab der Erfassung der Kohorte enthalten.

Wenn granularity den Wert DAILY hat, entspricht der startDate des erweiterten Berichtszeitraums startDate der Kohorte plus startOffset Tage.

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

Wenn granularity den Wert MONTHLY hat, entspricht der startDate des erweiterten Berichtszeitraums startDate der Kohorte plus startOffset * 30 Tage.

integer

Erforderlich. endOffset gibt das Enddatum des erweiterten Berichtszeitraums für einen Kohortenbericht an. endOffset kann eine beliebige positive Ganzzahl sein, ist aber im Allgemeinen auf einen Wert zwischen 5 und 10 festgelegt, sodass die Berichte Daten zur Kohorte für die jeweils nächsten Zeiträume enthalten.

Wenn granularity den Wert DAILY hat, entspricht der endDate des erweiterten Berichtszeitraums endDate der Kohorte plus endOffset Tage.

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

Wenn granularity den Wert MONTHLY hat, entspricht der endDate des erweiterten Berichtszeitraums endDate der Kohorte plus endOffset * 30 Tage.

{
  "accumulate": boolean
}

boolean

Bei „true“ wird das Ergebnis vom ersten Berührungstag bis zum letzten Tag erfasst. In RunReportRequest nicht unterstützt.

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

integer

Nur Ausgabe. Die Gesamtzahl der Kontingenttokens, die während der Erstellung des Berichts berechnet werden. Da die Tokenanzahl auf Aktivität aus dem Status CREATING basiert, wird diese Tokengebühr festgesetzt, sobald eine Berichtsaufgabe den Status ACTIVE oder FAILED erhält.

enum (State)

Nur Ausgabe. Der aktuelle Status für diese Berichtsaufgabe.

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem reportTasks.create aufgerufen und der Bericht mit dem Status CREATING begonnen 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".

integer

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

string

Nur Ausgabe. Eine Fehlermeldung wird eingefügt, wenn bei der Erstellung einer Berichtsaufgabe ein Fehler auftritt.

integer

Nur Ausgabe. Die Gesamtzahl der Zeilen im Google Analytics-Speicher. Wenn Sie zusätzliche Datenzeilen jenseits des aktuellen Berichts abfragen möchten, kann eine neue Berichtsaufgabe basierend auf totalRowCount gestartet werden.

Die 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 taskRowCount des aktuellen Berichts beträgt 20 und enthält die Daten aus den ersten 20 Zeilen. Gleichzeitig beträgt totalRowCount 30, was auf das Vorhandensein von Daten für alle 30 Zeilen hinweist. Mit taskRowCount kann durch die ersten 20 Zeilen paginiert werden. Um den Bericht zu erweitern und Daten aus allen 30 Zeilen einzubeziehen, kann mit totalRowCount eine neue Berichtsaufgabe erstellt werden, um auf alle Daten aus 30 Zeilen zuzugreifen.