- 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
- ReportMetadata
- Bundesland
- Methoden
Ressource: ReportTask
Eine bestimmte Konfiguration der Berichtsaufgabe.
JSON-Darstellung |
---|
{ "name": string, "reportDefinition": { object ( |
Felder | |
---|---|
name |
Nur Ausgabe. Kennung. Der Ressourcenname der Berichtsaufgabe, der bei der Erstellung zugewiesen wurde. Format: „properties/{property}/reportTasks/{reportTask}“ |
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. |
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. |
ReportDefinition
Die Definition für die Ausführung eines Berichts.
JSON-Darstellung |
---|
{ "dimensions": [ { object ( |
Felder | |
---|---|
dimensions[] |
Optional. Die angeforderten und angezeigten Abmessungen. |
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, werden die Ereignisdaten für die sich überschneidenden Tage in den Antwortzeilen für beide Zeiträume aufgeführt. In einer Kohortenanfrage darf |
dimensionFilter |
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. |
metricFilter |
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. |
offset |
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 |
limit |
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. Die API kann auch weniger Zeilen als vom angeforderten |
metricAggregations[] |
Optional. Zusammenfassung von Messwerten Zusammengefasste Messwerte werden in Zeilen angezeigt, in denen „dimensionValues“ auf „RESERVED_(MesswertAggregation)“ 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 im Bericht die Standardwährung der Property verwendet. |
cohortSpec |
Optional. Die mit dieser Anfrage verknüpfte Kohortengruppe. Wenn die Anfrage eine Kohortengruppe enthält, muss die Dimension „Kohorte“ vorhanden sein. |
keepEmptyRows |
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 Wenn für eine Property beispielsweise nie ein |
Dimension
Dimensionen sind Attribute Ihrer Daten. Die Dimension „Stadt“ gibt beispielsweise den Ort an, von dem das Ereignis ausgeht. Dimensionswerte in Berichtsantworten sind Strings. So könnte die Stadt „Paris“ oder „New York“ sein.
JSON-Darstellung |
---|
{
"name": string,
"dimensionExpression": {
object ( |
Felder | |
---|---|
name |
Der Name der Dimension. Unter API-Dimensionen finden Sie eine Liste der Dimensionsnamen, die von wichtigen Berichtsmethoden wie Wenn In |
dimensionExpression |
Eine Dimension kann das Ergebnis eines Ausdrucks mehrerer Dimensionen sein. Beispiel: Die Dimension „Land, Stadt“: verketten(Land, ", ", Stadt). |
DimensionExpression
Damit wird eine Dimension ausgedrückt, die das Ergebnis einer Formel mehrerer Dimensionen ist. Anwendungsbeispiele: 1) Kleinbuchstaben(Dimension) 2) Verketten(Dimension1, Symbol, Dimension2).
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld one_expression . Geben Sie eine Art von Dimensionsausdruck für DimensionExpression an. Für one_expression ist nur einer der folgenden Werte zulässig: |
|
lowerCase |
Damit wird ein Dimensionswert in Kleinbuchstaben umgewandelt. |
upperCase |
Damit wird ein Dimensionswert in Großbuchstaben umgewandelt. |
concatenate |
Damit werden Dimensionswerte zu einer einzelnen Dimension kombiniert. Beispiel: Die Dimension „Land, Stadt“: verketten(Land, ", ", Stadt). |
CaseExpression
Damit wird ein Dimensionswert in einen einzelnen Fall konvertiert.
JSON-Darstellung |
---|
{ "dimensionName": string } |
Felder | |
---|---|
dimensionName |
Name einer Dimension. Der Name muss sich auf einen Namen im Dimensionsfeld der Anfrage beziehen. |
ConcatenateExpression
Damit werden Dimensionswerte zu einer einzelnen Dimension kombiniert.
JSON-Darstellung |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
Felder | |
---|---|
dimensionNames[] |
Namen von Dimensionen. Die Namen müssen sich auf die Namen im Dimensionsfeld der Anfrage beziehen. |
delimiter |
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“. |
Messwert
Die quantitativen Messungen eines Berichts. Der Messwert eventCount
ist beispielsweise die Gesamtzahl der Ereignisse. Anfragen sind bis zu 10 Messwerte zulässig.
JSON-Darstellung |
---|
{ "name": string, "expression": string, "invisible": boolean } |
Felder | |
---|---|
name |
Der Name des Messwerts. Unter API-Messwerte finden Sie eine Liste der Messwertnamen, die von wichtigen Berichtsmethoden wie Wenn Auf Messwerte wird von |
expression |
Mathematischer Ausdruck für abgeleitete Messwerte. Der Messwert „Ereignisanzahl“ pro Nutzer ist beispielsweise |
invisible |
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 |
DateRange
Eine zusammenhängende Gruppe von Tagen: startDate
, startDate + 1
, ..., endDate
. Anfragen sind für bis zu vier Zeiträume zulässig.
JSON-Darstellung |
---|
{ "startDate": string, "endDate": string, "name": string } |
Felder | |
---|---|
startDate |
Das einschließende Startdatum für die Abfrage im Format |
endDate |
Das einschließende Enddatum für die Abfrage im Format |
name |
Weist diesem Zeitraum einen Namen zu. Die Dimension „ |
FilterExpression
Zum Ausdrucken von Dimensions- oder Messwertfiltern. Die Felder in derselben FilterExpression müssen entweder alle Dimensionen oder alle Messwerte enthalten.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld expr . Geben Sie eine Art von Filterausdruck 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 OR-Beziehung. |
notExpression |
FilterExpression ist NICHT auf notExpression. |
filter |
Ein primitiver 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. |
Filtern
Ein Ausdruck zum Filtern von Dimensions- oder Messwerten.
JSON-Darstellung |
---|
{ "fieldName": string, // Union field |
Felder | |
---|---|
fieldName |
Name der Dimension oder des Messwerts Muss ein Name sein, der in Dimensionen oder Messwerten definiert ist. |
Union-Feld one_filter . Geben Sie eine Filterart für Filter an. Für one_filter ist nur einer der folgenden Werte zulässig: |
|
stringFilter |
Filter zum Thema Strings. |
inListFilter |
Ein Filter für in Listenwerten. |
numericFilter |
Ein Filter für numerische Werte oder Datumswerte. |
betweenFilter |
Ein Filter für zwischen zwei Werten. |
StringFilter
Filter für String
JSON-Darstellung |
---|
{
"matchType": enum ( |
Felder | |
---|---|
matchType |
Die Keyword-Option für diesen Filter. |
value |
Der für den Abgleich verwendete Stringwert. |
caseSensitive |
Bei „true“ wird die Groß- und Kleinschreibung beim Stringwert beachtet. |
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 |
Er endet mit dem Stringwert. |
CONTAINS |
Enthält den Stringwert. |
FULL_REGEXP |
Vollständige Übereinstimmung mit dem regulären Ausdruck mit dem Stringwert. |
PARTIAL_REGEXP |
Teilü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[] |
Die Liste der Stringwerte. Darf nicht leer sein. |
caseSensitive |
Bei „true“ wird die Groß- und Kleinschreibung beim Stringwert 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 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 |
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 auszudrücken, 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. |
MetricAggregation
Aggregation von Messwerten.
Enums | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Der Operator ist nicht angegeben. |
TOTAL |
SUMME-Operator. |
MINIMUM |
Minimum-Operator. |
MAXIMUM |
Maximaler Operator. |
COUNT |
Der Operator "Count". |
OrderBy
Mit „Order by“ (Sortieren) wird festgelegt, wie Zeilen in der Antwort sortiert werden. Die Sortierung von Zeilen nach absteigender Ereignisanzahl entspricht beispielsweise einer Sortierung, während die Reihenfolge der Zeilen nach dem String des Ereignisnamens eine andere Reihenfolge ist.
JSON-Darstellung |
---|
{ "desc": boolean, // Union field |
Felder | |
---|---|
desc |
Bei „true“ wird in absteigender Reihenfolge sortiert. |
Union-Feld one_order_by . Geben Sie eine Sortierart für OrderBy an. Für one_order_by ist nur einer der folgenden Werte zulässig: |
|
metric |
Sortiert die Ergebnisse nach den Werten eines Messwerts. |
dimension |
Sortiert die Ergebnisse nach den Werten einer Dimension. |
MetricOrderBy
Sortiert nach Messwerten.
JSON-Darstellung |
---|
{ "metricName": string } |
Felder | |
---|---|
metricName |
Ein Messwertname in der Sortieranfrage. |
DimensionOrderBy
Sortiert nach Dimensionswerten.
JSON-Darstellung |
---|
{
"dimensionName": string,
"orderType": enum ( |
Felder | |
---|---|
dimensionName |
Ein Dimensionsname in der Anfrage, nach der sortiert werden soll. |
orderType |
Steuert die Regel für die Sortierung der Dimensionswerte. |
OrderType
Regel zur Sortierung 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 nach Unicode-Codepunkt in Kleinbuchstaben wird nicht berücksichtigt. Beispiel: "2" < "A" < "b" < "X" < "z". |
NUMERIC |
Dimensionswerte werden vor der Sortierung in Zahlen umgewandelt. Zum Beispiel bei NUMERISCHEr Sortierung „25“ < „100“ und in ALPHANUMERIC „100“ < „25“. Alle nicht numerischen Dimensionswerte haben alle numerischen Werte in gleicher Reihenfolge. |
CohortSpec
Die Angabe von Kohorten für einen Kohortenbericht.
In Kohortenberichten wird eine Zeitreihe zur Nutzerbindung für die Kohorte erstellt. Sie können beispielsweise die Kohorte von Nutzern 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 September-Kohorte gewonnen wurden, werden im cohort
-Objekt festgelegt. Die nachfolgenden Kohorten für die nächsten sechs Wochen werden im cohortsRange
-Objekt angegeben.
Beispiele finden Sie unter Beispiele für Kohortenberichte.
Die Antwort auf den Bericht könnte eine wöchentliche Zeitreihe enthalten, in der beispielsweise 60% dieser Kohorte nach drei Wochen und 25% der Kohorte nach sechs Wochen beibehalten wurden. Diese beiden Prozentsätze können mit dem Messwert cohortActiveUsers/cohortTotalUsers
berechnet werden und werden im Bericht als separate Zeilen dargestellt.
JSON-Darstellung |
---|
{ "cohorts": [ { object ( |
Felder | |
---|---|
cohorts[] |
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. |
cohortsRange |
Kohortenberichte folgen Kohorten über einen längeren Berichtszeitraum. Dieser Bereich gibt einen Versatzzeitraum an, der auf die Kohorten angewendet wird. |
cohortReportSettings |
Optionale Einstellungen für einen Kohortenbericht. |
Cohort
Definiert ein Kohortenauswahlkriterium. Eine Kohorte ist eine Gruppe von Nutzenden mit einem gemeinsamen Merkmal. Beispielsweise gehören Nutzer mit derselben 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 |
Für die Kohorte werden Nutzer ausgewählt, deren Datum des ersten Kontakts zwischen dem in der In einer Kohortenanfrage ist diese Der Messwert „ |
CohortsRange
Mit dieser Richtlinie wird der erweiterte Berichtszeitraum für einen Kohortenbericht konfiguriert. Gibt einen Versatzzeitraum an, der auf die Kohorten angewendet wird.
JSON-Darstellung |
---|
{
"granularity": enum ( |
Felder | |
---|---|
granularity |
Erforderlich. Der Detaillierungsgrad, mit dem |
startOffset |
Wenn Wenn Wenn |
endOffset |
Erforderlich. Wenn Wenn Wenn |
Detaillierungsgrad
Der Detaillierungsgrad, mit dem startOffset
und endOffset
für den erweiterten Berichtszeitraum für einen Kohortenbericht interpretiert werden.
Enums | |
---|---|
GRANULARITY_UNSPECIFIED |
Sollte nie angegeben werden. |
DAILY |
Tägliche Leseeinheit. Wird häufig verwendet, wenn das dateRange der Kohorte ein einzelner Tag ist und die Anfrage cohortNthDay enthält. |
WEEKLY |
Wöchentlicher Detaillierungsgrad. Wird häufig verwendet, wenn das dateRange der Kohorte eine Woche dauert (beginnt am Sonntag und endet am Samstag) und die Anfrage cohortNthWeek enthält. |
MONTHLY |
Monatlicher Detaillierungsgrad. Wird häufig verwendet, wenn das dateRange der Kohorte einen Monat lang ist und die Anfrage cohortNthMonth enthält. |
CohortReportSettings
Optionale Einstellungen eines Kohortenberichts.
JSON-Darstellung |
---|
{ "accumulate": boolean } |
Felder | |
---|---|
accumulate |
Bei „true“ wird das Ergebnis vom ersten Berührungstag bis zum letzten Tag erfasst. In |
ReportMetadata
Die Berichtsmetadaten für eine bestimmte Berichtsaufgabe.
JSON-Darstellung |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Felder | |
---|---|
creationQuotaTokensCharged |
Nur Ausgabe. Die Gesamtzahl der Kontingenttokens, die während der Erstellung des Berichts berechnet werden. Da die Tokenanzahl auf Aktivität aus dem Status |
state |
Nur Ausgabe. Der aktuelle Status für diese Berichtsaufgabe. |
beginCreatingTime |
Nur Ausgabe. Der Zeitpunkt, zu dem Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
taskRowCount |
Nur Ausgabe. Die Gesamtzahl der Zeilen im Berichtsergebnis. Dieses Feld wird ausgefüllt, wenn der Bundesstaat aktiv ist. Sie können |
errorMessage |
Nur Ausgabe. Eine Fehlermeldung wird eingefügt, wenn bei der Erstellung einer Berichtsaufgabe ein Fehler auftritt. |
totalRowCount |
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 Die Angenommen, der |
Status
Der Verarbeitungsstatus.
Enums | |
---|---|
STATE_UNSPECIFIED |
Ein nicht angegebener Status wird nie verwendet. |
CREATING |
Der Bericht wird derzeit erstellt und ist später 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 |
|
---|---|
|
Initiiert das Erstellen einer Berichtsaufgabe. |
|
Ruft Metadaten zu einer bestimmten Berichtsaufgabe ab. |
|
Listet alle Berichtsaufgaben für eine Property auf. |
|
Ruft den Inhalt einer Berichtsaufgabe ab. |