Method: reports.batchGet

Возвращает данные Google Analytics.

HTTP-запрос

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet

URL-адрес использует синтаксис транскодирования gRPC .

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
  "useResourceQuotas": boolean
}
Поля
reportRequests[]

object( ReportRequest )

Запросы, на каждый запрос будет отдельный ответ. Запросов может быть максимум 5. Все запросы должны иметь одинаковые dateRanges , viewId , segments , samplingLevel и cohortGroup .

useResourceQuotas

boolean

Включает квоты на основе ресурсов (по умолчанию False ). Если для этого поля установлено значение True квоты на представление (профиль) регулируются вычислительными затратами запроса. Обратите внимание, что использование квот, основанных на стоимости, позволит повысить частоту выборки. (10 миллионов для SMALL , 100 миллионов для LARGE . Подробности см. в документации по лимитам и квотам .

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

Основной класс ответа, который содержит отчеты из вызова batchGet Reporting API.

JSON-представление
{
  "reports": [
    {
      object(Report)
    }
  ],
  "queryCost": number,
  "resourceQuotasRemaining": {
    object(ResourceQuotasRemaining)
  }
}
Поля
reports[]

object( Report )

Ответы, соответствующие каждому запросу.

queryCost

number

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

resourceQuotasRemaining

object( ResourceQuotasRemaining )

Сумма квоты ресурсов, оставшаяся для свойства.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ОтчетЗапрос

Основной класс запроса, определяющий запрос API отчетов.

JSON-представление
{
  "viewId": string,
  "dateRanges": [
    {
      object(DateRange)
    }
  ],
  "samplingLevel": enum(Sampling),
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "metricFilterClauses": [
    {
      object(MetricFilterClause)
    }
  ],
  "filtersExpression": string,
  "orderBys": [
    {
      object(OrderBy)
    }
  ],
  "segments": [
    {
      object(Segment)
    }
  ],
  "pivots": [
    {
      object(Pivot)
    }
  ],
  "cohortGroup": {
    object(CohortGroup)
  },
  "pageToken": string,
  "pageSize": number,
  "includeEmptyRows": boolean,
  "hideTotals": boolean,
  "hideValueRanges": boolean
}
Поля
viewId

string

Идентификатор представления Analytics, из которого можно получить данные. Каждый ReportRequest в методе batchGet должен содержать один и тот же viewId .

dateRanges[]

object( DateRange )

Диапазоны дат в запросе. Запрос может содержать максимум два диапазона дат. Ответ будет содержать набор значений показателей для каждой комбинации параметров для каждого диапазона дат в запросе. Таким образом, если имеется два диапазона дат, будет два набора значений показателей: один для исходного диапазона дат, а другой для второго диапазона дат. Поле reportRequest.dateRanges не следует указывать для когорт или запросов жизненного значения. Если диапазон дат не указан, используется диапазон дат по умолчанию (startDate: текущая дата — 7 дней, endDate: текущая дата — 1 день). Каждый ReportRequest в методе batchGet должен содержать одно и то же определение dateRanges .

samplingLevel

enum( Sampling )

Желаемый размер выборки отчета. Если поле samplingLevel не указано, используется уровень выборки DEFAULT . Каждый ReportRequest в методе batchGet должен содержать одно и то же определение samplingLevel . Подробности смотрите в руководстве разработчика .

dimensions[]

object( Dimension )

Запрошенные размеры. Запросы могут иметь всего 9 измерений.

dimensionFilterClauses[]

object( DimensionFilterClause )

Предложения фильтра измерений для фильтрации значений измерений. Они логически объединяются оператором AND . Обратите внимание, что фильтрация происходит до агрегирования каких-либо измерений, поэтому возвращаемые показатели представляют собой итоговые значения только для соответствующих измерений.

metrics[]

object( Metric )

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

metricFilterClauses[]

object( MetricFilterClause )

Предложения фильтра метрики. Они логически объединяются оператором AND . Фильтры метрик учитывают только первый диапазон дат, а не сравниваемый диапазон дат. Обратите внимание, что фильтрация по метрикам происходит после агрегирования метрик.

filtersExpression

string

Фильтры параметров или показателей, которые ограничивают данные, возвращаемые по вашему запросу. Чтобы использовать filtersExpression , укажите параметр или показатель для фильтрации, а затем выражение фильтра. Например, следующее выражение выбирает измерение ga:browser , которое начинается с Firefox; ga:browser=~^Firefox . Дополнительную информацию о фильтрах параметров и показателей см. в разделе «Справочник по фильтрам» .

orderBys[]

object( OrderBy )

Порядок сортировки выходных строк. Чтобы сравнить две строки, следующие элементы применяются по порядку, пока не будет найдена разница. Все диапазоны дат в выходных данных получают одинаковый порядок строк.

segments[]

object( Segment )

Сегментируйте данные, возвращаемые по запросу. Определение сегмента помогает просмотреть подмножество запроса сегмента. Запрос может содержать до четырех сегментов. Каждый ReportRequest в методе batchGet должен содержать одно и то же определение segments . Запросы с сегментами должны иметь измерение ga:segment .

pivots[]

object( Pivot )

Определения опорных точек. Запросы могут иметь максимум 2 пивота.

cohortGroup

object( CohortGroup )

Когортная группа, связанная с этим запросом. Если в запросе есть когортная группа, должно присутствовать измерение ga:cohort . Каждый ReportRequest в методе batchGet должен содержать одно и то же определение cohortGroup .

pageToken

string

Токен продолжения для получения следующей страницы результатов. Добавление этого к запросу вернет строки после pageToken. PageToken должно быть значением, возвращаемым в параметре nextPageToken в ответе на запрос report.batchGet.

pageSize

number

Размер страницы предназначен для разбиения на страницы и определяет максимальное количество возвращаемых строк. Размер страницы должен быть >= 0. Запрос возвращает значение по умолчанию — 1000 строк. API Analytics Core Reporting возвращает максимум 100 000 строк на каждый запрос, независимо от того, сколько вы запрашиваете. Он также может вернуть меньше строк, чем запрошено, если сегментов измерения не так много, как вы ожидаете. Например, для ga:country существует менее 300 возможных значений, поэтому при сегментировании только по стране вы не сможете получить более 300 строк, даже если вы установите pageSize более высокое значение.

includeEmptyRows

boolean

Если установлено значение false, ответ не включает строки, если все полученные метрики равны нулю. По умолчанию установлено значение false, что исключает эти строки.

hideTotals

boolean

Если установлено значение true, скрывается общая сумма всех показателей для всех соответствующих строк для каждого диапазона дат. По умолчанию false, и будут возвращены итоговые значения.

hideValueRanges

boolean

Если установлено значение true, скрывается минимум и максимум во всех совпадающих строках. По умолчанию установлено значение false, и возвращаются диапазоны значений.

Выборка

Значения уровня выборки.

Перечисления
SAMPLING_UNSPECIFIED Если поле samplingLevel не указано, используется уровень выборки DEFAULT .
DEFAULT Возвращает ответ с размером выборки, который обеспечивает баланс скорости и точности.
SMALL Он возвращает быстрый ответ с меньшим размером выборки.
LARGE Возвращает более точный ответ, используя большой размер выборки. Но это может привести к замедлению реакции.

Измерение

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

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

string

Имя извлекаемого измерения, например ga:browser .

histogramBuckets[]

string ( int64 format)

Если оно не пусто, мы помещаем значения измерения в сегменты после строки в int64. Значения измерений, которые не являются строковым представлением целочисленного значения, будут преобразованы в ноль. Значения сегментов должны быть в порядке возрастания. Каждое ведро закрыто на нижнем конце и открыто на верхнем конце. «Первый» сегмент включает все значения ниже первой границы, «последний» сегмент включает все значения до бесконечности. Значения измерения, попадающие в корзину, преобразуются в новое значение измерения. Например, если дать список «0, 1, 3, 4, 7», то мы вернем следующие сегменты:

  • сегмент №1: значения < 0, значение измерения «<0»
  • сегмент №2: значения в [0,1), значение измерения «0».
  • сегмент №3: значения в [1,3), значение измерения «1-2».
  • сегмент №4: значения в [3,4), значение измерения «3».
  • сегмент №5: значения в [4,7), значение размера «4-6».
  • сегмент №6: значения >= 7, значение параметра «7+».

ПРИМЕЧАНИЕ. Если вы применяете мутацию гистограммы к какому-либо измерению и используете это измерение при сортировке, для этой цели вам потребуется использовать тип сортировки HISTOGRAM_BUCKET . Без этого значения измерений будут отсортированы в соответствии со словарным (лексикографическим) порядком. Например, восходящий порядок словаря:

«<50», «1001+», «121-1000», «50-120»

И восходящий порядок HISTOGRAM_BUCKET :

«<50», «50-120», «121-1000», «1001+»

Клиент должен явно запросить "orderType": "HISTOGRAM_BUCKET" для измерения с измененной гистограммой.

Предложение «Фильтр измерения»

Группа фильтров параметров. Установите значение оператора, чтобы указать, как логически объединяются фильтры.

JSON-представление
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ]
}
Поля
operator

enum( FilterLogicalOperator )

Оператор для объединения нескольких фильтров измерений. Если не указано, оно рассматривается как OR .

filters[]

object( DimensionFilter )

Повторяющийся набор фильтров. Они логически объединяются на основе указанного оператора.

ФильтрЛогическийОператор

Как логически объединяются фильтры.

Перечисления
OPERATOR_UNSPECIFIED Неопределенный оператор. Это рассматривается как OR .
OR Логический оператор OR .
AND Логический оператор AND

Фильтр размеров

Фильтр измерения определяет параметры фильтрации для измерения.

JSON-представление
{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean
}
Поля
dimensionName

string

Измерение для фильтрации. DimensionFilter должен содержать измерение.

not

boolean

Логический оператор NOT . Если для этого логического значения установлено значение true, соответствующие значения измерения будут исключены из отчета. По умолчанию — ложь.

operator

enum( Operator )

Как сопоставить размерность с выражением. По умолчанию используется РЕГЭКСП.

expressions[]

string

Строки или регулярное выражение для сопоставления. Для сравнения используется только первое значение списка, если только оператор не IN_LIST . Если оператор IN_LIST , то весь список используется для фильтрации измерений, как описано в описании оператора IN_LIST .

caseSensitive

boolean

Должно ли совпадение быть чувствительным к регистру? По умолчанию — ложь.

Оператор

Поддерживаются различные типы соответствия.

Перечисления
OPERATOR_UNSPECIFIED Если тип соответствия не указан, он рассматривается как REGEXP .
REGEXP Выражение соответствия рассматривается как регулярное выражение. Все типы соответствия не рассматриваются как регулярные выражения.
BEGINS_WITH Соответствует значению, которое начинается с предоставленного выражения соответствия.
ENDS_WITH Соответствует значениям, которые заканчиваются указанным выражением соответствия.
PARTIAL Совпадение подстроки.
EXACT Значение должно полностью соответствовать выражению соответствия.
NUMERIC_EQUAL

Фильтры целочисленного сравнения. Для них игнорируется регистрозависимость, и предполагается, что выражение представляет собой строку, представляющую целое число. Условия отказа:

  • Если выражение не является допустимым типом int64, клиент должен ожидать ошибки.
  • Входные измерения, которые не являются допустимыми значениями int64, никогда не будут соответствовать фильтру.
NUMERIC_GREATER_THAN Проверяет, превышает ли размерность выражение соответствия. Прочтите описание NUMERIC_EQUALS чтобы узнать об ограничениях.
NUMERIC_LESS_THAN Проверяет, является ли размерность численно меньше выражения соответствия. Прочтите описание NUMERIC_EQUALS чтобы узнать об ограничениях.
IN_LIST

Эта опция используется для указания фильтра измерения, выражение которого может принимать любое значение из выбранного списка значений. Это помогает избежать оценки нескольких фильтров измерения точного соответствия, которые объединяются по логическому оператору ИЛИ для каждой отдельной строки ответа. Например:

expressions: ["A", "B", "C"]

Любая строка ответа, измерение которой имеет значение A, B или C, соответствует этому DimensionFilter.

Метрика

Метрики — это количественные измерения. Например, метрика ga:users указывает общее количество пользователей за запрошенный период времени.

JSON-представление
{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType)
}
Поля
expression

string

Выражение метрики в запросе. Выражение состоит из одной или нескольких метрик и чисел. Допустимые операторы: плюс (+), минус (-), отрицание (унарный -), деление на (/), умножение на (*), круглые скобки, положительные кардинальные числа (0–9), могут включать десятичные дроби и ограничены 1024 символа. Пример ga:totalRefunds/ga:users В большинстве случаев выражение метрики представляет собой просто одно имя метрики, например ga:users . Добавление смешанных метрик MetricType (например, CURRENCY + PERCENTAGE ) приведет к неожиданным результатам.

alias

string

Псевдоним выражения метрики — это альтернативное имя выражения. Псевдоним можно использовать для фильтрации и сортировки. Это поле является необязательным и полезно, если выражение представляет собой не один показатель, а сложное выражение, которое нельзя использовать при фильтрации и сортировке. Псевдоним также используется в заголовке столбца ответа.

formattingType

enum( MetricType )

Указывает, как должно быть отформатировано выражение метрики, например INTEGER .

Тип метрики

Виды метрик.

Перечисления
METRIC_TYPE_UNSPECIFIED Тип метрики не указан.
INTEGER Целочисленная метрика.
FLOAT Плавающая метрика.
CURRENCY Валютная метрика.
PERCENT Процентная метрика.
TIME Метрика времени в формате HH:MM:SS .

Предложение MetricFilter

Представляет группу фильтров метрик. Установите значение оператора, чтобы указать, как фильтры логически объединяются.

JSON-представление
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ]
}
Поля
operator

enum( FilterLogicalOperator )

Оператор для объединения нескольких фильтров метрик. Если не указано, оно рассматривается как OR .

filters[]

object( MetricFilter )

Повторяющийся набор фильтров. Они логически объединяются на основе указанного оператора.

МетрическийФильтр

MetricFilter определяет фильтр по метрике.

JSON-представление
{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string
}
Поля
metricName

string

Метрика, по которой будет выполняться фильтрация. metricFilter должен содержать имя метрики. Имя метрики может быть псевдонимом, ранее определенным как метрика, или выражением метрики.

not

boolean

Логический оператор NOT . Если для этого логического значения установлено значение true, соответствующие значения метрики будут исключены из отчета. По умолчанию — ложь.

operator

enum( Operator )

Является ли метрика EQUAL , LESS_THAN или GREATER_THAN значением сравнения, значением по умолчанию является EQUAL . Если оператор IS_MISSING , проверяет, отсутствует ли метрика, и игнорирует значение сравнения.

comparisonValue

string

Значение для сравнения.

Оператор

Различные варианты типов сравнения.

Перечисления
OPERATOR_UNSPECIFIED Если оператор не указан, он рассматривается как EQUAL .
EQUAL Должно ли значение метрики быть точно равным значению сравнения.
LESS_THAN Если значение метрики меньше значения сравнения.
GREATER_THAN Если значение метрики больше значения сравнения.
IS_MISSING Проверяет, отсутствует ли метрика. Не учитывает значение сравнения.

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

Задает параметры сортировки.

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

string

Поле, по которому производится сортировка. Порядок сортировки по умолчанию — по возрастанию. Пример: ga:browser . Обратите внимание, что здесь вы можете указать только одно поле для сортировки. Например, ga:browser, ga:city недопустимы.

orderType

enum( OrderType )

Тип заказа. Тип заказа по умолчанию — VALUE .

sortOrder

enum( SortOrder )

Порядок сортировки поля.

Тип заказа

OrderType управляет тем, как определяется порядок сортировки.

Перечисления
ORDER_TYPE_UNSPECIFIED Неуказанный тип заказа будет рассматриваться как сортировка по значению.
VALUE Порядок сортировки основан на значении выбранного столбца; смотрит только на первый диапазон дат.
DELTA Порядок сортировки основан на разнице значений выбранного столбца между первыми двумя диапазонами дат. Можно использовать только в том случае, если имеется ровно два диапазона дат.
SMART Порядок сортировки основан на взвешенном значении выбранного столбца. Если столбец имеет формат n/d, то взвешенное значение этого отношения будет (n + totals.n)/(d + totals.d) Используется только для показателей, представляющих отношения.
HISTOGRAM_BUCKET Тип порядка гистограммы применим только к столбцам измерения с непустыми сегментами гистограммы.
DIMENSION_AS_INTEGER Если размеры представляют собой числа фиксированной длины, обычная сортировка будет работать нормально. DIMENSION_AS_INTEGER можно использовать, если измерения представляют собой числа переменной длины.

Порядок сортировки

Порядок сортировки вида.

Перечисления
SORT_ORDER_UNSPECIFIED Если порядок сортировки не указан, по умолчанию используется возрастающий.
ASCENDING Восходящая сортировка. Поле будет отсортировано по возрастанию.
DESCENDING По убыванию. Поле будет отсортировано по убыванию.

Сегмент

Определение сегмента, если отчет необходимо сегментировать. Сегмент – это подмножество данных Google Analytics. Например, из всего набора пользователей один сегмент может состоять из пользователей из определенной страны или города.

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

  // Union field dynamicOrById can be only one of the following:
  "dynamicSegment": {
    object(DynamicSegment)
  },
  "segmentId": string
  // End of list of possible types for union field dynamicOrById.
}
Поля
Поле объединения dynamicOrById . Сегмент можно определить динамически с помощью DynamicSegment или с помощью идентификатора встроенного или настраиваемого сегмента. dynamicOrById может быть только одним из следующих:
dynamicSegment

object( DynamicSegment )

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

segmentId

string

Идентификатор встроенного или специального сегмента, например gaid::-3 .

Динамический сегмент

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

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

string

Имя динамического сегмента.

userSegment

object( SegmentDefinition )

Сегмент пользователей, чтобы выбрать пользователей для включения в сегмент.

sessionSegment

object( SegmentDefinition )

Сегмент сеанса, чтобы выбрать сеансы для включения в сегмент.

Определение сегмента

SegmentDefinition определяет сегмент как набор SegmentFilters, которые объединяются логической операцией AND .

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

object( SegmentFilter )

Сегмент определяется набором сегментных фильтров, которые объединяются логической операцией AND .

СегментФильтр

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

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

  // Union field simpleOrSequence can be only one of the following:
  "simpleSegment": {
    object(SimpleSegment)
  },
  "sequenceSegment": {
    object(SequenceSegment)
  }
  // End of list of possible types for union field simpleOrSequence.
}
Поля
not

boolean

Если это правда, сопоставить дополнение простого сегмента или сегмента последовательности. Например, чтобы сопоставить все посещения не из «Нью-Йорка», мы можем определить сегмент следующим образом:

  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },

Поле объединения simpleOrSequence . Это простой сегмент или определение сегмента последовательности. simpleOrSequence может быть только одним из следующих:
simpleSegment

object( SimpleSegment )

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

sequenceSegment

object( SequenceSegment )

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

Простой сегмент

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

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

object( OrFiltersForSegment )

Список групп сегментных фильтров, которые объединяются логическим оператором AND

ОрФильтерсФорСегмент

Список сегментных фильтров в группе OR объединяется логическим оператором ИЛИ.

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

object( SegmentFilterClause )

Список фильтров сегментов, которые можно объединить с оператором OR .

Предложение SegmentFilter

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

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

  // Union field dimensionOrMetricFilter can be only one of the following:
  "dimensionFilter": {
    object(SegmentDimensionFilter)
  },
  "metricFilter": {
    object(SegmentMetricFilter)
  }
  // End of list of possible types for union field dimensionOrMetricFilter.
}
Поля
not

boolean

Соответствует дополнению ( ! ) фильтра.

Поле объединения dimensionOrMetricFilter . Фильтр измерения или метрики. dimensionOrMetricFilter может иметь только одно из следующих значений:
dimensionFilter

object( SegmentDimensionFilter )

Фильтр измерений для определения сегмента.

metricFilter

object( SegmentMetricFilter )

Фильтр метрик для определения сегмента.

SegmentDimensionFilter

Фильтр измерения определяет параметры фильтрации для измерения.

JSON-представление
{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string
}
Поля
dimensionName

string

Имя измерения, к которому применяется фильтр.

operator

enum( Operator )

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

caseSensitive

boolean

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

expressions[]

string

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

minComparisonValue

string

Минимальные значения сравнения для типа соответствия BETWEEN .

maxComparisonValue

string

Максимальные значения сравнения для типа соответствия BETWEEN .

Оператор

Поддерживаются различные типы соответствия.

Перечисления
OPERATOR_UNSPECIFIED Если тип соответствия не указан, он рассматривается как REGEXP.
REGEXP Выражение соответствия рассматривается как регулярное выражение. Все остальные типы соответствия не рассматриваются как регулярные выражения.
BEGINS_WITH Соответствует значениям, начинающимся с предоставленного выражения соответствия.
ENDS_WITH Соответствует значениям, которые заканчиваются указанным выражением соответствия.
PARTIAL Совпадение подстроки.
EXACT Значение должно полностью соответствовать выражению соответствия.
IN_LIST

Эта опция используется для указания фильтра измерений, выражение которого может принимать любое значение из выбранного списка значений. Это помогает избежать оценки нескольких фильтров измерения точного соответствия, которые объединяются по логическому оператору ИЛИ для каждой отдельной строки ответа. Например:

expressions: ["A", "B", "C"]

Любая строка ответа, измерение которой имеет значение A, B или C, соответствует этому DimensionFilter.

NUMERIC_LESS_THAN

Фильтры целочисленного сравнения. Для них игнорируется регистрозависимость, и предполагается, что выражение представляет собой строку, представляющую целое число. Условия отказа:

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

Проверяет, является ли размерность численно меньше выражения соответствия.

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

Сегментметрическийфильтр

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

JSON-представление
{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string
}
Поля
scope

enum( Scope )

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

metricName

string

Метрика, по которой будет выполняться фильтрация. metricFilter должен содержать имя метрики.

operator

enum( Operator )

Указывает операцию, которую необходимо выполнить для сравнения метрики. По умолчанию EQUAL .

comparisonValue

string

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

maxComparisonValue

string

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

Объем

Область действия метрики определяет уровень, на котором определена эта метрика: PRODUCT , HIT , SESSION или USER . Значения метрики также могут сообщаться в областях, превышающих его основную область. Например, ga:pageviews и ga:transactions можно сообщать на уровне SESSION и USER , просто суммируя их для каждого обращения, которое происходит в этих сеансах или для этих пользователей.

Перечисления
UNSPECIFIED_SCOPE Если область не указана, по умолчанию используется область условия USER или SESSION в зависимости от того, пытается ли сегмент выбрать пользователей или сеансы.
PRODUCT Объем продукта.
HIT Хит прицел.
SESSION Область сеанса.
USER Область действия пользователя.

Оператор

Различные варианты типов сравнения.

Перечисления
UNSPECIFIED_OPERATOR Неуказанный оператор рассматривается как оператор LESS_THAN .
LESS_THAN Проверяет, меньше ли значение метрики значения сравнения.
GREATER_THAN Проверяет, превышает ли значение метрики значение сравнения.
EQUAL Оператор равенства.
BETWEEN Для оператора между минимум и максимум являются исключительными. Для сравнения мы будем использовать LT и GT .

Сегмент последовательности

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

JSON-представление
{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean
}
Поля
segmentSequenceSteps[]

object( SegmentSequenceStep )

Список шагов в последовательности.

firstStepShouldMatchFirstHit

boolean

Если установлено, условие первого шага должно соответствовать первому обращению посетителя (в диапазоне дат).

СегментПоследовательностьШаг

Определение последовательности сегментов.

JSON-представление
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType)
}
Поля
orFiltersForSegment[]

object( OrFiltersForSegment )

Последовательность задается списком сгруппированных фильтров Или, которые объединяются оператором AND

matchType

enum( MatchType )

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

Тип соответствия

Тип соответствия последовательности.

Перечисления
UNSPECIFIED_MATCH_TYPE Неуказанный тип соответствия рассматривается как предшествующий.
PRECEDES Оператор указывает, что предыдущий шаг предшествует следующему шагу.
IMMEDIATELY_PRECEDES Оператор указывает, что предыдущий шаг непосредственно предшествует следующему шагу.

Вращаться

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

JSON-представление
{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number
}
Поля
dimensions[]

object( Dimension )

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

dimensionFilterClauses[]

object( DimensionFilterClause )

DimensionFilterClauses логически комбинируются с оператором AND : только данные, включенные во все эти DimensionFilterClauses, вносят вклад в значения в этой сводной области. Фильтры измерений можно использовать для ограничения столбцов, отображаемых в сводной области. Например, если у вас есть ga:browser в качестве запрошенного измерения в сводной области, и вы указываете ключевые фильтры, чтобы ограничить ga:browser только «IE» или «Firefox», тогда в качестве столбцов будут отображаться только эти два браузера.

metrics[]

object( Metric )

Поворотные метрики. Метрики сводной таблицы являются частью ограничения на общее количество метрик, разрешенных в запросе.

startGroup

number

Если было запрошено k метрик, то ответ будет содержать некоторое зависящее от данных количество столбцов отчета, кратное k. Например, если вы повернете измерение ga:browser , вы получите k столбцов для «Firefox», k столбцов для «IE», k столбцов для «Chrome» и т. д. Порядок групп столбцов определяется по убыванию. порядок «итого» для первого из значений k. Связи разрушаются лексикографическим упорядочиванием первого основного измерения, затем лексикографическим упорядочиванием второго основного измерения и так далее. Например, если итоговые значения для первого значения для Firefox, IE и Chrome были 8, 2, 8 соответственно, порядок столбцов будет следующим: Chrome, Firefox, IE.

Следующее позволяет вам выбрать, какая из групп из k столбцов будет включена в ответ.

maxGroupCount

number

Указывает максимальное количество возвращаемых групп. Значение по умолчанию — 10, максимальное значение — 1000.

Когортная группа

Определяет когортную группу. Например:

"cohortGroup": {
  "cohorts": [{
    "name": "cohort 1",
    "type": "FIRST_VISIT_DATE",
    "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
  },{
    "name": "cohort 2"
     "type": "FIRST_VISIT_DATE"
     "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
  }]
}
JSON-представление
{
  "cohorts": [
    {
      object(Cohort)
    }
  ],
  "lifetimeValue": boolean
}
Поля
cohorts[]

object( Cohort )

Определение когорты.

lifetimeValue

boolean

Включите пожизненную ценность (LTV). LTV измеряет пожизненную ценность пользователей, привлеченных по разным каналам. См.: Когортный анализ и пожизненная ценность. Если значение lifeValue неверно:

  • Значения показателей аналогичны значениям в когортном отчете веб-интерфейса.
  • Диапазоны дат определения когорты должны соответствовать календарной неделе и месяцу. т.е. при запросе ga:cohortNthWeek startDate в определении когорты должно быть воскресеньем, а endDate должна быть следующей субботой, а для ga:cohortNthMonth startDate должно быть 1-м числом месяца, а endDate должно быть последним днем ​​месяца. .

Когда lifeValue истинно:

  • Значения метрики будут соответствовать значениям в отчете о значениях LifeTime веб-интерфейса.
  • Отчет «Пожизненная ценность» показывает, как ценность пользователя (доход) и вовлеченность (просмотры приложений, достигнутые цели, сеансы и продолжительность сеанса) растут в течение 90 дней после привлечения пользователя.
  • Метрики рассчитываются как совокупное среднее значение на пользователя за интервал времени.
  • Диапазоны дат определения когорты не обязательно должны быть согласованы с границами календарных недель и месяцев.
  • viewId должен быть идентификатором представления приложения.

когорта

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

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

string

Уникальное имя для когорты. Если не указано, имя будет сгенерировано автоматически со значениями cohort_[1234...].

type

enum( Type )

Тип когорты. На данный момент единственным поддерживаемым типом является FIRST_VISIT_DATE . Если это поле не указано, когорта рассматривается как когорта типа FIRST_VISIT_DATE .

dateRange

object( DateRange )

Это используется для когорты FIRST_VISIT_DATE . Когорта выбирает пользователей, дата первого посещения которых находится между датой начала и датой окончания, определенной в DateRange. Диапазоны дат должны быть согласованы для запросов когорт. Если запрос содержит ga:cohortNthDay он должен длиться ровно один день, если ga:cohortNthWeek он должен быть выровнен по границе недели (начиная с воскресенья и заканчивая субботой), а для ga:cohortNthMonth диапазон дат должен быть выровнен по месяцу. (начиная с первого и заканчивая последним днем ​​месяца). Для запросов LTV таких ограничений нет. Вам не нужно указывать диапазон дат для поля reportsRequest.dateRanges .

Тип

Тип когорты.

Перечисления
UNSPECIFIED_COHORT_TYPE Если не указано, оно рассматривается как FIRST_VISIT_DATE .
FIRST_VISIT_DATE Когорты, выбранные на основе даты первого посещения.

Отчет

Ответ данных, соответствующий запросу.

JSON-представление
{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string
}
Поля
columnHeader

object( ColumnHeader )

Заголовки столбцов.

data

object( ReportData )

Данные ответа.

nextPageToken

string

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

Заголовок столбца

Заголовки столбцов.

JSON-представление
{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  }
}
Поля
dimensions[]

string

Имена измерений в ответе.

metricHeader

object( MetricHeader )

Заголовки метрик для метрик в ответе.

Метрикхедер

Заголовки метрик.

JSON-представление
{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ]
}
Поля
metricHeaderEntries[]

object( MetricHeaderEntry )

Заголовки метрик в ответе.

pivotHeaders[]

object( PivotHeader )

Заголовки для сводных данных в ответе.

MetricHeaderEntry

Заголовок для метрик.

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

string

Название заголовка.

type

enum( MetricType )

Тип метрики, например INTEGER .

PivotHeader

Заголовки для каждого из разделов сводной таблицы, определенных в запросе.

JSON-представление
{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number
}
Поля
pivotHeaderEntries[]

object( PivotHeaderEntry )

Один заголовок сводного раздела.

totalPivotGroupsCount

number

Общее количество групп для этой сводной таблицы.

PivotHeaderEntry

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

JSON-представление
{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  }
}
Поля
dimensionNames[]

string

Имя измерений в сводном ответе.

dimensionValues[]

string

Значения размеров в сводной таблице.

metric

object( MetricHeaderEntry )

Заголовок метрики в сводной таблице.

Данные отчета

Часть данных отчета.

JSON-представление
{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
  "dataLastRefreshed": string
}
Поля
rows[]

object( ReportRow )

Для каждой уникальной комбинации измерений существует один ReportRow.

totals[]

object( DateRangeValues )

Для каждого запрошенного диапазона дат, для набора всех строк, соответствующих запросу, каждый запрошенный формат значения получает итоговое значение. Итоговое значение для формата значения вычисляется путем суммирования метрик, упомянутых в формате значения, а затем оценки формата значения как скалярного выражения. Например, «итогов» для 3 / (ga:sessions + 2) мы вычисляем 3 / ((sum of all relevant ga:sessions) + 2) . Итоговые значения вычисляются до разбиения на страницы.

rowCount

number

Общее количество совпадающих строк для этого запроса.

minimums[]

object( DateRangeValues )

Минимальные и максимальные значения, наблюдаемые во всех совпадающих строках. Оба они пусты, если hideValueRanges в запросе равно false или если rowCount равен нулю.

maximums[]

object( DateRangeValues )

Минимальные и максимальные значения, наблюдаемые во всех совпадающих строках. Оба они пусты, если hideValueRanges в запросе равно false или если rowCount равен нулю.

samplesReadCounts[]

string ( int64 format)

Если результаты являются выборочными , возвращается общее количество прочитанных образцов, по одной записи на диапазон дат. Если результаты не выбраны, это поле не будет определено. Подробности смотрите в руководстве разработчика .

samplingSpaceSizes[]

string ( int64 format)

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

isDataGolden

boolean

Указывает, является ли ответ на этот запрос золотым или нет. Данные являются золотыми, когда тот же самый запрос не даст никаких новых результатов, если его задать в более поздний момент времени.

dataLastRefreshed

string ( Timestamp format)

Время последнего обновления данных в отчете. Все обращения, полученные до этой отметки времени, включаются в расчет отчета.

Временная метка в формате RFC3339 UTC «Зулу» с точностью до наносекунд. Пример: "2014-10-02T15:01:23.045123456Z" .

Строка отчета

В отчете строка.

JSON-представление
{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ]
}
Поля
dimensions[]

string

Список требуемых размеров.

metrics[]

object( DateRangeValues )

Список метрик для каждого запрошенного DateRange.

ДатаРангеЗначения

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

JSON-представление
{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ]
}
Поля
values[]

string

Каждое значение соответствует каждой метрике в запросе.

pivotValueRegions[]

object( PivotValueRegion )

Значения каждого сводного региона.

PivotValueRegion

Значения метрики в сводной области.

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

string

Значения показателей в каждом из опорных регионов.

ResourceQuotasRemaining

Токены квоты ресурсов, оставшиеся для свойства после завершения запроса.

JSON-представление
{
  "dailyQuotaTokensRemaining": number,
  "hourlyQuotaTokensRemaining": number
}
Поля
dailyQuotaTokensRemaining

number

Осталась ежедневная квота ресурсов.

hourlyQuotaTokensRemaining

number

Остались жетоны почасовой квоты ресурсов.

Попробуй это!