Method: properties.batchRunReports

Zwraca wiele raportów zbiorczo. Wszystkie raporty muszą dotyczyć tej samej usługi w GA4.

Żądanie HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunReports

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
property

string

Identyfikator usługi w GA4 w Google Analytics, której zdarzenia są śledzone. Jest określona w ścieżce adresu URL, a nie w treści. Więcej informacji znajdziesz w sekcji, gdzie możesz znaleźć identyfikator usługi. Tę właściwość należy określić dla grupy. Właściwość RunReportRequest może być nieokreślona lub zgodna z tą właściwością.

Przykład: properties/1234

Treść żądania

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

Zapis JSON
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
Pola
requests[]

object (RunReportRequest)

Pojedyncze żądania. Każde żądanie wiąże się z osobną odpowiedzią w raporcie. Każde żądanie zbiorcze może zawierać maksymalnie 5 żądań.

Treść odpowiedzi

Odpowiedź zbiorcza zawierająca wiele raportów.

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

Zapis JSON
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
Pola
reports[]

object (RunReportResponse)

Poszczególne odpowiedzi. Każda odpowiedź zawiera osobne żądanie raportu.

kind

string

Określa rodzaj zasobu, do którego należy ten komunikat. Ta wiadomość kind jest zawsze stałym ciągiem znaków „analyticsData#batchRunReports”. Przydaje się do rozróżniania typów odpowiedzi w formacie JSON.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

RunReportRequest

Żądanie wygenerowania raportu.

Zapis JSON
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Pola
property

string

Identyfikator usługi w GA4 w Google Analytics, której zdarzenia są śledzone. Jest określona w ścieżce adresu URL, a nie w treści. Więcej informacji znajdziesz w sekcji, gdzie możesz znaleźć identyfikator usługi. W żądaniu zbiorczym ta właściwość powinna być nieokreślona lub spójna z właściwością na poziomie wsadu.

Przykład: properties/1234

dimensions[]

object (Dimension)

Żądane i wyświetlone wymiary.

metrics[]

object (Metric)

Żądane i wyświetlone wskaźniki.

dateRanges[]

object (DateRange)

Zakresy dat danych do odczytania. Jeśli poprosisz o wiele zakresów dat, każdy wiersz odpowiedzi będzie zawierał indeks zakresu dat liczony od 0. Jeśli 2 zakresy dat się pokrywają, dane zdarzeń z pokrywających się dni znajdą się w wierszach odpowiedzi dla obu zakresów dat. W żądaniu dotyczącym kohorty parametr dateRanges musi być nieokreślony.

dimensionFilter

object (FilterExpression)

Za pomocą filtrów wymiarów możesz poprosić o podawanie w raporcie tylko określonych wartości wymiarów. Aby dowiedzieć się więcej, zapoznaj się z przykładami w artykule Podstawy filtrów wymiarów. W tym filtrze nie można używać danych.

metricFilter

object (FilterExpression)

Klauzula filtra wskaźników. Stosowana po zagregowaniu wierszy raportu, podobnie jak w przypadku klauzuli SQL. W tym filtrze nie można używać wymiarów.

offset

string (int64 format)

Liczba wierszy w wierszu początkowym. 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 zwraca drugie limit wierszy.

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

limit

string (int64 format)

Liczba wierszy do zwrócenia. Jeśli wartość nie jest określona, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 000 wierszy na żądanie. 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. Na przykład w wymiarze country dostępnych jest mniej niż 300 wartości, więc w raportach tylko dla wymiaru country nie uda się uzyskać więcej niż 300 wierszy nawet wtedy, gdy ustawisz w polu limit wyższą wartość.

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

metricAggregations[]

enum (MetricAggregation)

Agregacja danych. Łączne wartości danych będą widoczne w wierszach, w których wymiar wymiar ma wartość „RESERVED_(MetricAggregation)”.

orderBys[]

object (OrderBy)

Określa kolejność wierszy w odpowiedzi.

currencyCode

string

Kod waluty w formacie ISO4217, np. „AED”, „USD” lub „JPY”. Jeśli to pole jest puste, raport używa domyślnej waluty usługi.

cohortSpec

object (CohortSpec)

Grupa kohorty powiązana z tym żądaniem. Jeśli żądanie zawiera grupę kohorty, musi być obecny wymiar „kohorta”.

keepEmptyRows

boolean

Jeśli zasada ma wartość Fałsz lub jest nieokreślona, każdy wiersz ze wszystkimi danymi równymi 0 nie jest zwracany. Jeśli ma wartość true (prawda), te wiersze zostaną zwrócone, jeśli nie zostaną osobno usunięte przez filtr.

Niezależnie od tego ustawienia keepEmptyRows w raporcie mogą być wyświetlane tylko dane zarejestrowane przez usługę w Google Analytics (GA4).

Jeśli np. usługa nigdy nie rejestruje zdarzenia purchase, zapytanie dotyczące wymiaru eventName i danych eventCount nie będzie zawierać wiersza eventName: „purchase” i wyniku eventCount: 0.

returnPropertyQuota

boolean

Określa, czy ma być zwracany bieżący stan limitu tej usługi Analytics. Limit jest zwracany w polu PropertyQuota.