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 tabellarischen Zeilen- 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.

Beim Paging wird in der ersten Anfrage kein „offset“ angegeben oder entsprechend „offset“ auf 0. Die erste Anfrage gibt die erste limit der Zeilen zurück. Die zweite Anfrage legt „Offset“ auf den limit der ersten Anfrage fest. Die zweite Anfrage gibt die zweite limit der Zeilen zurück.

Weitere Informationen zu diesem Parameter finden Sie unter Paginierung.
limit

string (int64 format)

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

Die API kann auch weniger Zeilen als vom angeforderten limit zurückgeben, wenn nicht so viele Dimensionswerte wie limit vorhanden sind. Die Anzahl der Zeilen, die für QueryReportTaskRequest verfügbar sind, ist durch das Limit der zugehörigen ReportTask weiter begrenzt. Mit einer Abfrage können maximal ReportTask.limit-Zeilen abgerufen werden. Wenn die ReportTask beispielsweise ein Limit von 1.000 hat, gibt eine reportTasks.query-Anfrage mit offset=900 und limit=500 maximal 100 Zeilen zurück.

Weitere Informationen zu diesem Parameter finden Sie unter Paginierung.

Antworttext

Der Berichtinhalt, der einer Berichtsaufgabe entspricht.

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender 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 der 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)

Falls angefordert, die Gesamtwerte der Messwerte.
maximums[]

object (Row)

Falls angefordert, die Maximalwerte von Messwerten.
minimums[]

object (Row)

Falls angefordert, die Mindestwerte von Messwerten.
rowCount

integer

Die Gesamtzahl der Zeilen im Abfrageergebniss.
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, die zusätzliche Informationen zum Inhalt des Berichts enthalten.

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

boolean

Bei „true“ werden einige Gruppen von Dimensionskombinationen in die 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 Beschränkungen im Bericht korrekt ausgefüllt.

Beispielsweise kann die Zeile „Sonstiges“ aus dem Bericht entfernt werden, weil die Anfrage einen Filter für „sessionSource = google“ enthält. Dieser Parameter wird weiterhin ausgefüllt, wenn in den aggregierten Eingabedaten, die zum Generieren dieses Berichts verwendet wurden, ein Datenverlust aus einer anderen Zeile aufgetreten ist.

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. Zur Visualisierung zur Formatierung von Währungsmesswerten wie purchaseRevenue vorgesehen. Wenn in der Anfrage „currencyCode“ angegeben wurde, gibt dieser Antwortparameter den Anfrageparameter wieder. Andernfalls ist der Antwortparameter der aktuelle „currencyCode“ des Attributs.

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

string

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

string

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

boolean

Wenn subjectToThresholding „true“ ist, unterliegt dieser Bericht einem Grenzwert und gibt nur Daten zurück, die die Mindestwerte für die Aggregation erreichen. Es ist möglich, dass für eine Anfrage ein Grenzwert für den Grenzwert gilt und der Bericht keine Daten enthält. Das ist der Fall, wenn alle Daten über den Schwellenwerten liegen. Weitere Informationen finden Sie unter Datengrenzwerte und Informationen zu demografischen Merkmalen 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 beim Erstellen des Berichts werden aktiv erzwungen. purchaseRevenue hat beispielsweise immer den Einschränkungstyp REVENUE_DATA. Diese Einschränkung für aktive Antworten wird jedoch nur gefüllt, wenn die benutzerdefinierte Rolle des Nutzers den Zugriff auf REVENUE_DATA verhindert.

ActiveMetricRestriction

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

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 aufgerufen werden können

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