Использование¶
Форма команды¶
Глобальные опции идут ДО группы:
yac --token X --output table segments list # ✓ правильно
yac segments list --output table # ✗ --output не опция команды list
Глобальные опции¶
| Опция | Env | Значение | По умолчанию | Назначение |
|---|---|---|---|---|
--token |
YANDEX_AUDIENCE_TOKEN |
строка | — | OAuth-токен Яндекса |
--base-url |
YANDEX_AUDIENCE_BASE_URL |
URL | https://api-audience.yandex.ru |
Базовый URL API (тесты/прокси) |
-o, --output |
— | json | table |
json |
Формат вывода |
--pretty |
— | флаг | выкл | Запрашивать pretty-ответ у API (?pretty=1) |
--version |
— | флаг | — | Версия CLI |
Форматы вывода¶
yac segments list # JSON (по умолчанию), отформатированный
yac --output table segments list # таблица (rich)
yac -o table pixels list
В режиме table типичные ответы ({"segments":[...]}, {"pixels":[...]}) приводятся к таблице;
если данные не табличные — выводится JSON.
Справка¶
yac --help # группы и глобальные опции
yac segments --help # команды группы segments
yac segments list --help # аргументы и опции конкретной команды
Опция --data (JSON-тело)¶
Команды создания/изменения принимают тело запроса через --data в трёх формах:
| Форма | Пример | Что делает |
|---|---|---|
| Строка JSON | --data '{"name":"x"}' |
парсит строку напрямую |
@файл |
--data @segment.json |
читает JSON из файла (UTF-8) |
- (stdin) |
... \| yac ... --data - |
читает JSON из стандартного ввода |
Обёртка добавляется автоматически¶
В --data передаётся внутренний объект, а обёртку {"segment": …} / {"pixel": …} /
{"grant": …} добавляет сам CLI. То есть пишете так:
yac segments create-geo --data '{"name":"гео","geo_segment_type":1,"radius":1000,"points":[{"latitude":55.7558,"longitude":37.6173}],"times_quantity":1,"period_length":1}'
а на API уходит {"segment": {"name":"гео", …}}.
Гео-сегменты
Для create-geo и create-geo-polygon поле geo_segment_type — число (1 — окружность,
2 — полигон), не строка. У окружности radius задаётся на верхнем уровне объекта, точки — в
массиве points. У полигона контур (polygons[].points) должен быть замкнут (первая точка
равна последней) и небольшой площади.
Коды возврата¶
| Код | Значение |
|---|---|
0 |
успех |
1 |
ошибка API или конфигурации (выводится как Ошибка: …, без traceback) |
Ошибки API приходят в виде Ошибка: HTTP <код>: <сообщение>. Превышение квот (HTTP 429)
сообщается отдельно с напоминанием о лимитах (30 req/s по IP, 5000 req/day по логину;
запись — 10/мин, 100/час, 500/день).