Method: properties.runFunnelReport

Возвращает настроенный отчет по воронке данных о ваших событиях Google Analytics. Данные, возвращаемые из API, представляют собой таблицу со столбцами для запрошенных параметров и показателей.

Исследование воронки позволяет визуализировать шаги, которые ваши пользователи предпринимают для выполнения задачи, и быстро увидеть, насколько хорошо они добиваются успеха или терпят неудачу на каждом этапе. Например, как потенциальные клиенты становятся покупателями, а затем покупателями? Как разовые покупатели становятся постоянными? С помощью этой информации вы можете улучшить неэффективные или заброшенные пути взаимодействия с клиентами. Дополнительную информацию см. в разделе Исследование последовательностей GA4 .

Этот метод представлен на стадии альфа-версии с целью сбора отзывов о синтаксисе и возможностях перед входом в бета-версию. Чтобы оставить отзыв об этом API, заполните форму «Отзыв об отчетах по воронке API данных Google Analytics» .

HTTP-запрос

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

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

Параметры пути

Параметры
property

string

Необязательный. Идентификатор ресурса Google Analytics, события которого отслеживаются. Указывается в URL-пути, а не в теле. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта . В пакетном запросе это свойство должно быть либо неопределенным, либо соответствовать свойству уровня пакета.

Пример: свойства/1234

Тело запроса

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

JSON-представление 
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
Поля
date Ranges[]

object ( DateRange )

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

funnel

object ( Funnel )

Необязательный. Конфигурация воронки этого запроса. Эта конфигурация воронки является обязательной.

funnel Breakdown

object ( FunnelBreakdown )

Необязательный. Если указано, эта разбивка добавляет измерение к ответу подотчета таблицы воронки. Это измерение разбивки расширяет каждый шаг воронки до уникальных значений измерения разбивки. Например, при разбивке по измерению deviceCategory будут созданы строки для mobile , tablet , desktop и итоговых значений.

funnel Next Action

object ( FunnelNextAction )

Необязательный. Если указано, следующее действие добавляет измерение в ответ подотчета визуализации воронки. Это измерение следующего действия расширяет каждый шаг воронки до уникальных значений следующего действия. Например, следующее действие измерения eventName создаст строки для нескольких событий (например, session_start & click ) и итогового значения.

Следующее действие поддерживает только eventName и большинство размеров страницы/экрана, например pageTitle и pagePath .

funnel Visualization Type

enum ( FunnelVisualizationType )

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

segments[]

object ( Segment )

Необязательный. Конфигурации сегментов. Сегменты — это подмножества данных свойства. В отчете по воронке с сегментами последовательность оценивается в каждом сегменте.

Каждый сегмент, указанный в этом запросе, создает в ответе отдельную строку; в ответе каждый сегмент идентифицируется своим именем.

Параметр сегментов является необязательным. Запросы ограничены 4 сегментами.

limit

string ( int64 format)

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

API также может возвращать меньше строк, чем запрошенное limit , если значений измерения не так много, как limit .

dimension Filter

object ( FilterExpression )

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

return Property Quota

boolean

Необязательный. Переключает, возвращать ли текущее состояние квоты этого ресурса Analytics. Квота возвращается в PropertyQuota .

Тело ответа

Ответ на отчет о воронке содержит два подотчета. Два подотчета представляют собой разные комбинации параметров и показателей.

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

JSON-представление 
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Поля
funnel Table

object ( FunnelSubReport )

Таблица воронки — это отчет с указанием шага воронки, сегмента, параметра разбивки, активных пользователей, степени завершения, количества отказов и количества отказов.

Измерение сегмента присутствует в этом ответе только в том случае, если сегмент был запрошен. Измерение разбивки присутствует в этом ответе только в том случае, если оно было запрошено.

funnel Visualization

object ( FunnelSubReport )

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

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

property Quota

object ( PropertyQuota )

Состояние квоты этого ресурса Google Аналитики, включая этот запрос.

kind

string

Определяет, к какому типу ресурса относится это сообщение. Этот kind всегда представляет собой фиксированную строку «analyticsData#runFunnelReport». Полезно различать типы ответов в JSON.

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

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

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

Воронка

Настраивает воронку в запросе отчета о воронке. Воронка сообщает о пользователях, когда они проходят последовательность шагов.

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

JSON-представление 
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
Поля
is Open Funnel

boolean

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

steps[]

object ( FunnelStep )

Последовательные шаги этой воронки.

Шаг воронки

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

JSON-представление 
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
Поля
name

string

Отличительное имя для этого шага. Если не указано, шаги будут именоваться индексированным именем, начинающимся с 1 (например, «0.», «1.» и т. д.). Это имя определяет строковое значение, возвращаемое измерением funnelStepName . Например, если указать name = Purchase на третьем этапе воронки запроса, в ответе отчета по воронке будет указано 3. Purchase .

is Directly Followed By

boolean

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

filter Expression

object ( FunnelFilterExpression )

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

within Duration From Prior Step

string ( Duration format)

Если указано, этот шаг должен завершиться в пределах продолжительности завершения предыдущего шага. withinDurationFromPriorStep включает конечную точку с точностью до микросекунды. Например, длительность в 5 секунд можно завершить за 4,9 или 5,0 секунды, но не за 5 секунд и 1 микросекунду.

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

Выражение Фильтра Воронки

Выражает комбинации фильтров-воронок.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для FunnelFilterExpression . expr может быть только одним из следующих:
and Group

object ( FunnelFilterExpressionList )

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

or Group

object ( FunnelFilterExpressionList )

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

not Expression

object ( FunnelFilterExpression )

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

funnel Field Filter

object ( FunnelFieldFilter )

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

funnel Event Filter

object ( FunnelEventFilter )

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

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

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

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

object ( FunnelFilterExpression )

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

ВоронкаПолеФильтр

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

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

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Поля
field Name

string

Имя измерения или имя метрики.

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

Фильтр событий воронки

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

JSON-представление 
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
Поля
event Name

string

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

funnel Parameter Filter Expression

object ( FunnelParameterFilterExpression )

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

Внутри выражения фильтра параметров доступны только фильтры параметров.

ВоронкаПараметрФильтрВыражение

Выражает комбинации фильтров воронки по параметрам.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для FunnelParameterFilterExpression . expr может быть только одним из следующих:
and Group

object ( FunnelParameterFilterExpressionList )

Выражение FunnelParameterFilterExpression в andGroup имеет отношение И.

or Group

object ( FunnelParameterFilterExpressionList )

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

not Expression

object ( FunnelParameterFilterExpression )

FunnelParameterFilterExpression НЕ имеет значения notExpression .

funnel Parameter Filter

object ( FunnelParameterFilter )

Примитивный фильтр параметров воронки.

ВоронкаПараметрФильтрВыражениеСписок

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

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

object ( FunnelParameterFilterExpression )

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

ВоронкаПараметрФильтр

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

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

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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.
}
Поля
Поле объединения one_parameter . Поле, которое фильтруется. one_parameter может быть только одним из следующих:
event Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру события. Параметры события регистрируются как параметры события. Параметры события включают такие поля, как «firebase_screen» и «валюта».

Параметры событий можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

item Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру элемента. Параметры элемента регистрируются как параметры в массиве элементов. Параметры элемента включают такие поля, как «item_name» и «item_category».

Параметры элемента можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

Параметры товара доступны только в событиях электронной торговли. Дополнительную информацию о мероприятиях электронной торговли см. в руководстве «Измерение электронной торговли» .

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

Разбивка по воронке

Разбивки добавляют измерение в ответ подотчета таблицы воронки.

JSON-представление 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
Поля
breakdown Dimension

object ( Dimension )

Столбец измерения добавлен в ответ подотчета таблицы последовательностей. Измерение разбивки разбивает каждый шаг воронки. Если указан funnelBreakdown требуется допустимое значение breakdownDimension .

limit

string ( int64 format)

Максимальное количество различных значений измерения разбивки, возвращаемых в ответе. Если предел не указан, используется limit в 5 . Предел должен превышать ноль и не может превышать 15.

ВоронкаСледующееДействие

Следующие действия определяют значение измерения после того, как пользователь выполнил шаг, но до того, как тот же пользователь выполнил следующий шаг. Например, если nextActionDimension имеет eventName , то nextActionDimension в строке i го шага воронки вернет первое событие после события, которое квалифицировало пользователя на i -й шаг воронки, но до того, как пользователь достиг i+1 -го шага воронки.

JSON-представление 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
Поля
next Action Dimension

object ( Dimension )

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

nextActionDimension в настоящее время поддерживает только eventName и большинство размеров страницы/экрана, таких как pageTitle и pagePath . nextActionDimension не может быть выражением измерения.

limit

string ( int64 format)

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

Тип визуализации воронки

Управляет размерами, присутствующими в ответе подотчета визуализации воронки.

Перечисления
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED Неопределенный тип.
STANDARD_FUNNEL Стандартная (ступенчатая) воронка. Подотчет о визуализации воронки в ответе не будет содержать дату.
TRENDED_FUNNEL Воронка с трендом (линейный график). Подотчет по визуализации воронки в ответе будет содержать измерение даты.

Сегмент

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

Дополнительную информацию см. в разделе Построитель сегментов .

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

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
Поля
name

string

Имя этого сегмента. Если не указано, сегменты называются «Сегмент». Это имя определяет строковое значение, возвращаемое измерением segment . Измерение segment добавляет к имени сегмента префикс, начиная с 1, индексный номер сегмента в запросе (например, «1. Сегмент», «2. Сегмент» и т. д.).

Поле объединения one_segment_scope . Сегмент указан в одной области. one_segment_scope может быть только одним из следующих:
user Segment

object ( UserSegment )

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

session Segment

object ( SessionSegment )

Сегменты сеансов – это подмножества сеансов, произошедших на вашем сайте или в приложении.

event Segment

object ( EventSegment )

Сегменты событий – это подмножества событий, которые произошли на вашем сайте или в приложении.

Пользовательский сегмент

Сегменты пользователей — это подгруппы пользователей, которые взаимодействовали с вашим сайтом или приложением. Например, пользователи, которые ранее совершали покупки; пользователи, которые добавили товары в свои корзины, но не совершили покупку.

JSON-представление 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
Поля
user Inclusion Criteria

object ( UserSegmentCriteria )

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

exclusion

object ( UserSegmentExclusion )

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

Усерсегменткритериа

Пользователь соответствует критерию, если события пользователя соответствуют условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( UserSegmentConditionGroup )

Пользователь соответствует этому критерию, если он соответствует каждому из этих andConditionGroups и каждому из andSequenceGroups . andConditionGroups может быть пустым, если указаны andSequenceGroups .

and Sequence Groups[]

object ( UserSegmentSequenceGroup )

Пользователь соответствует этому критерию, если он соответствует каждому из этих andSequenceGroups и каждому из andConditionGroups . andSequenceGroups может быть пустым, если указаны andConditionGroups .

Усерсегменткондиционионгруппу

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

JSON-представление 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( UserCriteriaScoping )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они группе условий. Эта область определяет, на скольких событиях оценивается segmentFilterExpression , прежде чем будет определено, соответствует ли группа условий или нет. Например, еслиconditionScoping conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION , выражение оценивается для всех событий в сеансе, а затем определяется, соответствует ли группа условий этому пользователю. Например, если conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT , выражение оценивается по одному событию, а затем определяется, соответствует ли группа условий этому пользователю.

Необязательный. Если не указано, используется conditionScoping = ACROSS_ALL_SESSIONS .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

Пользовательские критерииОбзор

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

Перечисления
USER_CRITERIA_SCOPING_UNSPECIFIED Область применения неуказанных критериев. Не уточняйте.
USER_CRITERIA_WITHIN_SAME_EVENT Если критерии удовлетворяются в рамках одного события, пользователь соответствует критериям.
USER_CRITERIA_WITHIN_SAME_SESSION Если критерии удовлетворены в течение одного сеанса, пользователь соответствует критериям.
USER_CRITERIA_ACROSS_ALL_SESSIONS Если критериям удовлетворяют какие-либо события для пользователя, пользователь соответствует критериям.

Выражение сегментного фильтра

Выражает комбинации сегментных фильтров.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для SegmentFilterExpression . expr может быть только одним из следующих:
and Group

object ( SegmentFilterExpressionList )

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

or Group

object ( SegmentFilterExpressionList )

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

not Expression

object ( SegmentFilterExpression )

SegmentFilterExpression НЕ имеет notExpression .

segment Filter

object ( SegmentFilter )

Примитивный сегментный фильтр.

segment Event Filter

object ( SegmentEventFilter )

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

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

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

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

object ( SegmentFilterExpression )

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

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

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

JSON-представление 
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // 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.
}
Поля
field Name

string

Имя измерения или имя метрики.

filter Scoping

object ( SegmentFilterScoping )

Указывает область действия фильтра.

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

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

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

JSON-представление 
{
  "atAnyPointInTime": boolean
}
Поля
at Any Point In Time

boolean

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

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

Этот atAnyPointInTime можно указать только в том случае, если область действия критерия равна ACROSS_ALL_SESSIONS и его нельзя указать в последовательностях.

Если областью критериев является ACROSS_ALL_SESSIONS , atAnyPointInTime = false используется, если не указано.

Фильтр событий сегмента

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

JSON-представление 
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
Поля
event Name

string

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

segment Parameter Filter Expression

object ( SegmentParameterFilterExpression )

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

Внутри выражения фильтра параметров доступны только фильтры параметров.

СегментПараметрФильтрВыражение

Выражает комбинации сегментного фильтра по параметрам.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для SegmentParameterFilterExpression . expr может быть только одним из следующих:
and Group

object ( SegmentParameterFilterExpressionList )

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

or Group

object ( SegmentParameterFilterExpressionList )

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

not Expression

object ( SegmentParameterFilterExpression )

SegmentParameterFilterExpression НЕ имеет значения notExpression .

segment Parameter Filter

object ( SegmentParameterFilter )

Примитивный фильтр параметров сегмента.

СегментПараметрФильтрВыражениеСписок

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

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

object ( SegmentParameterFilterExpression )

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

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

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

JSON-представление 
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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.
}
Поля
filter Scoping

object ( SegmentParameterFilterScoping )

Указывает область действия фильтра.

Поле объединения one_parameter . Поле, которое фильтруется. one_parameter может быть только одним из следующих:
event Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру события. Параметры события регистрируются как параметры события. Параметры события включают такие поля, как «firebase_screen» и «валюта».

Параметры событий можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

item Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру элемента. Параметры элемента регистрируются как параметры в массиве элементов. Параметры элемента включают такие поля, как «item_name» и «item_category».

Параметры элемента можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

Параметры товара доступны только в событиях электронной торговли. Дополнительную информацию о мероприятиях электронной торговли см. в руководстве «Измерение электронной торговли» .

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

СегментПараметрФильтрОбзор

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

JSON-представление 
{
  "inAnyNDayPeriod": string
}
Поля
in Any N Day Period

string ( int64 format)

Накапливает параметр за указанный период дней перед применением фильтра. Поддерживается только в том случае, если область действия критериев равна ACROSS_ALL_SESSIONS или WITHIN_SAME_SESSION . Поддерживается только в том случае, если параметр event_count .

Например, если inAnyNDayPeriod равен 3, eventName — «purchase», параметр события — «event_count», а критерий фильтра больше 5, этот фильтр будет накапливать количество событий покупок за каждые 3 последовательных дня в отчете. диапазон дат; пользователь пройдет критерии этого фильтра для включения в этот сегмент, если количество событий покупки превысит 5 в течение любого трехдневного периода подряд. Например, будут учитываться периоды с 01.11.2021 по 03.11.2021, с 02.11.2021 по 04.11.2021, с 03.11.2021 по 05.11.2021 и т. д.

Диапазон дат не расширяется с целью создания полного окна N дней в начале диапазона дат. Например, если отчет составлен за период с 01.11.2021 по 10.11.2021 и inAnyNDayPeriod = 3, первые два дня будут эффективно сокращены, поскольку никакие данные о событиях за пределами диапазона дат отчета не будут считываться. Например, первые четыре периода фактически будут следующими: с 01.11.2021 по 01.11.2021, с 01.11.2021 по 02.11.2021, с 01.11.2021 по 03.11.2021 и с 2021-02. С 02.11 по 04.11.2021.

inAnyNDayPeriod является необязательным. Если не указано, segmentParameterFilter применяется к каждому событию индивидуально.

Усерсегментсеквенцегруппу

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

JSON-представление 
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
Поля
sequence Scoping

enum ( UserCriteriaScoping )

Все шаги последовательности должны быть удовлетворены в области видимости, чтобы пользователь мог соответствовать последовательности. Например, если sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION , все шаги последовательности должны быть выполнены в течение одного сеанса, чтобы пользователь соответствовал последовательности. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT не поддерживается.

Необязательный. Если не указано, используется conditionScoping = ACROSS_ALL_SESSIONS .

sequence Maximum Duration

string ( Duration format)

Определяет период времени, в течение которого должна произойти вся последовательность; например, 30 минут. sequenceMaximumDuration включает конечную точку с точностью до микросекунды. Например, последовательность с максимальной продолжительностью 5 секунд может быть завершена за 4,9 или 5,0 секунды, но не за 5 секунд и 1 микросекунду.

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

user Sequence Steps[]

object ( UserSequenceStep )

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

Усерсеквенцестеп

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

JSON-представление 
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
is Directly Followed By

boolean

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

step Scoping

enum ( UserCriteriaScoping )

Этот шаг последовательности должен быть выполнен в области видимости, чтобы пользователь мог соответствовать последовательности. Например, если sequenceScoping = WITHIN_SAME_SESSION , шаги этой последовательности должны завершиться в течение одного сеанса, чтобы пользователь соответствовал последовательности. stepScoping = ACROSS_ALL_SESSIONS разрешен только в том случае, если sequenceScoping = ACROSS_ALL_SESSIONS .

Необязательный. Если не указано, stepScoping использует тот же UserCriteriaScoping , что и sequenceScoping .

segment Filter Expression

object ( SegmentFilterExpression )

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

Пользовательское исключение

Указывает, какие пользователи исключены из этого сегмента.

JSON-представление 
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
Поля
user Exclusion Duration

enum ( UserExclusionDuration )

Указывает, как долго будет действовать исключение, если пользователь соответствует userExclusionCriteria .

Необязательный. Если не указано, используется userExclusionDuration из USER_EXCLUSION_TEMPORARY .

user Exclusion Criteria

object ( UserSegmentCriteria )

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

UserExclusionDuration

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

Перечисления
USER_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
USER_EXCLUSION_TEMPORARY Временно исключайте пользователей из сегмента в периоды, когда пользователь соответствует условию userExclusionCriteria .
USER_EXCLUSION_PERMANENT Навсегда исключайте пользователей из сегмента, если пользователь когда-либо соответствует условию userExclusionCriteria .

Сеансегмент

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

JSON-представление 
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
Поля
session Inclusion Criteria

object ( SessionSegmentCriteria )

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

exclusion

object ( SessionSegmentExclusion )

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

Сеансегменткритериа

Сеанс соответствует критерию, если события сеанса соответствуют условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( SessionSegmentConditionGroup )

Сеанс соответствует этому критерию, если сеанс соответствует каждому из этих andConditionGroups .

сессионсегменткондиционионгруппу

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

JSON-представление 
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( SessionCriteriaScoping )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они группе условий. Эта область определяет, на скольких событиях оценивается segmentFilterExpression , прежде чем будет определено, соответствует ли группа условий или нет. Например, еслиconditionScoping conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION , выражение оценивается для всех событий в сеансе, а затем определяется, соответствует ли группа условий этому сеансу. Например, если conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT , выражение оценивается для одного события, а затем определяется, соответствует ли группа условий этому сеансу.

Необязательный. Если не указано, используется conditionScoping WITHIN_SAME_SESSION .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

SessionCriteriaScoping

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

Перечисления
SESSION_CRITERIA_SCOPING_UNSPECIFIED Область применения неуказанных критериев. Не уточняйте.
SESSION_CRITERIA_WITHIN_SAME_EVENT Если критерии удовлетворяются в рамках одного события, сеанс соответствует критериям.
SESSION_CRITERIA_WITHIN_SAME_SESSION Если критерии удовлетворяются в течение одного сеанса, сеанс соответствует критериям.

Сеансегментисключение

Указывает, какие сеансы исключены в этом сегменте.

JSON-представление 
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
Поля
session Exclusion Duration

enum ( SessionExclusionDuration )

Указывает, как долго будет действовать исключение, если сеанс соответствует sessionExclusionCriteria .

Необязательный. Если не указано, используется sessionExclusionDuration SESSION_EXCLUSION_TEMPORARY .

session Exclusion Criteria

object ( SessionSegmentCriteria )

Если сеанс соответствует этому условию, он исключается из членства в сегменте для sessionExclusionDuration .

Сеансексклюзиондюрация

Перечисляет параметры продолжительности исключения, если сеанс соответствует sessionExclusionCriteria .

Перечисления
SESSION_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
SESSION_EXCLUSION_TEMPORARY Временно исключайте сеансы из сегмента в периоды, когда сеанс соответствует условию sessionExclusionCriteria .
SESSION_EXCLUSION_PERMANENT Навсегда исключайте сеансы из сегмента, если сеанс когда-либо соответствует условию sessionExclusionCriteria .

Событийный сегмент

Сегменты событий – это подмножества событий, которые произошли на вашем сайте или в приложении. например, все события покупки, совершенные в определенном месте; события app_Exception, произошедшие в конкретной операционной системе.

JSON-представление 
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
Поля
event Inclusion Criteria

object ( EventSegmentCriteria )

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

exclusion

object ( EventSegmentExclusion )

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

Критерии сегмента событий

Событие соответствует критерию, если оно соответствует условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( EventSegmentConditionGroup )

Событие соответствует этому критерию, если событие соответствует каждому из этих andConditionGroups .

ГруппаСобытийСегментУсловие

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

JSON-представление 
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( EventCriteriaScoping )

conditionScoping всегда должен быть EVENT_CRITERIA_WITHIN_SAME_EVENT .

Необязательный. Если не указано, используется conditionScoping EVENT_CRITERIA_WITHIN_SAME_EVENT .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

EventCriteriaScoping

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

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

Исключение сегмента событий

Указывает, какие события исключены в этом сегменте.

JSON-представление 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
Поля
event Exclusion Duration

enum ( EventExclusionDuration )

eventExclusionDuration всегда должно быть PERMANENTLY_EXCLUDE .

Необязательный. Если не указано, используется eventExclusionDuration равный EVENT_EXCLUSION_PERMANENT .

event Exclusion Criteria

object ( EventSegmentCriteria )

Если событие соответствует этому условию, оно исключается из членства в сегменте eventExclusionDuration .

EventExclusionDuration

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

Перечисления
EVENT_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
EVENT_EXCLUSION_PERMANENT Навсегда исключайте события из сегмента, если событие когда-либо соответствует условию eventExclusionCriteria .

SubReport воронки

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

JSON-представление 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
Поля
dimension Headers[]

object ( DimensionHeader )

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

metric Headers[]

object ( MetricHeader )

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

rows[]

object ( Row )

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

metadata

object ( FunnelResponseMetadata )

Метаданные для отчета о воронке.

Метаданные FunnelResponseMetadata

Метаданные ответа отчета о воронке содержат дополнительную информацию об отчете о воронке.

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

object ( SamplingMetadata )

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

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

,

Возвращает настроенный отчет по воронке данных о ваших событиях Google Analytics. Данные, возвращаемые из API, представляют собой таблицу со столбцами для запрошенных параметров и показателей.

Исследование воронки позволяет визуализировать шаги, которые ваши пользователи предпринимают для выполнения задачи, и быстро увидеть, насколько хорошо они добиваются успеха или терпят неудачу на каждом этапе. Например, как потенциальные клиенты становятся покупателями, а затем покупателями? Как разовые покупатели становятся постоянными? С помощью этой информации вы можете улучшить неэффективные или заброшенные пути взаимодействия с клиентами. Дополнительную информацию см. в разделе Исследование последовательностей GA4 .

Этот метод представлен на стадии альфа-версии с целью сбора отзывов о синтаксисе и возможностях перед входом в бета-версию. Чтобы оставить отзыв об этом API, заполните форму «Отзыв об отчетах по воронке API данных Google Analytics» .

HTTP-запрос

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

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

Параметры пути

Параметры
property

string

Необязательный. Идентификатор ресурса Google Analytics, события которого отслеживаются. Указывается в URL-пути, а не в теле. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта . В пакетном запросе это свойство должно быть либо неопределенным, либо соответствовать свойству уровня пакета.

Пример: свойства/1234

Тело запроса

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

JSON-представление 
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
Поля
date Ranges[]

object ( DateRange )

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

funnel

object ( Funnel )

Необязательный. Конфигурация воронки этого запроса. Эта конфигурация воронки является обязательной.

funnel Breakdown

object ( FunnelBreakdown )

Необязательный. Если указано, эта разбивка добавляет измерение к ответу подотчета таблицы воронки. Это измерение разбивки расширяет каждый шаг воронки до уникальных значений измерения разбивки. Например, при разбивке по измерению deviceCategory будут созданы строки для mobile , tablet , desktop и итоговых значений.

funnel Next Action

object ( FunnelNextAction )

Необязательный. Если указано, следующее действие добавляет измерение в ответ подотчета визуализации воронки. Это измерение следующего действия расширяет каждый шаг воронки до уникальных значений следующего действия. Например, следующее действие измерения eventName создаст строки для нескольких событий (например, session_start & click ) и итогового значения.

Следующее действие поддерживает только eventName и большинство размеров страницы/экрана, например pageTitle и pagePath .

funnel Visualization Type

enum ( FunnelVisualizationType )

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

segments[]

object ( Segment )

Необязательный. Конфигурации сегментов. Сегменты — это подмножества данных свойства. В отчете по воронке с сегментами последовательность оценивается в каждом сегменте.

Каждый сегмент, указанный в этом запросе, создает в ответе отдельную строку; в ответе каждый сегмент идентифицируется своим именем.

Параметр сегментов является необязательным. Запросы ограничены 4 сегментами.

limit

string ( int64 format)

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

API также может возвращать меньше строк, чем запрошенное limit , если значений измерения не так много, как limit .

dimension Filter

object ( FilterExpression )

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

return Property Quota

boolean

Необязательный. Переключает, возвращать ли текущее состояние квоты этого ресурса Analytics. Квота возвращается в PropertyQuota .

Тело ответа

Ответ на отчет о воронке содержит два подотчета. Два подотчета представляют собой разные комбинации параметров и показателей.

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

JSON-представление 
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Поля
funnel Table

object ( FunnelSubReport )

Таблица воронки — это отчет с указанием шага воронки, сегмента, параметра разбивки, активных пользователей, степени завершения, количества отказов и количества отказов.

Измерение сегмента присутствует в этом ответе только в том случае, если сегмент был запрошен. Измерение разбивки присутствует в этом ответе только в том случае, если оно было запрошено.

funnel Visualization

object ( FunnelSubReport )

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

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

property Quota

object ( PropertyQuota )

Состояние квоты этого ресурса Google Аналитики, включая этот запрос.

kind

string

Определяет, к какому типу ресурса относится это сообщение. Этот kind всегда представляет собой фиксированную строку «analyticsData#runFunnelReport». Полезно различать типы ответов в JSON.

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

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

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

Воронка

Настраивает воронку в запросе отчета о воронке. Воронка сообщает о пользователях, когда они проходят последовательность шагов.

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

JSON-представление 
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
Поля
is Open Funnel

boolean

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

steps[]

object ( FunnelStep )

Последовательные шаги этой воронки.

Шаг воронки

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

JSON-представление 
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
Поля
name

string

Отличительное имя для этого шага. Если не указано, шаги будут именоваться индексированным именем, начинающимся с 1 (например, «0.», «1.» и т. д.). Это имя определяет строковое значение, возвращаемое измерением funnelStepName . Например, если указать name = Purchase на третьем этапе воронки запроса, в ответе отчета по воронке будет указано 3. Purchase .

is Directly Followed By

boolean

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

filter Expression

object ( FunnelFilterExpression )

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

within Duration From Prior Step

string ( Duration format)

Если указано, этот шаг должен завершиться в пределах продолжительности завершения предыдущего шага. withinDurationFromPriorStep включает конечную точку с точностью до микросекунды. Например, длительность в 5 секунд можно завершить за 4,9 или 5,0 секунды, но не за 5 секунд и 1 микросекунду.

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

Выражение Фильтра Воронки

Выражает комбинации фильтров-воронок.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для FunnelFilterExpression . expr может быть только одним из следующих:
and Group

object ( FunnelFilterExpressionList )

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

or Group

object ( FunnelFilterExpressionList )

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

not Expression

object ( FunnelFilterExpression )

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

funnel Field Filter

object ( FunnelFieldFilter )

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

funnel Event Filter

object ( FunnelEventFilter )

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

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

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

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

object ( FunnelFilterExpression )

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

ВоронкаПолеФильтр

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

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

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Поля
field Name

string

Имя измерения или имя метрики.

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

Фильтр событий воронки

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

JSON-представление 
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
Поля
event Name

string

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

funnel Parameter Filter Expression

object ( FunnelParameterFilterExpression )

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

Внутри выражения фильтра параметров доступны только фильтры параметров.

ВоронкаПараметрФильтрВыражение

Выражает комбинации фильтров воронки по параметрам.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для FunnelParameterFilterExpression . expr может быть только одним из следующих:
and Group

object ( FunnelParameterFilterExpressionList )

Выражение FunnelParameterFilterExpression в andGroup имеет отношение И.

or Group

object ( FunnelParameterFilterExpressionList )

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

not Expression

object ( FunnelParameterFilterExpression )

FunnelParameterFilterExpression НЕ имеет значения notExpression .

funnel Parameter Filter

object ( FunnelParameterFilter )

Примитивный фильтр параметров воронки.

ВоронкаПараметрФильтрВыражениеСписок

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

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

object ( FunnelParameterFilterExpression )

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

ВоронкаПараметрФильтр

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

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

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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.
}
Поля
Поле объединения one_parameter . Поле, которое фильтруется. one_parameter может быть только одним из следующих:
event Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру события. Параметры события регистрируются как параметры события. Параметры события включают такие поля, как «firebase_screen» и «валюта».

Параметры событий можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

item Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру элемента. Параметры элемента регистрируются как параметры в массиве элементов. Параметры элемента включают такие поля, как «item_name» и «item_category».

Параметры элемента можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

Параметры товара доступны только в событиях электронной торговли. Дополнительную информацию о мероприятиях электронной торговли см. в руководстве «Измерение электронной торговли» .

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

Разбивка по воронке

Разбивки добавляют измерение в ответ подотчета таблицы воронки.

JSON-представление 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
Поля
breakdown Dimension

object ( Dimension )

Столбец измерения добавлен в ответ подотчета таблицы последовательностей. Измерение разбивки разбивает каждый шаг воронки. Если указан funnelBreakdown требуется допустимое значение breakdownDimension .

limit

string ( int64 format)

Максимальное количество различных значений измерения разбивки, возвращаемых в ответе. Если предел не указан, используется limit в 5 . Предел должен превышать ноль и не может превышать 15.

ВоронкаСледующееДействие

Следующие действия определяют значение измерения после того, как пользователь выполнил шаг, но до того, как тот же пользователь выполнил следующий шаг. Например, если nextActionDimension имеет eventName , то nextActionDimension в строке i го шага воронки вернет первое событие после события, которое квалифицировало пользователя на i -й шаг воронки, но до того, как пользователь достиг i+1 -го шага воронки.

JSON-представление 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
Поля
next Action Dimension

object ( Dimension )

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

nextActionDimension в настоящее время поддерживает только eventName и большинство размеров страницы/экрана, таких как pageTitle и pagePath . nextActionDimension не может быть выражением измерения.

limit

string ( int64 format)

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

Тип визуализации воронки

Управляет размерами, присутствующими в ответе подотчета визуализации воронки.

Перечисления
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED Неопределенный тип.
STANDARD_FUNNEL Стандартная (ступенчатая) воронка. Подотчет о визуализации воронки в ответе не будет содержать дату.
TRENDED_FUNNEL Воронка с трендом (линейный график). Подотчет по визуализации воронки в ответе будет содержать измерение даты.

Сегмент

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

Дополнительную информацию см. в разделе Построитель сегментов .

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

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
Поля
name

string

Имя этого сегмента. Если не указано, сегменты называются «Сегмент». Это имя определяет строковое значение, возвращаемое измерением segment . Измерение segment добавляет к имени сегмента префикс, начиная с 1, индексный номер сегмента в запросе (например, «1. Сегмент», «2. Сегмент» и т. д.).

Поле объединения one_segment_scope . Сегмент указан в одной области. one_segment_scope может быть только одним из следующих:
user Segment

object ( UserSegment )

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

session Segment

object ( SessionSegment )

Сегменты сеансов – это подмножества сеансов, произошедших на вашем сайте или в приложении.

event Segment

object ( EventSegment )

Сегменты событий – это подмножества событий, которые произошли на вашем сайте или в приложении.

Пользовательский сегмент

Сегменты пользователей — это подгруппы пользователей, которые взаимодействовали с вашим сайтом или приложением. Например, пользователи, которые ранее совершали покупки; пользователи, которые добавили товары в свои корзины, но не совершили покупку.

JSON-представление 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
Поля
user Inclusion Criteria

object ( UserSegmentCriteria )

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

exclusion

object ( UserSegmentExclusion )

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

Усерсегменткритериа

Пользователь соответствует критерию, если события пользователя соответствуют условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( UserSegmentConditionGroup )

Пользователь соответствует этому критерию, если он соответствует каждому из этих andConditionGroups и каждому из andSequenceGroups . andConditionGroups может быть пустым, если указаны andSequenceGroups .

and Sequence Groups[]

object ( UserSegmentSequenceGroup )

Пользователь соответствует этому критерию, если он соответствует каждому из этих andSequenceGroups и каждому из andConditionGroups . andSequenceGroups может быть пустым, если указаны andConditionGroups .

Усерсегменткондиционионгруппу

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

JSON-представление 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( UserCriteriaScoping )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они группе условий. Эта область определяет, на скольких событиях оценивается segmentFilterExpression , прежде чем будет определено, соответствует ли группа условий или нет. Например, еслиconditionScoping conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION , выражение оценивается для всех событий в сеансе, а затем определяется, соответствует ли группа условий этому пользователю. Например, если conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT , выражение оценивается по одному событию, а затем определяется, соответствует ли группа условий этому пользователю.

Необязательный. Если не указано, используется conditionScoping = ACROSS_ALL_SESSIONS .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

Пользовательские критерииОбзор

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

Перечисления
USER_CRITERIA_SCOPING_UNSPECIFIED Область применения неуказанных критериев. Не уточняйте.
USER_CRITERIA_WITHIN_SAME_EVENT Если критерии удовлетворяются в рамках одного события, пользователь соответствует критериям.
USER_CRITERIA_WITHIN_SAME_SESSION Если критерии удовлетворены в течение одного сеанса, пользователь соответствует критериям.
USER_CRITERIA_ACROSS_ALL_SESSIONS Если критериям удовлетворяют какие-либо события для пользователя, пользователь соответствует критериям.

Выражение сегментного фильтра

Выражает комбинации сегментных фильтров.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для SegmentFilterExpression . expr может быть только одним из следующих:
and Group

object ( SegmentFilterExpressionList )

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

or Group

object ( SegmentFilterExpressionList )

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

not Expression

object ( SegmentFilterExpression )

SegmentFilterExpression НЕ имеет notExpression .

segment Filter

object ( SegmentFilter )

Примитивный сегментный фильтр.

segment Event Filter

object ( SegmentEventFilter )

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

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

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

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

object ( SegmentFilterExpression )

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

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

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

JSON-представление 
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // 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.
}
Поля
field Name

string

Имя измерения или имя метрики.

filter Scoping

object ( SegmentFilterScoping )

Указывает область действия фильтра.

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

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

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

JSON-представление 
{
  "atAnyPointInTime": boolean
}
Поля
at Any Point In Time

boolean

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

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

Этот atAnyPointInTime можно указать только в том случае, если область действия критерия равна ACROSS_ALL_SESSIONS и его нельзя указать в последовательностях.

Если областью критериев является ACROSS_ALL_SESSIONS , atAnyPointInTime = false используется, если не указано.

Фильтр событий сегмента

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

JSON-представление 
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
Поля
event Name

string

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

segment Parameter Filter Expression

object ( SegmentParameterFilterExpression )

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

Внутри выражения фильтра параметров доступны только фильтры параметров.

СегментПараметрФильтрВыражение

Выражает комбинации сегментного фильтра по параметрам.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для SegmentParameterFilterExpression . expr может быть только одним из следующих:
and Group

object ( SegmentParameterFilterExpressionList )

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

or Group

object ( SegmentParameterFilterExpressionList )

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

not Expression

object ( SegmentParameterFilterExpression )

SegmentParameterFilterExpression НЕ имеет значения notExpression .

segment Parameter Filter

object ( SegmentParameterFilter )

Примитивный фильтр параметров сегмента.

СегментПараметрФильтрВыражениеСписок

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

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

object ( SegmentParameterFilterExpression )

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

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

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

JSON-представление 
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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.
}
Поля
filter Scoping

object ( SegmentParameterFilterScoping )

Указывает область действия фильтра.

Поле объединения one_parameter . Поле, которое фильтруется. one_parameter может быть только одним из следующих:
event Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру события. Параметры события регистрируются как параметры события. Параметры события включают такие поля, как «firebase_screen» и «валюта».

Параметры событий можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

item Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру элемента. Параметры элемента регистрируются как параметры в массиве элементов. Параметры элемента включают такие поля, как «item_name» и «item_category».

Параметры элемента можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

Параметры товара доступны только в событиях электронной торговли. Дополнительную информацию о мероприятиях электронной торговли см. в руководстве «Измерение электронной торговли» .

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

СегментПараметрФильтрОбзор

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

JSON-представление 
{
  "inAnyNDayPeriod": string
}
Поля
in Any N Day Period

string ( int64 format)

Накапливает параметр за указанный период дней перед применением фильтра. Поддерживается только в том случае, если область действия критериев равна ACROSS_ALL_SESSIONS или WITHIN_SAME_SESSION . Поддерживается только в том случае, если параметр event_count .

Например, если inAnyNDayPeriod равен 3, eventName — «purchase», параметр события — «event_count», а критерий фильтра больше 5, этот фильтр будет накапливать количество событий покупок за каждые 3 последовательных дня в отчете. диапазон дат; пользователь пройдет критерии этого фильтра для включения в этот сегмент, если количество событий покупки превысит 5 в течение любого трехдневного периода подряд. Например, будут учитываться периоды с 01.11.2021 по 03.11.2021, с 02.11.2021 по 04.11.2021, с 03.11.2021 по 05.11.2021 и т. д.

Диапазон дат не расширяется с целью создания полного окна N дней в начале диапазона дат. Например, если отчет составлен за период с 01.11.2021 по 10.11.2021 и inAnyNDayPeriod = 3, первые два дня будут эффективно сокращены, поскольку никакие данные о событиях за пределами диапазона дат отчета не будут считываться. Например, первые четыре периода фактически будут следующими: с 01.11.2021 по 01.11.2021, с 01.11.2021 по 02.11.2021, с 01.11.2021 по 03.11.2021 и с 2021-02. С 02.11 по 04.11.2021.

inAnyNDayPeriod является необязательным. Если не указано, segmentParameterFilter применяется к каждому событию индивидуально.

Усерсегментсеквенцегруппу

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

JSON-представление 
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
Поля
sequence Scoping

enum ( UserCriteriaScoping )

Все шаги последовательности должны быть удовлетворены в области видимости, чтобы пользователь мог соответствовать последовательности. Например, если sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION , все шаги последовательности должны быть выполнены в течение одного сеанса, чтобы пользователь соответствовал последовательности. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT не поддерживается.

Необязательный. Если не указано, используется conditionScoping = ACROSS_ALL_SESSIONS .

sequence Maximum Duration

string ( Duration format)

Определяет период времени, в течение которого должна произойти вся последовательность; например, 30 минут. sequenceMaximumDuration включает конечную точку с точностью до микросекунды. Например, последовательность с максимальной продолжительностью 5 секунд может быть завершена за 4,9 или 5,0 секунды, но не за 5 секунд и 1 микросекунду.

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

user Sequence Steps[]

object ( UserSequenceStep )

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

Усерсеквенцестеп

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

JSON-представление 
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
is Directly Followed By

boolean

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

step Scoping

enum ( UserCriteriaScoping )

Этот шаг последовательности должен быть выполнен в области видимости, чтобы пользователь мог соответствовать последовательности. Например, если sequenceScoping = WITHIN_SAME_SESSION , шаги этой последовательности должны завершиться в течение одного сеанса, чтобы пользователь соответствовал последовательности. stepScoping = ACROSS_ALL_SESSIONS разрешен только в том случае, если sequenceScoping = ACROSS_ALL_SESSIONS .

Необязательный. Если не указано, stepScoping использует тот же UserCriteriaScoping , что и sequenceScoping .

segment Filter Expression

object ( SegmentFilterExpression )

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

Пользовательское исключение

Указывает, какие пользователи исключены из этого сегмента.

JSON-представление 
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
Поля
user Exclusion Duration

enum ( UserExclusionDuration )

Указывает, как долго будет действовать исключение, если пользователь соответствует userExclusionCriteria .

Необязательный. Если не указано, используется userExclusionDuration из USER_EXCLUSION_TEMPORARY .

user Exclusion Criteria

object ( UserSegmentCriteria )

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

UserExclusionDuration

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

Перечисления
USER_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
USER_EXCLUSION_TEMPORARY Временно исключайте пользователей из сегмента в периоды, когда пользователь соответствует условию userExclusionCriteria .
USER_EXCLUSION_PERMANENT Навсегда исключайте пользователей из сегмента, если пользователь когда-либо соответствует условию userExclusionCriteria .

Сеансегмент

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

JSON-представление 
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
Поля
session Inclusion Criteria

object ( SessionSegmentCriteria )

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

exclusion

object ( SessionSegmentExclusion )

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

Сеансегменткритериа

Сеанс соответствует критерию, если события сеанса соответствуют условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( SessionSegmentConditionGroup )

Сеанс соответствует этому критерию, если сеанс соответствует каждому из этих andConditionGroups .

сессионсегменткондиционионгруппу

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

JSON-представление 
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( SessionCriteriaScoping )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они группе условий. Эта область определяет, на скольких событиях оценивается segmentFilterExpression , прежде чем будет определено, соответствует ли группа условий или нет. Например, еслиconditionScoping conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION , выражение оценивается для всех событий в сеансе, а затем определяется, соответствует ли группа условий этому сеансу. Например, если conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT , выражение оценивается для одного события, а затем определяется, соответствует ли группа условий этому сеансу.

Необязательный. Если не указано, используется conditionScoping WITHIN_SAME_SESSION .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

SessionCriteriaScoping

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

Перечисления
SESSION_CRITERIA_SCOPING_UNSPECIFIED Область применения неуказанных критериев. Не уточняйте.
SESSION_CRITERIA_WITHIN_SAME_EVENT Если критерии удовлетворяются в рамках одного события, сеанс соответствует критериям.
SESSION_CRITERIA_WITHIN_SAME_SESSION Если критерии удовлетворяются в течение одного сеанса, сеанс соответствует критериям.

Сеансегментисключение

Указывает, какие сеансы исключены в этом сегменте.

JSON-представление 
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
Поля
session Exclusion Duration

enum ( SessionExclusionDuration )

Указывает, как долго будет действовать исключение, если сеанс соответствует sessionExclusionCriteria .

Необязательный. Если не указано, используется sessionExclusionDuration SESSION_EXCLUSION_TEMPORARY .

session Exclusion Criteria

object ( SessionSegmentCriteria )

Если сеанс соответствует этому условию, он исключается из членства в сегменте для sessionExclusionDuration .

Сеансексклюзиондюрация

Перечисляет параметры продолжительности исключения, если сеанс соответствует sessionExclusionCriteria .

Перечисления
SESSION_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
SESSION_EXCLUSION_TEMPORARY Временно исключайте сеансы из сегмента в периоды, когда сеанс соответствует условию sessionExclusionCriteria .
SESSION_EXCLUSION_PERMANENT Навсегда исключайте сеансы из сегмента, если сеанс когда-либо соответствует условию sessionExclusionCriteria .

Событийный сегмент

Сегменты событий – это подмножества событий, которые произошли на вашем сайте или в приложении. например, все события покупки, совершенные в определенном месте; события app_Exception, произошедшие в конкретной операционной системе.

JSON-представление 
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
Поля
event Inclusion Criteria

object ( EventSegmentCriteria )

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

exclusion

object ( EventSegmentExclusion )

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

Критерии сегмента событий

Событие соответствует критерию, если оно соответствует условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( EventSegmentConditionGroup )

Событие соответствует этому критерию, если событие соответствует каждому из этих andConditionGroups .

ГруппаСобытийСегментУсловие

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

JSON-представление 
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( EventCriteriaScoping )

conditionScoping всегда должен быть EVENT_CRITERIA_WITHIN_SAME_EVENT .

Необязательный. Если не указано, используется conditionScoping EVENT_CRITERIA_WITHIN_SAME_EVENT .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

EventCriteriaScoping

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

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

Исключение сегмента событий

Указывает, какие события исключены в этом сегменте.

JSON-представление 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
Поля
event Exclusion Duration

enum ( EventExclusionDuration )

eventExclusionDuration всегда должно быть PERMANENTLY_EXCLUDE .

Необязательный. Если не указано, используется eventExclusionDuration равный EVENT_EXCLUSION_PERMANENT .

event Exclusion Criteria

object ( EventSegmentCriteria )

Если событие соответствует этому условию, оно исключается из членства в сегменте eventExclusionDuration .

EventExclusionDuration

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

Перечисления
EVENT_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
EVENT_EXCLUSION_PERMANENT Навсегда исключайте события из сегмента, если событие когда-либо соответствует условию eventExclusionCriteria .

SubReport воронки

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

JSON-представление 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
Поля
dimension Headers[]

object ( DimensionHeader )

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

metric Headers[]

object ( MetricHeader )

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

rows[]

object ( Row )

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

metadata

object ( FunnelResponseMetadata )

Метаданные для отчета о воронке.

Метаданные FunnelResponseMetadata

Метаданные ответа отчета о воронке содержат дополнительную информацию об отчете о воронке.

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

object ( SamplingMetadata )

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

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

,

Возвращает настроенный отчет по воронке данных о ваших событиях Google Analytics. Данные, возвращаемые из API, представляют собой таблицу со столбцами для запрошенных параметров и показателей.

Исследование воронки позволяет визуализировать шаги, которые ваши пользователи предпринимают для выполнения задачи, и быстро увидеть, насколько хорошо они добиваются успеха или терпят неудачу на каждом этапе. Например, как потенциальные клиенты становятся покупателями, а затем покупателями? Как разовые покупатели становятся постоянными? С помощью этой информации вы можете улучшить неэффективные или заброшенные пути взаимодействия с клиентами. Дополнительную информацию см. в разделе Исследование последовательностей GA4 .

Этот метод представлен на стадии альфа-версии с целью сбора отзывов о синтаксисе и возможностях перед входом в бета-версию. Чтобы оставить отзыв об этом API, заполните форму «Отзыв об отчетах по воронке API данных Google Analytics» .

HTTP-запрос

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

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

Параметры пути

Параметры
property

string

Необязательный. Идентификатор ресурса Google Analytics, события которого отслеживаются. Указывается в URL-пути, а не в теле. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта . В пакетном запросе это свойство должно быть либо неопределенным, либо соответствовать свойству уровня пакета.

Пример: свойства/1234

Тело запроса

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

JSON-представление 
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
Поля
date Ranges[]

object ( DateRange )

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

funnel

object ( Funnel )

Необязательный. Конфигурация воронки этого запроса. Эта конфигурация воронки является обязательной.

funnel Breakdown

object ( FunnelBreakdown )

Необязательный. Если указано, эта разбивка добавляет измерение к ответу подотчета таблицы воронки. Это измерение разбивки расширяет каждый шаг воронки до уникальных значений измерения разбивки. Например, при разбивке по измерению deviceCategory будут созданы строки для mobile , tablet , desktop и итоговых значений.

funnel Next Action

object ( FunnelNextAction )

Необязательный. Если указано, следующее действие добавляет измерение в ответ подотчета визуализации воронки. Это измерение следующего действия расширяет каждый шаг воронки до уникальных значений следующего действия. Например, следующее действие измерения eventName создаст строки для нескольких событий (например, session_start & click ) и итогового значения.

Следующее действие поддерживает только eventName и большинство размеров страницы/экрана, например pageTitle и pagePath .

funnel Visualization Type

enum ( FunnelVisualizationType )

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

segments[]

object ( Segment )

Необязательный. Конфигурации сегментов. Сегменты — это подмножества данных свойства. В отчете по воронке с сегментами последовательность оценивается в каждом сегменте.

Каждый сегмент, указанный в этом запросе, создает в ответе отдельную строку; в ответе каждый сегмент идентифицируется своим именем.

Параметр сегментов является необязательным. Запросы ограничены 4 сегментами.

limit

string ( int64 format)

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

API также может возвращать меньше строк, чем запрошенное limit , если значений измерения не так много, как limit .

dimension Filter

object ( FilterExpression )

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

return Property Quota

boolean

Необязательный. Переключает, возвращать ли текущее состояние квоты этого ресурса Analytics. Квота возвращается в PropertyQuota .

Тело ответа

Ответ на отчет о воронке содержит два подотчета. Два подотчета представляют собой разные комбинации параметров и показателей.

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

JSON-представление 
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Поля
funnel Table

object ( FunnelSubReport )

Таблица воронки — это отчет с указанием шага воронки, сегмента, параметра разбивки, активных пользователей, степени завершения, количества отказов и количества отказов.

Измерение сегмента присутствует в этом ответе только в том случае, если сегмент был запрошен. Измерение разбивки присутствует в этом ответе только в том случае, если оно было запрошено.

funnel Visualization

object ( FunnelSubReport )

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

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

property Quota

object ( PropertyQuota )

Состояние квоты этого ресурса Google Аналитики, включая этот запрос.

kind

string

Определяет, к какому типу ресурса относится это сообщение. Этот kind всегда представляет собой фиксированную строку «analyticsData#runFunnelReport». Полезно различать типы ответов в JSON.

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

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

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

Воронка

Настраивает воронку в запросе отчета о воронке. Воронка сообщает о пользователях, когда они проходят последовательность шагов.

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

JSON-представление 
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
Поля
is Open Funnel

boolean

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

steps[]

object ( FunnelStep )

Последовательные шаги этой воронки.

Шаг воронки

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

JSON-представление 
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
Поля
name

string

Отличительное имя для этого шага. Если не указано, шаги будут именоваться индексированным именем, начинающимся с 1 (например, «0.», «1.» и т. д.). Это имя определяет строковое значение, возвращаемое измерением funnelStepName . Например, если указать name = Purchase на третьем этапе воронки запроса, в ответе отчета по воронке будет указано 3. Purchase .

is Directly Followed By

boolean

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

filter Expression

object ( FunnelFilterExpression )

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

within Duration From Prior Step

string ( Duration format)

Если указано, этот шаг должен завершиться в пределах продолжительности завершения предыдущего шага. withinDurationFromPriorStep включает конечную точку с точностью до микросекунды. Например, длительность в 5 секунд можно завершить за 4,9 или 5,0 секунды, но не за 5 секунд и 1 микросекунду.

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

Выражение Фильтра Воронки

Выражает комбинации фильтров-воронок.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для FunnelFilterExpression . expr может быть только одним из следующих:
and Group

object ( FunnelFilterExpressionList )

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

or Group

object ( FunnelFilterExpressionList )

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

not Expression

object ( FunnelFilterExpression )

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

funnel Field Filter

object ( FunnelFieldFilter )

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

funnel Event Filter

object ( FunnelEventFilter )

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

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

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

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

object ( FunnelFilterExpression )

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

ВоронкаПолеФильтр

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

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

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Поля
field Name

string

Имя измерения или имя метрики.

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

Фильтр событий воронки

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

JSON-представление 
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
Поля
event Name

string

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

funnel Parameter Filter Expression

object ( FunnelParameterFilterExpression )

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

Внутри выражения фильтра параметров доступны только фильтры параметров.

ВоронкаПараметрФильтрВыражение

Выражает комбинации фильтров воронки по параметрам.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для FunnelParameterFilterExpression . expr может быть только одним из следующих:
and Group

object ( FunnelParameterFilterExpressionList )

Выражение FunnelParameterFilterExpression в andGroup имеет отношение И.

or Group

object ( FunnelParameterFilterExpressionList )

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

not Expression

object ( FunnelParameterFilterExpression )

FunnelParameterFilterExpression НЕ имеет значения notExpression .

funnel Parameter Filter

object ( FunnelParameterFilter )

Примитивный фильтр параметров воронки.

ВоронкаПараметрФильтрВыражениеСписок

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

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

object ( FunnelParameterFilterExpression )

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

ВоронкаПараметрФильтр

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

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

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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.
}
Поля
Поле объединения one_parameter . Поле, которое фильтруется. one_parameter может быть только одним из следующих:
event Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру события. Параметры события регистрируются как параметры события. Параметры события включают такие поля, как «firebase_screen» и «валюта».

Параметры событий можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

item Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру элемента. Параметры элемента регистрируются как параметры в массиве элементов. Параметры элемента включают такие поля, как «item_name» и «item_category».

Параметры элемента можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

Параметры товара доступны только в событиях электронной торговли. Дополнительную информацию о мероприятиях электронной торговли см. в руководстве «Измерение электронной торговли» .

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

Разбивка по воронке

Разбивки добавляют измерение в ответ подотчета таблицы воронки.

JSON-представление 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
Поля
breakdown Dimension

object ( Dimension )

Столбец измерения добавлен в ответ подотчета таблицы последовательностей. Измерение разбивки разбивает каждый шаг воронки. Если указан funnelBreakdown требуется допустимое значение breakdownDimension .

limit

string ( int64 format)

Максимальное количество различных значений измерения разбивки, возвращаемых в ответе. Если предел не указан, используется limit в 5 . Предел должен превышать ноль и не может превышать 15.

ВоронкаСледующееДействие

Следующие действия определяют значение измерения после того, как пользователь выполнил шаг, но до того, как тот же пользователь выполнил следующий шаг. Например, если nextActionDimension имеет eventName , то nextActionDimension в строке i го шага воронки вернет первое событие после события, которое квалифицировало пользователя на i -й шаг воронки, но до того, как пользователь достиг i+1 -го шага воронки.

JSON-представление 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
Поля
next Action Dimension

object ( Dimension )

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

nextActionDimension в настоящее время поддерживает только eventName и большинство размеров страницы/экрана, таких как pageTitle и pagePath . nextActionDimension не может быть выражением измерения.

limit

string ( int64 format)

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

Тип визуализации воронки

Управляет размерами, присутствующими в ответе подотчета визуализации воронки.

Перечисления
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED Неопределенный тип.
STANDARD_FUNNEL Стандартная (ступенчатая) воронка. Подотчет о визуализации воронки в ответе не будет содержать дату.
TRENDED_FUNNEL Воронка с трендом (линейный график). Подотчет по визуализации воронки в ответе будет содержать измерение даты.

Сегмент

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

Дополнительную информацию см. в разделе Построитель сегментов .

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

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
Поля
name

string

Имя этого сегмента. Если не указано, сегменты называются «Сегмент». Это имя определяет строковое значение, возвращаемое измерением segment . Измерение segment добавляет к имени сегмента префикс, начиная с 1, индексный номер сегмента в запросе (например, «1. Сегмент», «2. Сегмент» и т. д.).

Поле объединения one_segment_scope . Сегмент указан в одной области. one_segment_scope может быть только одним из следующих:
user Segment

object ( UserSegment )

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

session Segment

object ( SessionSegment )

Сегменты сеансов – это подмножества сеансов, произошедших на вашем сайте или в приложении.

event Segment

object ( EventSegment )

Сегменты событий – это подмножества событий, которые произошли на вашем сайте или в приложении.

Пользовательский сегмент

Сегменты пользователей — это подгруппы пользователей, которые взаимодействовали с вашим сайтом или приложением. Например, пользователи, которые ранее совершали покупки; пользователи, которые добавили товары в свои корзины, но не совершили покупку.

JSON-представление 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
Поля
user Inclusion Criteria

object ( UserSegmentCriteria )

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

exclusion

object ( UserSegmentExclusion )

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

Усерсегменткритериа

Пользователь соответствует критерию, если события пользователя соответствуют условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( UserSegmentConditionGroup )

Пользователь соответствует этому критерию, если он соответствует каждому из этих andConditionGroups и каждому из andSequenceGroups . andConditionGroups может быть пустым, если указаны andSequenceGroups .

and Sequence Groups[]

object ( UserSegmentSequenceGroup )

Пользователь соответствует этому критерию, если он соответствует каждому из этих andSequenceGroups и каждому из andConditionGroups . andSequenceGroups может быть пустым, если указаны andConditionGroups .

Усерсегменткондиционионгруппу

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

JSON-представление 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( UserCriteriaScoping )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они группе условий. Эта область определяет, на скольких событиях оценивается segmentFilterExpression , прежде чем будет определено, соответствует ли группа условий или нет. Например, еслиconditionScoping conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION , выражение оценивается для всех событий в сеансе, а затем определяется, соответствует ли группа условий этому пользователю. Например, если conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT , выражение оценивается по одному событию, а затем определяется, соответствует ли группа условий этому пользователю.

Необязательный. Если не указано, используется conditionScoping = ACROSS_ALL_SESSIONS .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

Пользовательские критерииОбзор

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

Перечисления
USER_CRITERIA_SCOPING_UNSPECIFIED Область применения неуказанных критериев. Не уточняйте.
USER_CRITERIA_WITHIN_SAME_EVENT Если критерии удовлетворяются в рамках одного события, пользователь соответствует критериям.
USER_CRITERIA_WITHIN_SAME_SESSION Если критерии удовлетворены в течение одного сеанса, пользователь соответствует критериям.
USER_CRITERIA_ACROSS_ALL_SESSIONS Если критериям удовлетворяют какие-либо события для пользователя, пользователь соответствует критериям.

Выражение сегментного фильтра

Выражает комбинации сегментных фильтров.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для SegmentFilterExpression . expr может быть только одним из следующих:
and Group

object ( SegmentFilterExpressionList )

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

or Group

object ( SegmentFilterExpressionList )

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

not Expression

object ( SegmentFilterExpression )

SegmentFilterExpression НЕ имеет notExpression .

segment Filter

object ( SegmentFilter )

Примитивный сегментный фильтр.

segment Event Filter

object ( SegmentEventFilter )

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

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

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

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

object ( SegmentFilterExpression )

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

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

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

JSON-представление 
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // 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.
}
Поля
field Name

string

Имя измерения или имя метрики.

filter Scoping

object ( SegmentFilterScoping )

Указывает область действия фильтра.

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

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

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

JSON-представление 
{
  "atAnyPointInTime": boolean
}
Поля
at Any Point In Time

boolean

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

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

Этот atAnyPointInTime можно указать только в том случае, если область действия критерия равна ACROSS_ALL_SESSIONS и его нельзя указать в последовательностях.

Если областью критериев является ACROSS_ALL_SESSIONS , atAnyPointInTime = false используется, если не указано.

Фильтр событий сегмента

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

JSON-представление 
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
Поля
event Name

string

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

segment Parameter Filter Expression

object ( SegmentParameterFilterExpression )

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

Внутри выражения фильтра параметров доступны только фильтры параметров.

СегментПараметрФильтрВыражение

Выражает комбинации сегментного фильтра по параметрам.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для SegmentParameterFilterExpression . expr может быть только одним из следующих:
and Group

object ( SegmentParameterFilterExpressionList )

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

or Group

object ( SegmentParameterFilterExpressionList )

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

not Expression

object ( SegmentParameterFilterExpression )

SegmentParameterFilterExpression НЕ имеет значения notExpression .

segment Parameter Filter

object ( SegmentParameterFilter )

Примитивный фильтр параметров сегмента.

СегментПараметрФильтрВыражениеСписок

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

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

object ( SegmentParameterFilterExpression )

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

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

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

JSON-представление 
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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.
}
Поля
filter Scoping

object ( SegmentParameterFilterScoping )

Указывает область действия фильтра.

Поле объединения one_parameter . Поле, которое фильтруется. one_parameter может быть только одним из следующих:
event Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру события. Параметры события регистрируются как параметры события. Параметры события включают такие поля, как «firebase_screen» и «валюта».

Параметры событий можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

item Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру элемента. Параметры элемента регистрируются как параметры в массиве элементов. Параметры элемента включают такие поля, как «item_name» и «item_category».

Параметры элемента можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

Параметры товара доступны только в событиях электронной торговли. Дополнительную информацию о мероприятиях электронной торговли см. в руководстве «Измерение электронной торговли» .

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

СегментПараметрФильтрОбзор

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

JSON-представление 
{
  "inAnyNDayPeriod": string
}
Поля
in Any N Day Period

string ( int64 format)

Накапливает параметр за указанный период дней перед применением фильтра. Поддерживается только в том случае, если область действия критериев равна ACROSS_ALL_SESSIONS или WITHIN_SAME_SESSION . Поддерживается только в том случае, если параметр event_count .

Например, если inAnyNDayPeriod равен 3, eventName — «purchase», параметр события — «event_count», а критерий фильтра больше 5, этот фильтр будет накапливать количество событий покупок за каждые 3 последовательных дня в отчете. диапазон дат; пользователь пройдет критерии этого фильтра для включения в этот сегмент, если количество событий покупки превысит 5 в течение любого трехдневного периода подряд. Например, будут учитываться периоды с 01.11.2021 по 03.11.2021, с 02.11.2021 по 04.11.2021, с 03.11.2021 по 05.11.2021 и т. д.

Диапазон дат не расширяется с целью создания полного окна N дней в начале диапазона дат. Например, если отчет составлен за период с 01.11.2021 по 10.11.2021 и inAnyNDayPeriod = 3, первые два дня будут эффективно сокращены, поскольку никакие данные о событиях за пределами диапазона дат отчета не будут считываться. Например, первые четыре периода фактически будут следующими: с 01.11.2021 по 01.11.2021, с 01.11.2021 по 02.11.2021, с 01.11.2021 по 03.11.2021 и с 2021-02. С 02.11 по 04.11.2021.

inAnyNDayPeriod является необязательным. Если не указано, segmentParameterFilter применяется к каждому событию индивидуально.

Усерсегментсеквенцегруппу

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

JSON-представление 
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
Поля
sequence Scoping

enum ( UserCriteriaScoping )

Все шаги последовательности должны быть удовлетворены в области видимости, чтобы пользователь мог соответствовать последовательности. Например, если sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION , все шаги последовательности должны быть выполнены в течение одного сеанса, чтобы пользователь соответствовал последовательности. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT не поддерживается.

Необязательный. Если не указано, используется conditionScoping = ACROSS_ALL_SESSIONS .

sequence Maximum Duration

string ( Duration format)

Определяет период времени, в течение которого должна произойти вся последовательность; например, 30 минут. sequenceMaximumDuration включает конечную точку с точностью до микросекунды. Например, последовательность с максимальной продолжительностью 5 секунд может быть завершена за 4,9 или 5,0 секунды, но не за 5 секунд и 1 микросекунду.

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

user Sequence Steps[]

object ( UserSequenceStep )

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

Усерсеквенцестеп

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

JSON-представление 
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
is Directly Followed By

boolean

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

step Scoping

enum ( UserCriteriaScoping )

Этот шаг последовательности должен быть выполнен в области видимости, чтобы пользователь мог соответствовать последовательности. Например, если sequenceScoping = WITHIN_SAME_SESSION , шаги этой последовательности должны завершиться в течение одного сеанса, чтобы пользователь соответствовал последовательности. stepScoping = ACROSS_ALL_SESSIONS разрешен только в том случае, если sequenceScoping = ACROSS_ALL_SESSIONS .

Необязательный. Если не указано, stepScoping использует тот же UserCriteriaScoping , что и sequenceScoping .

segment Filter Expression

object ( SegmentFilterExpression )

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

Пользовательское исключение

Указывает, какие пользователи исключены из этого сегмента.

JSON-представление 
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
Поля
user Exclusion Duration

enum ( UserExclusionDuration )

Указывает, как долго будет действовать исключение, если пользователь соответствует userExclusionCriteria .

Необязательный. Если не указано, используется userExclusionDuration из USER_EXCLUSION_TEMPORARY .

user Exclusion Criteria

object ( UserSegmentCriteria )

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

UserExclusionDuration

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

Перечисления
USER_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
USER_EXCLUSION_TEMPORARY Временно исключайте пользователей из сегмента в периоды, когда пользователь соответствует условию userExclusionCriteria .
USER_EXCLUSION_PERMANENT Навсегда исключайте пользователей из сегмента, если пользователь когда-либо соответствует условию userExclusionCriteria .

Сеансегмент

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

JSON-представление 
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
Поля
session Inclusion Criteria

object ( SessionSegmentCriteria )

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

exclusion

object ( SessionSegmentExclusion )

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

Сеансегменткритериа

Сеанс соответствует критерию, если события сеанса соответствуют условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( SessionSegmentConditionGroup )

Сеанс соответствует этому критерию, если сеанс соответствует каждому из этих andConditionGroups .

сессионсегменткондиционионгруппу

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

JSON-представление 
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( SessionCriteriaScoping )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они группе условий. Эта область определяет, на скольких событиях оценивается segmentFilterExpression , прежде чем будет определено, соответствует ли группа условий или нет. Например, еслиconditionScoping conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION , выражение оценивается для всех событий в сеансе, а затем определяется, соответствует ли группа условий этому сеансу. Например, если conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT , выражение оценивается для одного события, а затем определяется, соответствует ли группа условий этому сеансу.

Необязательный. Если не указано, используется conditionScoping WITHIN_SAME_SESSION .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

SessionCriteriaScoping

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

Перечисления
SESSION_CRITERIA_SCOPING_UNSPECIFIED Область применения неуказанных критериев. Не уточняйте.
SESSION_CRITERIA_WITHIN_SAME_EVENT Если критерии удовлетворяются в рамках одного события, сеанс соответствует критериям.
SESSION_CRITERIA_WITHIN_SAME_SESSION Если критерии удовлетворяются в течение одного сеанса, сеанс соответствует критериям.

Сеансегментисключение

Указывает, какие сеансы исключены в этом сегменте.

JSON-представление 
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
Поля
session Exclusion Duration

enum ( SessionExclusionDuration )

Указывает, как долго будет действовать исключение, если сеанс соответствует sessionExclusionCriteria .

Необязательный. Если не указано, используется sessionExclusionDuration SESSION_EXCLUSION_TEMPORARY .

session Exclusion Criteria

object ( SessionSegmentCriteria )

Если сеанс соответствует этому условию, он исключается из членства в сегменте для sessionExclusionDuration .

Сеансексклюзиондюрация

Перечисляет параметры продолжительности исключения, если сеанс соответствует sessionExclusionCriteria .

Перечисления
SESSION_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
SESSION_EXCLUSION_TEMPORARY Временно исключайте сеансы из сегмента в периоды, когда сеанс соответствует условию sessionExclusionCriteria .
SESSION_EXCLUSION_PERMANENT Навсегда исключайте сеансы из сегмента, если сеанс когда-либо соответствует условию sessionExclusionCriteria .

Событийный сегмент

Сегменты событий – это подмножества событий, которые произошли на вашем сайте или в приложении. например, все события покупки, совершенные в определенном месте; события app_Exception, произошедшие в конкретной операционной системе.

JSON-представление 
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
Поля
event Inclusion Criteria

object ( EventSegmentCriteria )

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

exclusion

object ( EventSegmentExclusion )

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

Критерии сегмента событий

Событие соответствует критерию, если оно соответствует условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( EventSegmentConditionGroup )

Событие соответствует этому критерию, если событие соответствует каждому из этих andConditionGroups .

ГруппаСобытийСегментУсловие

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

JSON-представление 
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( EventCriteriaScoping )

conditionScoping всегда должен быть EVENT_CRITERIA_WITHIN_SAME_EVENT .

Необязательный. Если не указано, используется conditionScoping EVENT_CRITERIA_WITHIN_SAME_EVENT .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

EventCriteriaScoping

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

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

Исключение сегмента событий

Указывает, какие события исключены в этом сегменте.

JSON-представление 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
Поля
event Exclusion Duration

enum ( EventExclusionDuration )

eventExclusionDuration всегда должно быть PERMANENTLY_EXCLUDE .

Необязательный. Если не указано, используется eventExclusionDuration равный EVENT_EXCLUSION_PERMANENT .

event Exclusion Criteria

object ( EventSegmentCriteria )

Если событие соответствует этому условию, оно исключается из членства в сегменте eventExclusionDuration .

EventExclusionDuration

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

Перечисления
EVENT_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
EVENT_EXCLUSION_PERMANENT Навсегда исключайте события из сегмента, если событие когда-либо соответствует условию eventExclusionCriteria .

SubReport воронки

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

JSON-представление 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
Поля
dimension Headers[]

object ( DimensionHeader )

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

metric Headers[]

object ( MetricHeader )

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

rows[]

object ( Row )

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

metadata

object ( FunnelResponseMetadata )

Метаданные для отчета о воронке.

Метаданные FunnelResponseMetadata

Метаданные ответа отчета о воронке содержат дополнительную информацию об отчете о воронке.

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

object ( SamplingMetadata )

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

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

,

Возвращает настроенный отчет по воронке данных о ваших событиях Google Analytics. Данные, возвращаемые из API, представляют собой таблицу со столбцами для запрошенных параметров и показателей.

Исследование воронки позволяет визуализировать шаги, которые ваши пользователи предпринимают для выполнения задачи, и быстро увидеть, насколько хорошо они добиваются успеха или терпят неудачу на каждом этапе. Например, как потенциальные клиенты становятся покупателями, а затем покупателями? Как разовые покупатели становятся постоянными? С помощью этой информации вы можете улучшить неэффективные или заброшенные пути взаимодействия с клиентами. Дополнительную информацию см. в разделе Исследование последовательностей GA4 .

Этот метод представлен на стадии альфа-версии с целью сбора отзывов о синтаксисе и возможностях перед входом в бета-версию. Чтобы оставить отзыв об этом API, заполните форму «Отзыв об отчетах по воронке API данных Google Analytics» .

HTTP-запрос

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

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

Параметры пути

Параметры
property

string

Необязательный. Идентификатор ресурса Google Analytics, события которого отслеживаются. Указывается в URL-пути, а не в теле. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта . В пакетном запросе это свойство должно быть либо неопределенным, либо соответствовать свойству уровня пакета.

Пример: свойства/1234

Тело запроса

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

JSON-представление 
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
Поля
date Ranges[]

object ( DateRange )

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

funnel

object ( Funnel )

Необязательный. Конфигурация воронки этого запроса. Эта конфигурация воронки является обязательной.

funnel Breakdown

object ( FunnelBreakdown )

Необязательный. Если указано, эта разбивка добавляет измерение к ответу подотчета таблицы воронки. Это измерение разбивки расширяет каждый шаг воронки до уникальных значений измерения разбивки. Например, при разбивке по измерению deviceCategory будут созданы строки для mobile , tablet , desktop и итоговых значений.

funnel Next Action

object ( FunnelNextAction )

Необязательный. Если указано, следующее действие добавляет измерение в ответ подотчета визуализации воронки. Это измерение следующего действия расширяет каждый шаг воронки до уникальных значений следующего действия. Например, следующее действие измерения eventName создаст строки для нескольких событий (например, session_start & click ) и итогового значения.

Следующее действие поддерживает только eventName и большинство размеров страницы/экрана, например pageTitle и pagePath .

funnel Visualization Type

enum ( FunnelVisualizationType )

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

segments[]

object ( Segment )

Необязательный. Конфигурации сегментов. Сегменты — это подмножества данных свойства. В отчете по воронке с сегментами последовательность оценивается в каждом сегменте.

Каждый сегмент, указанный в этом запросе, создает в ответе отдельную строку; в ответе каждый сегмент идентифицируется своим именем.

Параметр сегментов является необязательным. Запросы ограничены 4 сегментами.

limit

string ( int64 format)

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

API также может возвращать меньше строк, чем запрошенное limit , если значений измерения не так много, как limit .

dimension Filter

object ( FilterExpression )

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

return Property Quota

boolean

Необязательный. Переключает, возвращать ли текущее состояние квоты этого ресурса Analytics. Квота возвращается в PropertyQuota .

Тело ответа

Ответ на отчет о воронке содержит два подотчета. Два подотчета представляют собой разные комбинации параметров и показателей.

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

JSON-представление 
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Поля
funnel Table

object ( FunnelSubReport )

Таблица воронки — это отчет с указанием шага воронки, сегмента, параметра разбивки, активных пользователей, степени завершения, количества отказов и количества отказов.

Измерение сегмента присутствует в этом ответе только в том случае, если сегмент был запрошен. Измерение разбивки присутствует в этом ответе только в том случае, если оно было запрошено.

funnel Visualization

object ( FunnelSubReport )

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

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

property Quota

object ( PropertyQuota )

Состояние квоты этого ресурса Google Аналитики, включая этот запрос.

kind

string

Определяет, к какому типу ресурса относится это сообщение. Этот kind всегда представляет собой фиксированную строку «analyticsData#runFunnelReport». Полезно различать типы ответов в JSON.

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

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

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

Воронка

Настраивает воронку в запросе отчета о воронке. Воронка сообщает о пользователях, когда они проходят последовательность шагов.

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

JSON-представление 
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
Поля
is Open Funnel

boolean

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

steps[]

object ( FunnelStep )

Последовательные шаги этой воронки.

Шаг воронки

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

JSON-представление 
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
Поля
name

string

Отличительное имя для этого шага. Если не указано, шаги будут именоваться индексированным именем, начинающимся с 1 (например, «0.», «1.» и т. д.). Это имя определяет строковое значение, возвращаемое измерением funnelStepName . Например, если указать name = Purchase на третьем этапе воронки запроса, в ответе отчета по воронке будет указано 3. Purchase .

is Directly Followed By

boolean

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

filter Expression

object ( FunnelFilterExpression )

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

within Duration From Prior Step

string ( Duration format)

Если указано, этот шаг должен завершиться в пределах продолжительности завершения предыдущего шага. withinDurationFromPriorStep включает конечную точку с точностью до микросекунды. Например, длительность в 5 секунд можно завершить за 4,9 или 5,0 секунды, но не за 5 секунд и 1 микросекунду.

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

Выражение Фильтра Воронки

Выражает комбинации фильтров-воронок.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для FunnelFilterExpression . expr может быть только одним из следующих:
and Group

object ( FunnelFilterExpressionList )

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

or Group

object ( FunnelFilterExpressionList )

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

not Expression

object ( FunnelFilterExpression )

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

funnel Field Filter

object ( FunnelFieldFilter )

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

funnel Event Filter

object ( FunnelEventFilter )

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

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

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

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

object ( FunnelFilterExpression )

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

ВоронкаПолеФильтр

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

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

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Поля
field Name

string

Имя измерения или имя метрики.

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

Фильтр событий воронки

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

JSON-представление 
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
Поля
event Name

string

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

funnel Parameter Filter Expression

object ( FunnelParameterFilterExpression )

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

Внутри выражения фильтра параметров доступны только фильтры параметров.

ВоронкаПараметрФильтрВыражение

Выражает комбинации фильтров воронки по параметрам.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для FunnelParameterFilterExpression . expr может быть только одним из следующих:
and Group

object ( FunnelParameterFilterExpressionList )

Выражение FunnelParameterFilterExpression в andGroup имеет отношение И.

or Group

object ( FunnelParameterFilterExpressionList )

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

not Expression

object ( FunnelParameterFilterExpression )

FunnelParameterFilterExpression НЕ имеет значения notExpression .

funnel Parameter Filter

object ( FunnelParameterFilter )

Примитивный фильтр параметров воронки.

ВоронкаПараметрФильтрВыражениеСписок

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

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

object ( FunnelParameterFilterExpression )

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

ВоронкаПараметрФильтр

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

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

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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.
}
Поля
Поле объединения one_parameter . Поле, которое фильтруется. one_parameter может быть только одним из следующих:
event Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру события. Параметры события регистрируются как параметры события. Параметры события включают такие поля, как «firebase_screen» и «валюта».

Параметры событий можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

item Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру элемента. Параметры элемента регистрируются как параметры в массиве элементов. Параметры элемента включают такие поля, как «item_name» и «item_category».

Параметры элемента можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

Параметры товара доступны только в событиях электронной торговли. Дополнительную информацию о мероприятиях электронной торговли см. в руководстве «Измерение электронной торговли» .

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

Разбивка по воронке

Разбивки добавляют измерение в ответ подотчета таблицы воронки.

JSON-представление 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
Поля
breakdown Dimension

object ( Dimension )

Столбец измерения добавлен в ответ подотчета таблицы последовательностей. Измерение разбивки разбивает каждый шаг воронки. Если указан funnelBreakdown требуется допустимое значение breakdownDimension .

limit

string ( int64 format)

Максимальное количество различных значений измерения разбивки, возвращаемых в ответе. Если предел не указан, используется limit в 5 . Предел должен превышать ноль и не может превышать 15.

ВоронкаСледующееДействие

Следующие действия определяют значение измерения после того, как пользователь выполнил шаг, но до того, как тот же пользователь выполнил следующий шаг. Например, если nextActionDimension имеет eventName , то nextActionDimension в строке i го шага воронки вернет первое событие после события, которое квалифицировало пользователя на i -й шаг воронки, но до того, как пользователь достиг i+1 -го шага воронки.

JSON-представление 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
Поля
next Action Dimension

object ( Dimension )

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

nextActionDimension в настоящее время поддерживает только eventName и большинство размеров страницы/экрана, таких как pageTitle и pagePath . nextActionDimension не может быть выражением измерения.

limit

string ( int64 format)

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

Тип визуализации воронки

Управляет размерами, присутствующими в ответе подотчета визуализации воронки.

Перечисления
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED Неопределенный тип.
STANDARD_FUNNEL Стандартная (ступенчатая) воронка. Подотчет о визуализации воронки в ответе не будет содержать дату.
TRENDED_FUNNEL Воронка с трендом (линейный график). Подотчет по визуализации воронки в ответе будет содержать измерение даты.

Сегмент

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

Дополнительную информацию см. в разделе Построитель сегментов .

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

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
Поля
name

string

Имя этого сегмента. Если не указано, сегменты называются «Сегмент». Это имя определяет строковое значение, возвращаемое измерением segment . Измерение segment добавляет к имени сегмента префикс, начиная с 1, индексный номер сегмента в запросе (например, «1. Сегмент», «2. Сегмент» и т. д.).

Поле объединения one_segment_scope . Сегмент указан в одной области. one_segment_scope может быть только одним из следующих:
user Segment

object ( UserSegment )

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

session Segment

object ( SessionSegment )

Сегменты сеансов – это подмножества сеансов, произошедших на вашем сайте или в приложении.

event Segment

object ( EventSegment )

Сегменты событий – это подмножества событий, которые произошли на вашем сайте или в приложении.

Пользовательский сегмент

Сегменты пользователей — это подгруппы пользователей, которые взаимодействовали с вашим сайтом или приложением. Например, пользователи, которые ранее совершали покупки; пользователи, которые добавили товары в свои корзины, но не совершили покупку.

JSON-представление 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
Поля
user Inclusion Criteria

object ( UserSegmentCriteria )

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

exclusion

object ( UserSegmentExclusion )

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

Усерсегменткритериа

Пользователь соответствует критерию, если события пользователя соответствуют условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( UserSegmentConditionGroup )

Пользователь соответствует этому критерию, если он соответствует каждому из этих andConditionGroups и каждому из andSequenceGroups . andConditionGroups может быть пустым, если указаны andSequenceGroups .

and Sequence Groups[]

object ( UserSegmentSequenceGroup )

Пользователь соответствует этому критерию, если он соответствует каждому из этих andSequenceGroups и каждому из andConditionGroups . andSequenceGroups может быть пустым, если указаны andConditionGroups .

Усерсегменткондиционионгруппу

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

JSON-представление 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( UserCriteriaScoping )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они группе условий. Эта область определяет, на скольких событиях оценивается segmentFilterExpression , прежде чем будет определено, соответствует ли группа условий или нет. Например, еслиconditionScoping conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION , выражение оценивается для всех событий в сеансе, а затем определяется, соответствует ли группа условий этому пользователю. Например, если conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT , выражение оценивается по одному событию, а затем определяется, соответствует ли группа условий этому пользователю.

Необязательный. Если не указано, используется conditionScoping = ACROSS_ALL_SESSIONS .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

Пользовательские критерииОбзор

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

Перечисления
USER_CRITERIA_SCOPING_UNSPECIFIED Область применения неуказанных критериев. Не уточняйте.
USER_CRITERIA_WITHIN_SAME_EVENT Если критерии удовлетворяются в рамках одного события, пользователь соответствует критериям.
USER_CRITERIA_WITHIN_SAME_SESSION Если критерии удовлетворены в течение одного сеанса, пользователь соответствует критериям.
USER_CRITERIA_ACROSS_ALL_SESSIONS Если критериям удовлетворяют какие-либо события для пользователя, пользователь соответствует критериям.

Выражение сегментного фильтра

Выражает комбинации сегментных фильтров.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для SegmentFilterExpression . expr может быть только одним из следующих:
and Group

object ( SegmentFilterExpressionList )

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

or Group

object ( SegmentFilterExpressionList )

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

not Expression

object ( SegmentFilterExpression )

SegmentFilterExpression НЕ имеет notExpression .

segment Filter

object ( SegmentFilter )

Примитивный сегментный фильтр.

segment Event Filter

object ( SegmentEventFilter )

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

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

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

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

object ( SegmentFilterExpression )

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

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

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

JSON-представление 
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // 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.
}
Поля
field Name

string

Имя измерения или имя метрики.

filter Scoping

object ( SegmentFilterScoping )

Указывает область действия фильтра.

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

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

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

JSON-представление 
{
  "atAnyPointInTime": boolean
}
Поля
at Any Point In Time

boolean

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

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

Этот atAnyPointInTime можно указать только в том случае, если область действия критерия равна ACROSS_ALL_SESSIONS и его нельзя указать в последовательностях.

Если областью критериев является ACROSS_ALL_SESSIONS , atAnyPointInTime = false используется, если не указано.

Фильтр событий сегмента

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

JSON-представление 
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
Поля
event Name

string

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

segment Parameter Filter Expression

object ( SegmentParameterFilterExpression )

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

Внутри выражения фильтра параметров доступны только фильтры параметров.

СегментПараметрФильтрВыражение

Выражает комбинации сегментного фильтра по параметрам.

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

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип фильтра для SegmentParameterFilterExpression . expr может быть только одним из следующих:
and Group

object ( SegmentParameterFilterExpressionList )

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

or Group

object ( SegmentParameterFilterExpressionList )

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

not Expression

object ( SegmentParameterFilterExpression )

SegmentParameterFilterExpression НЕ имеет значения notExpression .

segment Parameter Filter

object ( SegmentParameterFilter )

Примитивный фильтр параметров сегмента.

СегментПараметрФильтрВыражениеСписок

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

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

object ( SegmentParameterFilterExpression )

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

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

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

JSON-представление 
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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.
}
Поля
filter Scoping

object ( SegmentParameterFilterScoping )

Указывает область действия фильтра.

Поле объединения one_parameter . Поле, которое фильтруется. one_parameter может быть только одним из следующих:
event Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру события. Параметры события регистрируются как параметры события. Параметры события включают такие поля, как «firebase_screen» и «валюта».

Параметры событий можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

item Parameter Name

string

Этот фильтр будет оцениваться по указанному параметру элемента. Параметры элемента регистрируются как параметры в массиве элементов. Параметры элемента включают такие поля, как «item_name» и «item_category».

Параметры элемента можно использовать только в сегментах и ​​последовательностях и только в фильтре-потомке EventFilter. В фильтре-потомке EventFilter следует использовать параметры события или элемента.

Параметры товара доступны только в событиях электронной торговли. Дополнительную информацию о мероприятиях электронной торговли см. в руководстве «Измерение электронной торговли» .

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

object ( StringFilter )

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

in List Filter

object ( InListFilter )

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

numeric Filter

object ( NumericFilter )

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

between Filter

object ( BetweenFilter )

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

СегментПараметрФильтрОбзор

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

JSON-представление 
{
  "inAnyNDayPeriod": string
}
Поля
in Any N Day Period

string ( int64 format)

Накапливает параметр за указанный период дней перед применением фильтра. Поддерживается только в том случае, если область действия критериев равна ACROSS_ALL_SESSIONS или WITHIN_SAME_SESSION . Поддерживается только в том случае, если параметр event_count .

Например, если inAnyNDayPeriod равен 3, eventName — «purchase», параметр события — «event_count», а критерий фильтра больше 5, этот фильтр будет накапливать количество событий покупок за каждые 3 последовательных дня в отчете. диапазон дат; пользователь пройдет критерии этого фильтра для включения в этот сегмент, если количество событий покупки превысит 5 в течение любого трехдневного периода подряд. Например, будут учитываться периоды с 01.11.2021 по 03.11.2021, с 02.11.2021 по 04.11.2021, с 03.11.2021 по 05.11.2021 и т. д.

Диапазон дат не расширяется с целью создания полного окна N дней в начале диапазона дат. Например, если отчет составлен за период с 01.11.2021 по 10.11.2021 и inAnyNDayPeriod = 3, первые два дня будут эффективно сокращены, поскольку никакие данные о событиях за пределами диапазона дат отчета не будут считываться. Например, первые четыре периода фактически будут следующими: с 01.11.2021 по 01.11.2021, с 01.11.2021 по 02.11.2021, с 01.11.2021 по 03.11.2021 и с 2021-02. С 02.11 по 04.11.2021.

inAnyNDayPeriod является необязательным. Если не указано, segmentParameterFilter применяется к каждому событию индивидуально.

Усерсегментсеквенцегруппу

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

JSON-представление 
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
Поля
sequence Scoping

enum ( UserCriteriaScoping )

Все шаги последовательности должны быть удовлетворены в области видимости, чтобы пользователь мог соответствовать последовательности. Например, если sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION , все шаги последовательности должны быть выполнены в течение одного сеанса, чтобы пользователь соответствовал последовательности. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT не поддерживается.

Необязательный. Если не указано, используется conditionScoping = ACROSS_ALL_SESSIONS .

sequence Maximum Duration

string ( Duration format)

Определяет период времени, в течение которого должна произойти вся последовательность; например, 30 минут. sequenceMaximumDuration включает конечную точку с точностью до микросекунды. Например, последовательность с максимальной продолжительностью 5 секунд может быть завершена за 4,9 или 5,0 секунды, но не за 5 секунд и 1 микросекунду.

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

user Sequence Steps[]

object ( UserSequenceStep )

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

Усерсеквенцестеп

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

JSON-представление 
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
is Directly Followed By

boolean

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

step Scoping

enum ( UserCriteriaScoping )

Этот шаг последовательности должен быть выполнен в области видимости, чтобы пользователь мог соответствовать последовательности. Например, если sequenceScoping = WITHIN_SAME_SESSION , шаги этой последовательности должны завершиться в течение одного сеанса, чтобы пользователь соответствовал последовательности. stepScoping = ACROSS_ALL_SESSIONS разрешен только в том случае, если sequenceScoping = ACROSS_ALL_SESSIONS .

Необязательный. Если не указано, stepScoping использует тот же UserCriteriaScoping , что и sequenceScoping .

segment Filter Expression

object ( SegmentFilterExpression )

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

Пользовательское исключение

Указывает, какие пользователи исключены из этого сегмента.

JSON-представление 
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
Поля
user Exclusion Duration

enum ( UserExclusionDuration )

Указывает, как долго будет действовать исключение, если пользователь соответствует userExclusionCriteria .

Необязательный. Если не указано, используется userExclusionDuration из USER_EXCLUSION_TEMPORARY .

user Exclusion Criteria

object ( UserSegmentCriteria )

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

UserExclusionDuration

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

Перечисления
USER_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
USER_EXCLUSION_TEMPORARY Временно исключайте пользователей из сегмента в периоды, когда пользователь соответствует условию userExclusionCriteria .
USER_EXCLUSION_PERMANENT Навсегда исключайте пользователей из сегмента, если пользователь когда-либо соответствует условию userExclusionCriteria .

Сеансегмент

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

JSON-представление 
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
Поля
session Inclusion Criteria

object ( SessionSegmentCriteria )

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

exclusion

object ( SessionSegmentExclusion )

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

Сеансегменткритериа

Сеанс соответствует критерию, если события сеанса соответствуют условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( SessionSegmentConditionGroup )

Сеанс соответствует этому критерию, если сеанс соответствует каждому из этих andConditionGroups .

сессионсегменткондиционионгруппу

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

JSON-представление 
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( SessionCriteriaScoping )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они группе условий. Эта область определяет, на скольких событиях оценивается segmentFilterExpression , прежде чем будет определено, соответствует ли группа условий или нет. Например, еслиconditionScoping conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION , выражение оценивается для всех событий в сеансе, а затем определяется, соответствует ли группа условий этому сеансу. Например, если conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT , выражение оценивается для одного события, а затем определяется, соответствует ли группа условий этому сеансу.

Необязательный. Если не указано, используется conditionScoping WITHIN_SAME_SESSION .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

SessionCriteriaScoping

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

Перечисления
SESSION_CRITERIA_SCOPING_UNSPECIFIED Область применения неуказанных критериев. Не уточняйте.
SESSION_CRITERIA_WITHIN_SAME_EVENT Если критерии удовлетворяются в рамках одного события, сеанс соответствует критериям.
SESSION_CRITERIA_WITHIN_SAME_SESSION Если критерии удовлетворяются в течение одного сеанса, сеанс соответствует критериям.

Сеансегментисключение

Указывает, какие сеансы исключены в этом сегменте.

JSON-представление 
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
Поля
session Exclusion Duration

enum ( SessionExclusionDuration )

Указывает, как долго будет действовать исключение, если сеанс соответствует sessionExclusionCriteria .

Необязательный. Если не указано, используется sessionExclusionDuration SESSION_EXCLUSION_TEMPORARY .

session Exclusion Criteria

object ( SessionSegmentCriteria )

Если сеанс соответствует этому условию, он исключается из членства в сегменте для sessionExclusionDuration .

Сеансексклюзиондюрация

Перечисляет параметры продолжительности исключения, если сеанс соответствует sessionExclusionCriteria .

Перечисления
SESSION_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
SESSION_EXCLUSION_TEMPORARY Временно исключайте сеансы из сегмента в периоды, когда сеанс соответствует условию sessionExclusionCriteria .
SESSION_EXCLUSION_PERMANENT Навсегда исключайте сеансы из сегмента, если сеанс когда-либо соответствует условию sessionExclusionCriteria .

Событийный сегмент

Сегменты событий – это подмножества событий, которые произошли на вашем сайте или в приложении. например, все события покупки, совершенные в определенном месте; события app_Exception, произошедшие в конкретной операционной системе.

JSON-представление 
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
Поля
event Inclusion Criteria

object ( EventSegmentCriteria )

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

exclusion

object ( EventSegmentExclusion )

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

Критерии сегмента событий

Событие соответствует критерию, если оно соответствует условиям критериев.

JSON-представление 
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
Поля
and Condition Groups[]

object ( EventSegmentConditionGroup )

Событие соответствует этому критерию, если событие соответствует каждому из этих andConditionGroups .

ГруппаСобытийСегментУсловие

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

JSON-представление 
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
condition Scoping

enum ( EventCriteriaScoping )

conditionScoping всегда должен быть EVENT_CRITERIA_WITHIN_SAME_EVENT .

Необязательный. Если не указано, используется conditionScoping EVENT_CRITERIA_WITHIN_SAME_EVENT .

segment Filter Expression

object ( SegmentFilterExpression )

Данные включаются или исключаются из сегмента в зависимости от того, соответствуют ли они этому выражению. Выражения выражают критерии измерения, показателей и/или параметров.

EventCriteriaScoping

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

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

Исключение сегмента событий

Указывает, какие события исключены в этом сегменте.

JSON-представление 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
Поля
event Exclusion Duration

enum ( EventExclusionDuration )

eventExclusionDuration всегда должно быть PERMANENTLY_EXCLUDE .

Необязательный. Если не указано, используется eventExclusionDuration равный EVENT_EXCLUSION_PERMANENT .

event Exclusion Criteria

object ( EventSegmentCriteria )

Если событие соответствует этому условию, оно исключается из членства в сегменте eventExclusionDuration .

EventExclusionDuration

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

Перечисления
EVENT_EXCLUSION_DURATION_UNSPECIFIED Неуказанный срок исключения. Не уточняйте.
EVENT_EXCLUSION_PERMANENT Навсегда исключайте события из сегмента, если событие когда-либо соответствует условию eventExclusionCriteria .

SubReport воронки

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

JSON-представление 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
Поля
dimension Headers[]

object ( DimensionHeader )

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

metric Headers[]

object ( MetricHeader )

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

rows[]

object ( Row )

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

metadata

object ( FunnelResponseMetadata )

Метаданные для отчета о воронке.

Метаданные FunnelResponseMetadata

Метаданные ответа отчета о воронке содержат дополнительную информацию об отчете о воронке.

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

object ( SamplingMetadata )

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

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