Method: properties.runFunnelReport

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

Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abandoned customer journeys. To learn more, see GA4 Funnel Explorations .

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

HTTP-запрос

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

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

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

Параметры
property

string

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

Example: properties/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
}
Поля
dateRanges[]

object ( DateRange )

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

funnel

object ( Funnel )

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

funnelBreakdown

object ( FunnelBreakdown )

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

funnelNextAction

object ( FunnelNextAction )

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

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

funnelVisualizationType

enum ( FunnelVisualizationType )

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

segments[]

object ( Segment )

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

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

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

limit

string ( int64 format)

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

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

dimensionFilter

object ( FilterExpression )

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

returnPropertyQuota

boolean

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

Ответный текст

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

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

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

object ( FunnelSubReport )

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

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

funnelVisualization

object ( FunnelSubReport )

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

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

propertyQuota

object ( PropertyQuota )

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

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)
    }
  ]
}
Поля
isOpenFunnel

boolean

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

steps[]

object ( FunnelStep )

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

FunnelStep

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

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

string

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

isDirectlyFollowedBy

boolean

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

filterExpression

object ( FunnelFilterExpression )

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

withinDurationFromPriorStep

string ( Duration format)

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

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

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

FunnelFilterExpression

Expresses combinations of funnel filters.

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

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

object ( FunnelFilterExpressionList )

Объект FunnelFilterExpression в andGroup имеет отношение И.

orGroup

object ( FunnelFilterExpressionList )

Объект FunnelFilterExpression в orGroup имеет отношение ИЛИ.

notExpression

object ( FunnelFilterExpression )

Объект FunnelFilterExpression НЕ является объектом notExpression .

funnelFieldFilter

object ( FunnelFieldFilter )

A funnel filter for a dimension or metric.

funnelEventFilter

object ( FunnelEventFilter )

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

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

FunnelFilterExpressionList

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

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

object ( FunnelFilterExpression )

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

FunnelFieldFilter

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

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

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

string

Название измерения или название метрики.

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

object ( StringFilter )

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

inListFilter

object ( InListFilter )

A filter for in list values.

numericFilter

object ( NumericFilter )

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

betweenFilter

object ( BetweenFilter )

Фильтр для выбора значения между двумя исходными значениями.

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

FunnelEventFilter

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

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

string

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

funnelParameterFilterExpression

object ( FunnelParameterFilterExpression )

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

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

FunnelParameterFilterExpression

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

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

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

object ( FunnelParameterFilterExpressionList )

В свойствах FunnelParameterFilterExpression в andGroup используется логическое И.

orGroup

object ( FunnelParameterFilterExpressionList )

Объект FunnelParameterFilterExpression в orGroup имеет связь типа ИЛИ.

notExpression

object ( FunnelParameterFilterExpression )

Параметр FunnelParameterFilterExpression не имеет свойства notExpression .

funnelParameterFilter

object ( FunnelParameterFilter )

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

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

FunnelParameterFilterExpressionList

A list of funnel parameter filter expressions.

JSON representation 
{
  "expressions": [
    {
      object (FunnelParameterFilterExpression)
    }
  ]
}
Поля
expressions[]

object ( FunnelParameterFilterExpression )

The list of funnel parameter filter expressions.

FunnelParameterFilter

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

JSON representation 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "eventParameterName": string,
  "itemParameterName": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of mutually exclusive fields.
}
Поля
Поле, которое фильтруется. Ниже приведен список взаимоисключающих полей. В ответе будет установлено значение не более чем для одного из полей:
eventParameterName

string

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

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

itemParameterName

string

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

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

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

End of mutually exclusive fields.
Укажите один тип фильтра. Ниже приведен список взаимоисключающих полей. В ответе будет установлено не более одного из полей:
stringFilter

object ( StringFilter )

Strings related filter.

inListFilter

object ( InListFilter )

A filter for in list values.

numericFilter

object ( NumericFilter )

A filter for numeric or date values.

betweenFilter

object ( BetweenFilter )

A filter for between two values.

End of mutually exclusive fields.

FunnelBreakdown

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

JSON representation 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
Поля
breakdownDimension

object ( Dimension )

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

limit

string ( int64 format)

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

FunnelNextAction

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

JSON representation 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
Поля
nextActionDimension

object ( Dimension )

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

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

limit

string ( int64 format)

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

FunnelVisualizationType

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

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

Сегмент

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

Для получения более подробной информации см. раздел «Конструктор сегментов» .

JSON representation 
{
  "name": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of mutually exclusive fields.
}
Поля
name

string

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

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

object ( UserSegment )

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

sessionSegment

object ( SessionSegment )

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

eventSegment

object ( EventSegment )

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

End of mutually exclusive fields.

UserSegment

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

JSON representation 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
Поля
userInclusionCriteria

object ( UserSegmentCriteria )

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

exclusion

object ( UserSegmentExclusion )

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

UserSegmentCriteria

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

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

object ( UserSegmentConditionGroup )

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

andSequenceGroups[]

object ( UserSegmentSequenceGroup )

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

UserSegmentConditionGroup

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

JSON representation 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Поля
conditionScoping

enum ( UserCriteriaScoping )

Data is included or excluded from the segment based on if it matches the condition group. This scoping defines how many events the segmentFilterExpression is evaluated on before the condition group is determined to be matched or not. For example if conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION , the expression is evaluated on all events in a session, and then, the condition group is determined to be matched or not for this user. For example if conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT , the expression is evaluated on a single event, and then, the condition group is determined to be matched or not for this user.

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

segmentFilterExpression

object ( SegmentFilterExpression )

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

UserCriteriaScoping

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

Перечисления
USER_CRITERIA_SCOPING_UNSPECIFIED Unspecified criteria scoping. Do not specify.
USER_CRITERIA_WITHIN_SAME_EVENT Если критерий выполняется в рамках одного события, пользователь соответствует критериям.
USER_CRITERIA_WITHIN_SAME_SESSION Если критерий выполняется в течение одной сессии, пользователь соответствует критериям.
USER_CRITERIA_ACROSS_ALL_SESSIONS Если хотя бы одному из событий, произошедших с пользователем, удовлетворяется критерий, значит, пользователь соответствует критериям.

SegmentFilterExpression

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

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

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

object ( SegmentFilterExpressionList )

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

orGroup

object ( SegmentFilterExpressionList )

Объект SegmentFilterExpression в orGroup имеет связь типа ИЛИ.

notExpression

object ( SegmentFilterExpression )

Объект SegmentFilterExpression не является объектом notExpression .

segmentFilter

object ( SegmentFilter )

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

segmentEventFilter

object ( SegmentEventFilter )

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

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

SegmentFilterExpressionList

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

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

object ( SegmentFilterExpression )

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

SegmentFilter

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

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

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

string

Название измерения или название метрики.

filterScoping

object ( SegmentFilterScoping )

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

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

object ( StringFilter )

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

inListFilter

object ( InListFilter )

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

numericFilter

object ( NumericFilter )

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

betweenFilter

object ( BetweenFilter )

Фильтр для выбора значения между двумя исходными значениями.

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

SegmentFilterScoping

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

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

boolean

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

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

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

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

SegmentEventFilter

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

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

string

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

segmentParameterFilterExpression

object ( SegmentParameterFilterExpression )

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

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

SegmentParameterFilterExpression

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

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

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

object ( SegmentParameterFilterExpressionList )

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

orGroup

object ( SegmentParameterFilterExpressionList )

Объект SegmentParameterFilterExpression в orGroup имеет связь типа ИЛИ.

notExpression

object ( SegmentParameterFilterExpression )

Параметр SegmentParameterFilterExpression не является выражением notExpression .

segmentParameterFilter

object ( SegmentParameterFilter )

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

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

SegmentParameterFilterExpressionList

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

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

object ( SegmentParameterFilterExpression )

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

SegmentParameterFilter

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "eventParameterName": string,
  "itemParameterName": string
  // End of mutually exclusive fields.

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

object ( SegmentParameterFilterScoping )

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

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

string

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

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

itemParameterName

string

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

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

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

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

object ( StringFilter )

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

inListFilter

object ( InListFilter )

A filter for in list values.

numericFilter

object ( NumericFilter )

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

betweenFilter

object ( BetweenFilter )

Фильтр для выбора значения между двумя исходными значениями.

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

SegmentParameterFilterScoping

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

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

string ( int64 format)

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

For example if inAnyNDayPeriod is 3, the eventName is "purchase", the event parameter is "event_count", and the Filter's criteria is greater than 5, this filter will accumulate the event count of purchase events over every 3 consecutive day period in the report's date range; a user will pass this Filter's criteria to be included in this segment if their count of purchase events exceeds 5 in any 3 consecutive day period. For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.

The date range is not extended for the purpose of having a full N day window near the start of the date range. For example if a report is for 2021-11-01 to 2021-11-10 and inAnyNDayPeriod = 3, the first two day period will be effectively shortened because no event data outside the report's date range will be read. For example, the first four periods will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02, 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.

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

UserSegmentSequenceGroup

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

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

enum ( UserCriteriaScoping )

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

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

sequenceMaximumDuration

string ( Duration format)

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

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

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

userSequenceSteps[]

object ( UserSequenceStep )

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

UserSequenceStep

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

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

boolean

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

stepScoping

enum ( UserCriteriaScoping )

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

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

segmentFilterExpression

object ( SegmentFilterExpression )

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

Исключение сегмента пользователя

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

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

enum ( UserExclusionDuration )

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

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

userExclusionCriteria

object ( UserSegmentCriteria )

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

UserExclusionDuration

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

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

SessionSegment

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

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

object ( SessionSegmentCriteria )

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

exclusion

object ( SessionSegmentExclusion )

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

Критерии сегмента сессии

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

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

object ( SessionSegmentConditionGroup )

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

SessionSegmentConditionGroup

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

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

enum ( SessionCriteriaScoping )

Data is included or excluded from the segment based on if it matches the condition group. This scoping defines how many events the segmentFilterExpression is evaluated on before the condition group is determined to be matched or not. For example if conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION , the expression is evaluated on all events in a session, and then, the condition group is determined to be matched or not for this session. For example if conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT , the expression is evaluated on a single event, and then, the condition group is determined to be matched or not for this session.

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

segmentFilterExpression

object ( SegmentFilterExpression )

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

SessionCriteriaScoping

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

Перечисления
SESSION_CRITERIA_SCOPING_UNSPECIFIED Unspecified criteria scoping. Do not specify.
SESSION_CRITERIA_WITHIN_SAME_EVENT Если критерий выполняется в рамках одного события, то сессия соответствует критериям.
SESSION_CRITERIA_WITHIN_SAME_SESSION Если критерий выполняется в течение одной сессии, значит, сессия соответствует критериям.

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

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

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

enum ( SessionExclusionDuration )

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

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

sessionExclusionCriteria

object ( SessionSegmentCriteria )

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

SessionExclusionDuration

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

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

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

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

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

object ( EventSegmentCriteria )

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

exclusion

object ( EventSegmentExclusion )

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

EventSegmentCriteria

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

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

object ( EventSegmentConditionGroup )

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

EventSegmentConditionGroup

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

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

enum ( EventCriteriaScoping )

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

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

segmentFilterExpression

object ( SegmentFilterExpression )

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

EventCriteriaScoping

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

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

EventSegmentExclusion

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

JSON representation 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
Поля
eventExclusionDuration

enum ( EventExclusionDuration )

eventExclusionDuration should always be PERMANENTLY_EXCLUDE .

Optional. If unspecified, an eventExclusionDuration of EVENT_EXCLUSION_PERMANENT is used.

eventExclusionCriteria

object ( EventSegmentCriteria )

If an event meets this condition, the event is excluded from membership in the segment for the eventExclusionDuration .

EventExclusionDuration

Enumerates options for how long an exclusion will last if an event matches the eventExclusionCriteria .

Перечисления
EVENT_EXCLUSION_DURATION_UNSPECIFIED Unspecified exclusion duration. Do not specify.
EVENT_EXCLUSION_PERMANENT Permanently exclude events from the segment if the event ever meets the eventExclusionCriteria condition.

FunnelSubReport

Funnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel.

JSON representation 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
Поля
dimensionHeaders[]

object ( DimensionHeader )

Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.

metricHeaders[]

object ( MetricHeader )

Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.

rows[]

object ( Row )

Rows of dimension value combinations and metric values in the report.

metadata

object ( FunnelResponseMetadata )

Metadata for the funnel report.

FunnelResponseMetadata

The funnel report's response metadata carries additional information about the funnel report.

JSON representation 
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
Поля
samplingMetadatas[]

object ( SamplingMetadata )

If funnel report results are sampled , this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.