- HTTP-запрос
- Параметры пути
- Тело запроса
- Тело ответа
- Области авторизации
- Диапазон дат
- Воронка
- Шаг воронки
- Выражение Фильтра Воронки
- Список выражений фильтра воронки
- ВоронкаПолеФильтр
- Строковый фильтр
- Тип соответствия
- Инлистфильтр
- ЧисловойФильтр
- Операция
- Числовое значение
- МеждуФильтр
- Фильтр событий воронки
- ВоронкаПараметрФильтрВыражение
- ВоронкаПараметрФильтрВыражениеСписок
- ВоронкаПараметрФильтр
- Разбивка по воронке
- Измерение
- Выражение Измерения
- Выражение случая
- ОбъединитьВыражение
- ВоронкаСледующееДействие
- Тип визуализации воронки
- Сегмент
- Пользовательский сегмент
- Усерсегменткритериа
- Усерсегменткондиционионгруппу
- Пользовательские критерии
- Выражение SegmentFilterExpression
- Список выражений сегмента фильтра
- СегментФильтр
- СегментФильтрОбзор
- Фильтр событий сегмента
- СегментПараметрФильтрВыражение
- СегментПараметрФильтрВыражениеСписок
- СегментПараметрФильтр
- СегментПараметрФильтрОбзор
- Усерсегментсеквенцегруппу
- Усерсеквенцестеп
- Пользовательское исключение
- UserExclusionDuration
- Сеансегмент
- Сеансегменткритериа
- Сеансегменткондиционионгруппу
- SessionCriteriaScoping
- Сеансегментисключение
- Сеансексклюзиондюрация
- Событийный сегмент
- Критерии сегмента событий
- ГруппаСобытийСегментУсловие
- EventCriteriaScoping
- Исключение сегмента событий
- СобытиеExclusionDuration
- Выражение фильтра
- Список выражений фильтра
- Фильтр
- SubReport воронки
- Заголовок измерения
- Метрикхедер
- Тип метрики
- Ряд
- РазмерностьЗначение
- Метричное значение
- Метаданные FunnelResponseMetadata
- Выборка метаданных
- PropertyQuota
- Статус квоты
- Попробуй это!
Возвращает настроенный отчет по воронке данных о ваших событиях Google Analytics. Данные, возвращаемые из API, представляют собой таблицу со столбцами для запрошенных параметров и показателей.
Исследование воронки позволяет визуализировать шаги, которые ваши пользователи предпринимают для выполнения задачи, и быстро увидеть, насколько хорошо они добиваются успеха или терпят неудачу на каждом этапе. Например, как потенциальные клиенты становятся покупателями, а затем покупателями? Как разовые покупатели становятся постоянными? С помощью этой информации вы можете улучшить неэффективные или заброшенные пути взаимодействия с клиентами. Дополнительную информацию см. в разделе Исследование последовательностей GA4 .
Этот метод представлен на стадии альфа-версии с целью сбора отзывов о синтаксисе и возможностях перед входом в бета-версию. Чтобы оставить отзыв об этом API, заполните форму «Отзыв об отчетах по воронке API данных Google Analytics» .
HTTP-запрос
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
property | Необязательный. Идентификатор ресурса Google Analytics GA4, события которого отслеживаются. Указывается в URL-пути, а не в теле. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта . В пакетном запросе это свойство должно быть либо неопределенным, либо соответствовать свойству уровня пакета. Пример: свойства/1234 |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "dateRanges": [ { object ( |
Поля | |
---|---|
dateRanges[] | Необязательный. Диапазоны дат данных для чтения. Если запрошено несколько диапазонов дат, каждая строка ответа будет содержать индекс диапазона дат, отсчитываемый от нуля. Если два диапазона дат перекрываются, данные о событиях для перекрывающихся дней включаются в строки ответа для обоих диапазонов дат. |
funnel | Необязательный. Конфигурация воронки этого запроса. Эта конфигурация воронки является обязательной. |
funnelBreakdown | Необязательный. Если указано, эта разбивка добавляет измерение к ответу подотчета таблицы воронки. Это измерение разбивки расширяет каждый шаг воронки до уникальных значений измерения разбивки. Например, при разбивке по измерению |
funnelNextAction | Необязательный. Если указано, следующее действие добавляет измерение в ответ подотчета визуализации воронки. Это измерение следующего действия расширяет каждый шаг воронки до уникальных значений следующего действия. Например, следующее действие измерения Следующее действие поддерживает только |
funnelVisualizationType | Необязательный. Тип визуализации воронки управляет размерами, представленными в ответе подотчета визуализации воронки. Если не указано, используется |
segments[] | Необязательный. Конфигурации сегментов. Сегменты — это подмножества данных свойства. В отчете по воронке с сегментами последовательность оценивается в каждом сегменте. Каждый сегмент, указанный в этом запросе, создает в ответе отдельную строку; в ответе каждый сегмент идентифицируется своим именем. Параметр сегментов является необязательным. Запросы ограничены 4 сегментами. |
limit | Необязательный. Количество возвращаемых строк. Если не указано, возвращается 10 000 строк. API возвращает максимум 250 000 строк на запрос, независимо от того, сколько вы запрашиваете. API также может возвращать меньше строк, чем запрошенное |
dimensionFilter | Необязательный. Фильтры измерений позволяют запрашивать в отчете только определенные значения измерений. Дополнительные сведения см. в разделе «Создание отчета: фильтры измерений» . В этом фильтре нельзя использовать метрики. |
returnPropertyQuota | Необязательный. Переключает, возвращать ли текущее состояние квоты этого ресурса Analytics. Квота возвращается в PropertyQuota . |
Тело ответа
Ответ на отчет о воронке содержит два подотчета. Два подотчета представляют собой разные комбинации параметров и показателей.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{ "funnelTable": { object ( |
Поля | |
---|---|
funnelTable | Таблица воронки — это отчет с указанием шага воронки, сегмента, параметра разбивки, активных пользователей, степени завершения, количества отказов и количества отказов. Измерение сегмента присутствует в этом ответе только в том случае, если сегмент был запрошен. Параметр разбивки присутствует в этом ответе только в том случае, если он был запрошен. |
funnelVisualization | Визуализация воронки – это отчет с указанием шага воронки, сегмента, даты, параметра следующего действия и активных пользователей. Измерение сегмента присутствует в этом ответе только в том случае, если сегмент был запрошен. Измерение даты присутствует в этом ответе только в том случае, если оно было запрошено через тип воронки |
propertyQuota | Состояние квоты этого ресурса Google Аналитики, включая этот запрос. |
kind | Определяет, к какому типу ресурса относится это сообщение. Этот |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/analytics.readonly
-
https://www.googleapis.com/auth/analytics
Диапазон дат
Непрерывный набор дней: startDate
, startDate + 1
, ..., endDate
. Запросы разрешены до 4 диапазонов дат.
JSON-представление |
---|
{ "startDate": string, "endDate": string, "name": string } |
Поля | |
---|---|
startDate | Включающая дата начала запроса в формате |
endDate | Включающая дата окончания запроса в формате |
name | Присваивает имя этому диапазону дат. Измерение |
Воронка
Настраивает воронку в запросе отчета о воронке. Воронка сообщает о пользователях, когда они проходят последовательность шагов.
Исследование воронки позволяет визуализировать шаги, которые ваши пользователи предпринимают для выполнения задачи, и быстро увидеть, насколько хорошо они добиваются успеха или терпят неудачу на каждом этапе. Например, как потенциальные клиенты становятся покупателями, а затем покупателями? Как разовые покупатели становятся постоянными? С помощью этой информации вы можете улучшить неэффективные или заброшенные пути взаимодействия с клиентами.
JSON-представление |
---|
{
"isOpenFunnel": boolean,
"steps": [
{
object ( |
Поля | |
---|---|
isOpenFunnel | В открытой воронке пользователи могут войти в воронку на любом этапе, а в закрытой воронке пользователи должны войти в воронку на первом этапе. Необязательный. Если не указано иное, используется закрытая воронка. |
steps[] | Последовательные шаги этой воронки. |
Шаг воронки
Шаги определяют путь пользователя, который вы хотите измерить. Шаги содержат одно или несколько условий, которым должны соответствовать ваши пользователи, чтобы их включили в этот этап воронки.
JSON-представление |
---|
{
"name": string,
"isDirectlyFollowedBy": boolean,
"filterExpression": {
object ( |
Поля | |
---|---|
name | Отличительное имя для этого шага. Если не указано, шаги будут именоваться индексированным именем, начинающимся с 1 (например, «0.», «1.» и т. д.). Это имя определяет строковое значение, возвращаемое измерением |
isDirectlyFollowedBy | Если это правда, этот шаг должен следовать непосредственно за предыдущим шагом. Если false, между предыдущим шагом и этим шагом могут быть события. Если значение не указано, |
filterExpression | Условие, которому должны соответствовать ваши пользователи, чтобы их включили в этот этап воронки. |
withinDurationFromPriorStep | Если указано, этот шаг должен завершиться в пределах продолжительности завершения предыдущего шага. Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
Выражение Фильтра Воронки
Выражает комбинации фильтров-воронок.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Союз полевых expr . Укажите один тип фильтра для FunnelFilterExpression . expr может быть только одним из следующих: | |
andGroup | Выражение FunnelFilterExpression в |
orGroup | Выражение FunnelFilterExpression в |
notExpression | FunnelFilterExpression НЕ является выражением |
funnelFieldFilter | Фильтр воронки для параметра или показателя. |
funnelEventFilter | Создает фильтр, который соответствует событиям с одним именем события. Если указано выражение фильтра параметров, этому фильтру событий соответствует только подмножество событий, которые соответствуют как одному имени события, так и выражениям фильтра параметров. |
Список выражений фильтра воронки
Список выражений фильтра воронки.
JSON-представление |
---|
{
"expressions": [
{
object ( |
Поля | |
---|---|
expressions[] | Список выражений фильтра воронки. |
ВоронкаПолеФильтр
Выражение для фильтрации значений параметра или показателя.
JSON-представление |
---|
{ "fieldName": string, // Union field |
Поля | |
---|---|
fieldName | Имя измерения или имя метрики. |
Поле объединения one_filter . Укажите один тип фильтра. one_filter может быть только одним из следующих: | |
stringFilter | Фильтр, связанный со строками. |
inListFilter | Фильтр для значений в списке. |
numericFilter | Фильтр для числовых значений или значений даты. |
betweenFilter | Фильтр между двумя значениями. |
Строковый фильтр
Фильтр для строки
JSON-представление |
---|
{
"matchType": enum ( |
Поля | |
---|---|
matchType | Тип соответствия для этого фильтра. |
value | Строковое значение, используемое для сопоставления. |
caseSensitive | Если это правда, строковое значение чувствительно к регистру. |
Тип соответствия
Тип соответствия строкового фильтра
Перечисления | |
---|---|
MATCH_TYPE_UNSPECIFIED | Неопределенные |
EXACT | Точное совпадение строкового значения. |
BEGINS_WITH | Начинается со строкового значения. |
ENDS_WITH | Заканчивается строковым значением. |
CONTAINS | Содержит строковое значение. |
FULL_REGEXP | Полное совпадение регулярного выражения со строковым значением. |
PARTIAL_REGEXP | Частичное совпадение регулярного выражения со строковым значением. |
Инлистфильтр
Результат должен быть в списке строковых значений.
JSON-представление |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Поля | |
---|---|
values[] | Список строковых значений. Должно быть непусто. |
caseSensitive | Если это правда, строковое значение чувствительно к регистру. |
ЧисловойФильтр
Фильтры для числовых значений или значений даты.
JSON-представление |
---|
{ "operation": enum ( |
Поля | |
---|---|
operation | Тип операции для этого фильтра. |
value | Числовое значение или значение даты. |
Операция
Операция, примененная к числовому фильтру
Перечисления | |
---|---|
OPERATION_UNSPECIFIED | Неопределенные. |
EQUAL | Равный |
LESS_THAN | Меньше, чем |
LESS_THAN_OR_EQUAL | Меньше или равно |
GREATER_THAN | Больше чем |
GREATER_THAN_OR_EQUAL | Больше или равно |
Числовое значение
Чтобы представить число.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения one_value . Одно из числовых значений one_value может быть только одним из следующих: | |
int64Value | Целое значение |
doubleValue | Двойное значение |
МеждуФильтр
Чтобы выразить это, результат должен находиться между двумя числами (включительно).
JSON-представление |
---|
{ "fromValue": { object ( |
Поля | |
---|---|
fromValue | Начинается с этого номера. |
toValue | Заканчивается этим номером. |
Фильтр событий воронки
Создает фильтр, который соответствует событиям с одним именем события. Если указано выражение фильтра параметров, этому фильтру событий соответствует только подмножество событий, которые соответствуют как одному имени события, так и выражениям фильтра параметров.
JSON-представление |
---|
{
"eventName": string,
"funnelParameterFilterExpression": {
object ( |
Поля | |
---|---|
eventName | Этот фильтр соответствует событиям с одним именем события. Укажите название мероприятия. |
funnelParameterFilterExpression | Если указано, этот фильтр соответствует событиям, которые соответствуют как одному имени события, так и выражениям фильтра параметров. Внутри выражения фильтра параметров доступны только фильтры параметров. |
ВоронкаПараметрФильтрВыражение
Выражает комбинации фильтров воронки по параметрам.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Союз полевых expr . Укажите один тип фильтра для FunnelParameterFilterExpression . expr может быть только одним из следующих: | |
andGroup | Выражение FunnelParameterFilterExpression в |
orGroup | Выражение FunnelParameterFilterExpression в |
notExpression | FunnelParameterFilterExpression НЕ имеет значения |
funnelParameterFilter | Примитивный фильтр параметров воронки. |
ВоронкаПараметрФильтрВыражениеСписок
Список выражений фильтра параметров воронки.
JSON-представление |
---|
{
"expressions": [
{
object ( |
Поля | |
---|---|
expressions[] | Список выражений фильтра параметров воронки. |
ВоронкаПараметрФильтр
Выражение для фильтрации значений параметров в воронке.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения one_parameter . Поле, которое фильтруется. one_parameter может быть только одним из следующих: | |
eventParameterName | Этот фильтр будет оцениваться по указанному параметру события. Параметры события регистрируются как параметры события. Параметры события включают такие поля, как «firebase_screen» и «валюта». Параметры событий можно использовать только в сегментах и последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента. |
itemParameterName | Этот фильтр будет оцениваться по указанному параметру элемента. Параметры элемента регистрируются как параметры в массиве элементов. Параметры элемента включают такие поля, как «item_name» и «item_category». Параметры элемента можно использовать только в сегментах и последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента. Параметры товара доступны только в событиях электронной торговли. Дополнительную информацию о мероприятиях электронной торговли см. в руководстве «Измерение электронной торговли» . |
Поле объединения one_filter . Укажите один тип фильтра. one_filter может быть только одним из следующих: | |
stringFilter | Фильтр, связанный со строками. |
inListFilter | Фильтр для значений в списке. |
numericFilter | Фильтр для числовых значений или значений даты. |
betweenFilter | Фильтр между двумя значениями. |
Разбивка по воронке
Разбивки добавляют измерение в ответ подотчета таблицы воронки.
JSON-представление |
---|
{
"breakdownDimension": {
object ( |
Поля | |
---|---|
breakdownDimension | Столбец измерения добавлен в ответ подотчета таблицы последовательностей. Измерение разбивки разбивает каждый шаг воронки. Если указан |
limit | Максимальное количество различных значений измерения разбивки, возвращаемых в ответе. Если предел не указан, используется |
Измерение
Измерения — это атрибуты ваших данных. Например, параметр «Город» указывает город, из которого происходит событие. Значения измерений в ответах отчета представляют собой строки; например, городом может быть «Париж» или «Нью-Йорк».
JSON-представление |
---|
{
"name": string,
"dimensionExpression": {
object ( |
Поля | |
---|---|
name | Имя измерения. См. раздел «Измерения API» для получения списка имен измерений, поддерживаемых основными методами отчетности, такими как Если На измерения ссылаются по |
dimensionExpression | Одно измерение может быть результатом выражения нескольких измерений. Например, измерение «страна, город»: concatenate(country, «, «, city). |
Выражение Измерения
Используется для выражения измерения, которое является результатом формулы нескольких измерений. Примеры использования: 1) нижний регистр (размерность) 2) объединение (размерность1, символ, размерность2).
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения one_expression . Укажите один тип выражения измерения для DimensionExpression . one_expression может быть только одним из следующих: | |
lowerCase | Используется для преобразования значения размера в нижний регистр. |
upperCase | Используется для преобразования значения размера в верхний регистр. |
concatenate | Используется для объединения значений измерения в одно измерение. Например, измерение «страна, город»: concatenate(country, «, «, city). |
Выражение случая
Используется для преобразования значения измерения в один случай.
JSON-представление |
---|
{ "dimensionName": string } |
Поля | |
---|---|
dimensionName | Имя измерения. Имя должно ссылаться на имя в поле размеров запроса. |
ОбъединитьВыражение
Используется для объединения значений измерения в одно измерение.
JSON-представление |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
Поля | |
---|---|
dimensionNames[] | Названия размеров. Имена должны ссылаться на имена в поле измерений запроса. |
delimiter | Разделитель, помещаемый между именами измерений. Разделителями часто являются одиночные символы, такие как «|». или «,», но могут быть и более длинными строками. Если значение измерения содержит разделитель, в ответе будут присутствовать оба без различия. Например, если значение параметра 1 = «US,FR», значение параметра 2 = «JP» и разделитель = «,», то ответ будет содержать «US,FR,JP». |
ВоронкаСледующееДействие
Следующие действия указывают значение измерения после того, как пользователь выполнил шаг, но до того, как тот же пользователь выполнил следующий шаг. Например, если nextActionDimension
— это eventName
, то nextActionDimension
в строке i
го шага воронки вернет первое событие после события, которое позволило пользователю попасть на i
-й шаг воронки, но до того, как пользователь достиг i+1
го шага воронки.
JSON-представление |
---|
{
"nextActionDimension": {
object ( |
Поля | |
---|---|
nextActionDimension | Столбец измерения добавлен в ответ подотчета визуализации воронки. Параметр «Следующее действие» возвращает следующее значение измерения этого измерения после того, как пользователь достиг |
limit | Максимальное количество различных значений измерения разбивки, возвращаемых в ответе. Если предел не указан, используется |
Тип визуализации воронки
Управляет размерами, представленными в ответе подотчета визуализации воронки.
Перечисления | |
---|---|
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED | Неопределенный тип. |
STANDARD_FUNNEL | Стандартная (ступенчатая) воронка. Подотчет о визуализации воронки в ответе не будет содержать дату. |
TRENDED_FUNNEL | Воронка с трендом (линейный график). Подотчет по визуализации воронки в ответе будет содержать измерение даты. |
Сегмент
Сегмент – это подмножество ваших данных Google Analytics. Например, из всего вашего набора пользователей один сегмент может состоять из пользователей из определенной страны или города. Другим сегментом могут быть пользователи, которые покупают определенную линейку продуктов или посещают определенную часть вашего сайта или вызывают определенные события в вашем приложении.
Дополнительную информацию см. в разделе Конструктор сегментов GA4 .
JSON-представление |
---|
{ "name": string, // Union field |
Поля | |
---|---|
name | Имя этого сегмента. Если не указано, сегменты называются «Сегмент». Это имя определяет строковое значение, возвращаемое измерением |
Поле объединения one_segment_scope . Сегмент указан в одной области. one_segment_scope может быть только одним из следующих: | |
userSegment | Сегменты пользователей – это подгруппы пользователей, которые взаимодействовали с вашим сайтом или приложением. |
sessionSegment | Сегменты сеансов – это подмножества сеансов, произошедших на вашем сайте или в приложении. |
eventSegment | Сегменты событий – это подмножества событий, которые произошли на вашем сайте или в приложении. |
Пользовательский сегмент
Сегменты пользователей – это подмножества пользователей, которые взаимодействовали с вашим сайтом или приложением. Например, пользователи, которые ранее совершали покупки; пользователи, которые добавили товары в свои корзины, но не совершили покупку.
JSON-представление |
---|
{ "userInclusionCriteria": { object ( |
Поля | |
---|---|
userInclusionCriteria | Определяет, какие пользователи включены в этот сегмент. Необязательный. |
exclusion | Определяет, какие пользователи исключены из этого сегмента. Необязательный. |
UserSegmentCriteria
Пользователь соответствует критерию, если события пользователя соответствуют условиям критериев.
JSON-представление |
---|
{ "andConditionGroups": [ { object ( |
Поля | |
---|---|
andConditionGroups[] | Пользователь соответствует этому критерию, если он соответствует каждому из этих |
andSequenceGroups[] | Пользователь соответствует этому критерию, если он соответствует каждому из этих |
Усерсегменткондиционионгруппу
Условия сообщают Analytics, какие данные следует включить в сегмент или исключить из него.
JSON-представление |
---|
{ "conditionScoping": enum ( |
Поля | |
---|---|
conditionScoping | Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они группе условий. Эта область определяет, на скольких событиях оценивается Необязательный. Если не указано, используется |
segmentFilterExpression | Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров. |
Пользовательские критерииОбзор
Область действия определяет, какие события учитываются при оценке соответствия пользователя критериям.
Перечисления | |
---|---|
USER_CRITERIA_SCOPING_UNSPECIFIED | Неуказанные критерии. Не уточняйте. |
USER_CRITERIA_WITHIN_SAME_EVENT | Если критерии удовлетворяются в рамках одного события, пользователь соответствует критериям. |
USER_CRITERIA_WITHIN_SAME_SESSION | Если критерии удовлетворены в течение одного сеанса, пользователь соответствует критериям. |
USER_CRITERIA_ACROSS_ALL_SESSIONS | Если критериям удовлетворяют какие-либо события для пользователя, пользователь соответствует критериям. |
Выражение SegmentFilterExpression
Выражает комбинации сегментных фильтров.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Союз полевых expr . Укажите один тип фильтра для SegmentFilterExpression . expr может быть только одним из следующих: | |
andGroup | Выражение SegmentFilterExpression в |
orGroup | Выражение SegmentFilterExpression в |
notExpression | SegmentFilterExpression НЕ имеет |
segmentFilter | Примитивный сегментный фильтр. |
segmentEventFilter | Создает фильтр, который соответствует событиям с одним именем события. Если указано выражение фильтра параметров, этому фильтру событий соответствует только подмножество событий, которые соответствуют как одному имени события, так и выражениям фильтра параметров. |
Список выражений сегмента фильтра
Список выражений сегментного фильтра.
JSON-представление |
---|
{
"expressions": [
{
object ( |
Поля | |
---|---|
expressions[] | Список выражений фильтра сегментов |
СегментФильтр
Выражение для фильтрации значений параметра или показателя.
JSON-представление |
---|
{ "fieldName": string, "filterScoping": { object ( |
Поля | |
---|---|
fieldName | Имя измерения или имя метрики. |
filterScoping | Указывает область действия фильтра. |
Поле объединения one_filter . Укажите один тип фильтра для Filter . one_filter может быть только одним из следующих: | |
stringFilter | Фильтр, связанный со строками. |
inListFilter | Фильтр для значений в списке. |
numericFilter | Фильтр для числовых значений или значений даты. |
betweenFilter | Фильтр между двумя значениями. |
СегментФильтрОбзор
Области действия определяют, как следует учитывать параметры и показатели нескольких событий при оценке сегментного фильтра.
JSON-представление |
---|
{ "atAnyPointInTime": boolean } |
Поля | |
---|---|
atAnyPointInTime | Если Этот параметр Этот Если областью критериев является |
Фильтр событий сегмента
Создает фильтр, который соответствует событиям с одним именем события. Если указано выражение фильтра параметров, этому фильтру событий соответствует только подмножество событий, которые соответствуют как одному имени события, так и выражениям фильтра параметров.
JSON-представление |
---|
{
"eventName": string,
"segmentParameterFilterExpression": {
object ( |
Поля | |
---|---|
eventName | Этот фильтр соответствует событиям с одним именем события. Укажите название мероприятия. |
segmentParameterFilterExpression | Если указано, этот фильтр соответствует событиям, которые соответствуют как одному имени события, так и выражениям фильтра параметров. Внутри выражения фильтра параметров доступны только фильтры параметров. |
СегментПараметрФильтрВыражение
Выражает комбинации сегментного фильтра по параметрам.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Союз полевых expr . Укажите один тип фильтра для SegmentParameterFilterExpression . expr может быть только одним из следующих: | |
andGroup | Выражение SegmentParameterFilterExpression в |
orGroup | Выражение SegmentParameterFilterExpression в |
notExpression | SegmentParameterFilterExpression НЕ имеет значения |
segmentParameterFilter | Примитивный фильтр параметров сегмента. |
СегментПараметрФильтрВыражениеСписок
Список выражений фильтра параметров сегмента.
JSON-представление |
---|
{
"expressions": [
{
object ( |
Поля | |
---|---|
expressions[] | Список выражений фильтра параметров сегмента. |
СегментПараметрФильтр
Выражение для фильтрации значений параметров в сегменте.
JSON-представление |
---|
{ "filterScoping": { object ( |
Поля | |
---|---|
filterScoping | Указывает область действия фильтра. |
Поле объединения one_parameter . Поле, которое фильтруется. one_parameter может быть только одним из следующих: | |
eventParameterName | Этот фильтр будет оцениваться по указанному параметру события. Параметры события регистрируются как параметры события. Параметры события включают такие поля, как «firebase_screen» и «валюта». Параметры событий можно использовать только в сегментах и последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента. |
itemParameterName | Этот фильтр будет оцениваться по указанному параметру элемента. Параметры элемента регистрируются как параметры в массиве элементов. Параметры элемента включают такие поля, как «item_name» и «item_category». Параметры элемента можно использовать только в сегментах и последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента. Параметры товара доступны только в событиях электронной торговли. Дополнительную информацию о мероприятиях электронной торговли см. в руководстве «Измерение электронной торговли» . |
Поле объединения one_filter . Укажите один тип фильтра. one_filter может быть только одним из следующих: | |
stringFilter | Фильтр, связанный со строками. |
inListFilter | Фильтр для значений в списке. |
numericFilter | Фильтр для числовых значений или значений даты. |
betweenFilter | Фильтр между двумя значениями. |
СегментПараметрФильтрОбзор
Области действия определяют, как следует учитывать несколько событий при оценке фильтра параметров сегмента.
JSON-представление |
---|
{ "inAnyNDayPeriod": string } |
Поля | |
---|---|
inAnyNDayPeriod | Накапливает параметр за указанный период дней перед применением фильтра. Поддерживается только в том случае, если область действия критериев равна Например, если Диапазон дат не расширяется с целью создания полного окна N дней в начале диапазона дат. Например, если отчет составлен за период с 01.11.2021 по 10.11.2021 и |
Усерсегментсеквенцегруппу
Определите условия, которые должны произойти в определенном порядке, чтобы пользователь стал участником сегмента.
JSON-представление |
---|
{ "sequenceScoping": enum ( |
Поля | |
---|---|
sequenceScoping | Все шаги последовательности должны быть удовлетворены в области видимости, чтобы пользователь мог соответствовать последовательности. Например, если Необязательный. Если не указано, используется |
sequenceMaximumDuration | Определяет период времени, в течение которого должна произойти вся последовательность; например, 30 минут. Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
userSequenceSteps[] | Упорядоченная последовательность шагов условия. События пользователя должны завершить каждый шаг, чтобы пользователь соответствовал |
Усерсеквенцестеп
Условие, которое должно произойти в указанном порядке шагов, чтобы этот пользователь соответствовал последовательности.
JSON-представление |
---|
{ "isDirectlyFollowedBy": boolean, "stepScoping": enum ( |
Поля | |
---|---|
isDirectlyFollowedBy | Если это правда, событие, удовлетворяющее этому шагу, должно быть следующим событием после события, удовлетворяющего последнему шагу. Если false, этот шаг косвенно следует за предыдущим шагом; например, между предыдущим шагом и этим шагом могут быть события. |
stepScoping | Этот шаг последовательности должен быть выполнен в области видимости, чтобы пользователь мог соответствовать последовательности. Например, если Необязательный. Если значение не указано, |
segmentFilterExpression | Пользователь соответствует этому шагу последовательности, если его события соответствуют этому выражению. Выражения выражают критерии измерения, показателей и/или параметров. |
Пользовательское исключение сегмента
Указывает, какие пользователи исключены из этого сегмента.
JSON-представление |
---|
{ "userExclusionDuration": enum ( |
Поля | |
---|---|
userExclusionDuration | Указывает, как долго будет действовать исключение, если пользователь соответствует Необязательный. Если не указано, используется |
userExclusionCriteria | Если пользователь соответствует этому условию, он исключается из членства в сегменте для |
UserExclusionDuration
Перечисляет параметры продолжительности исключения, если пользователь соответствует userExclusionCriteria
.
Перечисления | |
---|---|
USER_EXCLUSION_DURATION_UNSPECIFIED | Неуказанный срок исключения. Не уточняйте. |
USER_EXCLUSION_TEMPORARY | Временно исключайте пользователей из сегмента в периоды, когда пользователь соответствует условию userExclusionCriteria . |
USER_EXCLUSION_PERMANENT | Навсегда исключайте пользователей из сегмента, если пользователь когда-либо соответствует условию userExclusionCriteria . |
Сеансегмент
Сегменты сеансов — это подмножества сеансов, произошедших на вашем сайте или в приложении: например, все сеансы, возникшие в рамках определенной рекламной кампании.
JSON-представление |
---|
{ "sessionInclusionCriteria": { object ( |
Поля | |
---|---|
sessionInclusionCriteria | Определяет, какие сеансы включены в этот сегмент. Необязательный. |
exclusion | Определяет, какие сеансы исключены в этом сегменте. Необязательный. |
Сеансегменткритериа
Сеанс соответствует критерию, если события сеанса соответствуют условиям критериев.
JSON-представление |
---|
{
"andConditionGroups": [
{
object ( |
Поля | |
---|---|
andConditionGroups[] | Сеанс соответствует этому критерию, если сеанс соответствует каждому из этих |
Сеансегменткондиционионгруппу
Условия сообщают Analytics, какие данные следует включить в сегмент или исключить из него.
JSON-представление |
---|
{ "conditionScoping": enum ( |
Поля | |
---|---|
conditionScoping | Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они группе условий. Эта область определяет, на скольких событиях оценивается Необязательный. Если значение не указано, используется |
segmentFilterExpression | Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров. |
SessionCriteriaScoping
Определение области определяет, какие события учитываются при оценке соответствия сеанса критериям.
Перечисления | |
---|---|
SESSION_CRITERIA_SCOPING_UNSPECIFIED | Неуказанные критерии. Не уточняйте. |
SESSION_CRITERIA_WITHIN_SAME_EVENT | Если критерии удовлетворяются в рамках одного события, сеанс соответствует критериям. |
SESSION_CRITERIA_WITHIN_SAME_SESSION | Если критерии удовлетворяются в течение одного сеанса, сеанс соответствует критериям. |
Сеансегментисключение
Указывает, какие сеансы исключены в этом сегменте.
JSON-представление |
---|
{ "sessionExclusionDuration": enum ( |
Поля | |
---|---|
sessionExclusionDuration | Указывает, как долго будет действовать исключение, если сеанс соответствует Необязательный. Если не указано, используется |
sessionExclusionCriteria | Если сеанс соответствует этому условию, он исключается из членства в сегменте для |
Сеансексклюзиондюрация
Перечисляет параметры продолжительности исключения, если сеанс соответствует sessionExclusionCriteria
.
Перечисления | |
---|---|
SESSION_EXCLUSION_DURATION_UNSPECIFIED | Неуказанный срок исключения. Не уточняйте. |
SESSION_EXCLUSION_TEMPORARY | Временно исключайте сеансы из сегмента в периоды, когда сеанс соответствует условию sessionExclusionCriteria . |
SESSION_EXCLUSION_PERMANENT | Навсегда исключайте сеансы из сегмента, если сеанс когда-либо соответствует условию sessionExclusionCriteria . |
Событийный сегмент
Сегменты событий – это подмножества событий, которые произошли на вашем сайте или в приложении. например, все события покупки, совершенные в определенном месте; события app_Exception, произошедшие в конкретной операционной системе.
JSON-представление |
---|
{ "eventInclusionCriteria": { object ( |
Поля | |
---|---|
eventInclusionCriteria | Определяет, какие события включены в этот сегмент. Необязательный. |
exclusion | Определяет, какие события исключаются в этом сегменте. Необязательный. |
Критерии сегмента событий
Событие соответствует критерию, если оно соответствует условиям критериев.
JSON-представление |
---|
{
"andConditionGroups": [
{
object ( |
Поля | |
---|---|
andConditionGroups[] | Событие соответствует этому критерию, если событие соответствует каждому из этих |
ГруппаСобытийСегментУсловие
Условия сообщают Analytics, какие данные следует включить в сегмент или исключить из него.
JSON-представление |
---|
{ "conditionScoping": enum ( |
Поля | |
---|---|
conditionScoping | Необязательный. Если не указано, используется |
segmentFilterExpression | Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров. |
EventCriteriaScoping
Область действия определяет, какие события учитываются при оценке соответствия события критериям.
Перечисления | |
---|---|
EVENT_CRITERIA_SCOPING_UNSPECIFIED | Неуказанный критерий. Не уточняйте. |
EVENT_CRITERIA_WITHIN_SAME_EVENT | Если критерии удовлетворяются в рамках одного события, событие соответствует критериям. |
Исключение сегмента событий
Указывает, какие события исключены в этом сегменте.
JSON-представление |
---|
{ "eventExclusionDuration": enum ( |
Поля | |
---|---|
eventExclusionDuration | Необязательный. Если не указано, используется |
eventExclusionCriteria | Если событие соответствует этому условию, оно исключается из членства в сегменте |
СобытиеExclusionDuration
Перечисляет варианты того, как долго будет длиться исключение, если событие соответствует eventExclusionCriteria
.
Перечисления | |
---|---|
EVENT_EXCLUSION_DURATION_UNSPECIFIED | Неуказанная продолжительность исключения. Не указывайте. |
EVENT_EXCLUSION_PERMANENT | Постоянно исключайте события из сегмента, если событие когда -либо соответствует условию eventExclusionCriteria . |
Выражение фильтра
Выразить измерение или метрические фильтры. Поля в одной и той же фильтровской экспрессии должны быть либо всеми измерениями, либо всеми показателями.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Союз Филд expr . Укажите один тип выражения фильтра для FilterExpression . expr может быть только одним из следующих: | |
andGroup | FilterExpressions в Andgroup имеют и отношения. |
orGroup | FilterExpressions в Orgroup имеют или отношения. |
notExpression | FilterExpression не является неэкспрессией. |
filter | Примитивный фильтр. В той же фильтеровной экспрессии все имена поля фильтра должны быть либо всеми измерениями, либо всеми показателями. |
FilterExpressionList
Список выражений фильтра.
JSON-представление |
---|
{
"expressions": [
{
object ( |
Поля | |
---|---|
expressions[] | Список выражений фильтра. |
Фильтр
Выражение для фильтрации измерения или значений метрики.
JSON-представление |
---|
{ "fieldName": string, // Union field |
Поля | |
---|---|
fieldName | Имя измерения или метрическое имя. Должно быть имя, определенное в измерениях или метриках. |
Поле Союза one_filter . Укажите один тип фильтра для Filter . one_filter может быть только одним из следующих: | |
stringFilter | Строки, связанные с фильтром. |
inListFilter | Фильтр для значений в списке. |
numericFilter | Фильтр для числовых или значений даты. |
betweenFilter | Фильтр для двух значений. |
FunnelsubReport
Отчеты Fendel Sub содержат значения данных измерения и метрических данных. Например, 12 пользователей достигли второго этапа воронки.
JSON-представление |
---|
{ "dimensionHeaders": [ { object ( |
Поля | |
---|---|
dimensionHeaders[] | Описывает столбцы измерений. Отчеты о воронке всегда включают в себя измерение воронки в ответах под отчетами. Дополнительные измерения, такие как разбивки, даты и следующие действия, могут присутствовать в ответе, если их запрошен. |
metricHeaders[] | Описывает столбцы показателей. Отчеты о воронке всегда включают активных пользователей в ответах на подклады. В таблице воронки включаются дополнительные показатели, такие как коэффициент завершения, оставления и остановки. |
rows[] | Строки комбинаций значений измерений и значений показателей в отчете. |
metadata | Метаданные для отчета о воронке. |
DimensionHeader
Описывает столбец измерения в отчете. Измерения, запрошенные в отчете, создают записи столбцов в строках и заголовках измерений. Однако измерения, используемые исключительно в фильтрах или выражениях, не создают столбцы в отчете; соответственно, эти измерения не создают заголовки.
JSON-представление |
---|
{ "name": string } |
Поля | |
---|---|
name | Имя измерения. |
Метрихедер
Описывает метрическую колонку в отчете. Видимые метрики, запрошенные в отчете, производят записи столбцов в рядах и метрихере. Тем не менее, метрики, используемые исключительно в рамках фильтров или выражений, не производят столбцы в отчете; Соответственно, эти метрики не производят заголовки.
JSON-представление |
---|
{
"name": string,
"type": enum ( |
Поля | |
---|---|
name | Имя метрики. |
type | Тип данных метрики. |
MetricType
Тип значения метрики.
Перечисления | |
---|---|
METRIC_TYPE_UNSPECIFIED | Неопределенный тип. |
TYPE_INTEGER | Целочисленный тип. |
TYPE_FLOAT | Тип плавающей запятой. |
TYPE_SECONDS | Продолжительность секунд; Специальный тип плавания. |
TYPE_MILLISECONDS | Продолжительность в миллисекундах; Специальный тип плавания. |
TYPE_MINUTES | Продолжительность за считанные минуты; Специальный тип плавания. |
TYPE_HOURS | Продолжительность в часах; Специальный тип плавания. |
TYPE_STANDARD | Пользовательский показатель стандартного типа; Специальный тип плавания. |
TYPE_CURRENCY | Сумма денег; Специальный тип плавания. |
TYPE_FEET | Длина в футах; Специальный тип плавания. |
TYPE_MILES | Длина в милях; Специальный тип плавания. |
TYPE_METERS | Длина в метрах; Специальный тип плавания. |
TYPE_KILOMETERS | Длина в километрах; Специальный тип плавания. |
Ряд
Сообщите данные для каждой строки. Например, если runreportrequest содержит:
"dimensions": [
{
"name": "eventName"
},
{
"name": "countryId"
}
],
"metrics": [
{
"name": "eventCount"
}
]
Одна строка с «in_app_purchase» как eventName, «JP» как The CownID и 15 как EventCount, будет:
"dimensionValues": [
{
"value": "in_app_purchase"
},
{
"value": "JP"
}
],
"metricValues": [
{
"value": "15"
}
]
JSON-представление |
---|
{ "dimensionValues": [ { object ( |
Поля | |
---|---|
dimensionValues[] | Список запрошенных значений измерений. В поворотном докладе DimensionValues перечислены только для размеров, включенных в опорку. |
metricValues[] | Список запрошенных видимых значений метрических значений. |
DimensionValue
Значение измерения.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения one_value . Один вид значения измерения one_value может быть только одним из следующих: | |
value | Значение в виде строки, если тип измерения является строкой. |
Метричное значение
Значение метрики.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения one_value . Одним из метрических значений one_value может быть только одним из следующих: | |
value | Значение измерения. Смотрите Metricheader для типа. |
Furnel -ResponseMetAdata
Метаданные отчета о воронке содержит дополнительную информацию о отчете о воронке.
JSON-представление |
---|
{
"samplingMetadatas": [
{
object ( |
Поля | |
---|---|
samplingMetadatas[] | Если результаты отчета о воронке выбраны , это описывает, какой процент событий использовался в этом отчете о воронке. Один Однако, если результаты не будут отобраны, это поле не будет определена. |
ShapeMetmeData
Если результаты отчета о воронке выбраны , в этом метадате описываются, какой процент событий использовался в этом отчете о воронке для диапазона дат. Отбор выборки - это практика анализа подмножества всех данных, чтобы раскрыть значимую информацию в более широком наборе данных.
JSON-представление |
---|
{ "samplesReadCount": string, "samplingSpaceSize": string } |
Поля | |
---|---|
samplesReadCount | Общее количество событий, прочитанных в этом отчете о выборке для диапазона дат. Это размер подмножества данных этого свойства, который был проанализирован в этом отчете о воронке. |
samplingSpaceSize | Общее количество событий, присутствующих в данных этой собственности, которые могли быть проанализированы в этом отчете о воронке для диапазона дат. Выборка раскрывает значимую информацию о более крупном наборе данных, и это размер большего набора данных. Чтобы рассчитать процент доступных данных, которые использовались в этом отчете о воронке, вычислите |
Propertyquota
Текущее состояние всех квот для этой аналитической собственности. Если какая -либо квота для свойства исчерпана, все запросы на это свойство возвращают истощенные ресурсы.
JSON-представление |
---|
{ "tokensPerDay": { object ( |
Поля | |
---|---|
tokensPerDay | Стандартные аналитические свойства могут использовать до 200 000 жетонов в день; Analytics 360 Properties может использовать 2 000 000 токенов в день. Большинство запросов потребляют менее 10 токенов. |
tokensPerHour | Стандартные аналитические свойства могут использовать до 40 000 жетонов в час; Свойства Analytics 360 могут использовать 400 000 жетонов в час. Запрос API потребляет одно количество токенов, и это число вычитается из всех почасовых, ежедневных и почасовых квот проекта. |
concurrentRequests | Стандартные аналитические свойства могут отправлять до 10 параллельных запросов; Свойства Analytics 360 могут использовать до 50 параллельных запросов. |
serverErrorsPerProjectPerHour | Стандартные аналитические свойства и пары облачных проектов могут иметь до 10 ошибок сервера в час; Свойства Analytics 360 и пары облачных проектов могут иметь до 50 ошибок сервера в час. |
potentiallyThresholdedRequestsPerHour | Аналитические свойства могут отправлять до 120 запросов с потенциально пороговыми размерами в час. В пакетном запросе каждый запрос отчета имеет индивидуально для этой квоты, если запрос содержит потенциально пороговые размеры. |
tokensPerProjectPerHour | Аналитические свойства могут использовать до 35% своих токенов на проект в час. Это равносильно стандартной аналитической свойствам может использовать до 14 000 токенов на проект в час, а свойства Analytics 360 могут использовать 140 000 токенов на проект в час. Запрос API потребляет одно количество токенов, и это число вычитается из всех почасовых, ежедневных и почасовых квот проекта. |
Статус квоты
Текущее состояние для конкретной группы квот.
JSON-представление |
---|
{ "consumed": integer, "remaining": integer } |
Поля | |
---|---|
consumed | Квота, потребляемая по этому запросу. |
remaining | Квота остается после этого запроса. |