REST Resource: properties.reportTasks

{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}

string

Tylko dane wyjściowe. Identyfikator. Nazwa zasobu zadania raportu przypisana podczas tworzenia. Format: "properties/{property}/reportTasks/{reportTask}"

object (ReportDefinition)

Opcjonalnie: Definicja raportu umożliwiająca pobieranie danych do raportu, która opisuje strukturę raportu. Zwykle zawiera on pola uwzględnione w raporcie i kryteria filtrowania danych.

object (ReportMetadata)

Tylko dane wyjściowe. Metadane raportu związane z konkretnym zadaniem związanym z raportem, które zawierają informacje o raporcie. Zwykle zawiera on te informacje: nazwa zasobu raportu, stan raportu, sygnatura czasowa jego utworzenia itp.

{
  "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
}

object (Dimension)

Opcjonalnie: Żądane i wyświetlane wymiary.

object (Metric)

Opcjonalnie: Dane żądane i wyświetlone.

object (DateRange)

Opcjonalnie: Zakresy dat danych do odczytu. Jeśli zażądasz wielu zakresów dat, każdy wiersz odpowiedzi będzie zawierał indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat się nakładają, dane o zdarzeniach z pokrywających się dni są uwzględniane w wierszach odpowiedzi dotyczących obu zakresów dat. W żądaniu dotyczącym kohorty wartość dateRanges musi być nieokreślona.

object (FilterExpression)

Opcjonalnie: Filtry wymiarów umożliwiają wyświetlenie w raporcie tylko określonych wartości wymiarów. Więcej przykładów znajdziesz w artykule Podstawy filtrów wymiarów. W tym filtrze nie można używać danych.

object (FilterExpression)

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

string (int64 format)

Opcjonalnie: Liczba wierszy wiersza początkowego w Google Analytics Storage. Pierwszy wiersz jest liczony jako wiersz 0.

Podczas tworzenia zadania raportu parametry offset i limit określają podzbiór wierszy danych z miejsca na dane w Google Analytics, które mają być uwzględniane w wygenerowanym raporcie. Jeśli np. w Google Analytics jest łącznie 300 tys. wierszy, pierwsze zadanie raportu może zawierać pierwsze 10 000 wierszy z limitem 10 tys. i przesunięciem wynoszącym 0. Następnie inne zadanie raportowania może obejmować kolejne 10 000 wierszy z limitem 10 000 i przesunięciem 10 000.

string (int64 format)

Opcjonalnie: Liczba wierszy do zwrócenia w raporcie. 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. Wymiar country może mieć np. mniej niż 300 możliwych wartości, więc gdy raportujesz tylko element country, nie możesz uzyskać więcej niż 300 wierszy nawet wtedy, gdy ustawisz wyższą wartość w polu limit.

enum (MetricAggregation)

Opcjonalnie: Agregacja wskaźników. Zagregowane wartości danych będą widoczne w wierszach, w których wymiar wymiarValues ma wartość „RESERVED_(MetricAggregation)”.

object (OrderBy)

Opcjonalnie: Określa kolejność wierszy w odpowiedzi.

string

Opcjonalnie: Kod waluty w formacie ISO4217, np. „AED”, „USD” lub „JPY”. Jeśli to pole jest puste, w raporcie używana jest domyślna waluta usługi.

object (CohortSpec)

Opcjonalnie: Grupa kohort powiązana z tym żądaniem. Jeśli w żądaniu znajduje się grupa kohortowa, „kohorta” wymiar musi być podany.

boolean

Opcjonalnie: Jeśli wartość to fałsz lub nieokreślona wartość, nie zostaną zwrócone żadne wiersze z żadnymi danymi równymi 0. Jeśli tak, wiersze te zostaną zwrócone, jeśli nie zostały usunięte osobno przez filtr.

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

Jeśli np. usługa nigdy nie rejestruje zdarzenia purchase, zapytanie o wymiar eventName i dane eventCount nie będzie zawierać wiersza zawierającego parametr eventName: „purchase” i eventCount: 0.

{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}

string

Nazwa wymiaru. Listę wymiarów obsługiwanych przez podstawowe metody raportowania, np. runReport i batchRunReports, znajdziesz w artykule Wymiary interfejsu API. Lista nazw wymiarów obsługiwanych przez metodę runRealtimeReport znajdziesz w artykule Wymiary w czasie rzeczywistym. Listę nazw wymiarów obsługiwanych przez metodę runFunnelReport znajdziesz w artykule Wymiary ścieżki.

Jeśli parametr dimensionExpression jest określony, name może być dowolnym ciągiem znaków z zakresu dozwolonego zestawu. Jeśli np. wymiar dimensionExpression łączy elementy country i city, możesz nazwać ten wymiar countryAndCity. Wybrane nazwy wymiarów muszą być zgodne z wyrażeniem regularnym ^[a-zA-Z0-9_]$.

Wymiary są przywoływane przez atrybut name w atrybutach dimensionFilter, orderBys, dimensionExpression i pivots.

object (DimensionExpression)

Jeden wymiar może być wynikiem wyrażenia obejmującego kilka wymiarów. np. wymiar „kraj, miasto”: konkatenat(kraj, ", ", miasto).

{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}

object (CaseExpression)

Służy do konwertowania wartości wymiaru na małe litery.

object (CaseExpression)

Służy do konwertowania wartości wymiaru na wielkie litery.

object (ConcatenateExpression)

Służy do łączenia wartości wymiarów w jeden wymiar. np. wymiar „kraj, miasto”: konkatenat(kraj, ", ", miasto).

{
  "dimensionName": string
}

string

Nazwa wymiaru. Nazwa musi odnosić się do nazwy w polu wymiarów żądania.

{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}

string

Nazwy wymiarów. Nazwy muszą odnosić się do nazw podanych w polu wymiarów w żądaniu.

string

Separator umieszczony między nazwami wymiarów.

Ograniczniki to często pojedyncze znaki, np. „|” lub „,” ale mogą też być dłuższe. Jeśli wartość wymiaru zawiera separator, obie występują w odpowiedzi bez rozróżniania. Jeśli np. wartość wymiaru 1 to „PL,FR”, wymiar 2 = „JP”, a separator = „,”, odpowiedź będzie zawierać te ciągi „US,FR,JP”.

{
  "name": string,
  "expression": string,
  "invisible": boolean
}

string

Nazwa danych. Listę nazw danych obsługiwanych przez podstawowe metody raportowania, np. runReport i batchRunReports, znajdziesz w sekcji Dane interfejsu API. Listę nazw danych obsługiwanych przez metodę runRealtimeReport znajdziesz w sekcji Dane w czasie rzeczywistym. Listę nazw danych obsługiwanych przez metodę runFunnelReport znajdziesz w sekcji Dane ścieżki.

Jeśli parametr expression jest określony, name może być dowolnym ciągiem znaków z zakresu dozwolonego zestawu. Jeśli np. expression to screenPageViews/sessions, możesz nazwać nazwę tego rodzaju danych = viewsPerSession. Wybierane nazwy danych muszą być zgodne z wyrażeniem regularnym ^[a-zA-Z0-9_]$.

Do danych odwołują się name w metricFilter, orderBys i danych expression.

string

Wyrażenie matematyczne na derywowane dane. Na przykład dane Liczba zdarzeń na użytkownika wynoszą eventCount/totalUsers.

boolean

Wskazuje, czy dane są niewidoczne w odpowiedzi raportu. Jeśli dane są niewidoczne, nie generują kolumny w odpowiedzi, ale można ich użyć w funkcjach metricFilter, orderBys lub expression.

{
  "startDate": string,
  "endDate": string,
  "name": string
}

string

Uwzględniająca datę rozpoczęcia zapytania w formacie YYYY-MM-DD. Nie może przypadać po endDate. Akceptowany jest też format NdaysAgo, yesterday lub today, w którym data jest ustalana na podstawie strefy czasowej raportowania usługi.

string

Uwzględniająca datę zakończenia zapytania w formacie YYYY-MM-DD. Nie może przypadać przed startDate. Akceptowany jest też format NdaysAgo, yesterday lub today, w którym data jest ustalana na podstawie strefy czasowej raportowania usługi.

string

Powoduje przypisanie nazwy do wybranego zakresu dat. W odpowiedzi raportu wartość wymiaru dateRange jest przypisywana tej nazwie. Jeśli jest ustawiony, nie może zaczynać się od date_range_ ani RESERVED_. Jeśli zasada nie jest skonfigurowana, zakresy dat są nazywane zgodnie z indeksem liczonym w żądaniu (date_range_0, date_range_1 itd.).

{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}

object (FilterExpressionList)

Wyrażenia filtra w grupie andGroup są połączone relacją „AND” (ORAZ).

object (FilterExpressionList)

Argumenty filtra w polu lubGroup są połączone relacją LUB.

object (FilterExpression)

Argument FiltrExpression NIE ma wartości notExpression.

object (Filter)

Filtr podstawowy. W ramach tego samego wyrażenia filtra wszystkie nazwy pól filtra muszą zawierać albo wszystkie wymiary, albo wszystkie dane.

{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}

object (FilterExpression)

Lista wyrażeń filtra.

{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}

string

Nazwa wymiaru lub danych. Musi być nazwą zdefiniowaną w wymiarach lub danych.

object (StringFilter)

Filtr związany z ciągami znaków.

object (InListFilter)

Filtr wartości na liście.

object (NumericFilter)

Filtr wartości liczbowych lub dat.

object (BetweenFilter)

Filtr między 2 wartościami.

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

Typ dopasowania dla tego filtra.

string

Wartość ciągu znaków używana w dopasowaniu.

boolean

Jeśli wartość to prawda, w wartości ciągu znaków wielkość liter ma znaczenie.

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

Lista wartości ciągu znaków. Pole nie może być puste.

boolean

Jeśli wartość to prawda, w wartości ciągu znaków wielkość liter ma znaczenie.

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

Typ operacji dla tego filtra.

object (NumericValue)

Wartość liczbowa lub data.

{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}

string (int64 format)

Wartość w formie liczby całkowitej

number

Podwójna wartość

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

Zaczyna się od tej liczby.

object (NumericValue)

Kończy się tą liczbą.

{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}

boolean

Jeśli ma wartość true (prawda), sortuje w kolejności malejącej.

object (MetricOrderBy)

Sortuje wyniki według wartości danych.

object (DimensionOrderBy)

Sortuje wyniki według wartości wymiaru.

{
  "metricName": string
}

string

Nazwa danych w żądaniu sortowania.

{
  "dimensionName": string,
  "orderType": enum (OrderType)
}

string

Nazwa wymiaru w żądaniu, według którego ma być ustalany kolejność.

enum (OrderType)

Steruje regułą kolejności wartości wymiarów.

{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}

object (Cohort)

Określa kryteria wyboru służące do grupowania użytkowników w kohortach.

Większość raportów dotyczących kohort definiuje tylko jedną kohortę. Jeśli określisz wiele kohort, każda z nich będzie można rozpoznać w raporcie po nazwie.

object (CohortsRange)

Raporty dotyczące kohort obejmują kohorty w rozszerzonym zakresie dat. Ten zakres określa czas przesunięcia, przez który należy śledzić kohorty.

object (CohortReportSettings)

Opcjonalne ustawienia raportu dotyczącego kohorty.

{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}

string

Przypisuje nazwę do tej kohorty. W odpowiedzi raportu wartość wymiaru cohort jest przypisywana tej nazwie. Jeśli jest ustawiony, nie może zaczynać się od cohort_ ani RESERVED_. Jeśli zasada jest nieskonfigurowana, kohorty są nazywane zgodnie z ich indeksem liczonym od zera: cohort_0, cohort_1 itd.

string

Wymiar używany przez kohortę. Wymagany i obsługuje tylko firstSessionDate.

object (DateRange)

Kohorta wybiera użytkowników, których data pierwszego kontaktu przypada między datą rozpoczęcia a datą zakończenia określoną w dateRange. Ta reguła dateRange nie określa pełnego zakresu dat danych zdarzenia, które znajdują się w raporcie dotyczącym kohorty. W raporcie dotyczącym kohorty pole dateRange jest poszerzane o poziom szczegółowości i przesunięcia występujące w raporcie cohortsRange; dane zdarzeń z rozszerzonego zakresu dat raportowania są dostępne w raporcie dotyczącym kohorty.

W żądaniu dotyczącym kohorty ten atrybut dateRange jest wymagany, a element dateRanges w elemencie RunReportRequest lub RunPivotReportRequest musi być nieokreślony.

Ten element dateRange powinien zwykle odpowiadać szczegółowości kohorty. Jeśli CohortsRange używa szczegółowości na poziomie dziennym, wartość w polu dateRange może wynosić 1 dzień. Jeśli funkcja CohortsRange używa szczegółowości tygodniowej, ten element dateRange można wyrównać do granicy tygodnia, zaczynając od niedzieli i kończąc w sobotę. Jeśli w zasadzie CohortsRange używany jest poziom szczegółowości miesięczny, ten element dateRange może zostać wyrównany do miesiąca, począwszy od pierwszego, a kończy w ostatnim dniu miesiąca.

{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}

enum (Granularity)

Wymagane. Szczegółowość używana do interpretacji danych startOffset i endOffset w rozszerzonym zakresie dat raportu dotyczącego kohorty.

integer

startOffset określa datę rozpoczęcia rozszerzonego zakresu dat raportowania w raporcie dotyczącym kohorty. startOffset ma zwykle wartość 0, aby raporty zawierały dane z pozyskania kohorty.

Jeśli granularity to DAILY, startDate w rozszerzonym zakresie dat raportowania to startDate kohorty plus startOffset dni.

Jeśli granularity to WEEKLY, startDate w rozszerzonym zakresie dat raportowania to startDate kohorty plus startOffset * 7 dni.

Jeśli granularity to MONTHLY, startDate w rozszerzonym zakresie dat raportowania to startDate kohorty plus startOffset * 30 dni.

integer

Wymagane. endOffset określa datę zakończenia rozszerzonego zakresu dat raportowania raportu dotyczącego kohorty. Wartość endOffset może być dowolną dodatnią liczbą całkowitą, ale często wynosi od 5 do 10, aby raporty zawierały dane o kohorcie z kilku kolejnych okresów szczegółowości.

Jeśli granularity to DAILY, endDate w rozszerzonym zakresie dat raportowania to endDate kohorty plus endOffset dni.

Jeśli granularity to WEEKLY, endDate w rozszerzonym zakresie dat raportowania to endDate kohorty plus endOffset * 7 dni.

Jeśli granularity to MONTHLY, endDate w rozszerzonym zakresie dat raportowania to endDate kohorty plus endOffset * 30 dni.

{
  "accumulate": boolean
}

boolean

Jeśli ma wartość true (prawda), kumuluje wynik od dnia pierwszego kontaktu do dnia końcowego. Nieobsługiwane w tych krajach: RunReportRequest.

{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}

integer

Tylko dane wyjściowe. Łączna liczba tokenów limitów naliczona podczas tworzenia raportu. Ta liczba tokenów jest określana na podstawie aktywności w stanie CREATING, więc opłata za tokeny zostanie stała, gdy zadanie raportowania przejdzie w stan ACTIVE lub FAILED.

enum (State)

Tylko dane wyjściowe. Bieżący stan tego zadania raportowania.

string (Timestamp format)

Tylko dane wyjściowe. Czas wywołania funkcji reportTasks.create i rozpoczęcia raportu jako stanu CREATING.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

integer

Tylko dane wyjściowe. Łączna liczba wierszy w wyniku raportu. To pole zostanie zapełnione, gdy stan będzie aktywny. taskRowCount możesz używać do podziału na strony w ramach dotychczasowego raportu.

string

Tylko dane wyjściowe. Komunikat o błędzie zostanie wypełniony, jeśli podczas tworzenia zadania raportu nie uda się go utworzyć.

integer

Tylko dane wyjściowe. Łączna liczba wierszy w miejscu na dane w Google Analytics. Jeśli chcesz wysłać zapytanie o dodatkowe wiersze danych poza bieżącym raportem, możesz zainicjować nowe zadanie związane z raportem na podstawie raportu totalRowCount.

Wartość taskRowCount reprezentuje liczbę wierszy, która odnosi się do bieżącego raportu, a totalRowCount – łączną liczbę wierszy we wszystkich danych pobranych z miejsca na dane w Google Analytics.

Załóżmy na przykład, że w bieżącym raporcie taskRowCount widoczna jest wartość 20. Wyświetlamy dane z pierwszych 20 wierszy. Jednocześnie totalRowCount wynosi 30, co wskazuje obecność danych dla wszystkich 30 wierszy. taskRowCount może posłużyć do podziału na strony w pierwszych 20 wierszach. Aby rozwinąć raport i uwzględnić dane ze wszystkich 30 wierszy, można utworzyć nowe zadanie raportu z funkcją totalRowCount w celu uzyskania dostępu do pełnego zestawu 30 wierszy wiele danych.