- Ressource: ReportTask
- ReportDefinition
- Dimension
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Messwert
- DateRange
- FilterExpression
- FilterExpressionList
- Filter
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Vorgang
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Kohorte
- CohortsRange
- Detaillierungsgrad
- CohortReportSettings
- SamplingLevel
- ReportMetadata
- Bundesland
- Methoden
Ressource: ReportTask
Eine bestimmte Berichtsaufgabenkonfiguration.
JSON-Darstellung |
---|
{ "name": string, "reportDefinition": { object ( |
Felder | |
---|---|
name |
Nur Ausgabe. Kennung. Der Name der Berichtsaufgabe, der bei der Erstellung zugewiesen wurde. Format: „properties/{property}/reportTasks/{reportTask}“ |
report |
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. |
report |
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 ( |
Felder | |
---|---|
dimensions[] |
Optional. Die angeforderten und angezeigten Dimensionen. |
metrics[] |
Optional. Die angeforderten und angezeigten Messwerte. |
date |
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 |
dimension |
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. |
metric |
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 |
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 |
limit |
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. Die API kann auch weniger Zeilen als die angeforderte |
metric |
Optional. Aggregation von Messwerten. Aggregierte Messwertwerte werden in Zeilen angezeigt, in denen die Dimensionswerte auf „RESERVED_(MetricAggregation)“ festgelegt sind. |
order |
Optional. Gibt an, wie Zeilen in der Antwort angeordnet werden. |
currency |
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. |
cohort |
Optional. Die Kohortengruppe, die mit dieser Anfrage verknüpft ist. Wenn die Anfrage eine Kohortengruppe enthält, muss die Dimension „Kohorte“ vorhanden sein. |
keep |
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 Wenn für eine Property beispielsweise nie ein |
sampling |
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 ( |
Felder | |
---|---|
name |
Der Name der Dimension. Eine Liste der Dimensionennamen, die von den wichtigsten Berichtsmethoden wie Wenn
|
dimension |
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 |
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: |
|
lower |
Hiermit wird ein Dimensionswert in Kleinbuchstaben umgewandelt. |
upper |
Wandelt einen Dimensionswert in Großbuchstaben um. |
concatenate |
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 | |
---|---|
dimension |
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 | |
---|---|
dimension |
Namen der Dimensionen. Die Namen müssen auf Namen im Dimensionsfeld der Anfrage verweisen. |
delimiter |
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 |
Der Name des Messwerts. Eine Liste der Messwertnamen, die von den wichtigsten Berichtsmethoden wie Wenn Auf Messwerte wird in |
expression |
Ein mathematischer Ausdruck für abgeleitete Messwerte. Der Messwert „Ereignisanzahl pro Nutzer“ hat beispielsweise den Wert |
invisible |
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 |
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 | |
---|---|
start |
Das Startdatum (einschließlich) für die Abfrage im Format |
end |
Das Enddatum (letzter Tag eingeschlossen) der Abfrage im Format |
name |
Diesem Zeitraum wird ein Name zugewiesen. Die Dimension „ |
FilterExpression
Für Dimensions- oder Messwertfilter. Die Felder in derselben FilterExpression müssen entweder alle Dimensionen oder alle Messwerte enthalten.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld expr . Geben Sie einen Filterausdruck für FilterExpression an. Für expr ist nur einer der folgenden Werte zulässig: |
|
and |
Die Filterausdrücke in „andGroup“ haben eine AND-Beziehung. |
or |
Die Filterausdrücke in „orGroup“ haben eine ODER-Beziehung. |
not |
FilterExpression entspricht NICHT notExpression. |
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 ( |
Felder | |
---|---|
expressions[] |
Eine Liste von Filterausdrücken. |
Filter
Ein Ausdruck zum Filtern von Dimensions- oder Messwerten.
JSON-Darstellung |
---|
{ "fieldName": string, // Union field |
Felder | |
---|---|
field |
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: |
|
string |
Filter für Strings. |
in |
Ein Filter für Werte in einer Liste. |
numeric |
Ein Filter für numerische oder Datumswerte. |
between |
Ein Filter für Werte zwischen zwei Werten. |
StringFilter
Der Filter für Strings
JSON-Darstellung |
---|
{
"matchType": enum ( |
Felder | |
---|---|
match |
Der Übereinstimmungstyp für diesen Filter. |
value |
Der Stringwert, der für die Übereinstimmung verwendet wird. |
case |
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[] |
Die Liste der Stringwerte. Das Feld darf nicht leer sein. |
case |
Wenn diese Option aktiviert ist, wird beim Stringwert zwischen Groß- und Kleinschreibung unterschieden. |
NumericFilter
Filtert numerische Werte oder Datumswerte.
JSON-Darstellung |
---|
{ "operation": enum ( |
Felder | |
---|---|
operation |
Der Vorgangstyp für diesen Filter. |
value |
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 |
Felder | |
---|---|
Union-Feld one_value . Einer der numerischen Werte one_value kann nur einer der folgenden Werte sein: |
|
int64 |
Ganzzahlwert |
double |
Doppelter Wert |
BetweenFilter
Das Ergebnis muss zwischen zwei Zahlen liegen (einschließlich).
JSON-Darstellung |
---|
{ "fromValue": { object ( |
Felder | |
---|---|
from |
Beginnt mit dieser Zahl. |
to |
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 |
Felder | |
---|---|
desc |
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 |
Die Ergebnisse werden nach den Werten eines Messwerts sortiert. |
dimension |
Die Ergebnisse werden nach den Werten einer Dimension sortiert. |
MetricOrderBy
Sortiert nach Messwert.
JSON-Darstellung |
---|
{ "metricName": string } |
Felder | |
---|---|
metric |
Der Name eines Messwerts in der Anfrage, nach dem sortiert werden soll. |
DimensionOrderBy
Sortiert nach Dimensionswerten.
JSON-Darstellung |
---|
{
"dimensionName": string,
"orderType": enum ( |
Felder | |
---|---|
dimension |
Ein Dimensionsname in der Anfrage, nach der sortiert werden soll. |
order |
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 ( |
Felder | |
---|---|
cohorts[] |
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. |
cohorts |
In Kohortenberichten werden Kohorten über einen erweiterten Berichtszeitraum beobachtet. In diesem Bereich wird ein Zeitversatz angegeben, über den die Kohorten beobachtet werden sollen. |
cohort |
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 ( |
Felder | |
---|---|
name |
Weist dieser Kohorte einen Namen zu. Die Dimension „ |
dimension |
Von der Kohorte verwendete Dimension. Erforderlich und unterstützt nur |
date |
Für die Kohorte werden Nutzer ausgewählt, deren Datum der ersten Interaktion zwischen dem Start- und Enddatum liegt, das in der In einer Kohortenanfrage ist diese Diese |
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 ( |
Felder | |
---|---|
granularity |
Erforderlich. Die Detaillierung, mit der |
start |
Wenn Wenn Wenn |
end |
Erforderlich. Wenn Wenn Wenn |
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 |
Wenn „wahr“ festgelegt ist, wird das Ergebnis vom Tag der ersten Interaktion bis zum Enddatum erfasst. Nicht unterstützt in |
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 ( |
Felder | |
---|---|
creation |
Nur Ausgabe. Die gesamten Kontingenttokens, die bei der Erstellung des Berichts in Rechnung gestellt wurden. Da diese Tokenanzahl auf Aktivitäten im Status |
state |
Nur Ausgabe. Der aktuelle Status dieser Berichtsaufgabe. |
begin |
Nur Ausgabe. Die Uhrzeit, zu der Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
task |
Nur Ausgabe. Die Gesamtzahl der Zeilen im Berichtsergebnis. Dieses Feld wird ausgefüllt, wenn der Status aktiv ist. Sie können |
error |
Nur Ausgabe. Eine Fehlermeldung wird angezeigt, wenn eine Berichtsaufgabe beim Erstellen fehlschlägt. |
total |
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
Angenommen, |
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 |
|
---|---|
|
Damit wird die Erstellung einer Berichtsaufgabe gestartet. |
|
Ruft Metadaten zu einem Bericht zu einer bestimmten Berichtsaufgabe ab. |
|
Hier werden alle Berichtsaufgaben für eine Property aufgelistet. |
|
Ruft den Inhalt einer Berichtsaufgabe ab. |