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)

Необязательное поле. Условие фильтрации показателей. Применяется после агрегирования строк отчета, как и предложение HAVING в SQL. Параметры нельзя использовать в этом фильтре.

offset

string (int64 format)

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

При создании задачи отчета параметры offset и limit определяют подмножество строк данных из хранилища Google Аналитики, которые будут включены в сгенерированный отчет. Например, если в хранилище Google Аналитики всего 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

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

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

Независимо от этой настройки keepEmptyRows в отчете могут быть показаны только данные, записанные ресурсом Google Аналитики.

Например, если в свойстве никогда не регистрируется событие 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, ", ", city).

DimensionExpression

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

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of mutually exclusive fields.
}
Поля
Укажите один тип выражения для параметра DimensionExpression. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
lowerCase

object (CaseExpression)

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

upperCase

object (CaseExpression)

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

concatenate

object (ConcatenateExpression)

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

Конец взаимоисключающих полей.

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 и показателе expression.

expression

string

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

invisible

boolean

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

DateRange

Непрерывный набор дней: startDate, startDate + 1, …, endDate. Можно запросить до четырех диапазонов дат.

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-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of mutually exclusive fields.
}
Поля
Для параметра FilterExpression можно указать только один тип выражения фильтра. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
andGroup

object (FilterExpressionList)

Между выражениями FilterExpressions в группе andGroup действует логическое отношение И.

orGroup

object (FilterExpressionList)

Между выражениями фильтра в orGroup действует логическое отношение ИЛИ.

notExpression

object (FilterExpression)

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

filter

object (Filter)

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

Конец взаимоисключающих полей.

FilterExpressionList

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

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

object (FilterExpression)

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

Фильтр

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

JSON-представление
{
  "fieldName": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of mutually exclusive fields.
}
Поля
fieldName

string

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

Для Filter можно указать только один тип фильтра. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
stringFilter

object (StringFilter)

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

inListFilter

object (InListFilter)

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

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

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

emptyFilter

object (EmptyFilter)

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

Конец взаимоисключающих полей.

StringFilter

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

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

enum (MatchType)

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

value

string

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

caseSensitive

boolean

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

MatchType

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

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

InListFilter

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

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

string

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

caseSensitive

boolean

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

NumericFilter

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

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 Больше или равно

NumericValue

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

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "int64Value": string,
  "doubleValue": number
  // End of mutually exclusive fields.
}
Поля
Одно из числовых значений. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
int64Value

string (int64 format)

Целое число

doubleValue

number

Значение типа double

Конец взаимоисключающих полей.

BetweenFilter

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

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

object (NumericValue)

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

toValue

object (NumericValue)

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

EmptyFilter

У этого типа нет полей.

Отфильтруйте пустые значения. Соответствует значениям параметров "" или (not set). Используйте этот фильтр, чтобы найти строки с отсутствующими или незаполненными значениями параметров, или объедините его с notExpression, чтобы исключить такие строки из отчета, не фильтруя "" и (not set) по отдельности.

MetricAggregation

Представляет агрегированные показатели.

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

OrderBy

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

JSON-представление
{
  "desc": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of mutually exclusive fields.
}
Поля
desc

boolean

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

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

object (MetricOrderBy)

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

dimension

object (DimensionOrderBy)

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

Конец взаимоисключающих полей.

MetricOrderBy

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

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

string

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

DimensionOrderBy

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

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

string

Название параметра в запросе, по которому нужно отсортировать данные.

orderType

enum (OrderType)

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

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 можно сопоставить с месяцем, начиная с первого и заканчивая последним днем месяца.

CohortsRange

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

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

enum (Granularity)

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

startOffset

integer

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

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

Если 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.

CohortReportSettings

Необязательные настройки когортного отчета.

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

boolean

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

SamplingLevel

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

Перечисления
SAMPLING_LEVEL_UNSPECIFIED Неуказанный тип.
LOW Применяет уровень выборки 10 миллионов для стандартных ресурсов и 100 миллионов для ресурсов Google Аналитики 360.
MEDIUM Доступно только для ресурсов Google Аналитики 360 с уровнем выборки 1 млрд.
UNSAMPLED Доступно только в ресурсах Google Аналитики 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. Допустимы и другие типы нормализации. Примеры: "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 Аналитики. Если вы хотите запросить дополнительные строки данных, помимо тех, что есть в текущем отчете, вы можете запустить новую задачу создания отчета на основе totalRowCount.

taskRowCount – количество строк, относящихся к текущему отчету, а totalRowCount – общее количество строк во всех данных, полученных из хранилища Google Аналитики.

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

Штат

Статус обработки.

Перечисления
STATE_UNSPECIFIED Состояние "Не указано" никогда не используется.
CREATING Отчет создается и будет доступен позже. Создание отчета начинается сразу после вызова CreateReport.
ACTIVE Отчет создан и готов к запросам.
FAILED Не удалось создать отчет.

Методы

create

Запускает создание задачи отчета.

get

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

list

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

query

Получает контент задачи создания отчета.