REST Resource: properties.reportTasks

Zasób: ReportTask

Konkretna konfiguracja zadania raportu.

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

string

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

reportDefinition

object (ReportDefinition)

Opcjonalnie. Definicja raportu służącego do pobierania danych z raportu, która opisuje jego strukturę. Zwykle zawiera pola, które zostaną uwzględnione w raporcie, oraz kryteria, które będą używane do filtrowania danych.

reportMetadata

object (ReportMetadata)

Tylko dane wyjściowe. Metadane raportu dotyczące konkretnego zadania raportowania, które zawierają informacje o raporcie. Zwykle zawierają one te informacje: nazwę zasobu raportu, stan raportu, sygnaturę czasową utworzenia raportu itp.

ReportDefinition

Definicja sposobu generowania raportu.

Zapis JSON
{
  "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
}
Pola
dimensions[]

object (Dimension)

Opcjonalnie. Żądane i wyświetlone wymiary.

metrics[]

object (Metric)

Opcjonalnie. Żądane i wyświetlone wskaźniki.

dateRanges[]

object (DateRange)

Opcjonalnie. Zakresy dat danych do odczytania. Jeśli zażądasz kilku zakresów dat, każdy wiersz odpowiedzi będzie zawierał indeks zakresu dat liczony od zera. 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 pole dateRanges musi być nieokreślone.

dimensionFilter

object (FilterExpression)

Opcjonalnie. Dzięki filtrom wymiarów możesz poprosić o uwzględnienie w raporcie tylko określonych wartości wymiarów. Więcej informacji znajdziesz w artykule Podstawy filtrów wymiarów. W tym filtrze nie można używać danych.

metricFilter

object (FilterExpression)

Opcjonalnie. Klauzula filtra danych. 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)

Opcjonalnie. Liczba wierszy wiersza początkowego z pamięci Google Analytics. Pierwszy wiersz jest liczony jako wiersz 0.

Podczas tworzenia zadania raportu parametry offset i limit określają podzbiór wierszy danych z Google Analytics, które mają zostać uwzględnione w wygenerowanym raporcie. Jeśli np. w pamięci Google Analytics jest łącznie 300 tys. wierszy, pierwsze zadanie raportu może obejmować pierwsze 10 000 wierszy z limitem 10 000 i przesunięciem równym 0. Następnie inne zadanie raportu może obejmować kolejne 10 tys. wierszy z limitem 10 000 i przesunięciem równym 10 000.

limit

string (int64 format)

Opcjonalnie. Liczba wierszy do zwrócenia w raporcie. 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. Na przykład możliwych wartości wymiaru country jest mniej niż 300, więc w raporcie tylko dla wymiaru country nie możesz uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz w polu limit wyższą wartość.

metricAggregations[]

enum (MetricAggregation)

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

orderBys[]

object (OrderBy)

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

currencyCode

string

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

Opcjonalnie. Jeśli wartość fałsz lub nieokreślona, żaden wiersz ze wszystkimi danymi równymi 0 nie zostanie zwrócony. Jeśli ma wartość true (prawda), te wiersze zostaną zwrócone, jeśli nie zostaną usunięte oddzielnie 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 z wartością eventName: „purchase” i identyfikatora eventCount: 0.

Wymiar

Wymiary to atrybuty danych. Na przykład wymiar Miasto wskazuje miasto, z którego pochodzi zdarzenie. Wartości wymiarów w odpowiedziach w raporcie są ciągami tekstowymi, np. miastem może być „Paryż” lub „Nowy Jork”.

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

string

Nazwa wymiaru. Listę nazw wymiarów obsługiwanych przez podstawowe metody raportowania, np. runReport czy batchRunReports, znajdziesz w sekcji Wymiary interfejsu API. Listę 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 sekcji Wymiary ścieżki.

Jeśli określono dimensionExpression, name może być dowolnym ciągiem znaków z dozwolonego zestawu znaków. Jeśli np. zmienna 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 powiązane z wymiarami: name (dimensionFilter, orderBys, dimensionExpression i pivots).

dimensionExpression

object (DimensionExpression)

Jeden wymiar może być wynikiem wyrażenia wielu wymiarów. Na przykład wymiar „kraj, miasto”: concatenate(kraj, ", ", miasto).

DimensionExpression

Służy do wyrażenia wymiaru, który jest wynikiem formuły złożonej z wielu wymiarów. Przykładowe zastosowania: 1) LowCase(wymiar) 2) konkatenacja(wymiar1, symbol, wymiar2).

Zapis JSON
{

  // 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.
}
Pola
Pole sumy one_expression. Określ jeden typ wyrażenia wymiaru dla funkcji DimensionExpression. one_expression może być tylko jedną z tych wartości:
lowerCase

object (CaseExpression)

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

upperCase

object (CaseExpression)

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

concatenate

object (ConcatenateExpression)

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

CaseExpression

Służy do konwertowania wartości wymiaru na jeden przypadek.

Zapis JSON
{
  "dimensionName": string
}
Pola
dimensionName

string

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

ConcatenateExpression

Służy do łączenia wartości wymiarów w jeden wymiar.

Zapis JSON
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Pola
dimensionNames[]

string

Nazwy wymiarów. Nazwy muszą się odwoływać do nazw podanych w polu wymiarów żądania.

delimiter

string

Separator umieszczony między nazwami wymiarów.

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

Wskaźnik

Pomiary ilościowe z raportu. Na przykład dane eventCount to łączna liczba zdarzeń. Żądania mogą obejmować maksymalnie 10 rodzajów danych.

Zapis JSON
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Pola
name

string

Nazwa danych. Listę nazw danych obsługiwanych przez podstawowe metody raportowania, np. runReport czy 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 określono expression, name może być dowolnym ciągiem znaków z dozwolonego zestawu znaków. Jeśli np. expression to screenPageViews/sessions, możesz nazwać tę kategorię danych = viewsPerSession. Wybrane nazwy danych muszą być zgodne z wyrażeniem regularnym ^[a-zA-Z0-9_]$.

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

expression

string

Wyrażenie matematyczne dla wskaźników pochodnych. np. dane Liczba zdarzeń na użytkownika wynoszą eventCount/totalUsers.

invisible

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 tabeli metricFilter lub orderBys lub w danych expression.

DateRange

sąsiadujący zestaw dni: startDate, startDate + 1, ..., endDate; Żądania mogą obejmować maksymalnie 4 zakresy dat.

Zapis JSON
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Pola
startDate

string

Data początkowa zapytania w formacie YYYY-MM-DD. Nie może przypadać po endDate. Akceptowany jest też format NdaysAgo, yesterday lub today. W takim przypadku data jest ustalana na podstawie strefy czasowej raportowania usługi.

endDate

string

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

name

string

Powoduje przypisanie nazwy do tego zakresu dat. Wymiar dateRange otrzymuje tę nazwę w odpowiedzi na raport. Jeśli jest ustawione, nie może zaczynać się od date_range_ ani RESERVED_. Jeśli zakres dat nie jest ustawiony, zakresy dat są nazwane w postaci indeksu liczonego od zera w żądaniu: date_range_0, date_range_1 itd.

FilterExpression

Do wyrażania filtrów wymiarów lub danych. Pola w tym samym obiekcie FilterExpression muszą zawierać wszystkie wymiary lub dane.

Zapis JSON
{

  // 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.
}
Pola
Pole sumy expr. Określ jeden typ wyrażenia filtra dla właściwości FilterExpression. expr może być tylko jedną z tych wartości:
andGroup

object (FilterExpressionList)

Wyrażenie filtrujące w grupie andGroup jest połączone relacją ORAZ.

orGroup

object (FilterExpressionList)

Parametr FiltrExpressions w orGroup jest powiązany z operatorem LUB.

notExpression

object (FilterExpression)

Parametr FilterExpression NIE ma wartości typu notExpression.

filter

object (Filter)

Filtr podstawowy. W ramach tego samego filtra wszystkie nazwy pól filtra muszą być wszystkimi wymiarami lub danymi.

FilterExpressionList

Lista wyrażeń filtra.

Zapis JSON
{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}
Pola
expressions[]

object (FilterExpression)

Lista wyrażeń filtra.

Filtruj

Wyrażenie służące do filtrowania wartości wymiarów lub danych.

Zapis JSON
{
  "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.
}
Pola
fieldName

string

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

Pole sumy one_filter. Określ jeden typ filtra dla elementu Filter. one_filter może być tylko jedną z tych wartości:
stringFilter

object (StringFilter)

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

inListFilter

object (InListFilter)

Filtr wartości na liście.

numericFilter

object (NumericFilter)

Filtr wartości liczbowych lub dat.

betweenFilter

object (BetweenFilter)

Filtr między 2 wartościami.

StringFilter

Filtr ciągu znaków

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

enum (MatchType)

Typ dopasowania dla tego filtra.

value

string

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

caseSensitive

boolean

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

MatchType

typ dopasowania filtra ciągu tekstowego.

Wartości w polu enum
MATCH_TYPE_UNSPECIFIED Brak informacji
EXACT Dokładne dopasowanie wartości ciągu.
BEGINS_WITH Zaczyna się od wartości ciągu znaków.
ENDS_WITH Kończy się wartością ciągu.
CONTAINS Zawiera wartość ciągu znaków.
FULL_REGEXP Pełne dopasowanie wyrażenia regularnego do wartości ciągu znaków.
PARTIAL_REGEXP Dopasowanie częściowe do wyrażenia regularnego z wartością ciągu znaków.

InListFilter

Wynik musi się znajdować na liście wartości ciągu znaków.

Zapis JSON
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Pola
values[]

string

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

caseSensitive

boolean

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

NumericFilter

Filtry dla wartości liczbowych lub daty.

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

enum (Operation)

Typ operacji dla tego filtra.

value

object (NumericValue)

Wartość liczbowa lub data.

Operacja

Operacja zastosowana do filtra liczbowego

Wartości w polu enum
OPERATION_UNSPECIFIED Nie określono.
EQUAL Równa się
LESS_THAN To mniej niż
LESS_THAN_OR_EQUAL Mniejsze lub równe
GREATER_THAN To więcej niż
GREATER_THAN_OR_EQUAL Większe niż lub równe

NumericValue

Do reprezentowania liczby.

Zapis JSON
{

  // 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.
}
Pola
Pole sumy one_value. Jedna z wartości liczbowych one_value może być tylko jedną z tych wartości:
int64Value

string (int64 format)

Wartość w formie liczby całkowitej

doubleValue

number

Podwójna wartość

BetweenFilter

Aby wyrazić, że wynik musi się mieścić w przedziale między dwiema liczbami (włącznie).

Zapis JSON
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Pola
fromValue

object (NumericValue)

Zaczyna się od tej liczby.

toValue

object (NumericValue)

Kończy się na tej wartości.

MetricAggregation

Reprezentuje agregację danych.

Wartości w polu enum
METRIC_AGGREGATION_UNSPECIFIED Nieokreślony operator.
TOTAL SUMA.
MINIMUM Operator minimalnej.
MAXIMUM Operator maksymalny.
COUNT Operator liczenia.

OrderBy

Kolejność według kolejności określa sposób sortowania wierszy w odpowiedzi. Na przykład kolejność wierszy malejąco według liczby zdarzeń to 1 kolejność, a wiersze według ciągu nazwy zdarzenia – mają inną kolejność.

Zapis JSON
{
  "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.
}
Pola
desc

boolean

Jeśli ma wartość true (prawda), sortowanie powoduje sortowanie malejąco.

Pole sumy one_order_by. Określ jeden typ zamówienia dla OrderBy. one_order_by może być tylko jedną z tych wartości:
metric

object (MetricOrderBy)

Sortuje wyniki według wartości danych.

dimension

object (DimensionOrderBy)

Sortuje wyniki według wartości wymiaru.

MetricOrderBy

Sortuje według wartości danych.

Zapis JSON
{
  "metricName": string
}
Pola
metricName

string

Nazwa danych w żądaniu sortowania.

DimensionOrderBy

Sortuje według wartości wymiarów.

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

string

Nazwa wymiaru w żądaniu sortowania.

orderType

enum (OrderType)

Kontroluje regułę kolejności wartości wymiarów.

OrderType

Reguła porządkowania według wartości wymiaru ciągu znaków.

Wartości w polu enum
ORDER_TYPE_UNSPECIFIED Nie określono.
ALPHANUMERIC Sortowanie alfanumeryczne według punktu kodowego Unicode. np. „2” < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC Sortowanie alfanumeryczne według małych liter nie ma znaczenia. np. „2” < "A" < "b" < "X" < "z".
NUMERIC Przed sortowaniem wartości wymiarów są konwertowane na liczby. Na przykład w sortowaniu NUMERYCZNYM, „25” < „100” i w sortowaniu ALPHANUMERIC, „100” < „25”. Wszystkie wartości wymiarów nieliczbowych mają taką samą kolejność poniżej wszystkich wartości liczbowych.

CohortSpec

Specyfikacja kohort w raporcie dotyczącym kohorty.

Raporty dotyczące kohorty tworzą serię czasową utrzymania użytkowników w kohorcie. Możesz np. wybrać kohortę użytkowników pozyskanych w pierwszym tygodniu września i śledzić tę kohortę przez kolejne 6 tygodni. Wybór użytkowników pozyskanych w pierwszym tygodniu września jest określony w obiekcie cohort. Kohorta na kolejne 6 tygodni jest określona w obiekcie cohortsRange.

Przykłady znajdziesz w artykule Przykłady raportów dotyczących kohorty.

Odpowiedź w raporcie może zawierać cotygodniowy ciąg czasowy, w którym aplikacja utrzymała 60% tej kohorty po 3 tygodniach i 25% tej kohorty po 6 tygodniach. Te 2 wartości procentowe mogą być obliczane według danych cohortActiveUsers/cohortTotalUsers i znajdują się w oddzielnych wierszach raportu.

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

object (Cohort)

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

Większość raportów dotyczących kohorty definiuje tylko jedną kohortę. Jeśli określisz wiele kohort, każda z nich zostanie rozpoznana w raporcie po jej nazwie.

cohortsRange

object (CohortsRange)

Raporty dotyczące kohorty uwzględniają kohorty w rozszerzonym zakresie dat. Ten zakres określa czas przesunięcia, aby śledzić kohorty.

cohortReportSettings

object (CohortReportSettings)

Opcjonalne ustawienia raportu dotyczącego kohorty.

Kohorta

Określa kryteria wyboru kohorty. Kohorta to grupa użytkowników, którzy mają wspólną cechę. Na przykład użytkownicy z takim samym atrybutem firstSessionDate należą do tej samej kohorty.

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

string

Przypisuje nazwę do tej kohorty. Wymiar cohort otrzymuje tę nazwę w odpowiedzi na raport. Jeśli jest ustawione, nie może zaczynać się od cohort_ ani RESERVED_. Jeśli nie jest ustawiony, kohorty są nazwane według indeksu zerowego cohort_0, cohort_1 itd.

dimension

string

Wymiar używany przez kohortę. Wymagana i obsługiwana tylko w przypadku języka firstSessionDate.

dateRange

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 wartość dateRange nie określa pełnego zakresu dat danych zdarzenia zawartych w raporcie dotyczącym kohorty. W raporcie dotyczącym kohorty wartość dateRange jest rozszerzona o stopień szczegółowości i przesunięcie występujące w kolumnie cohortsRange. Dane zdarzeń z rozszerzonego zakresu dat raportowania są dostępne w raporcie dotyczącym kohorty.

W żądaniu dotyczącym kohorty pole dateRange jest wymagane, a pole dateRanges w RunReportRequest lub RunPivotReportRequest musi być nieokreślone.

Ten parametr dateRange powinien być zwykle dopasowany do szczegółowości kohorty. Jeśli CohortsRange używa szczegółowości dziennie, dateRange może oznaczać 1 dzień. Jeśli funkcja CohortsRange używa szczegółowości tygodniowej, ten parametr dateRange można wyrównać do granicy tygodnia, zaczynając od niedzieli i kończąc w sobotę. Jeśli funkcja CohortsRange używa szczegółowości miesięcznej, wartość dateRange można wyrównać do miesiąca, zaczynając od pierwszego do ostatniego dnia miesiąca.

CohortsRange

Konfiguruje rozszerzony zakres dat w raporcie dotyczącym kohorty. Określa czas przesunięcia, aby śledzić kohorty.

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

enum (Granularity)

Wymagane. Szczegółowość używana do interpretacji startOffset i endOffset w rozszerzonym zakresie dat raportowania w raporcie dotyczącym kohorty.

startOffset

integer

startOffset określa datę rozpoczęcia rozszerzonego zakresu dat raportowania na potrzeby raportu dotyczącego kohorty. startOffset ma zwykle wartość 0, aby raporty zawierały dane dotyczące pozyskania kohorty w przyszłości.

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

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

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

endOffset

integer

Wymagane. endOffset określa datę zakończenia rozszerzonego zakresu dat w raporcie dotyczącym kohorty. endOffset może być dowolną dodatnią liczbą całkowitą, ale zwykle jest ustawiona na 5–10, aby raporty zawierały dane o kohorcie z kilku kolejnych okresów szczegółowości.

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

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

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

Szczegółowość

Szczegółowość używana do interpretacji startOffset i endOffset w rozszerzonym zakresie dat raportowania w raporcie dotyczącym kohorty.

Wartości w polu enum
GRANULARITY_UNSPECIFIED Nigdy nie należy określać.
DAILY Szczegółowość dzienna. Zwykle używana, jeśli dateRange kohorty to 1 dzień, a żądanie zawiera cohortNthDay.
WEEKLY Szczegółowość tygodniowa. Zwykle używany, jeśli dateRange kohorty obejmuje tydzień (rozpoczynający się w niedzielę, a kończący w sobotę) i żądanie zawiera wartość cohortNthWeek.
MONTHLY Szczegółowość miesięczna. Zwykle używana, jeśli dateRange kohorty trwa miesiąc, a żądanie zawiera cohortNthMonth.

CohortReportSettings

Opcjonalne ustawienia raportu dotyczącego kohorty.

Zapis JSON
{
  "accumulate": boolean
}
Pola
accumulate

boolean

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

ReportMetadata

Metadane raportu związane z konkretnym zadaniem w raporcie.

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

integer

Tylko dane wyjściowe. Łączna liczba tokenów limitu opłaconych podczas tworzenia raportu. Ta liczba tokenów jest uzależniona od aktywności ze stanu CREATING, dlatego opłata za tokeny zostanie ustalona, gdy zadanie raportowania wejdzie w stan ACTIVE lub FAILED.

state

enum (State)

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

beginCreatingTime

string (Timestamp format)

Tylko dane wyjściowe. Godzina wywołania funkcji reportTasks.create i początku stanu CREATING.

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

taskRowCount

integer

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

errorMessage

string

Tylko dane wyjściowe. Jeśli podczas tworzenia zadania raportu nie uda się wykonać zadania raportu, pojawi się komunikat o błędzie.

totalRowCount

integer

Tylko dane wyjściowe. Łączna liczba wierszy zapisanych na koncie Google Analytics. Jeśli chcesz wysłać zapytanie do dodatkowych wierszy danych poza bieżącym raportem, mogą one zainicjować nowe zadanie raportu na podstawie parametru totalRowCount.

taskRowCount reprezentuje liczbę wierszy konkretnie dla bieżącego raportu, a totalRowCount – łączną liczbę wierszy ze wszystkimi danymi pobranymi z pamięci Google Analytics.

Załóżmy np., że w bieżącym raporcie wartość taskRowCount to 20, a wyświetlane są dane z pierwszych 20 wierszy. Jednocześnie totalRowCount wynosi 30, co wskazuje na obecność danych we wszystkich 30 wierszach. taskRowCount można użyć do podziału na strony przez pierwsze 20 wierszy. Aby rozwinąć raport i uwzględnić dane ze wszystkich 30 wierszy, możesz utworzyć nowe zadanie raportu, używając parametru totalRowCount, co zapewnia dostęp do pełnego zestawu danych obejmujących 30 wierszy.

Stan

Stan przetwarzania.

Wartości w polu enum
STATE_UNSPECIFIED Nieokreślony stan nigdy nie będzie używany.
CREATING Obecnie trwa tworzenie raportu i będzie on dostępny w przyszłości. Tworzenie następuje bezpośrednio po wywołaniu CreateReport.
ACTIVE Raport jest w pełni utworzony i można do niego wysyłać zapytania.
FAILED Nie udało się utworzyć raportu.

Metody

create

Inicjuje tworzenie zadania związanego z raportem.

get

Pobiera metadane raportu dotyczące określonego zadania związanego z raportem.

list

Wyświetla listę wszystkich zadań związanych z raportowaniem w danej usłudze.

query

Pobiera treść zadania raportu.