API Яндекс Тег Менеджера

Научились всем настройкам и отслеживаниям внутри интерфейса Яндекс Тег Менеджера? Пора переходить к изучению API.

Первая версия API Яндекс Тег Менеджера была выпущена в августе 2025 года. На данный момент API позволяет:

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

Подробнее об API Яндекс Тег Менеджера читайте в официальной документации.

Введение в API

API Яндекс Тег Менеджера построен по принципам REST (Representational State Transfer). Запросы к API передаются по протоколу HTTPS в следующем формате:

, где:

• <тип метода> - GET (читать содержимое и текущее состояние ресурса);
• <имя сервиса> - название сервиса API;
• <раздел_API> - название раздела API, в котором выполняется действие;
• <версия> - номер текущей версии API;
• <container> - идентификатор конкретного контейнера;
• <имя_метода> - URL ресурса, над которым выполняется действие;
• <параметры> - обязательные и необязательные параметры запроса.

Все сущности, доступные для получения информации через API, представлены в виде ресурсов: теги, триггеры, переменные и шаблоны. Ресурс - это целостная часть системы, к которой можно применять определенные HTTP-методы. API Яндекс Тег Менеджера работает в режиме чтения и поддерживает только HTTP-метод GET. Входные данные передаются в параметрах запроса URL. Входные структуры совпадают с выходными структурами GET-методов соответствующих ресурсов.

У каждого ресурса есть свой уникальный URL. Например:

• получить список шаблонов из галереи

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

• получить список триггеров

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

Все действия выполняются соответствующими методами протокола HTTPS на URL'ы ресурсов. С каждым запросом требуется передавать токен, необходимый для авторизации на OAuth-сервере Яндекса. Если метод API вызван без токена или в запросе передан недействительный токен, сервер возвращает HTTP-статус 401 Unauthorized.

С целью обеспечения максимального уровня доступности сервиса, в Яндекс Тег Менеджере предусмотрены ограничения на интенсивность запросов к API со стороны пользователей. В случае превышения квот дальнейшие действия пользователя временно блокируются. При этом API возвращает ответ с HTTP-статусом 429 Too Many Requests. В теле ответа содержится информация о типе превышенной квоты.

Ограничения API:

• Количество запросов для каждого пользователя (идентифицируемого по User ID) - до 5 000 запросов в сутки на чтение;
• Количество запросов на один контейнер - до 5 000 запросов в сутки.

Описание других ошибок смотрите в официальной справке.

Все разделы API Яндекс Тег Менеджера поддерживают версионирование. Каждая версия имеет уникальный идентификатор (например, v1, v2 и т.д.). При выходе новой версии предыдущие продолжают работать для обеспечения обратной совместимости.

Рекомендации по использованию версий:

• если вы только начинаете работу с API, используйте последнюю доступную версию;
• если вы используете старую версию, постепенно переходите на новую, так как поддержка устаревших версий ограничена по времени.

При формировании запроса к API всегда указывайте версию, с которой вы хотите работать. Например:

На момент написания этого руководства поддерживается только v1.

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

Получение OAuth-токена

Для использования API Яндекс Тег Менеджера необходимо получить авторизационный токен через OAuth-сервер Яндекса. Чтобы его получить, необходимо авторизоваться под своей учетной записью Яндекса, перейти по ссылке oauth.yandex.ru и создать приложение:

Примечание: если у вас нет логина в Яндексе - зарегистрируйте аккаунт Яндекс ID, а затем авторизуйтесь.

В открывшемся окне выберите вариант Для доступа к API или отладки (Для получения доступа к API сервисов Яндекса. Нет доступа к данным пользователей) и нажмите кнопку Перейти к созданию:

В настройках приложения укажите следующие данные:

• Название вашего сервиса - можно указать произвольно (например: API Яндекс Тег Менеджера);
• Почта для связи - почта компании или своя.

В разделе Доступ к данным добавьте ytm:read:

Redirect URI для веб-сервисов останется без изменений, изменить его нельзя - https://oauth.yandex.ru/verification_code:

Убедитесь, что все заполнено верно, а затем создайте приложение:

После этого вас перенаправит на страницу приложения, где будет отображаться ClientID:

Теперь авторизуйтесь под учетной записью Яндекса, на которой у вас есть доступ к счетчику Яндекс Метрики и Яндекс Тег Менеджеру, и перейдите по ссылке, добавив ее в адресную строку браузера:

, где вместо <идентификатор приложения> вставьте идентификатор вашего приложения ClientID, скопированный на предыдущем шаге:

У вас должно открыться окно авторизации. Нажмите кнопку Войти как… и тогда ваше приложение получит доступ к данным вашего контейнера Яндекс Тег Менеджера:

На следующей странице отобразится ваш авторизационный токен. Его вы будете использовать/передавать для каждого метода API в HTTP-заголовке Authorization:

Пример запроса с авторизационным токеном:

, где <access_token> - это ваш авторизационный токен.

 

tags (массив объектов) состоит из объектов типа SimpleLinkedEntityTag, которые содержат полную информацию о теге и его связях с другими сущностями (например, триггерами и переменными):

• name - название;
• create_time - дата и время создания в формате ISO 8601;
• update_time - дата и время последнего обновления в формате ISO 8601;
• tag_id - уникальный идентификатор тега;
• type - тип тега, определяющий его реализацию (template - тег, созданный на основе пользовательского шаблона; chtml - тег с пользовательским HTML-кодом, который позволяет вставлять произвольный HTML на страницу);
• tag_priority - числовое значение, определяющее порядок выполнения тега относительно других тегов. Теги с более высоким приоритетом выполняются раньше;
• status - текущий статус тега в контейнере (active - активный тег, который выполняется при срабатывании связанных триггеров; paused - приостановленный тег, который временно не выполняется, но сохраняет все настройки; deleted - удаленный тег, который не выполняется и не отображается в основном списке);
• original_tag_id - идентификатор тега из рабочей области, из которого был создан тег;
• updated_by - имя или идентификатор пользователя, который последним обновил данный тег;
• links_number - общее количество ссылок/связанных объектов на данную сущность из других сущностей (тегов, триггеров, переменных);
• data - объект TemplateData с данными шаблона тега.

Внутри data (объект TemplateData) содержатся:

• user_provided_values - массив параметров шаблона, заполненных пользователем;
• allowed - флаг, указывающий, разрешено ли использовать данный шаблон в текущем контейнере. Некоторые шаблоны могут быть недоступны в зависимости от настроек контейнера;
• template_id - уникальный идентификатор шаблона в системе Яндекс Тег Менеджер.

user_provided_values (массив объектов SimpleParameterData) включает:

• parameter_id - уникальный идентификатор параметра в шаблоне;
• type - тип параметра, определяющий способ его отображения и обработки (text_input - текстовое поле для ввода строковых значений; drop_down_menu - выпадающий список для выбора из предопределенных вариантов; radio_button - переключатель для выбора одного варианта из нескольких; checkbox - чекбокс для включения/выключения опции; code - редактор кода для ввода произвольного кода);
• required - флаг, указывающий, является ли параметр обязательным для заполнения. Если true, пользователь не сможет сохранить настройки без заполнения этого параметра.

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

В API Яндекс Тег Менеджера для тегов доступны Query parameters - это параметры в URL после ?, которые уточняют выборку (фильтр, пагинация, версия и т.д.). Например:

В requests лучше передавать их через params:

В моей программе Google Colab этот код написан в следующей ячейке. Вы можете его запустить и получить результат с учетом заданных параметров. Их лучше настроить под себя.

Query parameters:

• container_version - номер версии контейнера, для которой нужно получить список тегов. Значение 0 (по умолчанию) означает текущую рабочую область (неопубликованную версию);
• container_version_type - тип версии контейнера для фильтрации результатов (PRODUCTION - основная (опубликованная) версия, используемая на сайте; PREVIEW - предварительная версия для тестирования; DEVELOPMENT - версия в разработке);
• name_filter - строка для фильтрации тегов по имени. Возвращает только те теги, в названии которых содержится указанная строка (без учета регистра);
• offset - количество тегов, которое нужно пропустить перед началом выборки. Используется для постраничной навигации совместно с параметром (по умолчанию - 0);
• per_page - максимальное количество тегов, которое будет возвращено в ответе. Используется для постраничной навигации совместно с параметром offset (по умолчанию - 200);
• tag_ids - список идентификаторов тегов, информацию о которых нужно вернуть.

В моем примере использовался фильтр по названию тегов, где в названии содержится VK Реклама. Таких тегов в моем интерфейсе - 4:

Поэтому и результат запрос вывел мне 4 тега:

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

Результат выполнения:

Вы получите датафрейм с колонками:

• sub_container_id - ID подконтейнера (если контейнер логически разбит на части/пространства; помогает понять, к какому сегменту относится тег);
• name - название тега;
• create_time - дата и время создания тега (ISO 8601, обычно UTC);
• update_time - дата и время последнего изменения тега (ISO 8601);
• tag_id - уникальный идентификатор тега;
• type - тип тега: обычно template (шаблонный) или chtml (пользовательский HTML);
• tag_priority - приоритет выполнения: чем выше число, тем раньше тег выполняется относительно других;
• triggers - список ID триггеров, при срабатывании которых запускается тег;
• status - статус тега: active / paused / deleted;
• original_tag_id - ID исходного тега из рабочей области, если текущий тег создан как производный/копия;
• updated_by - пользователь (логин/ID), который последним изменил тег;
• links_number - количество связей этой сущности с другими объектами (теги/триггеры/переменные).

Поля из data (объект TemplateData):

• data.allowed - можно ли использовать этот шаблон в текущем контейнере (true/false);
• data.template_id - идентификатор шаблона тега в системе;
• data.template_version - версия шаблона, по которой создан/обновлен тег;
• data.user_provided_values - значения параметров шаблона, которые заполнил пользователь (обычно массив объектов с parameter_id, type, required и/или значением).

Прямо в Colab датафрейм можно преобразовать в интерактивную таблицу. Для этого рядом с ней нажмите на иконку таблицы в правом верхнем углу:

Теперь это будет не датафрейм, а обычная таблица, по которой можно искать, фильтровать данные и т.д. и т.п.:

Я предлагаю сохранить результат выполнения к себе на компьютер, чтобы открыть таблицу прямо в Excel и увидеть все регионы в одном списке. Для этого запустите следующую ячейку с кодом:

После того, как ячейка будет выполнена, слева в навигационном меню нажмите на иконку с папкой:

Вы должны увидеть загруженный в Colab файл в формате csv:

Чтобы сохранить его на компьютер, напротив него нажмите на иконку с тремя точками и выберите Скачать:

Файл со списком всех тегов будет загружен к вам на компьютер. Вы можете открыть его обычным блокнотом или в Excel:

Все данные будут располагаться в первом столбце. Выполнив стандартную функцию Текст по столбцам с разделителем запятая:

Вы получите удобочитаемую таблицу с заданным набором колонок:

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

Если вы хотите получить информацию о конкретном теге в вашем контейнере ЯТМ, а не обо всех тегах списком, тогда вы можете конкретизировать свой запрос, добавив в него еще один параметр - tagId:

, где tagId - уникальный идентификатор тега, информацию о котором необходимо получить. Посмотреть ID конкретного тега можно в интерфейсе Яндекс Тег Менеджера, перейдя на вкладку Теги. Под названием тега будет отображаться его идентификатор (ID):

Вставьте нужный идентификатор тега вместо {tagId} в url и запустите следующую ячейку программы:

После выполнения вы получите информацию по выбранному тегу.

СКАЧАТЬ ПРОГРАММУ

 

Просмотр триггеров

Материалы для справки:

• Получить список триггеров
• Получить триггер

Теперь давайте получим список всех триггеров контейнера и научимся запрашивать информацию по конкретному триггеру.

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

Данный ресурс возвращает список триггеров, соответствующих условию фильтрации.

Список всех триггеров контейнера (GET):

В программе Colab получение списка всех триггеров контейнера - это следующая ячейка:

Запустите ее, чтобы получить результат примерного такого вида:

Как видите, структура очень похожа на tags, но есть отличия. Query-параметры почти те же самые (container_version, container_version_type, name_filter, offset, per_page). Отличается только фильтр по ID:

• для тегов - tag_ids;
• для триггеров - trigger_ids (список идентификаторов триггеров, информацию о которых нужно вернуть).

По сравнению с SimpleLinkedEntityTag, у SimpleLinkedEntityTrigger появляются/меняются поля:

• trigger_id - уникальный идентификатор триггера;
• original_trigger_id - идентификатор триггера из рабочей области, из которого был создан данный триггер в версии контейнера;
• status - active и deleted (у тегов был еще paused);
• type - типы триггера;

Список типов триггеров:

1. initialization - инициализация страницы (срабатывает при первой загрузке кода Яндекс Тег Менеджера);
2. page_view - просмотр страницы (срабатывает при загрузке страницы);
3. dom_ready - модель DOM готова (срабатывает, когда DOM-структура страницы полностью загружена);
4. window_loaded - окно загружено (срабатывает, когда страница и все ресурсы полностью загружены);
5. click_all_elements - клики - все элементы (срабатывает при клике на любой элемент страницы);
6. click_just_links - клики - только ссылки (срабатывает при клике только на ссылки);
7. form_submission - отправка формы (срабатывает при отправке формы);
8. custom_event - специальное событие (срабатывает при возникновении пользовательского события);
9. timer - таймер (срабатывает через заданный промежуток времени);
10. scroll_depth - прокрутка страницы (срабатывает при прокрутке страницы на заданную глубину)

Новая сущность в триггерах - Predicate. Это условие, определяющее, когда должен сработать триггер. Отображается в массиве объектов user_predicates и может проверять значения переменных на равенство, содержание, соответствие регулярному выражению и т.д.

user_predicates содержит:

• predicate_id - уникальный идентификатор условия срабатывания в триггере;
• variable_id - идентификатор переменной, значение которой проверяется условием;
• target_value - значение, с которым сравнивается значение переменной. Интерпретация зависит от типа условия;
• not - флаг, указывающий, нужно ли инвертировать результат проверки условия. Если true, то условие считается выполненным, когда проверка не проходит.
• type - оператор условия;

Тип условия срабатывания для проверки значения переменной:

1. equals - значение переменной точно равно указанному целевому значению;
2. contains - значение переменной содержит указанное целевое значение как подстроку;
3. starts_with - значение переменной начинается с указанного целевого значения;
4. ends_with - значение переменной заканчивается указанным целевым значением;
5. matches_css_selector - элемент страницы соответствует указанному CSS-селектору;
6. matches_regex - значение переменной соответствует указанному регулярному выражению;
7. matches_regex_ignore_case - значение переменной соответствует указанному регулярному выражению без учета регистра;
8. less_than - числовое значение переменной меньше указанного целевого значения;
9. less_than_or_equal_to - числовое значение переменной меньше или равно указанному целевому значению.

В методе получения списка триггеров сохраняется общая логика, аналогичная методу получения тегов: ответ содержит поле total для общего количества объектов и массив сущностей (triggers вместо tags), поддерживаются те же механизмы фильтрации и пагинации (container_version, container_version_type, name_filter, offset, per_page), а также используются те же вложенные шаблонные структуры data (TemplateData) и user_provided_values (SimpleParameterData). Кроме того, совпадает набор базовых метаполей сущности: name, create_time, update_time, updated_by, links_number.

Как и в предыдущем методе, нажав на иконку преобразования датафрейма в интерактивную таблицу, вы получите:

Как видно, в колонке user_predicates хранится массив объектов (Predicate[]), где:

• user_predicates - массив (list);
• каждый элемент массива - объект Predicate с полями predicate_id, type, variable_id, target_value, not.

Мы можем развернуть user_predicates в отдельный датафрейм (df_predicates) с помощью фрагмента кода, представленного в отдельной ячейке программы. Она будет общей для таблиц со списком триггеров и списком условий:
В Colab это будет выглядеть так:

Это нужно для аналитики условий срабатывания триггеров на уровне отдельных правил. В основном датафрейме триггеров поле user_predicates хранится как вложенный массив, поэтому его неудобно фильтровать, группировать и сравнивать. После нормализации одна строка = одно условие можно быстро находить, какие переменные и операторы (equals, contains, matches_regex и др.) используются чаще всего, проверять корректность настроек и строить отчеты по логике срабатывания триггеров.

Вы можете сохранить таблицы в один файл на компьютер с помощью нижеприведенного кода:

После этого вы сможете скачать файл и открыть его у себя на компьютере. Первый лист (triggers) - это список ваших триггеров:

Второй лист (predicates) - это список условий срабатываний внутри триггеров:

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

Если вы хотите получить информацию о конкретном триггере в вашем контейнере ЯТМ, а не обо всех триггерах списком, тогда вы можете конкретизировать свой запрос, добавив в него еще один параметр - triggerId:

, где triggerId - уникальный идентификатор триггера, информацию о котором необходимо получить. Посмотреть ID конкретного триггера можно в интерфейсе Яндекс Тег Менеджера, перейдя на вкладку Триггер. Под названием триггера будет отображаться его идентификатор (ID):

Вставьте нужный идентификатор триггера вместо {triggerId} в url и запустите следующую ячейку программы:

После выполнения вы получите информацию по выбранному триггеру.

СКАЧАТЬ ПРОГРАММУ

 

Просмотр переменных

Материалы для справки:

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

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

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

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

Список всех переменных контейнера (GET):

В программе Colab получение списка всех переменных контейнера - это следующая ячейка:

Запустите ее, чтобы получить результат такого вида:

variables по общей модели очень похож на tags и triggers, но есть важные отличия в ID полях и составе сущности. Например, в фильтре по ID используется:

• tag_ids - для тегов;
• trigger_ids - для триггеров;
• variable_ids - для переменных (список идентификаторов переменных, информацию о которых нужно вернуть).

Вместо SimpleLinkedEntityTag / SimpleLinkedEntityTrigger в переменных используется SimpleLinkedEntityVariable и такое поле:

• group - группа переменной (clicks, errors, forms, history, pages, scroll, utils, visibility).

В переменных нет характерных для других сущностей полей:

• для тегов - tag_id, tag_priority, status, triggers, original_tag_id, updated_by;
• для триггеров - trigger_id, status, tags, user_predicates, original_trigger_id, updated_by.

В методе получения списка переменных сохраняется та же базовая логика, что и в методах для тегов и триггеров: ответ содержит поле total с общим количеством объектов и массив сущностей (variables), используются те же механизмы фильтрации и пагинации (container_version, container_version_type, name_filter, offset, per_page), а также та же вложенная шаблонная структура data (TemplateData) с user_provided_values (SimpleParameterData).

При этом у переменных есть своя специфика:

• фильтр variable_ids (тип string - строка);
• тип элементов ответа SimpleLinkedEntityVariable;
• наличие характерного поля group (категория переменной);
• поля, типичные для тегов и триггеров (например, tag_priority, status, user_predicates), в этой модели отсутствуют.

Как и в предыдущем методе, нажав на иконку преобразования датафрейма в интерактивную таблицу, вы получите:

Расшифровка колонок для переменных:

• sub_container_id - ID подконтейнера/рабочего сегмента, к которому относится переменная;
• name - название переменной;
• type - тип переменной (категория/механика получения значения в YTM);
• data_type - тип данных значения переменной (например, строка/число/boolean и т.п.);
• compute_scope - область/момент вычисления переменной (в каком контексте она рассчитывается);
• group - функциональная группа переменной (clicks, forms, pages, utils и др.);
• definition_type - способ определения переменной (встроенная, пользовательская, шаблонная и т.д.);
• variable_id - уникальный идентификатор переменной;
• links_number - сколько других сущностей ссылаются на эту переменную (связей с объектом);
• data.user_provided_values - значения параметров шаблона, заданные пользователем (массив объектов);
• data.template_id - ID шаблона переменной в системе YTM;
• create_time - дата/время создания (ISO 8601);
• update_time - дата/время последнего обновления (ISO 8601);
• status - статус переменной (например, активна/удалена, в зависимости от модели API);
• updated_by - кто последним обновил переменную (логин/ID);
• data.allowed - разрешено ли использовать этот шаблон в текущем контейнере (true/false);
• data.template_version - версия шаблона, на которой основана переменная.

Взглянув на таблицу, можно отметить, что в колонке data.user_provided_values хранится массив объектов SimpleParameterData с пользовательскими значениями параметров шаблона.

Мы можем развернуть data.user_provided_values в отдельный датафрейм (df_user_values) с помощью фрагмента кода, представленного в отдельной ячейке программы. Она будет общей для таблиц со списком переменных и списком объектов с настройками параметров шаблона:

В Colab это будет выглядеть так:

Вы можете сохранить обе таблицы в один файл на компьютер с помощью нижеприведенного кода:

После этого вы сможете скачать файл и открыть его у себя на компьютере. Первый лист (variables) - это список ваших переменных:

 

Использование шаблонов

Материалы для справки:

• Получить список шаблонов из галереи
• Получить опубликованную информацию по шаблону из галереи
• Получить список шаблонов контейнера

Последний ресурс, который мы разберем в этом руководстве - это шаблоны. Шаблоны - это готовые решения, которые позволяют внедрять теги и переменные, такие как коды для отслеживания, аналитики, интеграции с рекламными сетями и другими сервисами. Вместо того чтобы писать код с нуля, вы выбираете соответствующий шаблон, и он уже включает все необходимые настройки для работы.

В Яндекс Тег Менеджере есть два типа шаблонов:

1. Личные шаблоны - это созданные вами решения для уникальных задач или интеграций. Вы можете адаптировать их под свои нужды и использовать в проектах и не делиться ими с другими;
2. Публичные шаблоны - это шаблоны, которые доступны в каталоге шаблонов и могут использоваться другими пользователями. Вы можете выбрать их для ускоренной настройки, а также создать и опубликовать свой шаблон в галерее, чтобы другие могли его использовать.

Получение списка шаблонов из галереи

Ресурс возвращает список шаблонов из галереи.

Список шаблонов из галереи (GET):

Для получения результата запустите следующую ячейку в программе:

Примечательно то, что для получения списка шаблонов тегов и переменных из галереи вам не нужно указывать идентификатор своего контейнера Яндекс Тег Менеджера, поскольку галерея сообщества доступна вне зависимости от конкретного контейнера.

К тому же, у шаблонов присутствует сильная вложенность. Например, вот так выглядит шаблон тега Вариокуб:

Верхний уровень объекта templates (метаданные шаблона) описывает шаблон как сущность галереи и имеет следующий набор параметров:

• container_id - идентификатор контейнера/пространства, в контексте которого виден шаблон;
• template_id - уникальный идентификатор шаблона в системе Яндекс Тег Менеджер;
• name - название шаблона, отображаемое в интерфейсе;
• author - автор шаблона;
• create_time - дата и время создания шаблона в формате ISO 8601;
• update_time - дата и время последнего изменения шаблона в формате ISO 8601;
• hidden - флаг, указывающий, что шаблон скрыт в интерфейсе Яндекс Тег Менеджера. Скрытые шаблоны могут использоваться в контейнере, но не отображаются в основном списке шаблонов;
• publicity - уровень доступности шаблона для пользователей (PRIVATE - приватный шаблон, доступный только внутри контейнера, в котором он был создан; PUBLIC - публичный шаблон, доступный всем пользователям Яндекс Тег Менеджера; YANDEX - официальный шаблон, разработанный и поддерживаемый Яндексом);
• status - статус объекта в системе Яндекс Тег Менеджер (active - активный, deleted - удаленный);
• type - тип шаблона, определяющий его назначение (tag - шаблон для создания тега, который выполняет действия на странице; variable - шаблон для создания переменной, которая хранит или вычисляет значения);
• definition_type - тип происхождения/определения (user, system и т.п.).

Вложенный объект data описывает конкретную версию этого пользовательского шаблона, включая его параметры, разрешения, код и другие настройки:

• template_id - тот же ID шаблона;
• template_version - номер версии, растет при изменениях;
• description - подробное описание конкретной версии шаблона. Используется для пояснения назначения версии шаблона, изменений, внесенных относительно предыдущих версий, или других важных деталей, которые могут быть полезны пользователям при выборе подходящей версии шаблона;
• documentation_link - ссылка на документацию;
• main_page_link - URL-адрес главной страницы сервиса, с которым интегрируется шаблон;
• email - адрес электронной почты для связи с разработчиками шаблона или службой поддержки;
• changes - краткое описание изменений, внесенных в текущую версию шаблона по сравнению с предыдущими версиями;
• create_time - дата и время создания данной версии шаблона в формате ISO 8601;
• update_time - дата и время последнего обновления данной версии шаблона в формате ISO 8601;
• code - исходный код шаблона, написанный на изолированном JavaScript. Определяет функциональность шаблона при его использовании на сайте;
• validation_features - правила валидации/проверок для шаблона.
• status - статус версии шаблона в системе Яндекс Тег Менеджер.

Статусы версии шаблона:

• draft - черновик (версия в разработке);
• on_moderation - на модерации (версия отправлена на проверку модераторам);
• moderation_failed - модерация провалилась (версия не прошла проверку модераторами);
• outdated - устаревшая версия (существует более новая версия шаблона);
• latest - последняя версия (актуальная версия шаблона).

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

Суммарно запрос вернул 29 объектов - 25 шаблонов тегов и 4 шаблона переменных, ровно столько, сколько отображается в каталоге шаблонов Яндекс Тег Менеджера.

Сохранить все эти шаблоны в Excel можно с помощью одной строки кода:

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

Получение опубликованной информации по шаблону из галереи

Вставьте нужный идентификатор переменной вместо {templateId} в url и запустите следующую ячейку программы:

После выполнения вы получите информацию по выбранному шаблону из галереи.

СКАЧАТЬ ПРОГРАММУ

 

Получение списка шаблонов контейнера

Помимо публичных шаблонов, вы можете создавать личные. Они будут доступны только в вашем контейнере. Благодаря еще одному ресурсу есть возможность получить список сохраненных и используемых шаблонов в контейнере Яндекс Тег Менеджера.

Получение списка шаблонов контейнера (GET):

Все, что требуется сделать - это запустить еще одну ячейку моей программы и заменить {containerId} на свой собственный идентификатор контейнера ЯТМ.

В методе получения шаблонов контейнера возвращаются не все шаблоны галереи, а только шаблоны, которые уже связаны с конкретным контейнером (используемые/сохраненные внутри него). В отличие от методов списков тегов, триггеров и переменных, здесь фильтрация ориентирована на шаблоны:

• name_filter - строка для фильтрации шаблонов по имени. Возвращает только те шаблоны, в названии которых содержится указанная строка (без учета регистра).
• type - тип шаблона для фильтрации результатов. Если параметр не указан, возвращаются шаблоны всех типов. Тип шаблона, определяющий его назначение (tag - шаблон для создания тега, который выполняет действия на странице; variable - шаблон для создания переменной, которая хранит или вычисляет значения);
• visibility_filter - фильтр видимости шаблонов в интерфейсе Яндекс Тег Менеджера (all - все шаблоны, visible - только видимые шаблоны, hidden - только скрытые шаблоны).

В объекте SimpleLinkedEntityUsersTemplate содержатся сведения о шаблоне в контексте контейнера (метаданные, статус, видимость, связи):

• saved - флаг, указывающий, что шаблон добавлен в список сохраненных шаблонов пользователя для быстрого доступа;
• published - флаг, указывающий, что шаблон опубликован в галерее шаблонов и доступен другим пользователям;
• container_id - идентификатор контейнера/пространства, в контексте которого виден шаблон;
• template_id - тот же ID шаблона;
• name - название шаблона;
• author - автор шаблона;
• create_time - дата и время создания данной версии шаблона в формате ISO 8601;
• update_time - дата и время последнего обновления данной версии шаблона в формате ISO 8601;
• status - статус объекта (active/deleted);
• type - тип шаблона (tag или variable);
• publicity - уровень видимости (PRIVATE/PUBLIC/YANDEX);
• hidden - скрыт ли в интерфейсе;
• definition_type - тип происхождения (обычно пользовательский user).

Детальные данные версии шаблона находятся во вложенном объекте data (UsersTemplateVersion):

• allowed - флаг, указывающий, разрешено ли использовать данный шаблон в текущем контейнере. Некоторые шаблоны могут быть недоступны в зависимости от настроек контейнера;
• template_id - тот же ID шаблона;
• template_version - номер версии, растет при изменениях;
• description - подробное описание конкретной версии шаблона. Используется для пояснения назначения версии шаблона, изменений, внесенных относительно предыдущих версий, или других важных деталей, которые могут быть полезны пользователям при выборе подходящей версии шаблона;
• documentation_link - ссылка на документацию;
• main_page_link - URL-адрес главной страницы сервиса, с которым интегрируется шаблон;
• email - адрес электронной почты для связи с разработчиками шаблона или службой поддержки;
• changes - краткое описание изменений, внесенных в текущую версию шаблона по сравнению с предыдущими версиями;
• create_time - дата и время создания данной версии шаблона в формате ISO 8601;
• update_time - дата и время последнего обновления данной версии шаблона в формате ISO 8601;
• code - исходный код шаблона, написанный на изолированном JavaScript. Определяет функциональность шаблона при его использовании на сайте;
• validation_features - правила валидации/проверок для шаблона.
• status - статус версии шаблона в системе Яндекс Тег Менеджер.

Статусы версии шаблона:

• draft - черновик (версия в разработке);
• on_moderation - на модерации (версия отправлена на проверку модераторам);
• moderation_failed - модерация провалилась (версия не прошла проверку модераторами);
• outdated - устаревшая версия (существует более новая версия шаблона);
• latest - последняя версия (актуальная версия шаблона).

СКАЧАТЬ ПРОГРАММУ