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

Возвращает триггер

Request

GET

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

Path parameters

Name

Description

containerId

Type: integer

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

triggerId

Type: integer

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

Responses

200 OK

OK

Body

application/json
{
  "trigger": {
    "name": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "update_time": "2025-01-01T00:00:00Z",
    "trigger_id": 0,
    "status": "example",
    "type": "example",
    "data": {
      "user_provided_values": [
        null
      ],
      "allowed": true,
      "template_id": "example"
    },
    "tags": [
      0
    ],
    "user_predicates": [
      {
        "predicate_id": 0,
        "type": "example",
        "variable_id": "example",
        "target_value": "example",
        "not": true
      }
    ],
    "original_trigger_id": 0,
    "updated_by": "example",
    "links_number": 0,
    "tags_links": [
      "example"
    ],
    "triggers_links": [
      "example"
    ],
    "variables_links": [
      "example"
    ]
  }
}

Name

Description

trigger

Type: LinkedEntityTrigger

Триггер

Example
{
  "name": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "update_time": "2025-01-01T00:00:00Z",
  "trigger_id": 0,
  "status": "example",
  "type": "example",
  "data": {
    "user_provided_values": [
      {
        "type": "example",
        "required": true,
        "parameter_id": 0,
        "value": "example"
      }
    ],
    "allowed": true,
    "template_id": "example"
  },
  "tags": [
    0
  ],
  "user_predicates": [
    {
      "predicate_id": 0,
      "type": "example",
      "variable_id": "example",
      "target_value": "example",
      "not": true
    }
  ],
  "original_trigger_id": 0,
  "updated_by": "example",
  "links_number": 0,
  "tags_links": [
    "example"
  ],
  "triggers_links": [
    "example"
  ],
  "variables_links": [
    "example"
  ]
}

ParameterData

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

Name

Description

parameter_id

Type: integer

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

type

Type: string

Тип параметра, определяющий способ его отображения и обработки:

  • text_input - текстовое поле для ввода строковых значений
  • drop_down_menu - выпадающий список для выбора из предопределенных вариантов
  • radio_button - переключатель для выбора одного варианта из нескольких
  • checkbox - чекбокс для включения/выключения опции
  • code - редактор кода для ввода произвольного кода

Example: example

required

Type: boolean

Флаг, указывающий, является ли параметр обязательным для заполнения. Если true, то пользователь не сможет сохранить настройки без заполнения этого параметра.
Example
{
  "type": "example",
  "required": true,
  "parameter_id": 0
}

SimpleParameterData

All of 2 types

  • Type: ParameterData

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

    Example
    {
  "type": "example",
  "required": true,
  "parameter_id": 0
}
  • Type: object

    value

    Type: string

    Значение параметра, заполненное пользователем при настройке тега, триггера или переменной.

    Min length: 0

    Max length: 32767

    Example: example
    Example
    {
  "value": "example"
}
Example
{
  "type": "example",
  "required": true,
  "parameter_id": 0,
  "value": "example"
}

TemplateData

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

Name

Description

user_provided_values

Type: SimpleParameterData[]

Min items: 0

Max items: 100

Example
[
  {
    "type": "example",
    "required": true,
    "parameter_id": 0,
    "value": "example"
  }
]

allowed

Type: boolean

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

template_id

Type: string

Уникальный идентификатор шаблона в системе Яндекс Тег Менеджер.

Example: example
Example
{
  "user_provided_values": [
    {
      "type": "example",
      "required": true,
      "parameter_id": 0,
      "value": "example"
    }
  ],
  "allowed": true,
  "template_id": "example"
}

Predicate

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

Name

Description

not

Type: boolean

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

predicate_id

Type: integer

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

target_value

Type: string

Значение, с которым сравнивается значение переменной. Интерпретация зависит от типа условия.

Min length: 0

Max length: 255

Example: example

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 - числовое значение переменной меньше или равно указанному целевому значению

Example: example

variable_id

Type: string

Идентификатор переменной, значение которой проверяется условием.

Example: example
Example
{
  "predicate_id": 0,
  "type": "example",
  "variable_id": "example",
  "target_value": "example",
  "not": true
}

LinkedEntityTrigger

Триггер

Name

Description

data

Type: TemplateData

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

Example
{
  "user_provided_values": [
    {
      "type": "example",
      "required": true,
      "parameter_id": 0,
      "value": "example"
    }
  ],
  "allowed": true,
  "template_id": "example"
}

create_time

Type: string<date-time>

Дата и время создания в формате ISO 8601.

Example: 2025-01-01T00:00:00Z

links_number

Type: integer

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

name

Type: string

Название.

Min length: 0

Max length: 100

Example: example

original_trigger_id

Type: integer

Идентификатор триггера из рабочей области, из которого был создан данный триггер в версии контейнера.

status

Type: string

Статус объекта в системе Яндекс Тег Менеджер:

  • active - активный
  • deleted - удаленный

Example: example

tags

Type: integer[]

Example
[
  0
]

tags_links

Type: string[]

Example
[
  "example"
]

trigger_id

Type: integer

Уникальный идентификатор триггера.

triggers_links

Type: string[]

Example
[
  "example"
]

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 — прокрутка страницы (срабатывает при прокрутке страницы на заданную глубину)

Example: example

update_time

Type: string<date-time>

Дата и время последнего обновления в формате ISO 8601.

Example: 2025-01-01T00:00:00Z

updated_by

Type: string

Имя или идентификатор пользователя, который последним обновил данный триггер.

Example: example

user_predicates

Type: Predicate[]

Min items: 0

Max items: 100

Example
[
  {
    "predicate_id": 0,
    "type": "example",
    "variable_id": "example",
    "target_value": "example",
    "not": true
  }
]

variables_links

Type: string[]

Example
[
  "example"
]
Example
{
  "name": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "update_time": "2025-01-01T00:00:00Z",
  "trigger_id": 0,
  "status": "example",
  "type": "example",
  "data": {
    "user_provided_values": [
      {
        "type": "example",
        "required": true,
        "parameter_id": 0,
        "value": "example"
      }
    ],
    "allowed": true,
    "template_id": "example"
  },
  "tags": [
    0
  ],
  "user_predicates": [
    {
      "predicate_id": 0,
      "type": "example",
      "variable_id": "example",
      "target_value": "example",
      "not": true
    }
  ],
  "original_trigger_id": 0,
  "updated_by": "example",
  "links_number": 0,
  "tags_links": [
    "example"
  ],
  "triggers_links": [
    "example"
  ],
  "variables_links": [
    "example"
  ]
}
Предыдущая
Получить список триггеров
Следующая
Overview