Method: properties.reportTasks.query

Pobiera treść zadania raportu. Po przesłaniu prośby o reportTasks.create możesz pobrać treść zgłoszenia, gdy stanie się ono AKTYWNE. Ta metoda zwróci błąd, jeśli stan zadania raportowania nie jest wartością ACTIVE. Odpowiedź na zapytanie zwróci wiersz tabelaryczny & wartości kolumn raportu.

Żą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 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 wartość limit pierwszego żądania. drugie żądanie zwróci drugi limit wierszy.

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

string (int64 format)

Opcjonalnie: Liczba wierszy do zwrócenia z raportu. Jeśli wartość nie jest określona, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 000 wierszy na żądanie bez względu na to, o ile prosisz. Wartość limit musi być liczbą dodatnią.

Interfejs API może też zwrócić mniej wierszy niż żądane limit, jeśli nie ma tylu wartości wymiarów, co w polu limit. Liczba wierszy dostępnych dla QueryReportTaskRequest jest dodatkowo ograniczona przez limit powiązanego zadania ReportTask. Zapytanie może pobrać maksymalnie wiersze(y) ReportTask.limit. Jeśli na przykład zadanie ReportTask ma limit 1000 wierszy, żądanie reportTasks.query z przesunięciem=900 i limit=500 zwróci maksymalnie 100 wierszy.

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

Treść odpowiedzi

Zawartość raportu odpowiadająca zadaniu związanemu z raportowaniem.

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 DimensionsHeaders i kolejność nagłówków Wymiarów jest zgodna z wymiarami w wierszach.
metricHeaders[]

object (MetricHeader)

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

object (Row)

Wiersze kombinacji wartości wymiarów i wartości danych w raporcie.
totals[]

object (Row)

Łączne wartości danych, jeśli są wymagane.
maximums[]

object (Row)

Maksymalne wartości danych, jeśli są 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 protokołu OAuth:

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

ResponseMetaData

Metadane odpowiedzi zawierające dodatkowe informacje o zawartości zgłoszenia.

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

boolean

Jeśli wartość to prawda, niektóre grupy kombinacji wymiarów są umieszczane w grupie „(inne)” . Może się tak zdarzyć w przypadku raportów o dużej mocy zbioru.

Wartość parametru metadanych dataLossFromOtherRow jest wypełniana na podstawie tabeli danych zbiorczych używanej w raporcie. Ten parametr będzie prawidłowo wypełniany 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 wejściowych danych zbiorczych używanych do wygenerowania tego raportu występowała utrata 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. Służy do formatowania danych związanych z walutą, np. purchaseRevenue, na potrzeby wizualizacji. Jeśli w żądaniu określono kod currencyCode, ten parametr odpowiedzi powtórzy parametr żądania. W przeciwnym razie parametr odpowiedzi to bieżący kod waluty usługi.

Kody walut to kody walutowe zgodne ze standardem ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217). na przykład „USD”, „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 interpretowania wymiarów czasowych, np. hour i minute. Sformatowane jako ciągi znaków z bazy danych stref czasowych IANA (https://www.iana.org/time-zones). na przykład „Ameryka/Nowy_Jork”. lub „Azja/Tokio”.
emptyReason

string

Jeśli podasz pusty powód, raport z tego powodu będzie pusty.
subjectToThresholding

boolean

Jeśli subjectToThresholding ma wartość prawda, ten raport podlega ograniczeniom progowym i zwraca tylko dane, które spełniają minimalne wymagania agregacji. Może się zdarzyć, że żądanie będzie podlegać wymaganiom progowym, a w raporcie nie będzie brakowało – 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 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 aktywnych odpowiedzi jest jednak wypełniane tylko wtedy, gdy niestandardowa rola użytkownika uniemożliwia dostęp do funkcji REVENUE_DATA.

ActiveMetricRestriction

Dane, których tworzenie w raporcie jest aktywnie ograniczone.

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

enum (RestrictedMetricType)

Przyczyna nałożenia ograniczeń na te dane.
metricName

string

Nazwa danych objętych ograniczeniami.

RestrictedMetricType

Kategorie danych, których wyświetlanie możesz nie mieć w niektórych usługach 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.