Method: properties.reportTasks.query

Pobiera treść zadania raportu. Po wysłaniu żądania reportTasks.create możesz pobrać treść raportu, gdy stanie się on AKTYWNY. Ta metoda zwróci błąd, jeśli zadanie raportu ma stan inny niż ACTIVE. Odpowiedź na zapytanie zwróci wartości wiersza i kolumny raportu przedstawione w 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 początkowym wierszu raportu. Pierwszy wiersz jest liczony jako wiersz 0.

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

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

string (int64 format)

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

Interfejs API może też zwrócić mniej wierszy niż w żądaniu limit, jeśli nie ma tylu wartości wymiarów co limit. Liczba wierszy dostępnych dla zapytania QueryReportTaskRequest jest dodatkowo ograniczona przez limit powiązanego zadania ReportTask. Zapytanie może pobrać nie więcej wierszy ReportTask.limit. Jeśli np. zadanie ReportTask ma limit 1000 znaków, żądanie reportTasks.query z kompensacją wartości kompens=900 i limit=500 zwróci maksymalnie 100 wierszy.

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

Treść odpowiedzi

Treść raportu odpowiadająca zadaniu w postaci 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 nagłówków wymiarów i ich kolejność są zgodne z wymiarami podanymi w wierszach.
metricHeaders[]

object (MetricHeader)

Opisuje kolumny danych. Liczba i kolejność nagłówków MetricHeaders są zgodne z danymi w wierszach.
rows[]

object (Row)

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

object (Row)

Zsumowane wartości danych (w razie potrzeby).
maximums[]

object (Row)

Maksymalne wartości danych, jeśli jest to wymagane.
minimums[]

object (Row)

Minimalne wartości danych, jeśli są wymagane.
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 z dodatkowymi informacjami o treści raportu.

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

boolean

Jeśli wartość to prawda, wskazuje, że niektóre grupy kombinacji wymiarów zostały umieszczone 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żywanej w raporcie. Parametr zostanie wypełniony dokładnie niezależnie od filtrów i limitów w raporcie.

Na przykład wiersz „(inne)” może zostać usunięty z raportu, ponieważ żądanie zawiera filtr sessionSource = google. Ten parametr będzie nadal wypełniany, jeśli w danych zbiorczych użytych do wygenerowania tego raportu wykryto utratę danych z innego wiersza.

Więcej informacji znajdziesz w artykule Wiersz „(inne)” i próbkowanie danych.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

string

Kod waluty używany w tym raporcie. Przeznaczona do formatowania danych walutowych, takich jak purchaseRevenue, w celu wizualizacji. Jeśli w żądaniu określono parametr currencyCode, ten parametr odpowiedzi będzie odczytywany z parametrem żądania. W przeciwnym razie będzie to bieżący parametr currencyCode usługi.

Kody walut to zakodowane ciągi znaków określające typy walut zgodne ze standardem ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217), takie jak „PLN”, „EUR”, „JPY”. Więcej informacji znajdziesz na stronie https://support.google.com/analytics/answer/9796179.
timeZone

string

Bieżąca strefa czasowa usługi. Służy do interpretacji wymiarów opartych na czasie, np. hour i minute. Formatowany jako ciągi znaków z bazy danych strefy czasowej IANA (https://www.iana.org/time-zones), np. „Ameryka/Nowy_Jork” lub „Azja/Tokio”.
emptyReason

string

Jeśli podasz pustą przyczynę, raport będzie z tego powodu pusty.
subjectToThresholding

boolean

Jeśli subjectToThresholding ma wartość prawda, ten raport podlega progu agregacji i zwraca tylko te dane, które spełniają minimalne progi agregacji. Może się zdarzyć, że prośba zostanie poddana przekroczeniu progów i w raporcie nie brakuje żadnych danych. Dzieje się tak, gdy wszystkie dane przekraczają wartości progowe. Więcej informacji znajdziesz w artykułach Wartości progowe zbierania danych oraz Dane demograficzne i Zainteresowania.

SchemaRestrictionResponse

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

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

object (ActiveMetricRestriction)

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

ActiveMetricRestriction

Dane, w przypadku których tworzenie raportu jest aktywnie ograniczone.

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

enum (RestrictedMetricType)

Przyczyna ograniczenia tych danych.
metricName

string

Nazwa danych objętych ograniczeniami.

RestrictedMetricType

Kategorie danych, których możesz nie widzieć w niektórych usługach w GA4.

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.