REST Resource: properties.reportTasks

Zasób: ReportTask

Konfiguracja konkretnego zadania dotyczącego 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żąca do pobierania danych raportu, która opisuje strukturę raportu. Zwykle zawiera on pola uwzględnione w raporcie i kryteria filtrowania danych.

reportMetadata

object (ReportMetadata)

Tylko dane wyjściowe. Metadane raportu dotyczące konkretnego zadania związanego z raportami, które zawierają informacje o raporcie. Zwykle zawiera te informacje: nazwę zasobu raportu, stan raportu, sygnaturę czasową jego utworzenia 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,
  "samplingLevel": enum (SamplingLevel)
}
Pola
dimensions[]

object (Dimension)

Opcjonalnie: Wymiary żądane i wyświetlane.

metrics[]

object (Metric)

Opcjonalnie: Dane, które mają być wyświetlane.

dateRanges[]

object (DateRange)

Opcjonalnie: Zakresy dat danych do odczytu. Jeśli zostanie podany zakres dat, każdy wiersz odpowiedzi będzie zawierać indeks zakresu dat oparty na 0. Jeśli 2 zakresy dat się pokrywają, dane o zdarzeniach z nachodzących na siebie dni są uwzględniane w wierszach odpowiedzi dla obu zakresów dat. W żądaniu dotyczącym kohorty wartość dateRanges musi być nieokreślona.

dimensionFilter

object (FilterExpression)

Opcjonalnie: Filtry wymiarów umożliwiają wyświetlanie 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.

metricFilter

object (FilterExpression)

Opcjonalnie: Klauzula filtra danych. Jest 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 w wierszu początkowym z magazynu danych Google Analytics. 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 magazynie Google Analytics jest łącznie 300 tys. wierszy, zadanie początkowego raportu może zawierać pierwsze 10 tys. wierszy z limitem 10 tys. i przesunięciem 0. Kolejne zadanie raportu może obejmować kolejne 10 tys. wierszy z limitem 10 tys. i przesunięciem 10 tys.

limit

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 tys. wierszy na żądanie,niezależnie od tego, ile ich potrzebujesz. Wartość limit musi być dodatnia.

Interfejs API może też zwrócić mniej wierszy niż żądana liczba limit, jeśli nie ma tylu wartości wymiarów, co limit. Na przykład w przypadku wymiaru country jest mniej niż 300 możliwych wartości, więc w raportach dotyczących tylko wymiaru country nie możesz uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz większą wartość dla wymiaru limit.

metricAggregations[]

enum (MetricAggregation)

Opcjonalnie: Agregacja danych. Uwzględnione wartości danych będą wyświetlane w wierszach, w których wartości wymiarów mają ustawienie „RESERVED_(MetricAggregation)”.

orderBys[]

object (OrderBy)

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

currencyCode

string

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

cohortSpec

object (CohortSpec)

Opcjonalnie: Grupa kohorty powiązana z tym żądaniem. Jeśli w żądaniu występuje grupa kohorty, musi być podany wymiar „cohorta”.

keepEmptyRows

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 to pole ma wartość Prawda, zwrócone zostaną te wiersze, które nie zostały usunięte przez filtr.

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

Jeśli np. usługa nigdy nie rejestruje zdarzenia purchase, zapytanie o wymiar eventName i dane eventCount nie będzie zawierać wiersza z wartością eventName = „purchase” (zakup) i eventCount = 0.

samplingLevel

enum (SamplingLevel)

Opcjonalnie: Poziom próbkowania raportu.

Wymiar

Wymiary to atrybuty danych. Na przykład wymiar Miasto określa miasto, z którego pochodzi zdarzenie. Wartościami wymiarów w odpowiedziach na raport są ciągi tekstowe, np. „Paryż” lub „Nowy Jork”.

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

string

Nazwa wymiaru. Lista nazw wymiarów obsługiwanych przez podstawowe metody raportowania, takie jak runReportbatchRunReports, znajduje się w artykule Wymiary 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 sekcji 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. dimensionExpression łączy countrycity, 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.

dimensionExpression

object (DimensionExpression)

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

DimensionExpression

Służy do wyrażenia wymiaru, który jest wynikiem formuły zawierającej wiele wymiarów. Przykładowe zastosowania: 1) małe litery(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 unii one_expression. Określ 1 typ wyrażenia wymiaru na potrzeby elementu DimensionExpression. one_expression może być tylko jednym z tych elementów:
lowerCase

object (CaseExpression)

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

upperCase

object (CaseExpression)

Służy do zamiany wartości wymiaru na wielką literę.

concatenate

object (ConcatenateExpression)

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

CaseExpression

Służy do konwertowania wartości wymiaru na wielkość pojedynczą.

Zapis JSON
{
  "dimensionName": string
}
Pola
dimensionName

string

Nazwa wymiaru. Nazwa musi się odnosić 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ę odnosić do nazw w polu „Wymiary” żądania.

delimiter

string

Separator umieszczony między nazwami wymiarów.

Separatory są często pojedynczymi znakami, takimi jak „|”, „|”, ale mogą być dłuższymi ciągami. Jeśli wartość wymiaru zawiera separator, w odpowiedzi będą obecne oba znaki bez żadnej różnicy. Jeśli np. wartość wymiaru 1 = „US,FR”, wartość wymiaru 2 = „JP”, a rozdzielacz = „,”, odpowiedź będzie zawierać ciąg „US,FR,JP”.

Dane

Ilościowe pomiary w raporcie. Na przykład dane eventCount to łączna liczba zdarzeń. W żądaniu można podać maksymalnie 10 danych.

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

string

Nazwa rodzaju danych. Listę nazw danych obsługiwanych przez podstawowe metody raportowania, np. runReport i batchRunReports, znajdziesz w sekcji Dane interfejsu API. Aby zobaczyć listę nazw danych obsługiwanych przez metodę runRealtimeReport, zapoznaj się z artykułem Dane w czasie rzeczywistym. Listę nazw danych obsługiwanych przez metodę runFunnelReport znajdziesz w sekcji Dane ścieżki.

Jeśli określono parametr expression, parametr name może zawierać dowolny ciąg znaków z dozwolonego zestawu znaków. Jeśli np. expression to screenPageViews/sessions, możesz nazwać te dane „= viewsPerSession”. Wybrane nazwy danych muszą być zgodne z wyrażeniem regularnym ^[a-zA-Z0-9_]$.

Dane są odwoływane za pomocą parametru name w definicjach metricFilterorderBys oraz w danych expression.

expression

string

Wyrażenie matematyczne danych pochodnych. Na przykład dane Liczba zdarzeń na użytkownika to eventCount/totalUsers.

invisible

boolean

Wskazuje, czy dane są niewidoczne w odpowiedzi na raport. Jeśli dane są niewidoczne, nie będą generować kolumny w odpowiedzi, ale można ich używać w elementach metricFilter, orderBys lub danych expression.

Zakres dat

ciągły zbiór dni: startDate, startDate + 1, …, endDate. W prośbach można podać maksymalnie 4 zakresy dat.

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

string

Data rozpoczęcia zapytania w formacie YYYY-MM-DD. Nie może być późniejsza niż endDate. Akceptowany jest też format NdaysAgo, yesterday lub today, w którym data jest ustalana na podstawie strefy czasowej raportowania usługi.

endDate

string

Data zakończenia zapytania w tym sensie, że jest uwzględniona w tym dniu (format YYYY-MM-DD). Nie może przypadać przed startDate. Akceptowany jest też format NdaysAgo, yesterday lub today. W takim przypadku data jest określana na podstawie strefy czasowej usługi.

name

string

Przypisuje nazwę do tego zakresu dat. Wymiar dateRange ma w odpowiedzi na raport tę nazwę. Jeśli jest ustawiony, nie może zaczynać się od date_range_ ani RESERVED_. Jeśli nie są ustawione, zakresy dat są nazywane w żądaniu według indeksu opartego na 0: date_range_0, date_range_1 itd.

FilterExpression

Aby wyrazić filtry wymiarów lub danych. Pola w ramach tego samego wyrażenia filtra 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 unii expr. W przypadku FilterExpression określ jeden typ wyrażenia filtra. expr może być tylko jednym z tych elementów:
andGroup

object (FilterExpressionList)

Wyrażenia filtra w grupie AND są ze sobą powiązane operatorem ORAZ.

orGroup

object (FilterExpressionList)

Wyrażenia filtra w grupie OR są powiązane relacją LUB.

notExpression

object (FilterExpression)

Wyrażenie filtra NIE jest wyrażeniem nie.

filter

object (Filter)

Filtr podstawowy. W tym samym wyrażeniu filtra wszystkie nazwy pól filtra muszą być albo wszystkimi wymiarami, albo wszystkimi rodzajami danych.

FilterExpressionList

Lista wyrażeń filtra.

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

object (FilterExpression)

Lista wyrażeń filtra.

Filtr

Wyrażenie 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 to być nazwa zdefiniowana w wymiarach lub danych.

Pole unii one_filter. Określ 1 typ filtra dla: Filter. one_filter może być tylko jednym z tych elementów:
stringFilter

object (StringFilter)

Filtr powiązany z ciągiem znaków.

inListFilter

object (InListFilter)

Filtr według wartości w 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 tego filtra.

value

string

Wartość ciągu używana do dopasowywania.

caseSensitive

boolean

Jeśli ma wartość true, wielkość liter w ciągu znaków jest rozróżniana.

MatchType

Typ dopasowania filtra ciągu znaków

Wartości w polu enum
MATCH_TYPE_UNSPECIFIED Nie określono
EXACT Dopasowanie ścisłe wartości ciągu znaków.
BEGINS_WITH zaczyna się od ciągu znaków;
ENDS_WITH Kończy się wartością ciągu znaków.
CONTAINS Zawiera wartość ciągu znaków.
FULL_REGEXP Dopasowanie dokładne wyrażenia regularnego do wartości ciągu znaków.
PARTIAL_REGEXP Dopasowanie częściowe wyrażenia regularnego do wartości ciągu znaków.

InListFilter

Wynik musi być listą wartości ciągu znaków.

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

string

Lista wartości ciągu tekstowego. Nie może być puste.

caseSensitive

boolean

Jeśli ma wartość true, wielkość liter w ciągu znaków jest rozróżniana.

NumericFilter

Filtry według wartości liczbowych lub dat.

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

enum (Operation)

Typ operacji dla tego filtra.

value

object (NumericValue)

Wartość liczbowa lub wartość daty.

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 unii one_value. Wartość liczbowa one_value może mieć 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 mieścić się między dwoma liczbami (włącznie).

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

object (NumericValue)

zaczyna się od tego numeru;

toValue

object (NumericValue)

Kończy się na tym numerze.

MetricAggregation

Reprezentują one agregację danych.

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

OrderBy

Sortowanie określa sposób sortowania wierszy w odpowiedzi. Na przykład sortowanie wierszy według malejącej liczby zdarzeń to jedno uporządkowanie, a sortowanie według ciągu znaków nazwy zdarzenia to inne uporządkowanie.

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), sortuje w kolejności malejącej.

Pole unii one_order_by. Określ jeden typ sortowania w przypadku kolumny OrderBy. one_order_by może być tylko jednym z tych elementów:
metric

object (MetricOrderBy)

Sortuje wyniki według wartości danych.

dimension

object (DimensionOrderBy)

Sortuje wyniki według wartości wymiaru.

MetricOrderBy

Sortuje dane według wartości.

Zapis JSON
{
  "metricName": string
}
Pola
metricName

string

Nazwa danych w prośbie, według których mają być one posortowane.

DimensionOrderBy

Sortuje dane według wartości wymiarów.

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

string

Nazwa wymiaru w pytaniu, według którego mają być sortowane dane.

orderType

enum (OrderType)

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

OrderType

Reguła służąca do sortowania 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. Na przykład „2” < „A” < „X” < „b” < „z”.
CASE_INSENSITIVE_ALPHANUMERIC Sortowanie alfanumeryczne bez uwzględniania wielkości liter według punktu kodowego Unicode w małej literze. Na przykład „2” < „A” < „b” < „X” < „z”.
NUMERIC Wartości wymiarów są konwertowane na liczby przed posortowaniem. Na przykład w sortowaniu NUMERYCZNYM „25” < „100”, a w sortowaniu ARYTMETYCZNYM „100” < „25”.ALPHANUMERIC Wartości wymiarów niebędących liczbami mają tę samą wartość sortowania niż wszystkie wartości liczbowe.

CohortSpec

Specyfikacja kohort na potrzeby raportu dotyczącego kohorty.

Raporty kohortowe tworzą serię czasową danych o utrzymaniu użytkowników w kohortach. Możesz na przykład wybrać grupę użytkowników pozyskanych w pierwszym tygodniu września i śledzić ją przez kolejne 6 tygodni. Wybór użytkowników pozyskanych w pierwszym tygodniu września jest określony w obiekcie cohort. Dane o tych grupach na kolejne 6 tygodni są podawane w obiekcie cohortsRange.

Przykłady znajdziesz w artykule Przykłady raportu dotyczącego kohorty.

Odpowiedź w raporcie może wskazywać tygodniowy ciąg czasowy, w którym Twoja aplikacja utrzymała 60% z tej kohorty po 3 tygodniach, a 25% – po 6 tygodniach. Te 2 wartości procentowe można obliczyć na podstawie danych cohortActiveUsers/cohortTotalUsers i będą one widoczne w raporcie w oddzielnych wierszach.

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 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.

cohortsRange

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.

cohortReportSettings

object (CohortReportSettings)

Opcjonalne ustawienia raportu dotyczącego kohorty.

Kohorta

Określa kryteria wyboru kohorty. Kohorta jest grupą użytkowników mających wspólną cechę. Na przykład użytkownicy z tym samym firstSessionDate należą do tej samej kohorty.

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

string

Przypisuje nazwę tej kohorcie. Wymiar cohort ma w odpowiedzi na raport tę nazwę. Jeśli jest ustawiony, nie może zaczynać się od cohort_ ani RESERVED_. Jeśli nie zostanie ustawiony, kohorty będą nazywane według indeksu o wartości 0, cohort_0, cohort_1 itd.

dimension

string

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

dateRange

object (DateRange)

Kohorta wybiera użytkowników, których data pierwszego kontaktu mieści się w zakresie daty rozpoczęcia i zakończenia zdefiniowanych w dateRange. W tym dateRange nie jest podany pełny zakres dat danych o zdarzeniach, które są dostępne w raporcie grup. W raporcie dotyczącym kohorty zakres danych dateRange jest poszerzany 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ącej grupy dateRange jest wymagane, a wartość dateRanges w kolumnie RunReportRequest lub RunPivotReportRequest musi być nieokreślona.

Wartość dateRange powinna być dopasowana do szczegółowości kohorty. Jeśli CohortsRange używa szczegółowości na poziomie dni, ten dateRange może być pojedynczym dniem. Jeśli CohortsRange używa tygodniowej szczegółowości, ta dateRange może być dopasowana do granicy tygodnia, rozpoczynając się w niedzielę i kończąc w sobotę. Jeśli CohortsRange używa granularności miesięcznej, ta dateRange może być dopasowana do miesiąca, rozpoczynając się pierwszego dnia i kończąc ostatniego dnia miesiąca.

CohortsRange

Konfiguruje rozszerzony zakres dat raportowania na potrzeby raportu dotyczących grup odbiorców. Określa czas przesunięcia, po którym następuje śledzenie kohort.

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

enum (Granularity)

Wymagane. Dokładność, która służy do interpretacji wartości startOffsetendOffset w przypadku rozszerzonego zakresu 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. Wartość startOffset jest zwykle ustawiana na 0, aby raporty zawierały dane od momentu pozyskania kohorty.

Jeśli granularity to DAILY, startDate rozszerzonego zakresu dat raportowania to startDate kohorty plus startOffset dni.

Jeśli granularity to WEEKLY, startDate rozszerzonego zakresu dat raportowania to startDate kohorty plus startOffset * 7 dni.

Jeśli granularity to MONTHLY, startDate rozszerzonego zakresu dat raportowania to startDate kohorty plus startOffset * 30 dni.

endOffset

integer

Wymagane. endOffset określa datę końcową rozszerzonego zakresu dat raportowania w przypadku raportu dotyczącego grup odbiorców. 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 rozszerzonego zakresu 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 rozszerzonego zakresu dat raportowania to endDate kohorty plus endOffset * 30 dni.

Szczegółowość

Dokładność, która służy do interpretacji wartości startOffsetendOffset w przypadku rozszerzonego zakresu dat raportowania w raporcie dotyczącym kohorty.

Wartości w polu enum
GRANULARITY_UNSPECIFIED Nigdy nie należy go podawać.
DAILY Szczegółowość dzienna. Jest często używana, jeśli dateRange w przypadku kohorty to 1 dzień, a żądanie zawiera cohortNthDay.
WEEKLY szczegółowość tygodniowa, Jest często używany, jeśli dateRange kohorty obejmuje tydzień (od niedzieli do soboty), a żądanie zawiera cohortNthWeek.
MONTHLY Miesięczny stopień szczegółowości. Zwykle używany, jeśli wartość dateRange kohorty obejmuje miesiąc, a żądanie zawiera cohortNthMonth.

CohortReportSettings

Opcjonalne ustawienia raportu dotyczącego kohorty.

Zapis JSON
{
  "accumulate": boolean
}
Pola
accumulate

boolean

Jeśli ma wartość true, kumuluje wynik od dnia pierwszego kontaktu do dnia zakończenia. Nieobsługiwane w RunReportRequest.

SamplingLevel

Kategorie poziomów próbkowania żądań.

Wartości w polu enum
SAMPLING_LEVEL_UNSPECIFIED Nieokreślony typ.
LOW Stosuje próbkowanie na poziomie 10 mln w przypadku usług standardowych i 100 mln w przypadku usług w Google Analytics 360.
MEDIUM Dostępne tylko w usługach w Google Analytics 360 z poziomem próbkowania 1 mld.
UNSAMPLED Funkcja dostępna tylko w usługach Google Analytics 360. Eksploracje niespróbkowane są dokładniejsze i mogą dostarczyć statystyk, które są niewidoczne w standardowych eksploracjach. Więcej informacji znajdziesz na stronie https://support.google.com/analytics/answer/10896953.

ReportMetadata

Metadane raportu związane z konkretnym zadaniem związanym z raportem.

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 wykorzystanych 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.

state

enum (State)

Tylko dane wyjściowe. Bieżący stan tego zadania polegającego na wygenerowaniu raportu.

beginCreatingTime

string (Timestamp format)

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

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

taskRowCount

integer

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

errorMessage

string

Tylko dane wyjściowe. Jeśli podczas tworzenia zadania związanego z raportowaniem wystąpi błąd, zostanie wyświetlony komunikat o błędzie.

totalRowCount

integer

Tylko dane wyjściowe. Łączna liczba wierszy w magazynie Google Analytics. Jeśli chcesz zapytać o dodatkowe wiersze danych poza bieżącym raportem, możesz utworzyć nowe zadanie dotyczące raportu na podstawie totalRowCount.

Wartość taskRowCount to liczba wierszy należących do bieżącego raportu, a wartość totalRowCount to łączna liczba wierszy we wszystkich danych pobranych z magazynu 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 to 30, co oznacza obecność danych we wszystkich 30 wierszach. taskRowCount może sł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 zbioru danych zawierającego 30 wierszy.

Stan

Stan przetwarzania.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony nigdy nie będzie używany.
CREATING Raport jest obecnie tworzony i będzie dostępny w przyszłości. Tworzenie następuje natychmiast po wywołaniu CreateReport.
ACTIVE Raport jest w pełni utworzony i gotowy do tworzenia zapytań.
FAILED Nie udało się utworzyć raportu.

Metody

create

Inicjowanie tworzenia zadania raportu.

get

Pobiera metadane raportu dotyczące konkretnego zadania związanego z raportowaniem.

list

Zawiera listę wszystkich zadań związanych z raportami w ramach danej usługi.

query

Pobiera treść zadania raportu.