Форматы входных данных и результата

Формат входных данных

API Яндекс Тег Менеджера работает в режиме чтения и поддерживает только HTTP-метод GET.

Входные данные передаются в параметрах запроса URL. Входные структуры совпадают с выходными структурами GET-методов соответствующих ресурсов.

Формат результата

API возвращает ответы в кодировке UTF-8. Ответы имеют формат JSON.

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

GET https://api.ytm.yandex.net/ytm/management/v1/container/{containerId}/tags

Пример:

GET /ytm/management/v1/container/{containerId}/tags HTTP/1.1
Host: https://api.ytm.yandex.net
Authorization: OAuth <access_token>
Content-Type: application/json
Content-Length: 127

{
  "tags": [
    {
      "container_id": 0,
      "container_version": 0,
      "container_version_type": "PRODUCTION",
      "name": "string",
      "create_time": "2025-09-01T08:53:08.790Z",
      "update_time": "2025-09-01T08:53:08.790Z",
      "tag_id": 0,
      "type": "template",
      "tag_priority": 0,
      "triggers": [
        0
      ],
      "status": "active",
      "data": {
        "user_provided_values": [
          {
            "type": "text_input",
            "data_type": "any",
            "required": true,
            "parameter_id": 0
          },
          {
            "type": "text_input",
            "data_type": "any",
            "required": true,
            "parameter_id": 0,
            "value": "string",
            "raw_value": "string"
          }
        ],
        "allowed": true,
        "template_id": "string"
      },
      "original_tag_id": 0,
      "updated_by": "string",
      "links_number": 0,
      "tags_links": [
        "string"
      ],
      "triggers_links": [
        "string"
      ],
      "variables_links": [
        "string"
      ]
    }
  ],
  "total": 0
}

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

GET https://api.ytm.yandex.net/ytm/management/v1/container/{containerId}/tags

GET https://api.ytm.yandex.net/ytm/management/v1/container/{containerId}/tags?pretty=1

При успешном выполнении GET-методов API возвращает HTTP-статус с кодом 200. Если HTTP-статус содержит другой код, запрос не выполнен.

Предыдущая
Следующая