Получить список триггеров

Возвращает список триггеров, соответствующих условию фильтрации.

Request

GET

https://api.ytm.yandex.net/ytm/management/v1/container/{containerId}/triggers

Path parameters

Name

Description

containerId*

Type: integer<int64>

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

Query parameters

Name	Description
container_version	Type: integer<int32> Номер версии контейнера, для которой нужно получить список триггеров. Значение 0 (по умолчанию) означает текущую рабочую область (неопубликованную версию). Default: `0`
container_version_type	Type: string Тип версии контейнера для фильтрации результатов. Тип версии контейнера: `PRODUCTION` - основная (опубликованная) версия, используемая на сайте `PREVIEW` - предварительная версия для тестирования `DEVELOPMENT` - версия в разработке
name_filter	Type: string Строка для фильтрации триггеров по имени. Возвращает только те триггеры, в названии которых содержится указанная строка (без учета регистра). Default: ``
offset	Type: integer<int32> Количество триггеров, которое нужно пропустить перед началом выборки. Используется для постраничной навигации совместно с параметром `per_page`. Default: `0`
per_page	Type: integer<int32> Максимальное количество триггеров, которое будет возвращено в ответе. Используется для постраничной навигации совместно с параметром `offset`. Default: `200`
trigger_ids	Type: integer[] Список идентификаторов триггеров, информацию о которых нужно вернуть.

Responses

200 OK

Body

application/json

{
    "triggers": [
        {
            "name": "string",
            "create_time": "2022-12-29T18:02:01Z",
            "update_time": "2022-12-29T18:02:01Z",
            "trigger_id": 0,
            "status": "string",
            "type": "string",
            "data": {
                "user_provided_values": [
                    {
                        "type": "string",
                        "required": false,
                        "parameter_id": 0,
                        "value": "string"
                    }
                ],
                "allowed": false,
                "template_id": "string"
            },
            "tags": [
                0
            ],
            "user_predicates": [
                {
                    "predicate_id": 0,
                    "type": "string",
                    "variable_id": "string",
                    "target_value": "string",
                    "not": false
                }
            ],
            "original_trigger_id": 0,
            "updated_by": "string",
            "links_number": 0
        }
    ],
    "total": 0
}

Name

Description

total

Type: integer<int32>

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

triggers

Type: SimpleLinkedEntityTrigger[]

Представление триггера в контейнере с информацией о количестве связей с другими сущностями (тегами, переменными).

SimpleLinkedEntityTrigger

Name	Description
data*	Type: TemplateData Данные шаблона, включая значения параметров, заполненные пользователем, и информацию о доступности шаблона.
create_time	Type: string<date-time> Дата и время создания в формате ISO 8601.
links_number	Type: integer<int32> Общее количество ссылок на данную сущность из других сущностей (тегов, триггеров, переменных).
name	Type: string Название. Min length: `0` Max length: `100`
original_trigger_id	Type: integer<int64> Идентификатор триггера из рабочей области, из которого был создан данный триггер в версии контейнера.
status	Type: string Статус объекта в системе Яндекс Тег Менеджер: `active` - активный `deleted` - удаленный
tags	Type: integer[] Список идентификаторов тегов, которые активируются при срабатывании данного триггера.
trigger_id	Type: integer<int64> Уникальный идентификатор триггера.
type	Type: string Тип триггера, определяющий условие его срабатывания: `initialization` — инициализация страницы (срабатывает при первой загрузке кода Яндекс Тег Менеджера) `page_view` — просмотр страницы (срабатывает при загрузке страницы) `dom_ready` — модель DOM готова (срабатывает, когда DOM-структура страницы полностью загружена) `window_loaded` — окно загружено (срабатывает, когда страница и все ресурсы полностью загружены) `click_all_elements` — клики - все элементы (срабатывает при клике на любой элемент страницы) `click_just_links` — клики - только ссылки (срабатывает при клике только на ссылки) `form_submission` — отправка формы (срабатывает при отправке формы) `custom_event` — специальное событие (срабатывает при возникновении пользовательского события) `timer` — таймер (срабатывает через заданный промежуток времени) `scroll_depth` — прокрутка страницы (срабатывает при прокрутке страницы на заданную глубину)
update_time	Type: string<date-time> Дата и время последнего обновления в формате ISO 8601.
updated_by	Type: string Имя или идентификатор пользователя, который последним обновил данный триггер.
user_predicates	Type: Predicate[] Условие, определяющее, когда должен сработать триггер. Может проверять значения переменных на равенство, содержание, соответствие регулярному выражению и т.д. Min items: `0` Max items: `100`

TemplateData

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

Name	Description
user_provided_values*	Type: SimpleParameterData[] Базовый класс для значений параметров шаблона, заполненных пользователем. Min items: `0` Max items: `100`
allowed	Type: boolean Флаг, указывающий, разрешено ли использовать данный шаблон в текущем контейнере. Некоторые шаблоны могут быть недоступны в зависимости от настроек контейнера.
template_id	Type: string Уникальный идентификатор шаблона в системе Яндекс Тег Менеджер.

Predicate

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

Name	Description
not	Type: boolean Флаг, указывающий, нужно ли инвертировать результат проверки условия. Если true, то условие считается выполненным, когда проверка не проходит.
predicate_id	Type: integer<int64> Уникальный идентификатор условия срабатывания в триггере.
target_value	Type: string Значение, с которым сравнивается значение переменной. Интерпретация зависит от типа условия. Min length: `0` Max length: `100`
type	Type: string Тип условия срабатывания для проверки значения переменной: `equals` - значение переменной точно равно указанному целевому значению `contains` - значение переменной содержит указанное целевое значение как подстроку `starts_with` - значение переменной начинается с указанного целевого значения `ends_with` - значение переменной заканчивается указанным целевым значением `matches_css_selector` - элемент страницы соответствует указанному CSS-селектору `matches_regex` - значение переменной соответствует указанному регулярному выражению `matches_regex_ignore_case` - значение переменной соответствует указанному регулярному выражению без учета регистра `less_than` - числовое значение переменной меньше указанного целевого значения `less_than_or_equal_to` - числовое значение переменной меньше или равно указанному целевому значению
variable_id	Type: string Идентификатор переменной, значение которой проверяется условием.

SimpleParameterData

Name	Description
parameter_id*	Type: integer<int64> Уникальный идентификатор параметра в шаблоне.
type*	Type: string Тип параметра, определяющий способ его отображения и обработки: `text_input` - текстовое поле для ввода строковых значений `drop_down_menu` - выпадающий список для выбора из предопределенных вариантов `radio_button` - переключатель для выбора одного варианта из нескольких `checkbox` - чекбокс для включения/выключения опции `code` - редактор кода для ввода произвольного кода
value*	Type: string Значение параметра, заполненное пользователем при настройке тега, триггера или переменной. Min length: `0` Max length: `32767`
required	Type: boolean Флаг, указывающий, является ли параметр обязательным для заполнения. Если true, то пользователь не сможет сохранить настройки без заполнения этого параметра.

Была ли статья полезна?

Overview

Получить триггер