- Ressource: ReportTask
- ReportDefinition
- Dimension
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Messwert
- DateRange
- FilterExpression
- FilterExpressionList
- Filter
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Vorgang
- NumericValue
- BetweenFilter
- EmptyFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Kohorte
- CohortsRange
- Detaillierungsgrad
- CohortReportSettings
- SamplingLevel
- ReportMetadata
- Status
- Methoden
Ressource: ReportTask
Eine bestimmte Berichtskonfiguration.
| JSON-Darstellung |
|---|
{ "name": string, "reportDefinition": { object ( |
| Felder | |
|---|---|
name |
Nur Ausgabe. ID. Der Name der Berichtsaufgabenressource, die bei der Erstellung zugewiesen wurde. Format: „properties/{property}/reportTasks/{reportTask}“ |
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 |
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 ( |
| Felder | |
|---|---|
dimensions[] |
Optional. Die angeforderten und angezeigten Dimensionen. |
metrics[] |
Optional. Die angeforderten und angezeigten Messwerte. |
dateRanges[] |
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 |
dimensionFilter |
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 |
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 |
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 |
limit |
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. Die API kann auch weniger Zeilen als die angeforderten |
metricAggregations[] |
Optional. Aggregation von Messwerten. Aggregierte Messwerte werden in Zeilen angezeigt, in denen „dimensionValues“ auf „RESERVED_(MetricAggregation)“ festgelegt ist. |
orderBys[] |
Optional. Gibt an, wie Zeilen in der Antwort sortiert werden. |
currencyCode |
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 |
Optional. Die Kohortengruppe, die dieser Anfrage zugeordnet ist. Wenn in der Anfrage eine Kohortengruppe vorhanden ist, muss die Dimension „Kohorte“ vorhanden sein. |
keepEmptyRows |
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 Wenn für eine Property beispielsweise nie ein |
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 ( |
| Felder | |
|---|---|
name |
Der Name der Dimension. Eine Liste der von den wichtigsten Berichtsmethoden wie Wenn Auf Dimensionen wird in |
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 |
| 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 |
Wird verwendet, um einen Dimensionswert in Kleinbuchstaben zu konvertieren. |
upperCase |
Wird verwendet, um einen Dimensionswert in Großbuchstaben umzuwandeln. |
concatenate |
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 |
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[] |
Namen der Dimensionen. Die Namen müssen sich auf Namen im Feld „dimensions“ der Anfrage beziehen. |
delimiter |
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 |
Der Name des Messwerts. Eine Liste der Messwertnamen, die von Core Reporting-Methoden wie Wenn Auf Messwerte wird in |
expression |
Ein mathematischer Ausdruck für abgeleitete Messwerte. Der Messwert „Ereignisanzahl pro Nutzer“ ist beispielsweise |
invisible |
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 |
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 |
Das Startdatum (angegebener Tag ist eingeschlossen) für die Abfrage im Format |
endDate |
Das Enddatum (letzter Tag eingeschlossen) für die Abfrage im Format |
name |
Weist diesem Zeitraum einen Namen zu. Die Dimension |
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 |
| Felder | |
|---|---|
Union-Feld expr. Geben Sie einen Filterausdruckstyp für FilterExpression an. Für expr ist nur einer der folgenden Werte zulässig: |
|
andGroup |
Die FilterExpressions in andGroup haben eine AND-Beziehung. |
orGroup |
Die FilterExpressions in orGroup haben eine ODER-Beziehung. |
notExpression |
Der FilterExpression ist NICHT vom Typ „notExpression“. |
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 ( |
| Felder | |
|---|---|
expressions[] |
Eine Liste mit Filterausdrücken. |
Filter
Ein Ausdruck zum Filtern von Dimensions- oder Messwerten.
| JSON-Darstellung |
|---|
{ "fieldName": string, // Union field |
| Felder | |
|---|---|
fieldName |
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 |
Filter für Strings. |
inListFilter |
Ein Filter für Werte in der Liste. |
numericFilter |
Ein Filter für numerische Werte oder Datumswerte. |
betweenFilter |
Ein Filter für einen Bereich zwischen zwei Werten. |
emptyFilter |
Ein Filter für leere Werte wie „(not set)“ und „“. |
StringFilter
Der Filter für String
| JSON-Darstellung |
|---|
{
"matchType": enum ( |
| Felder | |
|---|---|
matchType |
Der Übereinstimmungstyp für diesen Filter. |
value |
Der Stringwert, der für den Abgleich verwendet wird. |
caseSensitive |
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[] |
Die Liste der Stringwerte. Darf nicht leer sein. |
caseSensitive |
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 ( |
| Felder | |
|---|---|
operation |
Der Vorgangstyp für diesen Filter. |
value |
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 |
| Felder | |
|---|---|
Union-Feld one_value. Einer der numerischen Werte one_value kann nur einer der folgenden Werte sein: |
|
int64Value |
Ganzzahlwert |
doubleValue |
Doppelter Wert |
BetweenFilter
Um anzugeben, dass das Ergebnis zwischen zwei Zahlen (einschließlich) liegen muss.
| JSON-Darstellung |
|---|
{ "fromValue": { object ( |
| Felder | |
|---|---|
fromValue |
Beginnt mit dieser Zahl. |
toValue |
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 |
| Felder | |
|---|---|
desc |
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 |
Sortiert Ergebnisse nach den Werten eines Messwerts. |
dimension |
Sortiert Ergebnisse nach den Werten einer Dimension. |
MetricOrderBy
Sortiert nach Messwerten.
| JSON-Darstellung |
|---|
{ "metricName": string } |
| Felder | |
|---|---|
metricName |
Ein Messwertname in der Anfrage, nach dem sortiert werden soll. |
DimensionOrderBy
Sortiert nach Dimensionswerten.
| JSON-Darstellung |
|---|
{
"dimensionName": string,
"orderType": enum ( |
| Felder | |
|---|---|
dimensionName |
Ein Dimensionsname in der Anfrage, nach dem sortiert werden soll. |
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 ( |
| Felder | |
|---|---|
cohorts[] |
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 |
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 |
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 ( |
| Felder | |
|---|---|
name |
Weist dieser Kohorte einen Namen zu. Die Dimension |
dimension |
Von der Kohorte verwendete Dimension. Erforderlich und unterstützt nur |
dateRange |
Die Kohorte umfasst Nutzer, deren erstes Touchpoint-Datum zwischen dem Start- und Enddatum liegt, das in In einer Kohortenanfrage ist Dieser |
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 ( |
| Felder | |
|---|---|
granularity |
Erforderlich. Der Detaillierungsgrad, der zum Interpretieren von |
startOffset |
Mit Wenn Wenn Wenn |
endOffset |
Erforderlich. Mit Wenn Wenn Wenn |
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 |
Wenn „true“, wird das Ergebnis vom Tag des ersten Kontakts bis zum Enddatum kumuliert. Nicht unterstützt in |
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 ( |
| Felder | |
|---|---|
creationQuotaTokensCharged |
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 |
state |
Nur Ausgabe. Der aktuelle Status dieser Berichtsaufgabe. |
beginCreatingTime |
Nur Ausgabe. Der Zeitpunkt, zu dem 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: |
taskRowCount |
Nur Ausgabe. Die Gesamtzahl der Zeilen im Berichtsergebnis. Dieses Feld wird ausgefüllt, wenn der Status aktiv ist. Sie können |
errorMessage |
Nur Ausgabe. Fehlermeldung, die angezeigt wird, wenn beim Erstellen einer Berichtsaufgabe ein Fehler auftritt. |
totalRowCount |
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
Angenommen, der aktuelle Bericht hat einen |
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 |
|
|---|---|
|
Leitet die Erstellung einer Berichtsaufgabe ein. |
|
Ruft Bericht-Metadaten zu einer bestimmten Berichtsaufgabe ab. |
|
Listet alle Berichtsaufgaben für eine Property auf. |
|
Ruft den Inhalt einer Berichtsaufgabe ab. |