Method: properties.reportTasks.query

Pobiera treść zadania dotyczącego raportu. Po wysłaniu reportTasks.create możesz pobrać treść zgłoszenia, gdy stanie się ono AKTYWNE. Ta metoda zwróci błąd, jeśli stan zadania raportu nie jest ACTIVE. Odpowiedź na zapytanie zwróci wartości wierszy i kolumn raportu w postaci 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.

W przypadku pobierania stron pierwsze żądanie nie określa przesunięcia, czyli jest ustawiane na 0. Pierwsze żądanie zwraca pierwsze limit wierszy. Drugie żądanie ustawia offset na limit pierwszego żądania; zwraca drugi limit wierszy.

Więcej informacji o tym parametrze podziału znajdziesz w sekcji Podział na strony.
limit

string (int64 format)

Opcjonalnie: Liczba wierszy do zwrócenia z raportu. Jeśli nie podasz tej wartości, zwróci się 10 tys. wierszy. Interfejs API zwraca maksymalnie 250 tys. wierszy na żądanie,niezależnie od tego, o ile prosisz. Wartość limit musi być dodatnia.

Interfejs API może też zwrócić mniej wierszy niż żądana liczba limit, jeśli nie ma tylu wartości wymiarów, ile wynosi parametr limit. Liczba wierszy dostępnych dla żądania QueryReportTaskRequest jest dodatkowo ograniczona przez limit powiązanego zadania ReportTask. Zapytanie może zwrócić maksymalnie ReportTask.limit wierszy. Jeśli np. zadanie związane z raportowaniem ma limit 1000, to żądanie reportTasks.query z offsetem=900 i limitem=500 zwróci co najwyżej 100 wierszy.

Więcej informacji o tym parametrze podziału znajdziesz w sekcji Podział na strony.

Treść odpowiedzi

Treść zgłoszenia odpowiadająca zadaniu zgłoszenia.

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 obecnym we wierszach.
metricHeaders[]

object (MetricHeader)

Opisuje kolumny danych. Liczba nagłówków danych i ich kolejność odpowiadają danym w wierszach.
rows[]

object (Row)

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

object (Row)

W razie potrzeby łączne wartości danych.
maximums[]

object (Row)

W razie potrzeby maksymalne wartości 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

ResponseMetaData

Metadane odpowiedzi zawierające dodatkowe informacje o treści raportu.

Zapis JSON 
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Pola
dataLossFromOtherRow

boolean

Jeśli ma wartość true, oznacza, że niektóre grupy kombinacji wymiarów są uwzględniane w wierszu „(inne)”. Może się tak zdarzyć w przypadku raportów o dużej mocy zbioru.

Parametr metadanych dataLossFromOtherRow jest wypełniany na podstawie tabeli danych zbiorczych użytej w raporcie. Parametr zostanie wypełniony prawidłowo niezależnie od filtrów i limitów w raporcie.

Wiersz „(inne)” może zostać pominięty w raporcie, ponieważ prośba zawiera filtr sessionSource = google. Ten parametr będzie nadal wypełniany, jeśli w danych zbiorczych wejściowych użytych do wygenerowania tego raportu wystąpiła utrata danych z innego wiersza.

Więcej informacji znajdziesz w artykule Więcej informacji o wierszu „(inne)” i próbkowaniu danych.
samplingMetadatas[]

object (SamplingMetadata)

Jeśli wyniki tego raportu są próbkowane, określają odsetek zdarzeń użytych w tym raporcie. Dla każdego zakresu dat wypełniana jest jedna kolumna samplingMetadatas. Każdy element samplingMetadatas odpowiada zakresowi dat w kolejności, w jakiej zakresy dat zostały określone w żądaniu.

Jeśli jednak wyniki nie są próbkowane, to pole nie będzie zdefiniowane.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Opisuje ograniczenia schematu aktywnie egzekwowane podczas tworzenia tego raportu. Więcej informacji znajdziesz w artykule [GA4] Zarządzanie dostępem i ograniczeniami dotyczącymi danych.
currencyCode

string

Kod waluty używany w tym raporcie. Służy do formatowania danych o walucie, np. purchaseRevenue, w wizualizacji. Jeśli w żądaniu podano parametr currencyCode, ten parametr odpowiedzi będzie odzwierciedlać parametr żądania. W przeciwnym razie będzie to bieżący kod waluty usługi.

Kody walut to kody łańcuchowe typów walut według standardu ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217), np. „USD”, „EUR”, „JPY”. Więcej informacji znajdziesz na stronie https://support.google.com/analytics/answer/9796179.
timeZone

string

Obecna strefa czasowa obiektu. Służy do interpretacji wymiarów czasowych, np. hour i minute. W formacie ciągów znaków z bazy danych stref czasowych IANA (https://www.iana.org/time-zones), np. „Ameryka/Nowy_York” lub „Azja/Tokio”.
emptyReason

string

Jeśli podano pusty powód, raport jest pusty.
subjectToThresholding

boolean

Jeśli wartość subjectToThresholding to prawda, raport podlega progowaniu i zwraca tylko dane, które spełniają minimalne progi agregacji. Zapytanie może podlegać ograniczeniom związanym z wartościami progowymi i nie zawierać żadnych danych w raporcie. Dzieje się tak, gdy wszystkie dane przekraczają wartości progowe. Więcej informacji znajdziesz w artykułach Wartości progowe danych i Dane demograficzne i zainteresowania.

SchemaRestrictionResponse

Ograniczenia schematu aktywnie egzekwowane podczas tworzenia tego raportu. Więcej informacji znajdziesz w artykule [GA4] Zarządzanie dostępem i ograniczeniami dotyczącymi danych.

Zapis JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Pola
activeMetricRestrictions[]

object (ActiveMetricRestriction)

wszystkie ograniczenia aktywnie egzekwowane podczas tworzenia raportu. Na przykład purchaseRevenue ma zawsze typ ograniczenia REVENUE_DATA. To ograniczenie aktywnej odpowiedzi jest jednak wypełniane tylko wtedy, gdy niestandardowa rola użytkownika nie zezwala na dostęp do REVENUE_DATA.

ActiveMetricRestriction

Dane objęte ograniczeniem podczas tworzenia raportu.

Zapis JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Pola
restrictedMetricTypes[]

enum (RestrictedMetricType)

Uzasadnienie ograniczenia tego rodzaju danych.
metricName

string

Nazwa rodzaju danych z ograniczeniami.

RestrictedMetricType

Kategorie danych, których wyświetlanie może być ograniczone w niektórych usługach w Google Analytics.

Wartości w polu enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED Nieokreślony typ.
COST_DATA Dane o kosztach, np. adCost.
REVENUE_DATA Dane o przychodach, np. purchaseRevenue.