Получить список всех переменных контейнера

Возвращает список всех переменных контейнера

Request

GET

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

Path parameters

Name

Description

containerId

Type: integer

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

Query parameters

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

Responses

200 OK

Body

application/json

{
  "variables": [
    {
      "name": "example",
      "create_time": "2025-01-01T00:00:00Z",
      "update_time": "2025-01-01T00:00:00Z",
      "data": {
        "user_provided_values": [
          null
        ],
        "allowed": true,
        "template_id": "example"
      },
      "type": "example",
      "group": "example",
      "links_number": 0
    }
  ],
  "total": 0
}

Name

Description

total

Type: integer

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

variables

Type: SimpleLinkedEntityVariable[]

Example

[
  {
    "name": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "update_time": "2025-01-01T00:00:00Z",
    "data": {
      "user_provided_values": [
        null
      ],
      "allowed": true,
      "template_id": "example"
    },
    "type": "example",
    "group": "example",
    "links_number": 0
  }
]

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"
}

SimpleLinkedEntityVariable

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

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`
group	Type: string Группа переменной: `clicks` `errors` `forms` `history` `pages` `scroll` `utils` `visibility` Example: `example`
links_number	Type: integer Общее количество ссылок на данную сущность из других сущностей (тегов, триггеров, переменных).
name	Type: string Название. Min length: `0` Max length: `100` Example: `example`
type	Type: string Example: `example`
update_time	Type: string<date-time> Дата и время последнего обновления в формате ISO 8601. Example: `2025-01-01T00:00:00Z`

Example

{
  "name": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "update_time": "2025-01-01T00:00:00Z",
  "data": {
    "user_provided_values": [
      {
        "type": "example",
        "required": true,
        "parameter_id": 0,
        "value": "example"
      }
    ],
    "allowed": true,
    "template_id": "example"
  },
  "type": "example",
  "group": "example",
  "links_number": 0
}

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

Overview

Получить информацию по переменной