Method: properties.reportTasks.query

Ruft den Inhalt einer Berichtsaufgabe ab. Nachdem Sie die reportTasks.create angefordert haben, können Sie den Berichtsinhalt abrufen, sobald der Bericht AKTIV ist. Diese Methode gibt einen Fehler zurück, wenn der Status der Berichtsaufgabe nicht ACTIVE ist. Eine Abfrageantwort gibt die tabellarische Zeile und Spaltenwerte des Berichts.

HTTP-Anfrage

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Name der Berichtsquelle. Format: properties/{property}/reportTasks/{report}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "offset": string,
  "limit": string
}
Felder
offset

string (int64 format)

Optional. Die Zeilenanzahl der Startzeile im Bericht. Die erste Zeile wird als Zeile 0 gezählt.

Beim Paging wird mit der ersten Anfrage kein Offset angegeben. oder entsprechend setzt Offset auf 0; Die erste Anfrage gibt die ersten limit der Zeilen zurück. Die zweite Anfrage legt einen Offset auf den limit der ersten Anfrage fest. Die zweite Anfrage gibt die zweiten limit der Zeilen zurück.

Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung.
limit

string (int64 format)

Optional. Die Anzahl der Zeilen, die aus dem 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. limit muss positiv sein.

Die API kann auch weniger Zeilen als die angeforderte limit zurückgeben, wenn nicht so viele Dimensionswerte wie der limit vorhanden sind. Die Anzahl der für eine QueryReportTaskRequest verfügbaren Zeilen wird durch das Limit der zugehörigen ReportTask weiter begrenzt. Eine Abfrage kann höchstens „ReportTask.limit“-Zeilen abrufen. Beispiel: Wenn die ReportTask ein Limit von 1.000 hat, gibt eine reportTasks.query-Anfrage mit „offset=900“ und „limit=500“ höchstens 100 Zeilen zurück.

Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung.

Antworttext

Der Berichtsinhalt, der einer Berichtsaufgabe entspricht.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
Felder
dimensionHeaders[]

object (DimensionHeader)

Beschreibt Dimensionsspalten. Die Anzahl der DimensionHeaders und die Reihenfolge von DimensionHeaders entsprechen den Dimensionen in den Zeilen.
metricHeaders[]

object (MetricHeader)

Beschreibt Messwertspalten. Die Anzahl der MetricHeaders und die Reihenfolge der MetricHeaders entsprechen den Messwerten in den Zeilen.
rows[]

object (Row)

Zeilen mit Dimensionswertkombinationen und Messwerten im Bericht.
totals[]

object (Row)

Auf Anfrage die Gesamtwerte der Messwerte.
maximums[]

object (Row)

Auf Anfrage die Maximalwerte der Messwerte.
minimums[]

object (Row)

Bei Bedarf die Mindestwerte für Messwerte.
rowCount

integer

Die Gesamtzahl der Zeilen im Abfrageergebnis.
metadata

object (ResponseMetaData)

Metadaten für den Bericht.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ResponseMetaData

Die Metadaten der Antwort mit zusätzlichen Informationen zum Inhalt des Berichts.

JSON-Darstellung 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Felder
dataLossFromOtherRow

boolean

Falls wahr, werden einige Gruppen von Dimensionskombinationen in „Sonstiges“ zusammengefasst. Zeile. Das kann bei Berichten mit hoher Kardinalität vorkommen.

Der Metadatenparameter dataLossFromOtherRow wird basierend auf der im Bericht verwendeten aggregierten Datentabelle ausgefüllt. Der Parameter wird unabhängig von den Filtern und Grenzwerten im Bericht korrekt ausgefüllt.

Beispielsweise könnte die Zeile „Sonstiges“ aus dem Bericht entfernt werden, weil die Anfrage einen Filter für sessionSource = google. Dieser Parameter wird weiterhin gefüllt, wenn in den aggregierten Eingabedaten, die zum Generieren dieses Berichts verwendet werden, Datenverluste aus anderen Zeilen aufgetreten sind.

Weitere Informationen zur Zeile „Sonstiges“ und zur Stichprobenerhebung
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Beschreibt die Schemaeinschränkungen, die beim Erstellen dieses Berichts aktiv erzwungen werden. Weitere Informationen finden Sie unter Verwaltung von Zugriffs- und Dateneinschränkungen.
currencyCode

string

Der in diesem Bericht verwendete Währungscode. Vorgesehen zur Formatierung von Währungsmesswerten wie purchaseRevenue zur Visualisierung. Wenn in der Anfrage „currencyCode“ angegeben wurde, gibt dieser Antwortparameter den Anfrageparameter zurück. Andernfalls ist dieser Antwortparameter der aktuelle „currencyCode“ der Property.

Währungscodes sind Stringcodierungen von Währungstypen aus dem ISO-Standard 4217 (https://en.wikipedia.org/wiki/ISO_4217). Beispiel: „USD“, „EUR“, „JPY“. Weitere Informationen finden Sie unter https://support.google.com/analytics/answer/9796179.
timeZone

string

Die aktuelle Zeitzone der Unterkunft. Wird zur Interpretation zeitbasierter Dimensionen wie hour und minute verwendet. als Strings aus der Zeitzonendatenbank der IANA (https://www.iana.org/time-zones)) formatiert Beispiel: „America/New_York“ oder „Asien/Tokio“.
emptyReason

string

Wird kein Grund angegeben, ist der Bericht aus diesem Grund leer.
subjectToThresholding

boolean

Wenn subjectToThresholding auf „true“ gesetzt ist, unterliegt dieser Bericht einem Grenzwert und es werden nur Daten zurückgegeben, die die minimalen Aggregationsschwellenwerte erreichen. Es ist möglich, dass eine Anfrage einem Grenzwert unterliegt und im Bericht keine Daten fehlen. Dies ist der Fall, wenn alle Daten über den Schwellenwerten liegen. Weitere Informationen finden Sie unter Datengrenzwerte und Demografische Merkmale und Interessen.

SchemaRestrictionResponse

Die Schemaeinschränkungen, die beim Erstellen dieses Berichts aktiv erzwungen werden. Weitere Informationen finden Sie unter Verwaltung von Zugriffs- und Dateneinschränkungen.

JSON-Darstellung 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Felder
activeMetricRestrictions[]

object (ActiveMetricRestriction)

Alle Einschränkungen werden beim Erstellen des Berichts aktiv erzwungen. Beispielsweise hat purchaseRevenue immer den Einschränkungstyp REVENUE_DATA. Diese Einschränkung für aktive Antworten wird jedoch nur angewendet, wenn die benutzerdefinierte Rolle des Nutzers den Zugriff auf REVENUE_DATA nicht zulässt.

ActiveMetricRestriction

Ein Messwert, der beim Erstellen des Berichts aktiv eingeschränkt wurde.

JSON-Darstellung 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Felder
restrictedMetricTypes[]

enum (RestrictedMetricType)

Der Grund für die Einschränkung dieses Messwerts.
metricName

string

Der Name des eingeschränkten Messwerts.

RestrictedMetricType

Datenkategorien, die in bestimmten GA4-Properties möglicherweise nicht angezeigt werden können.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Nicht definierter Typ.
COST_DATA Kostenmesswerte wie adCost.
REVENUE_DATA Umsatzmesswerte wie purchaseRevenue.