REST Resource: properties.reportTasks

Zasób: ReportTask

Określona 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żąca do pobierania danych raportu, która opisuje strukturę raportu. Zwykle zawiera ona pola, które będą 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 związanego z raportem, które zawierają informacje o raporcie. Zwykle zawiera te informacje: nazwę zasobu raportu, jego stan, sygnaturę czasową 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, o które poproszono i które zostały wyświetlone.

metrics[]

object (Metric)

Opcjonalnie. Żądane i wyświetlane dane.

dateRanges[]

object (DateRange)

Opcjonalnie. Zakresy dat danych do odczytania. Jeśli zostanie wysłana prośba o wiele zakresów dat, każdy wiersz odpowiedzi będzie zawierać indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat pokrywają się, dane o zdarzeniach z dni, w których się pokrywają, są uwzględniane w wierszach odpowiedzi dla obu zakresów dat. W przypadku prośby dotyczącej kohorty ten parametr dateRanges musi być nieokreślony.

dimensionFilter

object (FilterExpression)

Opcjonalnie. Filtry wymiarów umożliwiają wyświetlanie w raporcie tylko określonych wartości wymiarów. Więcej informacji znajdziesz w artykule Podstawy filtrów wymiarów, w którym znajdziesz przykłady. W tym filtrze nie można używać wskaźników.

metricFilter

object (FilterExpression)

Opcjonalnie. Klauzula filtra danych. Stosowany po agregacji wierszy raportu, podobnie jak klauzula HAVING w SQL-u. W tym filtrze nie można używać wymiarów.

offset

string (int64 format)

Opcjonalnie. Liczba wierszy w wierszu początkowym z pamięci Google Analytics. Pierwszy wiersz jest liczony jako wiersz 0.

Podczas tworzenia zadania raportu parametry offsetlimit określają podzbiór wierszy danych z pamięci Google Analytics, które mają być uwzględnione w wygenerowanym raporcie. Jeśli np. w pamięci Google Analytics jest łącznie 300 tys. wierszy, początkowe zadanie raportu może zawierać pierwsze 10 tys. wierszy z limitem 10 tys. i przesunięciem 0. Kolejne zadanie raportu może obejmować następne 10 000 wierszy z limitem 10 000 i przesunięciem 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 tys. wierszy na żądanie,niezależnie od tego, ile wierszy zażądasz. limit musi być liczbą dodatnią.

Interfejs API może też zwracać mniej wierszy niż żądana wartość limit, jeśli nie ma tylu wartości wymiarów, ile wynosi limit. Na przykład wymiar country ma mniej niż 300 możliwych wartości, więc podczas generowania raportu tylko na podstawie tego wymiaru nie możesz uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz wartość limit na wyższą.country

metricAggregations[]

enum (MetricAggregation)

Opcjonalnie. Agregacja danych. Zagregowane wartości danych będą wyświetlane w wierszach, w których parametr dimensionValues ma wartość „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 kohortowa powiązana z tym żądaniem. Jeśli w żądaniu znajduje się grupa kohort, musi być w nim obecny wymiar „kohorta”.

keepEmptyRows

boolean

Opcjonalnie. Jeśli wartość jest fałszywa lub nieokreślona, każdy wiersz, w którym wszystkie dane mają wartość 0, nie zostanie zwrócony. Jeśli ma wartość „true”, te wiersze zostaną zwrócone, o ile nie zostaną osobno usunięte przez filtr.

Niezależnie od tego ustawienia keepEmptyRows w raporcie można wyświetlać tylko dane zarejestrowane przez usługę w Google Analytics.

Jeśli np. usługa nigdy nie rejestruje zdarzenia purchase, zapytanie o wymiar eventName i rodzaj danych eventCount nie będzie zawierać wiersza z wartościami eventName: „purchase” 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ści wymiarów w odpowiedziach raportu są ciągami znaków, np. miasto może mieć wartość „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, takie jak runReportbatchRunReports, znajdziesz w sekcji Wymiary API. Listę nazw wymiarów obsługiwanych przez metodę runRealtimeReport znajdziesz w sekcji Wymiary w czasie rzeczywistym. Listę nazw wymiarów obsługiwanych przez metodę runFunnelReport znajdziesz w artykule Wymiary ścieżki.

Jeśli podano dimensionExpression, name może być dowolnym ciągiem znaków z dozwolonego zestawu. Jeśli np. wymiar dimensionExpression łączy wymiary countrycity, możesz go nazwać countryAndCity. Wybrane nazwy wymiarów muszą być zgodne z wyrażeniem regularnym ^[a-zA-Z0-9_]$.

Wymiary są określane przez namedimensionFilter, orderBys, dimensionExpressionpivots.

dimensionExpression

object (DimensionExpression)

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

DimensionExpression

Używany do wyrażania wymiaru, który jest wynikiem formuły obejmującej wiele wymiarów. Przykłady użycia: 1) lowerCase(dimension) 2) concatenate(dimension1, symbol, dimension2).

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 zbiorcze one_expression. Określ jeden typ wyrażenia wymiaru dla DimensionExpression. one_expression może mieć 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 przekształcania wartości wymiaru na jeden rodzaj wielkości liter.

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ą odnosić się do nazw w polu wymiarów żądania.

delimiter

string

Ogranicznik umieszczony między nazwami wymiarów.

Separatorami są często pojedyncze znaki, np. „|” lub „,”, ale mogą to być też dłuższe ciągi znaków. Jeśli wartość wymiaru zawiera separator, w odpowiedzi będą widoczne oba znaki bez rozróżnienia. Jeśli np. wartość wymiaru 1 to „US,FR”, wartość wymiaru 2 to „JP”, a ogranicznik to „,”, odpowiedź będzie zawierać ciąg „US,FR,JP”.

Dane

Dane w raporcie wyrażone w formie liczbowej. Na przykład dane eventCount to łączna liczba zdarzeń. W żądaniach można podać maksymalnie 10 rodzajów danych.

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

string

Nazwa rodzaju danych. Listę nazw danych obsługiwanych przez podstawowe metody raportowania, takie jak runReportbatchRunReports, znajdziesz w sekcji Dane 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 artykule Dane dotyczące ścieżki.

Jeśli podano expression, name może być dowolnym ciągiem znaków z dozwolonego zestawu. Jeśli na przykład 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ą oznaczone symbolem name w przypadku metricFilter, orderBys i danych expression.

expression

string

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

invisible

boolean

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

Zakres dat

Ciągły zestaw dni: startDate, startDate + 1, ..., endDate. Możesz przesłać maksymalnie 4 zakresy dat.

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

string

Data rozpoczęcia zapytania (włącznie z tym dniem) w formacie YYYY-MM-DD. Nie może przypadać po dacie endDate. Akceptowane są też formaty NdaysAgo, yesterdaytoday. W takim przypadku data jest określana na podstawie strefy czasowej raportowania usługi.

endDate

string

Data zakończenia zapytania (włącznie z tym dniem) w formacie YYYY-MM-DD. Nie może być wcześniejsza niż startDate. Akceptowane są też formaty NdaysAgo, yesterdaytoday. W takim przypadku data jest określana na podstawie strefy czasowej raportowania usługi.

name

string

Przypisuje nazwę do tego zakresu dat. W odpowiedzi raportu wymiar dateRange ma wartość zgodną z tą nazwą. Jeśli jest ustawiona, nie może zaczynać się od klucza date_range_ ani RESERVED_. Jeśli nie jest ustawiony, zakresy dat są nazywane na podstawie indeksu w żądaniu (liczonego od zera): date_range_0, date_range_1 itd.

FilterExpression

do wyrażania filtrów wymiarów lub danych. Pola w tym samym wyrażeniu FilterExpression muszą być albo wymiarami, albo danymi.

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 zbiorcze expr. Określ jeden typ wyrażenia filtra dla FilterExpression. expr może mieć tylko jedną z tych wartości:
andGroup

object (FilterExpressionList)

Elementy FilterExpressions w andGroup są ze sobą powiązane operatorem AND.

orGroup

object (FilterExpressionList)

Elementy FilterExpressions w orGroup są ze sobą powiązane operatorem OR.

notExpression

object (FilterExpression)

Wartość FilterExpression nie jest typu notExpression.

filter

object (Filter)

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

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)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of list of possible types for union field one_filter.
}
Pola
fieldName

string

Nazwa wymiaru lub nazwa danych. Musi to być nazwa zdefiniowana w wymiarach lub danych.

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

object (StringFilter)

Filtr powią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 dla wartości z określonego zakresu.

emptyFilter

object (EmptyFilter)

Filtr pustych wartości, takich jak „(not set)” i „”.

StringFilter

Filtr ciągu tekstowego

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 wartości ciągu znaków ma znaczenie.

MatchType

Typ dopasowania filtra ciągu znaków

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

InListFilter

Wynik musi być listą wartości w formie ciągów 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 wartości ciągu znaków ma znaczenie.

NumericFilter

Filtry wartości liczbowych lub dat.

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

enum (Operation)

Typ operacji przy tym filtrze.

value

object (NumericValue)

wartość liczbowa lub data.

Operacja

Operacja zastosowana do filtra numerycznego

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

NumericValue

reprezentować liczbę.

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 zbiorcze 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ę 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ę tą liczbą;

EmptyFilter

Ten typ nie ma pól.

Filtruj według pustych wartości.

MetricAggregation

Reprezentuje agregację danych.

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

OrderBy

Kryteria sortowania określają sposób sortowania wierszy w odpowiedzi. Na przykład porządkowanie wierszy według malejącej liczby zdarzeń to jedno porządkowanie, a porządkowanie wierszy według ciągu nazwy zdarzenia to inne porzą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ść „prawda”, sortuje w kolejności malejącej.

Pole zbiorcze one_order_by. Określ jeden typ kolejności sortowania dla OrderBy. one_order_by może mieć 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 wskaźnika.

Zapis JSON
{
  "metricName": string
}
Pola
metricName

string

Nazwa danych w żądaniu, według których ma być wykonane sortowanie.

DimensionOrderBy

Sortuje według wartości wymiaru.

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

string

Nazwa wymiaru w zapytaniu, według którego ma być przeprowadzane sortowanie.

orderType

enum (OrderType)

Określa regułę kolejności wartości wymiaru.

OrderType

Reguła, według której mają być porządkowane wartości wymiaru tekstowego.

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 rozróżniania wielkości liter według punktu kodowego Unicode małych liter. Na przykład „2” < „A” < „b” < „X” < „z”.
NUMERIC Wartości wymiarów są przed sortowaniem przekształcane w liczby. Na przykład w przypadku sortowania NUMERIC „25” < „100”, a w przypadku sortowania ALPHANUMERIC „100” < „25”. Wartości wymiarów nienumerycznych mają taką samą wartość porządkowania, która jest mniejsza niż wszystkie wartości numeryczne.

CohortSpec

Specyfikacja kohort w raporcie dotyczącym kohorty.

Raporty dotyczące kohort tworzą szereg czasowy utrzymania użytkowników w kohorcie. Możesz na przykład wybrać kohortę użytkowników pozyskanych w pierwszym tygodniu września i śledzić ją przez kolejne 6 tygodni. Wybór użytkowników pozyskanych w kohorcie z pierwszego tygodnia września jest określony w obiekcie cohort. Śledzenie tej kohorty przez kolejne 6 tygodni jest określone w obiekcie cohortsRange.

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

Odpowiedź raportu może zawierać tygodniowe dane szeregowe, np. po 3 tygodniach aplikacja utrzymała 60% użytkowników z tej kohorty, a po 6 tygodniach – 25%. Te 2 wartości procentowe można obliczyć za pomocą rodzaju danych cohortActiveUsers/cohortTotalUsers. Będą one wyświetlane w raporcie w osobnych wierszach.

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

object (Cohort)

Określa kryteria wyboru, według których użytkownicy są grupowani w kohorty.

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

cohortsRange

object (CohortsRange)

Raporty kohortowe śledzą kohorty w dłuższym okresie raportowania. Ten zakres określa czas przesunięcia, w którym mają być śledzone 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 tą samą firstSessionDate należą do tej samej kohorty.

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

string

Przypisuje nazwę do tej kohorty. W odpowiedzi raportu wymiar cohort ma wartość zgodną z tą nazwą. Jeśli jest ustawiona, nie może zaczynać się od klucza cohort_ ani RESERVED_. Jeśli nie zostanie ustawiona, kohorty będą nazywane na podstawie indeksu opartego na zerze, np. cohort_0, cohort_1 itp.

dimension

string

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

dateRange

object (DateRange)

Kohorta wybiera użytkowników, których data pierwszego kontaktu mieści się w zakresie dat określonym w dateRange. Ten parametr dateRange nie określa pełnego zakresu dat danych zdarzeń, które są dostępne w raporcie dotyczącym kohorty. W raporcie dotyczącym kohorty ten okres dateRange jest wydłużany o szczegółowość i przesunięcie występujące w cohortsRange. Dane zdarzeń z wydłużonego zakresu dat raportowania są dostępne w raporcie dotyczącym kohorty.

W przypadku żądania dotyczącego kohorty ten parametr dateRange jest wymagany, a parametr dateRanges w polu RunReportRequest lub RunPivotReportRequest musi być nieokreślony.

Ten dateRange powinien być ogólnie zgodny z poziomem 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 korzysta z tygodniowej szczegółowości, ten dateRange może być dopasowany do granicy tygodnia, zaczynając się w niedzielę, a kończąc w sobotę. Jeśli CohortsRange korzysta z miesięcznej szczegółowości, ten dateRange może być dopasowany do miesiąca, zaczynając się pierwszego i kończąc ostatniego dnia miesiąca.

CohortsRange

Konfiguruje rozszerzony zakres dat raportowania w przypadku raportu dotyczącego kohorty. Określa czas przesunięcia, w którym mają być śledzone kohorty.

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

enum (Granularity)

Wymagane. Granularność używana do interpretowania 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 w przypadku raportu dotyczącego kohorty. startOffset jest zwykle ustawiona na 0, aby raporty zawierały dane od momentu pozyskania kohorty.

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

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

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

endOffset

integer

Wymagane. endOffset określa datę zakończenia rozszerzonego zakresu dat raportowania w przypadku raportu dotyczącego kohorty. endOffset może być dowolną liczbą całkowitą, ale zwykle ustawia się ją na 5–10, aby raporty zawierały dane o kohorcie z kilku kolejnych okresów o określonej szczegółowości.

Jeśli granularity ma wartość DAILY, endDate rozszerzonego zakresu dat raportowania to endDate kohorty plus endOffset dni.

Jeśli granularity ma wartość WEEKLY, endDate rozszerzonego zakresu dat raportowania to endDate kohorty plus endOffset * 7 dni.

Jeśli granularity ma wartość MONTHLY, endDate rozszerzonego zakresu dat raportowania to endDate kohorty plus endOffset * 30 dni.

Szczegółowość

Granularność używana do interpretowania 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 określać.
DAILY Szczegółowość dzienna. Używane zwykle, gdy dateRange kohorty to jeden dzień, a żądanie zawiera cohortNthDay.
WEEKLY Szczegółowość tygodniowa. Używane zwykle, gdy dateRange kohorty trwa tydzień (od niedzieli do soboty), a żądanie zawiera cohortNthWeek.
MONTHLY Miesięczny stopień szczegółowości. Używane zwykle, gdy dateRange kohorty trwa miesiąc, a żądanie zawiera cohortNthMonth.

CohortReportSettings

Ustawienia opcjonalne raportu dotyczącego kohorty.

Zapis JSON
{
  "accumulate": boolean
}
Pola
accumulate

boolean

Jeśli wartość to „true”, wynik jest kumulowany od dnia pierwszego kontaktu do dnia zakończenia. Nieobsługiwane na ścieżce RunReportRequest.

SamplingLevel

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

Wartości w polu enum
SAMPLING_LEVEL_UNSPECIFIED Nieokreślony typ.
LOW Stosuje poziom próbkowania 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 wynoszącym 1 mld.
UNSAMPLED Dostępne tylko w usługach w Google Analytics 360. Eksploracje niespróbkowane są dokładniejsze i mogą ujawniać statystyki, które są niewidoczne w standardowych eksploracjach. Więcej informacji znajdziesz na stronie https://support.google.com/analytics/answer/10896953.

ReportMetadata

Metadane raportu dotyczące konkretnego zadania związanego 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 limitu wykorzystanych podczas tworzenia raportu. Liczba tokenów jest obliczana na podstawie aktywności w stanie CREATING, więc opłata za tokeny będzie stała, gdy zadanie raportu przejdzie do stanu ACTIVE lub FAILED.

state

enum (State)

Tylko dane wyjściowe. Bieżący stan tego zadania związanego z raportem.

beginCreatingTime

string (Timestamp format)

Tylko dane wyjściowe. Godzina, o której wywołano reportTasks.create i raport osiągnął stan CREATING.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

taskRowCount

integer

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

errorMessage

string

Tylko dane wyjściowe. Jeśli podczas tworzenia zadania raportu wystąpi błąd, wyświetli się komunikat o błędzie.

totalRowCount

integer

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

Symbol taskRowCount oznacza liczbę wierszy odnoszących się konkretnie do bieżącego raportu, a symbol totalRowCount – łączną liczbę wierszy we wszystkich danych pobranych z pamięci Google Analytics.

Załóżmy na przykład, że bieżąca wartość taskRowCount w raporcie to 20, co oznacza, że wyświetlane są dane z pierwszych 20 wierszy. Jednocześnie wartość totalRowCount wynosi 30, co oznacza, że dane są dostępne dla wszystkich 30 wierszy. Za pomocą taskRowCount możesz przechodzić między pierwszymi 20 wierszami. Aby rozwinąć raport i uwzględnić dane ze wszystkich 30 wierszy, możesz utworzyć nowe zadanie raportu, używając parametru totalRowCount, aby uzyskać dostęp do pełnego zestawu danych z 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 funkcji CreateReport.
ACTIVE Raport jest w pełni utworzony i gotowy do wysyłania zapytań.
FAILED Nie udało się utworzyć raportu.

Metody

create

Inicjuje tworzenie zadania raportu.

get

Pobiera metadane raportu dotyczące konkretnego zadania raportu.

list

Zawiera listę wszystkich zadań związanych z raportami dotyczącymi usługi.

query

Pobiera zawartość zadania raportu.