- Ressource: ReportTask
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ReportDefinition
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Dimension
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DimensionExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CaseExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ConcatenateExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Messwert
- DateRange
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- FilterExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- FilterExpressionList
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Filter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StringFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MatchType
- InListFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NumericFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Vorgang
- NumericValue
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- BetweenFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MetricAggregation
- OrderBy
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MetricOrderBy
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DimensionOrderBy
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- OrderType
- CohortSpec
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Kohorte
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CohortsRange
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Detaillierungsgrad
- CohortReportSettings
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ReportMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Bundesland
- Methoden
Ressource: ReportTask
Eine bestimmte Konfiguration der Berichtsaufgabe.
JSON-Darstellung |
---|
{ "name": string, "reportDefinition": { object ( |
Felder | |
---|---|
name |
Nur Ausgabe. Kennung. Der Ressourcenname der Berichtaufgabe, der bei der Erstellung zugewiesen wurde. Format: „properties/{property}/reportTasks/{reportTask}“ |
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 |
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 ( |
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, werden die Ereignisdaten für die sich überschneidenden Tage in den Antwortzeilen für beide Zeiträume angezeigt. In einer Kohortenanfrage darf diese |
dimensionFilter |
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 |
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 |
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 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. Die API kann auch weniger Zeilen als die angeforderte |
metricAggregations[] |
Optional. Aggregation von Messwerten. Aggregierte Messwerte werden in Zeilen angezeigt, in denen die DimensionValues auf „RESERVED_(MetricAggregation)“ festgelegt ist. |
orderBys[] |
Optional. Gibt an, wie Zeilen in der Antwort angeordnet 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. Mit dieser Anfrage verknüpfte Kohortengruppe. Gibt es eine Kohortengruppe in der Anfrage, wird die „Kohorte“ Dimension vorhanden sein muss. |
keepEmptyRows |
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 Wenn für eine Property beispielsweise nie ein |
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 ( |
Felder | |
---|---|
name |
Der Name der Dimension. Unter API-Dimensionen finden Sie eine Liste der Dimensionsnamen, die von zentralen Berichtsmethoden wie Wenn
|
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 |
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 umzuwandeln. |
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 Einzelfall umzuwandeln.
JSON-Darstellung |
---|
{ "dimensionName": string } |
Felder | |
---|---|
dimensionName |
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[] |
Namen der Dimensionen. Die Namen müssen auf Namen im Dimensionsfeld der Anfrage verweisen. |
delimiter |
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 |
Der Name des Messwerts. Unter API-Messwerte finden Sie eine Liste der Messwertnamen, die von zentralen Berichtsmethoden wie Wenn Messwerte werden von |
expression |
Ein 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 generiert, er kann aber in |
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 |
Das Startdatum der Abfrage im Format |
endDate |
Das Enddatum der Abfrage im Format |
name |
Weist diesem Zeitraum einen Namen zu. 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 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 OR-Beziehung. |
notExpression |
FilterExpression entspricht NICHT notExpression. |
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 ( |
Felder | |
---|---|
expressions[] |
Eine Liste von 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 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 |
Stringbezogener Filter. |
inListFilter |
Ein Filter für In-Listen-Werte. |
numericFilter |
Ein Filter für numerische Werte oder Datumswerte. |
betweenFilter |
Ein Filter für zwei Werte. |
StringFilter
Der Filter für den String
JSON-Darstellung |
---|
{
"matchType": enum ( |
Felder | |
---|---|
matchType |
Der Übereinstimmungstyp für diesen Filter. |
value |
Der für den Abgleich verwendete Stringwert. |
caseSensitive |
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[] |
Die Liste der Stringwerte. Das Feld darf nicht leer sein. |
caseSensitive |
Falls wahr, 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 |
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 liegen muss (einschließlich).
JSON-Darstellung |
---|
{ "fromValue": { object ( |
Felder | |
---|---|
fromValue |
Beginnt mit dieser Zahl. |
toValue |
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 |
Felder | |
---|---|
desc |
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 |
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, 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 ( |
Felder | |
---|---|
cohorts[] |
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 |
Kohortenberichte beziehen sich auf Kohorten über einen längeren Berichtszeitraum. Dieser Bereich gibt einen Versatzzeitraum für die Kohorten an. |
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 ( |
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 der ersten Interaktion zwischen dem in der In einer Kohortenanfrage ist diese Dieser Wert ( |
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 ( |
Felder | |
---|---|
granularity |
Erforderlich. Der Detaillierungsgrad, der zur Interpretation von |
startOffset |
Wenn Wenn Wenn |
endOffset |
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 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 |
Falls wahr, wird das Ergebnis vom ersten Berührungstag bis zum Endtag erfasst. Wird in |
ReportMetadata
Die Metadaten für eine bestimmte Berichtsaufgabe.
JSON-Darstellung |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Felder | |
---|---|
creationQuotaTokensCharged |
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 |
state |
Nur Ausgabe. Der aktuelle Status dieser 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 Status aktiv ist. Sie können |
errorMessage |
Nur Ausgabe. Es wird eine Fehlermeldung angezeigt, 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 diese eine neue Berichtsaufgabe auf der Grundlage von
Angenommen, der |
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 |
|
---|---|
|
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. |