Method: properties.reportTasks.query

Ruft den Inhalt einer Berichtsaufgabe ab. Nachdem Sie reportTasks.create angefordert haben, können Sie den Berichtsinhalt abrufen, sobald der Bericht den Status „AKTIV“ hat. 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 Zeilennummer der Startzeile im Bericht. Die erste Zeile wird als Zeile 0 gezählt.

Bei der Paginierung wird im ersten Antrag kein Offset angegeben oder das Offset wird auf 0 gesetzt. Der erste Antrag gibt die ersten limit Zeilen zurück. Im zweiten Antrag wird das Offset auf den limit-Wert des ersten Antrags gesetzt. Der zweite Antrag gibt die zweiten limit 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 Sie anfordern. limit muss positiv sein.

Die API kann auch weniger Zeilen als der angeforderte limit-Wert zurückgeben, wenn es nicht so viele Dimensionswerte wie der limit-Wert gibt. Die Anzahl der Zeilen, die für eine QueryReportTaskRequest verfügbar sind, ist durch den Grenzwert der zugehörigen ReportTask weiter begrenzt. Eine Abfrage kann maximal ReportTask.limit Zeilen abrufen. Wenn die ReportTask beispielsweise einen Grenzwert von 1.000 hat, gibt eine reportTasks.query-Anfrage mit offset=900 und limit=500 maximal 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 und Reihenfolge der DimensionHeaders entspricht den Dimensionen in den Zeilen.
metricHeaders[]

object (MetricHeader)

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

object (Row)

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

object (Row)

Falls angefordert, die Summen der Messwerte.
maximums[]

object (Row)

Falls angefordert, die Höchstwerte der Messwerte.
minimums[]

object (Row)

Falls 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