Получить список триггеров
Возвращает список триггеров, соответствующих условию фильтрации.
Request
GET
https://api.ytm.yandex.net/ytm/management/v1/container/{containerId}/triggers
Path parameters
|
Name |
Description |
|
containerId |
Type: integer Уникальный идентификатор контейнера, для которого необходимо получить список триггеров. |
Query parameters
|
Name |
Description |
|
container_version |
Type: integer Номер версии контейнера, для которой нужно получить список триггеров. Значение 0 (по умолчанию) означает текущую рабочую область (неопубликованную версию). Default: |
|
container_version_type |
Type: string Тип версии контейнера для фильтрации результатов. Тип версии контейнера:
Example: `` |
|
name_filter |
Type: string Строка для фильтрации триггеров по имени. Возвращает только те триггеры, в названии которых содержится указанная строка (без учета регистра). Default: `` Example: `` |
|
offset |
Type: integer Количество триггеров, которое нужно пропустить перед началом выборки. Используется для постраничной навигации совместно с параметром Default: |
|
per_page |
Type: integer Максимальное количество триггеров, которое будет возвращено в ответе. Используется для постраничной навигации совместно с параметром Default: |
|
trigger_ids |
Type: integer[] Список идентификаторов триггеров, информацию о которых нужно вернуть. Example: `` |
Responses
200 OK
OK
Body
application/json
{
"triggers": [
{
"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
}
],
"total": 0
}
|
Name |
Description |
|
total |
Type: integer Общее количество триггеров, соответствующих критериям запроса. Используется для постраничной навигации и отображения информации о количестве результатов. |
|
triggers |
Type: SimpleLinkedEntityTrigger[] Example
|
ParameterData
Базовый класс для значений параметров шаблона, заполненных пользователем.
|
Name |
Description |
|
parameter_id |
Type: integer Уникальный идентификатор параметра в шаблоне. |
|
type |
Type: string Тип параметра, определяющий способ его отображения и обработки:
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:
0Max length:
32767Example:
exampleExample
{ "value": "example" }
Example
{
"type": "example",
"required": true,
"parameter_id": 0,
"value": "example"
}
TemplateData
Данные шаблона, включая значения параметров, заполненные пользователем, и информацию о доступности шаблона.
|
Name |
Description |
|
user_provided_values |
Type: SimpleParameterData[] Min items: Max items: Example
|
|
allowed |
Type: boolean Флаг, указывающий, разрешено ли использовать данный шаблон в текущем контейнере. Некоторые шаблоны могут быть недоступны в зависимости от настроек контейнера. |
|
template_id |
Type: string Уникальный идентификатор шаблона в системе Яндекс Тег Менеджер. 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: Max length: Example: |
|
type |
Type: string Тип условия срабатывания для проверки значения переменной:
Example: |
|
variable_id |
Type: string Идентификатор переменной, значение которой проверяется условием. Example: |
Example
{
"predicate_id": 0,
"type": "example",
"variable_id": "example",
"target_value": "example",
"not": true
}
SimpleLinkedEntityTrigger
Представление триггера в контейнере с информацией о количестве связей с другими сущностями (тегами, переменными).
|
Name |
Description |
|
data |
Type: TemplateData Данные шаблона, включая значения параметров, заполненные пользователем, и информацию о доступности шаблона. Example
|
|
create_time |
Type: string<date-time> Дата и время создания в формате ISO 8601. Example: |
|
links_number |
Type: integer Общее количество ссылок на данную сущность из других сущностей (тегов, триггеров, переменных). |
|
name |
Type: string Название. Min length: Max length: Example: |
|
original_trigger_id |
Type: integer Идентификатор триггера из рабочей области, из которого был создан данный триггер в версии контейнера. |
|
status |
Type: string Статус объекта в системе Яндекс Тег Менеджер:
Example: |
|
tags |
Type: integer[] Example
|
|
trigger_id |
Type: integer Уникальный идентификатор триггера. |
|
type |
Type: string Тип триггера, определяющий условие его срабатывания:
Example: |
|
update_time |
Type: string<date-time> Дата и время последнего обновления в формате ISO 8601. Example: |
|
updated_by |
Type: string Имя или идентификатор пользователя, который последним обновил данный триггер. Example: |
|
user_predicates |
Type: Predicate[] Min items: Max items: 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
}