Method: properties.reportTasks.query

Pobiera zawartość zadania raportu. Po wysłaniu prośby o reportTasks.create możesz pobrać zawartość raportu, gdy jego stan zmieni się na AKTYWNY. Ta metoda zwraca błąd, jeśli stan zadania raportu nie jest ACTIVE. Odpowiedź na zapytanie zwróci wartości wierszy i kolumn raportu w formie tabeli.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Wymagane. Nazwa źródła raportu. Format: properties/{property}/reportTasks/{report}

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "offset": string,
  "limit": string
}
Pola
offset

string (int64 format)

Opcjonalnie. Liczba wierszy w wierszu początkowym w raporcie. Pierwszy wiersz jest liczony jako wiersz 0.

Podczas stronicowania pierwsze żądanie nie określa przesunięcia lub ustawia przesunięcie na 0. Pierwsze żądanie zwraca pierwsze limit wierszy. Drugie żądanie ustawia przesunięcie na limit pierwszego żądania, a drugie żądanie zwraca drugi limit wierszy.

Więcej informacji o tym parametrze stronicowania znajdziesz w sekcji Stronicowanie.
limit

string (int64 format)

Opcjonalnie. Liczba wierszy do zwrócenia z raportu. Jeśli nie określono inaczej, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 tys. wierszy na żądanie,niezależnie od tego, ile wierszy zażądasz. limit musi być liczbą dodatnią.

Interfejs API może też zwracać mniej wierszy niż żądana wartość limit, jeśli nie ma tylu wartości wymiarów, ile wynosi limit. Liczba wierszy dostępnych dla elementu QueryReportTaskRequest jest dodatkowo ograniczona przez limit powiązanego elementu ReportTask. Zapytanie może pobrać maksymalnie ReportTask.limit wierszy. Jeśli np. ReportTask ma limit 1000, żądanie reportTasks.query z parametrami offset=900 i limit=500 zwróci co najwyżej 100 wierszy.

Więcej informacji o tym parametrze stronicowania znajdziesz w sekcji Stronicowanie.

Treść odpowiedzi

Treść raportu odpowiadająca zadaniu raportu.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

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

object (DimensionHeader)

Opisuje kolumny wymiarów. Liczba elementów DimensionHeaders i ich kolejność odpowiadają wymiarom występującym w wierszach.
metricHeaders[]

object (MetricHeader)

Opisuje kolumny danych. Liczba elementów MetricHeaders i ich kolejność odpowiadają rodzajom danych w wierszach.
rows[]

object (Row)

Wiersze z kombinacjami wartości wymiarów i wartościami danych w raporcie.
totals[]

object (Row)

Na żądanie: łączne wartości danych.
maximums[]

object (Row)

W razie potrzeby maksymalne wartości rodzajów danych.
minimums[]

object (Row)

W razie potrzeby minimalne wartości danych.
rowCount

integer

Łączna liczba wierszy w wyniku zapytania.
metadata

object (ResponseMetaData)

Metadane raportu.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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