Управление через агента
Обновлено
Общие условия
Четыре пишущих инструмента находятся в группе «Управление». Для вызова нужны соответствующее право MCP и OAuth-токен Яндекса с metrika:write.
Каждый инструмент проверяет confirm: true. Без подтверждения возвращается ok: false, error_code: confirm_required; запрос изменения не отправляется. Плагин проверяет аргумент вызова: отдельного окна подтверждения он не создаёт.
Для целей и фильтров действует счётчик по умолчанию, если не передан counter_id. Перед изменением попросите агента показать номер и сайт счётчика.
Создать счётчик
metrika_create_counter создаёт новый счётчик.
| Параметр | Назначение |
|---|---|
name |
Обязательное название счётчика. |
site |
Обязательный домен, например example.com. Схема и путь удаляются перед отправкой. |
timezone |
Необязательный часовой пояс, например Europe/Moscow. Если не задан, параметр в API не отправляется. |
webvisor |
При true запрашивает включение Вебвизора. По умолчанию не включается этим вызовом. |
confirm |
Для выполнения требуется true. |
После создания инструмент возвращает номер счётчика. Установите его код на сайт отдельно и при необходимости выберите новый счётчик в настройках плагина. Счётчик по умолчанию автоматически не меняется.
Подготовь создание счётчика «Магазин» для example.com
с часовым поясом Europe/Moscow. Сначала покажи параметры.Создать цель
metrika_create_goal поддерживает два типа: url — посещение страницы, action — JavaScript-событие.
| Параметр | Назначение |
|---|---|
counter_id |
Необязательный номер счётчика. |
name |
Обязательное название цели. |
goal_type |
Обязательный тип: url или action. |
condition |
Одно условие: адрес или его часть для url, идентификатор события для action. |
conditions |
Список условий, объединённых как «или». Если непустой список передан, он имеет приоритет над condition. Нужен хотя бы один непустой вариант. |
operator |
Для url: contain (по умолчанию), exact, start, regexp. Для action всегда применяется exact. |
default_price |
Необязательная ценность достижения в валюте счётчика. Передаётся в API только при значении больше нуля. |
confirm |
Для выполнения требуется true. |
Для action сайт должен отправлять событие ym(<номер счётчика>, "reachGoal", "<идентификатор>"). Инструмент создаёт цель в Метрике, но не добавляет этот вызов в код сайта. Составные и специальные типы целей инструментом не создаются.
Подготовь цель «Заявка отправлена» типа JavaScript-событие
с идентификатором lead_sent. Покажи счётчик и параметры перед созданием.Удалить цель
metrika_delete_goal требует goal_id, goal_name и confirm: true; counter_id необязателен.
Сначала инструмент запрашивает цель из Метрики и точно сравнивает её текущее название с goal_name. При несовпадении возвращается name_mismatch, удаление не выполняется. Регистр и текст названия должны совпасть.
Удаление необратимо: согласно описанию операции в плагине, статистика по цели исчезает из отчётов за всё время. Перед подтверждением проверьте цель через metrika_get_goals и её достижения через metrika_get_goal_conversions.
Создать фильтр визитов
metrika_create_filter добавляет фильтр счётчика, влияющий на сбор статистики. Это отдельная операция от filters в произвольном отчёте: фильтр отчёта только отбирает данные для конкретного запроса.
| Параметр | Назначение |
|---|---|
counter_id |
Необязательный номер счётчика. |
field |
Обязательное поле: title — заголовок страницы, url — адрес, client_ip — IP-адрес. |
action |
Обязательное действие: exclude — не учитывать такие визиты, include — учитывать только их. Передавайте явно. |
operator |
contain — содержит (по умолчанию), equal — равно, start — начинается с, regexp — регулярное выражение. |
value |
Обязательное непустое значение для сравнения. |
confirm |
Для выполнения требуется true. |
Фильтра по User-Agent или источнику трафика среди поддерживаемых полей нет. После создания проверьте возвращённый status и настройку счётчика через metrika_get_counter_setup.
Подготовь фильтр, исключающий мои визиты по IP 192.0.2.10:
поле client_ip, оператор equal, действие exclude.
Покажи параметры и дождись моего подтверждения.Адрес в примере условный: замените его нужным IP. Изменение и удаление существующих фильтров выполняются вне этого плагина.