Введение
API сервиса Яндекс Тег Менеджер позволяет:
- Получать информацию о тегах.
- Получать информацию о триггерах.
- Получать информацию о переменных.
- Использовать шаблоны.
Для использования API Яндекс Тег Менеджера необходима авторизация с помощью OAuth-токена. Авторизационный токен необходимо передавать в каждом запросе к API.
Структура API
API содержит следующие разделы:
- Просмотр тегов — позволяет получать список тегов и информацию о конкретных тегах.
- Просмотр триггеров — позволяет получать информацию о триггерах и условиях их срабатывания.
- Просмотр переменных — позволяет получать данные о переменных, используемых в тегах и триггерах.
- Использование шаблонов — позволяет получать список публичных шаблонов из галереи.
Версионирование
Все разделы API Яндекс Тег Менеджера поддерживают версионирование. Каждая версия имеет уникальный идентификатор (например, v1, v2 и т.д.). При выходе новой версии предыдущие продолжают работать для обеспечения обратной совместимости.
Рекомендации по использованию версий:
- Если вы только начинаете работу с API, используйте последнюю доступную версию.
- Если вы используете старую версию, постепенно переходите на новую, так как поддержка устаревших версий ограничена по времени.
При формировании запроса к API всегда указывайте версию, с которой вы хотите работать.
Примеры запросов:
https://api.ytm.yandex.net/ytm/management/v1/...
https://api.ytm.yandex.net/ytm/management/v1/...
Ресурсы
API Яндекс Тег Менеджера построен по принципам REST (Representational State Transfer).
Все сущности, доступные для получения информации через API, представлены в виде ресурсов: теги, триггеры, переменные и шаблоны.
Ресурс — это целостная часть системы, к которой можно применять определенные HTTP-методы:
Примечание
Данный режим API поддерживает только HTTP-метод GET.
- GET — читать содержимое и текущее состояние ресурса.
У каждого ресурса есть свой уникальный URL. Все действия выполняются соответствующими методами протокола HTTPS на URL'ы ресурсов.
Пример:
- Для получения списка тегов отправьте GET-запрос на URL списка тегов.