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

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

Request

GET

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

Path parameters

Name

Description

containerId

Type: integer

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

tagId

Type: integer

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

Responses

200 OK

OK

Body

application/json
{
  "tag": {
    "name": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "update_time": "2025-01-01T00:00:00Z",
    "tag_id": 0,
    "type": "example",
    "tag_priority": 0,
    "triggers": [
      0
    ],
    "status": "example",
    "data": {
      "user_provided_values": [
        null
      ],
      "allowed": true,
      "template_id": "example"
    },
    "original_tag_id": 0,
    "updated_by": "example",
    "links_number": 0,
    "tags_links": [
      "example"
    ],
    "triggers_links": [
      "example"
    ],
    "variables_links": [
      "example"
    ]
  }
}

Name

Description

tag

Type: LinkedEntityTag

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

Example
{
  "name": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "update_time": "2025-01-01T00:00:00Z",
  "tag_id": 0,
  "type": "example",
  "tag_priority": 0,
  "triggers": [
    0
  ],
  "status": "example",
  "data": {
    "user_provided_values": [
      {
        "type": "example",
        "required": true,
        "parameter_id": 0,
        "value": "example"
      }
    ],
    "allowed": true,
    "template_id": "example"
  },
  "original_tag_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"
}

LinkedEntityTag

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

Name

Description

data

Type: TemplateData

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

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

triggers

Type: integer[]

Min items: 0

Max items: 100

Example
[
  0
]

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_tag_id

Type: integer

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

status

Type: string

Текущий статус тега в контейнере:

  • active - активный тег, который выполняется при срабатывании связанных триггеров
  • paused - приостановленный тег, который временно не выполняется, но сохраняет все настройки
  • deleted - удаленный тег, который не выполняется и не отображается в основном списке

Example: example

tag_id

Type: integer

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

tag_priority

Type: integer

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

tags_links

Type: string[]

Example
[
  "example"
]

triggers_links

Type: string[]

Example
[
  "example"
]

type

Type: string

Тип тега, определяющий его реализацию:

  • template - тег, созданный на основе пользовательского шаблона
  • chtml - тег с пользовательским HTML-кодом, который позволяет вставлять произвольный HTML на страницу

Example: example

update_time

Type: string<date-time>

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

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

updated_by

Type: string

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

Example: example

variables_links

Type: string[]

Example
[
  "example"
]
Example
{
  "name": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "update_time": "2025-01-01T00:00:00Z",
  "tag_id": 0,
  "type": "example",
  "tag_priority": 0,
  "triggers": [
    0
  ],
  "status": "example",
  "data": {
    "user_provided_values": [
      {
        "type": "example",
        "required": true,
        "parameter_id": 0,
        "value": "example"
      }
    ],
    "allowed": true,
    "template_id": "example"
  },
  "original_tag_id": 0,
  "updated_by": "example",
  "links_number": 0,
  "tags_links": [
    "example"
  ],
  "triggers_links": [
    "example"
  ],
  "variables_links": [
    "example"
  ]
}