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

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

Request

GET

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

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`
type	Type: string Тип шаблона по источнику: `built_in` - встроенный шаблон, предоставляемый Яндекс Тег Менеджером `user` - пользовательский шаблон, созданный пользователем
variable_ids	Type: string[] Список идентификаторов переменных, информацию о которых нужно вернуть.

Responses

200 OK

Body

application/json

{
    "variables": [
        {
            "name": "string",
            "create_time": "2022-12-29T18:02:01Z",
            "update_time": "2022-12-29T18:02:01Z",
            "data": {
                "user_provided_values": [
                    {
                        "type": "string",
                        "required": false,
                        "parameter_id": 0,
                        "value": "string"
                    }
                ],
                "allowed": false,
                "template_id": "string"
            },
            "type": "string",
            "group": "string",
            "links_number": 0
        }
    ],
    "total": 0
}

Name

Description

total

Type: integer<int32>

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

variables

Type: SimpleLinkedEntityVariable[]

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

SimpleLinkedEntityVariable

Name	Description
data*	Type: TemplateData Данные шаблона, включая значения параметров, заполненные пользователем, и информацию о доступности шаблона.
create_time	Type: string<date-time> Дата и время создания в формате ISO 8601.
group	Type: string Группа переменной: `clicks` `errors` `forms` `history` `pages` `scroll` `utils` `visibility`
links_number	Type: integer<int32> Общее количество ссылок на данную сущность из других сущностей (тегов, триггеров, переменных).
name	Type: string Название. Min length: `0` Max length: `100`
type	Type: string
update_time	Type: string<date-time> Дата и время последнего обновления в формате ISO 8601.

TemplateData

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

Name	Description
user_provided_values*	Type: SimpleParameterData[] Базовый класс для значений параметров шаблона, заполненных пользователем. Min items: `0` Max items: `100`
allowed	Type: boolean Флаг, указывающий, разрешено ли использовать данный шаблон в текущем контейнере. Некоторые шаблоны могут быть недоступны в зависимости от настроек контейнера.
template_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

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