REST Resource: properties.reportTasks

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

string

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

object ( ReportDefinition )

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

object ( ReportMetadata )

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

{
  "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
}

object ( Dimension )

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

object ( Metric )

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

object ( DateRange )

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

object ( FilterExpression )

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

object ( FilterExpression )

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

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.

string ( int64 format)

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

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

enum ( MetricAggregation )

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

object ( OrderBy )

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

string

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

object ( CohortSpec )

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

boolean

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

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

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

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

string

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

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

На измерения ссылаются по name в dimensionFilter , orderBys , dimensionExpression и pivots .

object ( DimensionExpression )

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

{

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

object ( CaseExpression )

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

object ( CaseExpression )

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

object ( ConcatenateExpression )

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

{
  "dimensionName": string
}

string

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

{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}

string

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

string

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

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

{
  "name": string,
  "expression": string,
  "invisible": boolean
}

string

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

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

На метрики ссылаются по name в metricFilter , orderBys и expression метрики.

string

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

boolean

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

{
  "startDate": string,
  "endDate": string,
  "name": string
}

string

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

string

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

string

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

{

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

object ( FilterExpressionList )

Выражения FilterExpressions в andGroup имеют отношение AND.

object ( FilterExpressionList )

Выражения FilterExpressions в orGroup имеют отношение ИЛИ.

object ( FilterExpression )

FilterExpression НЕ является выражением notExpression.

object ( Filter )

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

{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}

object ( FilterExpression )

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

{
  "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.
}

string

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

object ( StringFilter )

Фильтр, связанный со строками.

object ( InListFilter )

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

object ( NumericFilter )

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

object ( BetweenFilter )

Фильтр между двумя значениями.

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

enum ( MatchType )

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

string

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

boolean

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

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

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

boolean

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

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

enum ( Operation )

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

object ( NumericValue )

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

{

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

string ( int64 format)

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

number

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

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object ( NumericValue )

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

object ( NumericValue )

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

{
  "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.
}

boolean

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

object ( MetricOrderBy )

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

object ( DimensionOrderBy )

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

{
  "metricName": string
}

string

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

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

string

Имя измерения в запросе на упорядочивание.

enum ( OrderType )

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

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

object ( Cohort )

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

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

object ( CohortsRange )

Отчеты по когортам следуют за когортами за расширенный диапазон дат отчетности. Этот диапазон определяет продолжительность смещения для отслеживания когорт.

object ( CohortReportSettings )

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

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

string

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

string

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

object ( DateRange )

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

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

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

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

enum ( Granularity )

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

integer

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

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

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

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

integer

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

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

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

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

{
  "accumulate": boolean
}

boolean

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

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

integer

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

enum ( State )

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

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

integer

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

string

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

integer

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

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

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