Method: properties.reportTasks.query

Ruft den Inhalt einer Berichtsaufgabe ab. Nachdem Sie den reportTasks.create angefordert haben, können Sie den Inhalt des Berichts 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 Tabellenzeilen- und -spaltenwerte des Berichts zurück.

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.

Bei der Paginierung wird in der ersten Anfrage kein Offset angegeben oder der Offset wird auf 0 gesetzt. Die erste Anfrage gibt die ersten limit Zeilen zurück. Bei der zweiten Anfrage wird der Offset auf den limit der ersten Anfrage festgelegt. Die zweite Anfrage gibt die zweite limit von Zeilen zurück.

Weitere Informationen zu diesem Parameter für die Paginierung finden Sie unter Paginierung.
limit

string (int64 format)

Optional. Die Anzahl der Zeilen, die aus dem Bericht zurückgegeben werden sollen. Wenn keine Angabe gemacht wird, werden 10.000 Zeilen zurückgegeben. Die API gibt pro Anfrage maximal 250.000 Zeilen zurück,unabhängig davon, wie viele Sie anfordern. limit muss positiv sein.

Die API kann auch weniger Zeilen als die angeforderte limit zurückgeben, wenn es nicht so viele Dimensionswerte wie die limit gibt. Die Anzahl der Zeilen, die für eine QueryReportTaskRequest verfügbar sind, wird zusätzlich durch die Beschränkung der zugehörigen ReportTask begrenzt. Mit einer Abfrage können maximal ReportTask.limit Zeilen abgerufen werden. Wenn für die Berichtsaufgabe beispielsweise ein Limit von 1.000 festgelegt ist, werden bei einer reportTasks.query-Anfrage mit offset=900 und limit=500 maximal 100 Zeilen zurückgegeben.

Weitere Informationen zu diesem Parameter für die Paginierung 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 DimensionsHeaders und die Reihenfolge der DimensionsHeaders stimmen mit den in den Zeilen vorhandenen Dimensionen überein.
metricHeaders[]

object (MetricHeader)

Beschreibt Messwertspalten. Die Anzahl der Messwertüberschriften und ihre Reihenfolge stimmen mit den Messwerten in den Zeilen überein.
rows[]

object (Row)

Zeilen mit Kombinationen von Dimensionswerten und Messwerten im Bericht.
totals[]

object (Row)

Auf Anfrage die Summe der Messwerte.
maximums[]

object (Row)

Auf Anfrage: die Maximalwerte der Messwerte.
minimums[]

object (Row)

Sofern angefordert, die Mindestwerte der 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,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Felder
dataLossFromOtherRow

boolean

Wenn „wahr“ festgelegt ist, werden einige Bucket von Dimensionskombinationen in der Zeile „Sonstiges“ zusammengefasst. Das kann bei Berichten mit hoher Kardinalität passieren.

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

Die Zeile „Sonstiges“ wird beispielsweise aus dem Bericht entfernt, wenn die Anfrage einen Filter auf „sessionSource = google“ enthält. Dieser Parameter wird auch dann ausgefüllt, wenn in den zusammengefassten Eingabedaten, die zum Generieren dieses Berichts verwendet wurden, Datenverluste aus anderen Zeilen aufgetreten sind.

Weitere Informationen finden Sie unter Zeile „Sonstiges“ und Stichprobenerhebung.
samplingMetadatas[]

object (SamplingMetadata)

Wenn die Ergebnisse dieses Berichts stichprobenartig sind, wird der Prozentsatz der Ereignisse angegeben, die in diesem Bericht verwendet wurden. Für jeden Zeitraum wird eine samplingMetadatas erfasst. Jedes samplingMetadatas entspricht einem Zeitraum, der in der Anfrage angegeben wurde.

Wenn die Ergebnisse jedoch nicht Stichprobenerhebungen sind, ist dieses Feld nicht definiert.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

string

Der in diesem Bericht verwendete Währungscode. Zur Formatierung von Währungsmesswerten wie purchaseRevenue für die Visualisierung. Wenn „currencyCode“ in der Anfrage angegeben wurde, wird dieser Antwortparameter mit dem Anfrageparameter übereinstimmen. Andernfalls ist dieser Antwortparameter der aktuelle „currencyCode“ der Unterkunft.

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

string

Die aktuelle Zeitzone der Unterkunft. Zur Interpretation zeitbezogener Dimensionen wie hour und minute. Als Strings aus der IANA-Zeitzonendatenbank (https://www.iana.org/time-zones) formatiert, z. B. „America/New_York“ oder „Asia/Tokyo“.
emptyReason

string

Wenn „Leere Antwort“ angegeben ist, ist der Bericht aus diesem Grund leer.
subjectToThresholding

boolean

Wenn subjectToThresholding wahr ist, wird für diesen Bericht ein Grenzwert angewendet und es werden nur Daten zurückgegeben, die die Mindestwerte für die Aggregation erreichen. Es ist möglich, dass eine Anfrage einem Grenzwert unterliegt und im Bericht keine Daten fehlen. Das ist der Fall, wenn alle Daten über den Grenzwerten liegen. Weitere Informationen finden Sie unter Datengrenzwerte und Demografische Merkmale und Interessen.

SchemaRestrictionResponse

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

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

object (ActiveMetricRestriction)

Alle Einschränkungen, die beim Erstellen des Berichts aktiv erzwungen wurden. purchaseRevenue hat beispielsweise immer den Einschränkungstyp REVENUE_DATA. Diese Einschränkung für aktive Antworten wird jedoch nur dann erfasst, 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 Sie in bestimmten Google Analytics-Properties möglicherweise nicht sehen können

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