Параметризация
API отчетов поддерживает параметризацию группировок и метрик.
Параметризация — это механизм задания параметров для некоторых группировок и метрик.
Параметры указываются в угловых скобках <>
. Например:
- Чтобы сгруппировать визиты по времени, группировка
ym:s:datePeriod<group>
параметризовано параметромgroup
(группировка). - Чтобы получить количество целевых визитов, метрика
ym:s:visits
параметризована следующим образом:ym:s:goal<goal_id>visits
.
Существуют следующие параметры:
Параметр | Название | Описание | Значение по умолчанию |
---|---|---|---|
goal_id | Цель | Идентификатор цели. | |
group | Группировка | Группировка по времени для некоторых группировок. Возможные значения: | week |
attribution | Модель атрибуции | Некоторые группировки позволяют задать модель атрибуции. Возможные значения:
Также доступны значения, определяющие кросс-девайс атрибуцию:
| lastsign |
currency | Валюта | Некоторые группировки позволяют настраивать валюту. Возможные значения: | Зависит от настроек счетчика |
experiment_ab | Идентификатор эксперимента в Директе или Аудиториях | В Аудиториях можно создавать эксперименты, а в Директе настраивать рекламную кампанию по созданному эксперименту. В Метрике вы можете отслеживать ход эксперимента с помощью отчета Директ, эксперименты. | — |
Параметр | Название | Описание | Значение по умолчанию |
---|---|---|---|
goal_id | Цель | Идентификатор цели. | |
group | Группировка | Группировка по времени для некоторых группировок. Возможные значения: | week |
attribution | Модель атрибуции | Некоторые группировки позволяют задать модель атрибуции. Возможные значения:
Также доступны значения, определяющие кросс-девайс атрибуцию:
| lastsign |
currency | Валюта | Некоторые группировки позволяют настраивать валюту. Возможные значения: | Зависит от настроек счетчика |
experiment_ab | Идентификатор эксперимента в Директе или Аудиториях | В Аудиториях можно создавать эксперименты, а в Директе настраивать рекламную кампанию по созданному эксперименту. В Метрике вы можете отслеживать ход эксперимента с помощью отчета Директ, эксперименты. | — |
Задать параметр в выражении можно двумя способами:
- Задать параметр непосредственно в выражении (например,
ym:s:goal12345IsReached
) — позволяет задать разные значения параметров для разных выражений. - Добавить параметр выражения в запрос в исходном виде (например,
...&dimensions=ym:s:goal<goal_id>IsReached&goal_id=12345&...
) — позволяет задать один параметр для всех выражений.
Вы можете использовать оба способа в запросе одновременно.
Посмотрите как используется параметризация группировок и метрик в примере.