Получить информацию по тегу
Возвращает информацию по тегу
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
|
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"
}
LinkedEntityTag
Представление тега в контейнере с информацией о его связях с другими сущностями (триггерами, переменными).
|
Name |
Description |
|
data |
Type: TemplateData Данные шаблона, включая значения параметров, заполненные пользователем, и информацию о доступности шаблона. Example
|
|
triggers |
Type: integer[] Min items: Max items: Example
|
|
create_time |
Type: string<date-time> Дата и время создания в формате ISO 8601. Example: |
|
links_number |
Type: integer Общее количество ссылок на данную сущность из других сущностей (тегов, триггеров, переменных). |
|
name |
Type: string Название. Min length: Max length: Example: |
|
original_tag_id |
Type: integer Идентификатор тега из рабочей области, из которого был создан тег |
|
status |
Type: string Текущий статус тега в контейнере:
Example: |
|
tag_id |
Type: integer Уникальный идентификатор тега. |
|
tag_priority |
Type: integer Числовое значение, определяющее порядок выполнения тега относительно других тегов. Теги с более высоким приоритетом выполняются раньше. |
|
tags_links |
Type: string[] Example
|
|
triggers_links |
Type: string[] Example
|
|
type |
Type: string Тип тега, определяющий его реализацию:
Example: |
|
update_time |
Type: string<date-time> Дата и время последнего обновления в формате ISO 8601. Example: |
|
updated_by |
Type: string Имя или идентификатор пользователя, который последним обновил данный тег. Example: |
|
variables_links |
Type: string[] 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"
]
}