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

Возвращает информацию по тегу

Request

GET

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

Path parameters

Name

Description

containerId*

Type: integer<int64>

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

tagId*

Type: integer<int64>

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

Responses

200 OK

Body

application/json

{
    "tag": {
        "name": "string",
        "create_time": "2022-12-29T18:02:01Z",
        "update_time": "2022-12-29T18:02:01Z",
        "tag_id": 0,
        "type": "string",
        "tag_priority": 0,
        "triggers": [
            0
        ],
        "status": "string",
        "data": {
            "user_provided_values": [
                {
                    "type": "string",
                    "required": false,
                    "parameter_id": 0,
                    "value": "string"
                }
            ],
            "allowed": false,
            "template_id": "string"
        },
        "original_tag_id": 0,
        "updated_by": "string",
        "links_number": 0,
        "tags_links": [
            "string"
        ],
        "triggers_links": [
            "string"
        ],
        "variables_links": [
            "string"
        ]
    }
}

Name

Description

tag

Type: LinkedEntityTag

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

LinkedEntityTag

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

Name	Description
data*	Type: TemplateData Данные шаблона, включая значения параметров, заполненные пользователем, и информацию о доступности шаблона.
triggers*	Type: integer[] Список идентификаторов триггеров, при срабатывании которых активируется данный тег. Min items: `0` Max items: `100`
create_time	Type: string<date-time> Дата и время создания в формате ISO 8601.
links_number	Type: integer<int32> Общее количество ссылок на данную сущность из других сущностей (тегов, триггеров, переменных).
name	Type: string Название. Min length: `0` Max length: `100`
original_tag_id	Type: integer<int64> Идентификатор тега из рабочей области, из которого был создан тег
status	Type: string Текущий статус тега в контейнере: `active` - активный тег, который выполняется при срабатывании связанных триггеров `paused` - приостановленный тег, который временно не выполняется, но сохраняет все настройки `deleted` - удаленный тег, который не выполняется и не отображается в основном списке
tag_id	Type: integer<int64> Уникальный идентификатор тега.
tag_priority	Type: integer<int32> Числовое значение, определяющее порядок выполнения тега относительно других тегов. Теги с более высоким приоритетом выполняются раньше.
tags_links	Type: string[] Список идентификаторов или имен тегов, которые используют данную сущность.
triggers_links	Type: string[] Список идентификаторов или имен триггеров, которые используют данную сущность.
type	Type: string Тип тега, определяющий его реализацию: `template` - тег, созданный на основе пользовательского шаблона `chtml` - тег с пользовательским HTML-кодом, который позволяет вставлять произвольный HTML на страницу
update_time	Type: string<date-time> Дата и время последнего обновления в формате ISO 8601.
updated_by	Type: string Имя или идентификатор пользователя, который последним обновил данный тег.
variables_links	Type: string[] Список идентификаторов или имен других переменных, которые используют данную сущность.

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, то пользователь не сможет сохранить настройки без заполнения этого параметра.

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

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

Обратная связь