REST Resource: properties.reportTasks

Ресурс: ReportTask

Конкретная конфигурация задачи создания отчета.

JSON-представление 
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
Поля
name

string

Только вывод. Идентификатор. Имя ресурса задачи отчета, присвоенное при создании. Формат: "properties/{property}/reportTasks/{reportTask}"

reportDefinition

object ( ReportDefinition )

Необязательно. Определение отчета для получения данных отчета, описывающее его структуру. Обычно оно включает поля, которые будут включены в отчет, и критерии, которые будут использоваться для фильтрации данных.

reportMetadata

object ( ReportMetadata )

Только для вывода. Метаданные отчета для конкретной задачи создания отчета, содержащие информацию об отчете. Обычно они включают следующую информацию: имя ресурса отчета, состояние отчета, метку времени создания отчета и т. д.

ReportDefinition

Определение того, как должен формироваться отчет.

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)
}
Поля
dimensions[]

object ( Dimension )

Необязательно. Запрашиваемые и отображаемые размеры.

metrics[]

object ( Metric )

Необязательно. Запрашиваемые и отображаемые метрики.

dateRanges[]

object ( DateRange )

Необязательно. Диапазоны дат для чтения данных. Если запрашивается несколько диапазонов дат, каждая строка ответа будет содержать индекс диапазона дат, начинающийся с нуля. Если два диапазона дат перекрываются, данные о событиях за перекрывающиеся дни включаются в строки ответа для обоих диапазонов дат. В запросе для когорты параметр dateRanges должен быть не указан.

dimensionFilter

object ( FilterExpression )

Необязательно. Фильтры измерений позволяют запрашивать в отчете только значения определенных измерений. Для получения дополнительной информации см. раздел «Основы фильтров измерений» с примерами. Метрики в этом фильтре использовать нельзя.

metricFilter

object ( FilterExpression )

Необязательный параметр. Это условие фильтрации метрик. Применяется после агрегирования строк отчета, аналогично условию SQL having. В этом фильтре нельзя использовать измерения.

offset

string ( int64 format)

Необязательно. Количество строк в начальной строке из хранилища Google Analytics. Первая строка считается строкой 0.

При создании задачи отчета параметры offset и limit определяют подмножество строк данных из хранилища Google Analytics, которые будут включены в сгенерированный отчет. Например, если в хранилище Google Analytics всего 300 000 строк, первоначальная задача отчета может включать первые 10 000 строк с ограничением в 10 000 и смещением 0. Впоследствии другая задача отчета может охватывать следующие 10 000 строк с ограничением в 10 000 и смещением в 10 000.

limit

string ( int64 format)

Необязательный параметр. Количество строк, которые должны быть возвращены в отчете. Если не указано, возвращается 10 000 строк. API возвращает максимум 250 000 строк за запрос, независимо от количества запрошенных строк. limit должен быть положительным.

API также может возвращать меньше строк, чем запрошенный limit , если количество значений измерений меньше limit . Например, для измерения country возможно менее 300 значений, поэтому при формировании отчета только по country вы не получите более 300 строк, даже если установите limit на более высокое значение.

metricAggregations[]

enum ( MetricAggregation )

Необязательно. Агрегация метрик. Агрегированные значения метрик будут отображаться в строках, где значение dimensionValues ​​установлено на "RESERVED_(MetricAggregation)".

orderBys[]

object ( OrderBy )

Необязательный параметр. Указывает порядок сортировки строк в ответе.

currencyCode

string

Необязательно. Код валюты в формате ISO4217, например, "AED", "USD", "JPY". Если поле пустое, в отчете используется валюта по умолчанию для данного объекта.

cohortSpec

object ( CohortSpec )

Необязательно. Группа когорт, связанная с этим запросом. Если в запросе указана группа когорт, необходимо указать параметр «когорта».

keepEmptyRows

boolean

Необязательный параметр. Если значение равно false или не указано, ни одна строка, у которой все метрики равны 0, не будет возвращена. Если значение равно true, эти строки будут возвращены, если они не будут удалены отдельно с помощью фильтра.

Независимо от параметра keepEmptyRows , в отчете будут отображаться только данные, записанные с помощью ресурса Google Analytics.

Например, если объект недвижимости никогда не регистрирует событие purchase , то запрос по измерению eventName и метрике eventCount не будет содержать строку с eventName: "purchase" и eventCount: 0.

samplingLevel

enum ( SamplingLevel )

Необязательно. Уровень выборки в отчете.

Измерение

Измерения — это атрибуты ваших данных. Например, измерение «город» указывает город, из которого происходит событие. Значения измерений в ответах отчета представляют собой строки; например, городом может быть «Париж» или «Нью-Йорк».

JSON-представление 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
Поля
name

string

Название измерения. Список поддерживаемых основными методами формирования отчетов, такими как runReport и batchRunReports см. в разделе «Измерения API» . Список поддерживаемых методом runRealtimeReport названий измерений см. в разделе «Измерения в реальном времени» . Список поддерживаемых методом runFunnelReport названий измерений см. в разделе «Измерения воронки» .

Если указано dimensionExpression , name может быть любой строкой в ​​пределах допустимого набора символов. Например, если dimensionExpression объединяет country и city , вы можете назвать это измерение countryAndCity . Выбранные вами имена измерений должны соответствовать регулярному выражению ^[a-zA-Z0-9_]$ .

Размеры указываются по name в dimensionFilter , orderBys , dimensionExpression и pivots .

dimensionExpression

object ( DimensionExpression )

Одно измерение может быть результатом выражения, содержащего несколько измерений. Например, измерение "страна, город": concatenate(country, ", ", город).

DimensionExpression

Используется для обозначения измерения, являющегося результатом формулы для нескольких измерений. Примеры использования: 1) lowerCase(dimension) 2) concatenate(dimension1, symbol, dimension2).

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.
}
Поля
Поле объединения one_expression . Укажите один тип выражения измерения для DimensionExpression . one_expression может принимать только одно из следующих значений:
lowerCase

object ( CaseExpression )

Используется для преобразования значения измерения в нижний регистр.

upperCase

object ( CaseExpression )

Используется для преобразования значения измерения в верхний регистр.

concatenate

object ( ConcatenateExpression )

Используется для объединения значений измерений в одно измерение. Например, измерение "страна, город": concatenate(country, ", ", город).

CaseExpression

Используется для преобразования значения измерения в один конкретный случай.

JSON-представление 
{
  "dimensionName": string
}
Поля
dimensionName

string

Название измерения. Название должно ссылаться на название в поле «Измерения» запроса.

ConcatenateExpression

Используется для объединения значений измерений в одно измерение.

JSON-представление 
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Поля
dimensionNames[]

string

Названия параметров. Названия должны ссылаться на названия в поле параметров запроса.

delimiter

string

Разделитель, используемый между названиями измерений.

Разделителями часто являются отдельные символы, такие как "|" или ",", но могут быть и более длинные строки. Если значение измерения содержит разделитель, то в ответе будут присутствовать оба символа без различия. Например, если значение измерения 1 = "US,FR", значение измерения 2 = "JP", и разделитель = ",", то ответ будет содержать "US,FR,JP".

Метрика

Количественные показатели отчета. Например, метрика eventCount — это общее количество событий. Допускается запрос до 10 метрик.

JSON-представление 
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Поля
name

string

Название метрики. Список поддерживаемых основными методами формирования отчетов, такими как runReport и batchRunReports , см. в разделе «Метрики API» . Список поддерживаемых методом runRealtimeReport названий метрик см. в разделе « Метрики реального времени» . Список поддерживаемых методом runFunnelReport названий метрик см. в разделе «Метрики воронки» .

Если указано expression , name может быть любой строкой в ​​пределах допустимого набора символов. Например, если expression — screenPageViews/sessions , вы можете назвать метрику именем = viewsPerSession . Выбранные вами имена метрик должны соответствовать регулярному выражению ^[a-zA-Z0-9_]$ .

Метрики указываются по name в metricFilter , orderBys и metric expression .

expression

string

Математическое выражение для производных метрик. Например, метрика «Количество событий на пользователя» равна eventCount/totalUsers .

invisible

boolean

Указывает, является ли метрика невидимой в ответе отчета. Если метрика невидима, она не будет отображаться в столбце ответа, но может использоваться в metricFilter , orderBys или expression метрики.

Диапазон дат

Последовательный набор дней: startDate , startDate + 1 , ..., endDate . Допускается отправка запросов с диапазоном дат до 4.

JSON-представление 
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Поля
startDate

string

Начальная дата запроса включительно указывается в формате YYYY-MM-DD . Не может быть позже endDate . Также принимается формат NdaysAgo , yesterday или today , в этом случае дата определяется исходя из часового пояса объекта недвижимости.

endDate

string

Конечная дата запроса включительно указывается в формате YYYY-MM-DD . Не может быть раньше startDate . Также принимаются форматы NdaysAgo , yesterday или today , в этом случае дата определяется исходя из часового пояса объекта недвижимости.

name

string

Присваивает имя этому диапазону дат. В ответе на отчет этому имени присваивается значение измерения dateRange . Если задано, имя не может начинаться с date_range_ или RESERVED_ . Если не задано, диапазоны дат именуются по их нулевому индексу в запросе: date_range_0 , date_range_1 и т. д.

FilterExpression

Для выражения фильтров по измерениям или метрикам. Поля в одном и том же выражении FilterExpression должны представлять либо все измерения, либо все метрики.

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.
}
Поля
Поле объединения expr . Укажите один тип выражения фильтра для FilterExpression . expr может принимать только одно из следующих значений:
andGroup

object ( FilterExpressionList )

В свойствах FilterExpressions внутри andGroup существует логическая связь И.

orGroup

object ( FilterExpressionList )

В свойствах FilterExpressions в группе orGroup существует связь ИЛИ.

notExpression

object ( FilterExpression )

FilterExpression не является notExpression.

filter

object ( Filter )

Примитивный фильтр. В одном и том же выражении FilterExpression все имена полей фильтра должны представлять собой либо все измерения, либо все метрики.

FilterExpressionList

Список выражений фильтра.

JSON-представление 
{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}
Поля
expressions[]

object ( FilterExpression )

Список выражений фильтра.

Фильтр

Выражение для фильтрации значений измерений или метрик.

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.
}
Поля
fieldName

string

Название измерения или метрики. Должно быть именем, определенным в измерениях или метриках.

Поле объединения one_filter . Укажите один тип фильтра для Filter . one_filter может принимать только одно из следующих значений:
stringFilter

object ( StringFilter )

Фильтр по строкам.

inListFilter

object ( InListFilter )

Фильтр для значений в списке.

numericFilter

object ( NumericFilter )

Фильтр для числовых значений или дат.

betweenFilter

object ( BetweenFilter )

Фильтр для выбора значения между двумя исходными значениями.

emptyFilter

object ( EmptyFilter )

Фильтр для пустых значений, таких как "(не задано)" и "".

StringFilter

Фильтр для строк

JSON-представление 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Поля
matchType

enum ( MatchType )

Тип соответствия для этого фильтра.

value

string

Строковое значение, используемое для сопоставления.

caseSensitive

boolean

Если значение истинно, строковое значение чувствительно к регистру.

MatchType

Тип соответствия строкового фильтра

Перечисления
MATCH_TYPE_UNSPECIFIED Не указано
EXACT Точное совпадение строкового значения.
BEGINS_WITH Начинается со строкового значения.
ENDS_WITH Заканчивается строковым значением.
CONTAINS Содержит строковое значение.
FULL_REGEXP Полное совпадение регулярного выражения со строковым значением.
PARTIAL_REGEXP Частичное совпадение регулярного выражения со строковым значением.

InListFilter

Результат должен быть представлен в виде списка строковых значений.

JSON-представление 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Поля
values[]

string

Список строковых значений. Должен быть непустым.

caseSensitive

boolean

Если значение истинно, строковое значение чувствительно к регистру.

ЧисловойФильтр

Фильтры для числовых значений или дат.

JSON-представление 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Поля
operation

enum ( Operation )

Тип операции для данного фильтра.

value

object ( NumericValue )

Числовое значение или значение даты.

Операция

Операция, применяемая к числовому фильтру.

Перечисления
OPERATION_UNSPECIFIED Не указано.
EQUAL Равный
LESS_THAN Меньше, чем
LESS_THAN_OR_EQUAL Меньше или равно
GREATER_THAN Больше, чем
GREATER_THAN_OR_EQUAL больше или равно

Числовое значение

Для представления числа.

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.
}
Поля
Поле объединения one_value . Числовое значение one_value может принимать только одно из следующих значений:
int64Value

string ( int64 format)

Целочисленное значение

doubleValue

number

Двойное значение

BetweenFilter

Чтобы указать, что результат должен находиться в диапазоне от двух чисел (включительно).

JSON-представление 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Поля
fromValue

object ( NumericValue )

Начинается с этого числа.

toValue

object ( NumericValue )

Заканчивается этим числом.

ПустойФильтр

Этот тип не содержит полей.

Отфильтровать пустые значения.

Агрегация метрик

Представляет собой агрегированное представление метрик.

Перечисления
METRIC_AGGREGATION_UNSPECIFIED Оператор не указан.
TOTAL Оператор SUM.
MINIMUM Минимальный оператор.
MAXIMUM Максимальный оператор.
COUNT Оператор подсчета.

Сортировать по

Параметр ORDER BY определяет, как будут сортироваться строки в ответе. Например, сортировка строк по убыванию количества событий — это один из вариантов сортировки, а сортировка строк по строковому названию события — другой.

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.
}
Поля
desc

boolean

Если это так, сортировка производится в порядке убывания.

Поле объединения one_order_by . Укажите один тип сортировки для OrderBy . one_order_by может принимать только одно из следующих значений:
metric

object ( MetricOrderBy )

Сортирует результаты по значениям метрики.

dimension

object ( DimensionOrderBy )

Сортирует результаты по значениям измерения.

MetricOrderBy

Сортировка по значениям метрик.

JSON-представление 
{
  "metricName": string
}
Поля
metricName

string

Название метрики в запросе на сортировку.

DimensionOrderBy

Сортировка по значениям измерений.

JSON-представление 
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
Поля
dimensionName

string

Название измерения в запросе на сортировку.

orderType

enum ( OrderType )

Управляет правилом упорядочивания значений измерений.

Тип заказа

Правило для упорядочивания значений строковых измерений.

Перечисления
ORDER_TYPE_UNSPECIFIED Не указано.
ALPHANUMERIC Сортировка по буквенно-цифровому коду Unicode. Например: "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC Сортировка буквенно-цифровых символов без учета регистра по коду Unicode в нижнем регистре. Например: "2" < "A" < "b" < "X" < "z".
NUMERIC Значения измерений преобразуются в числа перед сортировкой. Например, при числовой сортировке "25" < "100", а при ALPHANUMERIC сортировке "100" < "25". Нечисловые значения измерений имеют одинаковый порядок, расположенный ниже всех числовых значений.

CohortSpec

Описание когорт для когортного отчета.

Когортные отчеты создают временной ряд удержания пользователей для данной когорты. Например, вы можете выбрать когорту пользователей, привлеченных в первую неделю сентября, и отслеживать эту когорту в течение следующих шести недель. Выбор пользователей, привлеченных в первую неделю сентября, указывается в объекте cohort . Отслеживание этой когорты в течение следующих шести недель указывается в объекте cohortsRange .

Примеры см. в разделе «Примеры отчетов по когортам» .

В отчете может быть представлен еженедельный временной ряд, где, например, ваше приложение сохранило 60% этой группы пользователей через три недели и 25% через шесть недель. Эти два процента могут быть рассчитаны с помощью метрики cohortActiveUsers/cohortTotalUsers и будут отображаться в отдельных строках отчета.

JSON-представление 
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Поля
cohorts[]

object ( Cohort )

Определяет критерии отбора для группировки пользователей в группы.

В большинстве когортных отчетов определяется только одна когорта. Если указано несколько когорт, каждая когорта может быть идентифицирована в отчете по своему названию.

cohortsRange

object ( CohortsRange )

В когортных отчетах отслеживаются когорты в течение расширенного диапазона отчетных дат. Этот диапазон определяет период сдвига, в течение которого отслеживаются когорты.

cohortReportSettings

object ( CohortReportSettings )

Дополнительные настройки для когортного отчета.

Когорта

Определяет критерии отбора когорты. Когорта — это группа пользователей, обладающих общей характеристикой. Например, пользователи с одинаковой датой firstSessionDate принадлежат к одной когорте.

JSON-представление 
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
Поля
name

string

Присваивает имя этой когорте. Значение этого имени присваивается переменной cohort в ответе отчета. Если задано, имя не может начинаться с cohort_ или RESERVED_ . Если не задано, когорты именуются по их нулевым индексам: cohort_0 , cohort_1 и т. д.

dimension

string

Параметр, используемый когортой. Обязательный параметр, поддерживает только firstSessionDate .

dateRange

object ( DateRange )

В когорту выбираются пользователи, дата первого контакта которых находится в диапазоне между начальной и конечной датами, определенными в dateRange . Этот dateRange не определяет полный диапазон дат данных о событиях, присутствующих в отчете по когорте. В отчете по когорте этот dateRange расширяется за счет детализации и смещения, указанных в параметре cohortsRange ; данные о событиях для расширенного диапазона дат отчетности присутствуют в отчете по когорте.

В запросе на формирование когорты этот dateRange является обязательным, тогда как dateRanges в запросах RunReportRequest или RunPivotReportRequest не должны быть указаны.

Этот dateRange как правило, должен соответствовать детализации когорты. Если CohortsRange использует ежедневную детализацию, этот dateRange может составлять один день. Если CohortsRange использует еженедельную детализацию, этот dateRange может соответствовать границе недели, начиная с воскресенья и заканчивая субботой. Если CohortsRange использует месячную детализацию, этот dateRange может соответствовать месяцу, начиная с первого и заканчивая последним днем ​​месяца.

Диапазон когорт

Настраивает расширенный диапазон дат отчетности для когортного отчета. Указывает период смещения для отслеживания когорт.

JSON-представление 
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Поля
granularity

enum ( Granularity )

Обязательно. Уровень детализации, используемый для интерпретации startOffset и endOffset для расширенного диапазона дат отчетности в когортном отчете.

startOffset

integer

startOffset задает начальную дату расширенного диапазона отчетных дат для когортного отчета. Обычно startOffset устанавливается равным 0, чтобы отчеты содержали данные начиная с момента приобретения когорты.

Если granularity установлен DAILY , то startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset days.

Если granularity установлен WEEKLY , то startDate расширенного диапазона дат отчетности равна startDate когорты плюс startOffset * 7 дней.

Если granularity установлен MONTHLY , то startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset * 30 дней.

endOffset

integer

Обязательный параметр. endOffset задает конечную дату расширенного диапазона дат отчетности для когортного отчета. endOffset может быть любым положительным целым числом, но обычно устанавливается равным 5–10, чтобы отчеты содержали данные по когорте за несколько последующих периодов детализации.

Если granularity установлен DAILY , то endDate расширенного диапазона дат отчетности равна endDate когорты плюс endOffset дни смещения.

Если granularity установлен WEEKLY , то endDate расширенного диапазона дат отчетности равна endDate когорты плюс endOffset * 7 дней.

Если granularity равен MONTHLY , то endDate расширенного диапазона дат отчетности равен endDate когорты плюс endOffset * 30 дней.

Гранулярность

Детализация, используемая для интерпретации значений startOffset и endOffset для расширенного диапазона дат отчетности в когортном отчете.

Перечисления
GRANULARITY_UNSPECIFIED Это никогда не следует уточнять.
DAILY Ежедневная детализация. Обычно используется, если dateRange когорты составляет один день, а запрос содержит cohortNthDay .
WEEKLY Детализация по неделям. Обычно используется, если dateRange когорты составляет неделю (начиная с воскресенья и заканчивая субботой), а запрос содержит cohortNthWeek .
MONTHLY Детализация по месяцам. Обычно используется, если dateRange когорты составляет один месяц, а запрос содержит cohortNthMonth .

Настройки когортного отчета

Дополнительные настройки когортного отчета.

JSON-представление 
{
  "accumulate": boolean
}
Поля
accumulate

boolean

Если значение истинно, результат суммируется с первого дня обращения до конечного дня. Не поддерживается в RunReportRequest .

Уровень выборки

Категории уровней выборки для запросов.

Перечисления
SAMPLING_LEVEL_UNSPECIFIED Тип не указан.
LOW Применяется уровень выборки в 10 миллионов для стандартных объектов и 100 миллионов для объектов Google Analytics 360.
MEDIUM Эксклюзивно для ресурсов Google Analytics 360 с уровнем выборки в 1 миллиард.
UNSAMPLED Эта функция доступна только в Google Analytics 360. Невыборочные исследования более точны и могут выявить закономерности, невидимые при стандартных исследованиях. Подробнее см. https://support.google.com/analytics/answer/10896953 .

ReportMetadata

Метаданные отчета для конкретной задачи создания отчета.

JSON-представление 
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
Поля
creationQuotaTokensCharged

integer

Только для вывода. Общее количество токенов квоты, списанных во время создания отчета. Поскольку это количество токенов основано на действиях из состояния CREATING , списание этих токенов будет зафиксировано, как только задача отчета перейдет в состояние ACTIVE или FAILED .

state

enum ( State )

Только вывод. Текущее состояние задачи создания отчета.

beginCreatingTime

string ( Timestamp format)

Только вывод. Время вызова метода reportTasks.create и перехода отчета в состояние CREATING .

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

taskRowCount

integer

Только для вывода. Общее количество строк в результате отчета. Это поле будет заполнено, когда состояние станет активным. Вы можете использовать taskRowCount для постраничной навигации в рамках существующего отчета.

errorMessage

string

Только для вывода. Сообщение об ошибке заполняется, если задача создания отчета завершается с ошибкой.

totalRowCount

integer

Только вывод. Общее количество строк в хранилище Google Analytics. Если вы хотите запросить дополнительные строки данных помимо текущего отчета, можно инициировать новую задачу отчета на основе значения totalRowCount .

Параметр taskRowCount представляет собой количество строк, относящихся непосредственно к текущему отчету, тогда как totalRowCount включает в себя общее количество строк по всем данным, полученным из хранилища Google Analytics.

Например, предположим, что в текущем отчете taskRowCount равно 20, отображая данные из первых 20 строк. Одновременно totalRowCount равно 30, что указывает на наличие данных для всех 30 строк. taskRowCount можно использовать для постраничного отображения данных по первым 20 строкам. Чтобы расширить отчет и включить данные из всех 30 строк, можно создать новую задачу отчета, используя totalRowCount для доступа ко всему набору данных из 30 строк.

Состояние

Состояние обработки.

Перечисления
STATE_UNSPECIFIED Неуказанный штат никогда не будет использоваться.
CREATING В данный момент создается отчет, который будет доступен в будущем. Создание отчета происходит сразу после вызова функции CreateReport.
ACTIVE Отчет полностью сформирован и готов к отправке запросов.
FAILED Отчет не был создан.

Методы

create

 Инициирует создание задачи для формирования отчета.

get

 Получает метаданные отчета, относящиеся к конкретной задаче создания отчета.

list

 Отображает список всех задач по составлению отчетов для данного объекта недвижимости.

query

 Извлекает содержимое задачи отчета.