Direct CLI

English | Русский

Command-line interface for the Yandex Direct API.

Installation

pip install direct-cli

Мастер кампаний (Campaign Wizard) — browser-only

Мастер кампаний has no Yandex Direct API surface at all — it only exists in the web interface, and must not be confused with UNIFIED_CAMPAIGN (an unrelated v5 API campaign type already supported by campaigns add/get --type unified_campaign). direct masters list / direct masters get <ids> read it by decrypting your existing Chrome cookies for yandex.ru and injecting them into a Playwright-driven browser — no separate login. Only those cookies are ever read; the rest of your Chrome profile is never touched. On macOS the cookie key lives in your login Keychain, so the first run shows a one-time system permission dialog — click Allow. Linux is supported when Chrome uses its basic (non-keyring) password store; Windows isn't supported yet. Requires the optional browser extra:

pip install "direct-cli[browser]"
playwright install chromium
direct masters list
direct masters list --status archived
direct masters get 72349978
direct masters suspend 72349978
direct masters resume 72349978
direct masters archive 72349978
direct masters delete 713337891
direct masters delete 713337891 --yes
direct masters update 72349978 --weekly-budget 95000
direct masters update 72349978 --promotion-goal max-clicks --no-directs-helps
direct masters update 72349978 --name "Мастер ИЖ Источник Жизни (тёплый)"
direct masters update 72349978 --headline "2=Новый заголовок" --text "1=Новый текст"
direct masters update 72349978 --image "2=/path/to/banner.png"
direct masters adimages get 72349978
direct masters adimages add 72349978 --image-file /path/to/a.png --image-file /path/to/b.png
direct masters adimages delete 72349978 --position 2
direct masters adimages delete 72349978 --all
direct masters adimages set 72349978 --image-file /path/to/a.png --image-file /path/to/b.png
direct masters add https://example.com/ --headline "Заголовок 1" --headline "Заголовок 2" --text "Текст объявления" --region Москва --add-target-action "236386933=150" --weekly-budget 50000 --draft
direct masters add https://example.com/ --headline "Заголовок 1" --text "Текст объявления" --region-id 213 --add-target-action "236386933=150" --weekly-budget 50000 --draft
direct masters copy 72349978
direct masters copy 72349978 --launch

masters list filters by status with --status (not-archived/active/stopped/archived/all, default not-archived). It always reads the logged-in browser session's own account — there is no --login/agency support for managed clients.

masters add creates a new Мастер кампаний. Besides --headline/--text and one of --region/--region-id, it requires --add-target-action ("goal_id=price", repeatable — the same flag name and syntax as masters update --add-target-action) and --weekly-budget: Yandex's create form refuses to submit without at least one Яндекс Метрика conversion goal, or without a weekly budget, and refuses silently in both cases — both terminal buttons keep reporting visible/enabled with no aria-disabled, so a goal-less or budget-less attempt would otherwise fail as an unexplained timeout after the whole form was filled in. The goals on offer come from the Metrika counter Yandex auto-discovers from the landing page's domain, so a domain with no counter installed cannot be used here. There is no sandbox and no rollback for Мастер кампаний — double-check every flag before running it for real.

masters update edits a single Мастер кампаний's settings page. It currently covers the simplest scalar fields (Этап A of a larger, staged rollout — see direct_cli/browser/masters.py module docstring), the campaign name, point-replacement of individual headline/ad-text variants (Этап B), and point-replacement of individual images (Этап D): --weekly-budget (integer), --promotion-goal (max-conversions/max-clicks), --directs-helps/--no-directs-helps (auto-apply recommendations), --name (Название кампании), --headline/--text (repeatable "N=text", N is the 1-based variant slot shown on the edit page — 1-5 for headlines, 1-3 for ad text), and --image (repeatable "N=/path/to/file.png", N is the 1-based position in the campaign's current image set). At least one flag is required. The settings page is a single form with one save button — passing only some flags leaves every other field at its current value; it does not send a partial payload to a separate per-field endpoint. Unlike the other fields, --name is edited through a separate header modal, not a plain form input — but it is still persisted only by that same terminal save button, not by the modal's own "Применить".

--headline/--text replace one existing variant at a time rather than the whole variant list — a deliberate departure from this CLI's usual list-field convention (e.g. campaigns update --negative-keywords replaces the entire array in one call). Мастер кампаний has no API, variant sets can be large, and forcing every variant to be re-typed just to fix one typo would defeat the point of a partial update — see direct_cli/browser/masters.py::_set_repeating_value for the full rationale. Writing to a slot that is currently empty is refused (UsageError) — this only edits variants that already exist, it does not add new ones. An empty or whitespace-only replacement (--headline "1=") is refused for the mirror-image reason: blanking a slot would delete a live ad variant, not replace it — use --clear-headline N/--clear-text N (repeatable, 1-based slot number) to actually delete a variant instead, which clicks that slot's own clear button. A slot number cannot be passed to both a set flag and its clear counterpart in the same call, and clearing an already-empty slot is refused too. Adding a brand-new variant beyond the page's fixed slot count is not supported — Yandex's edit page has no "add another" control. Editing variant weights isn't supported either, but for a different reason: Мастер кампаний has no weight/priority UI for these slots at all (confirmed live), unlike ordinary text-campaign ad variants.

--image "N=/path/to/file.png" replaces the image currently at position N of the campaign's image set with a local PNG/JPEG/GIF file, through the edit page's image manager modal. Known limitation — the set is reordered. Yandex has no "replace this slot" primitive for images at all, only "remove from the set" and "add to the set", so a point replacement is composed from the two — and a newly uploaded image is always appended to the END of the set (confirmed live), never inserted at the freed position. Replacing position 2 of [A, B, C, D] therefore yields [A, C, D, NEW], not [A, NEW, C, D]. The flag's semantics are "replace the image that is currently at position N" (which one to drop), not "put the new image at position N". This has no effect on ad delivery — Yandex rotates images by performance regardless of their order in the set. Unlike headlines/texts there is no fixed slot count: the upper bound for N is whatever the campaign actually has (up to Yandex's cap of 5), read fresh from the page, and a campaign with no images at all is a legitimate state that --image refuses with its own explicit error rather than a generic "out of range". Nonexistent paths and extensions Yandex won't accept are rejected before any browser opens. --image only replaces an existing image one at a time — for adding beyond the current set, deleting without a replacement, or replacing the whole set at once, use masters adimages below. Because both the removal and the upload happen inside the same open modal, any failure before Save leaves the campaign's saved image set untouched.

masters adimages get/add/delete/set is the full CRUD counterpart to --image, mirroring direct adimages get/add/delete's vocabulary (the API-side ad-image group) for a campaign's whole image set. Unlike --image, an empty image set is a completely normal state on both ends here — a campaign can start with zero images (adimages add works from an empty set), and every image can be deleted (adimages delete --all), exactly like ad images on a text ad via the API. adimages get is read-only and never saves. adimages add --image-file PATH (repeatable) appends files, refusing if the campaign's current count plus the new files would exceed Yandex's cap of 5. adimages delete removes images addressed by --position (1-based, as shown by adimages get), --content-id, or --all; --all on an already-empty set is an idempotent no-op, but naming a specific position or content ID that doesn't exist is always an error. adimages set --image-file PATH (repeatable) replaces the ENTIRE set — every current image is removed and every given file uploaded inside one modal session; with no --image-file at all it would delete every image, so it requires an explicit --allow-empty to confirm (or use adimages delete --all instead). All three mutating subcommands accept --launch (same draft-publishing semantics as masters update) and, like --image, are NOT idempotent for add/set — a retried call after a partial failure may upload duplicates.

Later fields (sitelinks, audience, Metrika counters/goals, budget adaptation, video) aren't implemented yet.

A DRAFT campaign's edit page has no "Сохранить кампанию" button at all — masters update on a DRAFT saves it via "Сохранить как черновик" by default, keeping it a DRAFT; pass --launch to publish it while saving instead ("Запустить кампанию"). Has no effect on a non-DRAFT campaign.

If you see "Found no Yandex cookies", open https://direct.yandex.ru in Chrome and log in first. If you use a non-default Chrome profile, pass --chrome-profile "Profile 1".

Since this data has no API contract, the parser degrades per-section (a warning, not a hard failure) if Yandex changes the page markup, rather than failing the whole command.

suspend/resume click the campaign overview page's stop/start button and verify the status actually changed before reporting success — never trusting the click alone. They're idempotent (already-suspended/-active is a no-op warning, not an error). There is no --sandbox for these — Мастер кампаний has no API at all, so there is no isolated test copy; any mutation hits your real account.

archive is the closest thing to "delete" a non-DRAFT Мастер кампаний has: a live recon (issue #633) confirmed there is no separate delete action in Yandex's UI for it, only "Архивировать" on the overview page's own menu. masters archive clicks that menu item and verifies the campaign actually shows up as archived in the campaigns grid before reporting success. It is idempotent (already-archived is a no-op warning) but irreversible from this CLI — there is no masters unarchive. Same no---sandbox caveat as suspend/resume above.

delete (issue #782) removes a DRAFT campaign — the one status archive cannot touch, since a DRAFT's overview page has no "⋮" menu at all (issue #660). A DRAFT created by mistake (e.g. via masters add --draft) was previously a one-way door: the only documented route out was launching it, spending real money, purely to gain access to archive. Live recon found the campaigns grid's own row menu (a separate menu from the overview page's) does offer "Удалить" for a DRAFT row — masters delete uses that instead. Refuses anything but DRAFT with a clear error pointing at masters archive. Unlike every other masters mutation, Yandex shows no confirmation dialog before deleting — the campaign is gone the instant the click lands — so this command always asks for its own confirmation first: interactively by default, or pass --yes to skip the prompt non-interactively. Same no---sandbox caveat as suspend/resume above. The campaigns grid is a virtualized SPA (#639/#671): delete locates the row's DOM node to click its menu, and a row that isn't currently rendered in the grid's viewport is simply absent from the DOM, not just off-screen. delete drives the grid's own internal scroll container programmatically until the target row appears (issue #791, live-verified against a DRAFT placed outside the initial ~10-row render window), so an older DRAFT buried under many other campaigns is reached the same as a just-created one.

add creates a brand-new "Конверсии и трафик" Мастер кампаний by driving the same create wizard a human uses. It is NOT idempotent — running it twice with the same arguments creates a second campaign, not an update to the first, since Мастер кампаний has no API-level duplicate detection the way campaigns add does. --headline/--text are required (repeat the flag for multiple values): even though Yandex's own wizard can auto-generate headlines/texts by scanning the landing page, add refuses to silently publish AI-written ad copy you never reviewed — pass the text you actually want published. At least one of --region/--region-id is required (repeat for multiple regions, and they combine): --region takes Yandex's exact region wording as free text, while --region-id (issue #652) takes a numeric RegionId and resolves it to the canonical name via the GeoRegions dictionary (direct dictionaries get-geo-regions) — use --region-id to avoid guessing the widget's exact text. Unlike the rest of masters, resolving --region-id requires valid Yandex Direct API credentials (same chain as any other command). By default the campaign launches immediately; pass --draft to save it as a draft instead (Сохранить как черновик) without going live. There is no --sandbox for this command either — verify with --draft first and check the result in the web UI before launching for real.

copy clones an existing Мастер кампаний via the overview page's "⋮" menu → "Клонировать" — the same action a human uses in the web UI. Yandex pre-fills the new campaign from the source's headlines, texts, images, budget, and display region verbatim, which sidesteps the region text-matching issues add --region/--region-id can hit (issues #652/#656/#657) since nothing is retyped or re-matched. Nothing on the copy is renamed or edited beyond what Yandex itself does (it appends " — N" to the name) — this command is intentionally a 1:1 mirror of the web UI's clone action; use masters update afterwards for any further changes. Not idempotent, same as add: running it twice creates a SECOND copy, not an update to the first. By default the copy is saved as a draft (--draft); pass --launch to launch it immediately in production instead. Same no---sandbox caveat as add.

Browser session (optional but recommended): direct masters decrypts your Chrome cookies fresh on every call by default, which means a Keychain prompt every time on macOS. Run direct playwright login once to decrypt and save a reusable session (~/.direct-cli/playwright/session.json, 0600) — subsequent direct masters calls use it automatically and skip the Keychain round-trip. If something in the pipeline is broken (playwright not installed, wrong Chrome profile, expired session), direct playwright doctor reports the full chain of checks without logging in or writing anything.

Keychain-free alternative: direct masters login opens a visible browser window on a persistent Chromium profile owned by the CLI (~/.direct-cli/chrome-profile/) — log in by hand once via Yandex Passport, and the command exits once the session is confirmed. This never touches your real Chrome profile or the macOS Keychain at all, so it works identically on macOS/Linux/Windows; the cost is a one-time manual login instead of a transparent cookie copy. When this profile exists, direct masters prefers it automatically over the saved playwright login session. It's interactive (blocks for up to --timeout seconds, default 300, waiting for you to sign in), so it can't run unattended. Run direct masters logout to delete the profile and revoke the on-disk session (a no-op warning, not an error, if none exists).

Configuration

Create a .env file in your working directory:

YANDEX_DIRECT_TOKEN=your_access_token
YANDEX_DIRECT_LOGIN=your_yandex_login

Or pass credentials directly per command:

direct --token YOUR_TOKEN --login YOUR_LOGIN campaigns get

Use profile-specific credentials from .env:

YANDEX_DIRECT_TOKEN_AGENCY1=token-1
YANDEX_DIRECT_LOGIN_AGENCY1=client-login-1
YANDEX_DIRECT_TOKEN_AGENCY2=token-2
YANDEX_DIRECT_LOGIN_AGENCY2=client-login-2

OAuth and profile commands:

direct auth login
direct auth login --profile agency1
direct auth login --profile agency1 --format json
direct auth login --code abc123 --profile agency1
printf '%s\n' abc123 | direct auth login --code - --profile agency1
direct auth list
direct auth use --profile agency1
direct auth status --profile agency1
direct --profile agency1 campaigns get

Notes:

• Legacy profile environment variable is not used.
• Select credentials with --profile.
• --login remains Direct client login.
• Authorization is performed via direct auth login.
• OAuth profiles store refresh tokens and refresh access tokens automatically.
• In a non-interactive shell, run direct auth login --profile NAME first, then finish with direct auth login --code - --profile NAME and pass the browser code on stdin.
• direct auth login --code CODE --profile NAME remains supported for compatibility, but automation should use --code - to avoid exposing the code in process arguments.
• If the first non-interactive step includes --client-secret, the secret is remembered for the matching completion step.
• If a profile already stores a confidential OAuth client, direct auth login --code CODE --profile NAME reuses the saved client_id and client_secret.
• direct auth login --oauth-token TOKEN is a manual access-token import and does not auto-refresh.
• After a successful interactive login, Direct CLI asks whether to save the access token and login to the current working directory .env; non-interactive login flows do not prompt.
• Alias auth_login is not supported.

Credential resolution priority:

Direct CLI automatically loads only the .env file from the current working directory, i.e. the directory where you run direct. It does not search for .env from the installed package or source-code location. Without an explicit --profile, base YANDEX_DIRECT_TOKEN / YANDEX_DIRECT_LOGIN from env or cwd .env win over the active OAuth profile. With explicit --profile, Direct CLI uses only that profile's OAuth/profile-env credentials and does not fall back to base YANDEX_DIRECT_LOGIN; this prevents mixing accounts. direct auth status without --profile reports the effective credential source; with --profile it reports that profile.

Tests follow the safe credential order. Live-API test suites (e.g. tests/test_v4_live_contracts.py) read YANDEX_DIRECT_TOKEN / YANDEX_DIRECT_LOGIN from the environment first, only then fall back to the active direct auth profile, and skip the test if neither is set. This prevents a developer machine with an active profile from silently hitting production on a plain pytest invocation. See CLAUDE.md for the contract.

Install with pip install direct-cli, then run commands with direct. Invoking the deprecated direct-cli entrypoint exits with use direct instead of direct-cli.

Quick Start: Check Balance

Yandex removed the legacy v4 GetBalance method. Direct CLI uses the v4 Live AccountManagement method with Action=Get for direct balance, returning money fields such as Amount, AmountAvailableForTransfer, and Currency.

direct balance
direct balance --logins client-login,other-client --format table
direct balance --logins client-login --dry-run

Global Options

Help text is shown in Russian by default. Switch to English with direct --locale en ... or export YANDEX_DIRECT_CLI_LOCALE=en. For example, direct v4finance --help shows the financial master-token setup steps using the locale-appropriate Yandex Direct UI labels.

V4 Live Goals

direct v4goals get-stat-goals --campaign-ids 123,456
direct v4goals get-retargeting-goals --campaign-ids 123,456 --format table
direct v4goals get-stat-goals --campaign-ids 123 --dry-run

V4 Live Tags

Campaign tags are managed as {TagID, Tag} pairs. Use TagID=0 to create a new campaign tag. Banner/ad tags are assigned by campaign tag IDs. Update methods replace the full tag list for the target campaign or banner, so pass existing tags again if they must remain assigned. Ad group tags are filter-only through direct adgroups get --tag-ids/--tags; this release does not add ad group tag mutation commands.

direct v4tags get-campaigns --campaign-ids 3193279,1634563
direct v4tags get-banners --banner-ids 2571700,2571745
direct v4tags get-banners --campaign-ids 3193279
direct v4tags update-campaigns --campaign-id 3193279 --tag 0=akapulko --tag 16590=orange --dry-run
direct v4tags update-banners --banner-ids 2571700,2571745 --tag-ids 16590,16734 --dry-run
direct v4tags update-banners --banner-ids 2571700 --clear-tags --dry-run

V4 Live Events

direct v4events get-events-log --from 2026-04-14T00:00:00 --to 2026-04-15T00:00:00
direct v4events get-events-log --from 2026-04-14T00:00:00 --to 2026-04-15T00:00:00 --currency RUB --limit 100 --offset 0 --format table
direct v4events get-events-log --from 2026-04-14T00:00:00 --to 2026-04-15T00:00:00 --last-event-only Yes --with-text-description Yes --filter-campaign-ids 123,456 --filter-event-type MoneyOut,MoneyIn

V4 Live Wordstat Reports

Wordstat reports are asynchronous. Direct CLI makes exactly one API call per command and does not poll automatically; repeat list-reports or get-report yourself until the report is ready.

direct v4wordstat create-report --phrases "buy laptop,buy desktop" --geo-ids 213
direct v4wordstat list-reports --format table
direct v4wordstat get-report --report-id 123 --format table
direct v4wordstat delete-report --report-id 123

V4 Live Keyword Suggestions

get-suggestion returns up to 20 related phrases for the seed phrases. Repeat --keyword for multiple seeds. The method consumes API points.

direct v4keywords get-suggestion --keyword холодильник --keyword камера
direct v4keywords get-suggestion --keyword "buy laptop" --format table
direct v4keywords get-suggestion --keyword холодильник --dry-run

V4 Live Ad-Image Associations

AdImageAssociation is exposed as two typed commands. get reads ad-to-image associations via an optional selection filter (an empty filter returns up to 10000 associations). set attaches or detaches images: --association AD_ID=HASH attaches an image, --association AD_ID (no hash) detaches the current image (max 10000 associations per call).

direct v4adimage get --ad-ids 123,456 --status-moderate Yes --limit 20
direct v4adimage get --campaign-ids 789 --format table
direct v4adimage set --association 123=abc123hash --association 456 --dry-run

V4 Live Budget Forecasts

Budget forecasts are asynchronous. Direct CLI makes exactly one API call per command and does not poll automatically; repeat list or get yourself until the forecast is ready.

direct v4forecast create --phrases "buy laptop,buy desktop" --geo-ids 213 --currency RUB
direct v4forecast create --phrases "buy laptop" --geo-ids 213 --auction-bids Yes --common-minus-words "used,broken"
direct v4forecast list --format table
direct v4forecast get --forecast-id 123 --format table
direct v4forecast delete --forecast-id 123

V4 Live Finance

Finance methods require an extra financial token for money operations. In the Yandex Direct web UI, open Tools -> API -> Financial operations, enable the financial operations checkbox, click Save, then issue the master token on the same Financial operations page and confirm by SMS. Direct CLI can compute the per-request token from --master-token, --operation-num, and --finance-login; alternatively pass a precomputed token with --finance-token. Environment variables are YANDEX_DIRECT_MASTER_TOKEN, YANDEX_DIRECT_FINANCE_LOGIN, YANDEX_DIRECT_FINANCE_TOKEN, and YANDEX_DIRECT_OPERATION_NUM. transfer-money, pay-campaigns, and pay-campaigns-by-card are dry-run-only in this release and always require --dry-run; create-invoice can be sent live when --dry-run is omitted. Dry-run output masks the financial token. pay-campaigns-by-card has an undocumented request shape; its dry-run body mirrors the documented pay-campaigns shape as a best-effort preview.

⚠ Finance commands have not been tested against the live API. Treat the request shapes as best-effort and always verify with --dry-run before sending anything that runs live (create-invoice).

direct v4finance get-clients-units --logins client-login,other-client --format table
direct v4finance get-credit-limits --master-token MASTER_TOKEN --operation-num 123 --finance-login agency-login
direct v4finance create-invoice --payment 123=100.50 --payment 456=25 --currency RUB --master-token MASTER_TOKEN --operation-num 124 --finance-login agency-login --dry-run
direct v4finance check-payment --custom-transaction-id A123456789012345678901234567890B
direct v4finance transfer-money --from-campaign-id 123 --to-campaign-id 456 --amount 100.50 --currency RUB --master-token MASTER_TOKEN --operation-num 123 --finance-login agency-login --dry-run
direct v4finance pay-campaigns --campaign-ids 123,456 --amount 100.50 --contract-id CONTRACT_ID --pay-method Bank --currency RUB --master-token MASTER_TOKEN --operation-num 123 --finance-login agency-login --dry-run
direct v4finance pay-campaigns-by-card --campaign-ids 123,456 --amount 100.50 --currency RUB --master-token MASTER_TOKEN --operation-num 128 --finance-login agency-login --dry-run

V4 Live Shared Account

EnableSharedAccount accepts one client Login (agencies only). AccountManagement exposes the five official v4 Live actions: Get, Update, Deposit, Invoice, and TransferMoney. Get is read-only and runs against production without --dry-run. Update, Deposit, Invoice, and TransferMoney are mutations: they require --dry-run in production and can be sent live only with top-level --sandbox. Deposit, Invoice, and TransferMoney are financial operations that need --finance-token (or --master-token + --operation-num + --finance-login); dry-run output masks the financial token.

direct v4account enable-shared-account --client-login client-login --dry-run
direct v4account account-management --action Get
direct v4account account-management --action Get --logins client-a,client-b
direct v4account account-management --action Get --account-ids 1327944,1327945
direct v4account account-management --action Update --account-id 1327944 --day-budget 100.50 --spend-mode Default --money-in-sms Yes --money-out-sms No --email ops@example.com --money-warning-value 25 --dry-run
direct v4account account-management --action Deposit --payment 1327944=100.50 --currency RUB --master-token MASTER_TOKEN --operation-num 124 --finance-login agency-login --dry-run
direct v4account account-management --action Deposit --payment 1327944=100.50 --currency RUB --origin Overdraft --contract CONTRACT_ID --master-token MASTER_TOKEN --operation-num 125 --finance-login agency-login --dry-run
direct v4account account-management --action Invoice --payment 1327944=100.50 --currency RUB --master-token MASTER_TOKEN --operation-num 126 --finance-login agency-login --dry-run
direct v4account account-management --action TransferMoney --from-account-id 1327944 --to-account-id 1327945 --amount 50.00 --currency RUB --master-token MASTER_TOKEN --operation-num 127 --finance-login agency-login --dry-run
direct --sandbox v4account enable-shared-account --client-login client-login

V4 Live — Intentionally Omitted Methods

Some v4 Live methods present in the API registry are intentionally not exposed as CLI commands:

• DeleteReport / DeleteOfflineReport — disabled by Yandex (the official docs list them under "Отключенные методы" / "Метод отключен. Используйте API версии 5"). Use the v5 reports API instead.
• PingAPI, PingAPI_X, GetVersion, GetAvailableVersions — service diagnostics / version probes with no documented request shape; not useful as user-facing CLI commands.
• PayCampaignsByCard is exposed but dry-run-only (undocumented, financially sensitive — see V4 Live Finance above).

CLI Convention

The current CLI convention is defined as follows.

CLI Contract

The canonical command shape is:

direct <group> <command> [flags]

Naming rules:

• group:

  • lowercase ASCII only
  • no underscores
  • multiword groups are concatenated
  • examples: dynamicads, smartadtargets, negativekeywordsharedsets

• command:

  • lowercase only
  • multiword commands use kebab-case
  • examples: get, set-bids, check-campaigns, has-search-volume

The direct executable defines the public naming contract. The direct-cli package name and deprecated shim do not define canonical CLI names. tapi-yandex-direct may influence the internal transport layer, but it does not define canonical CLI names.

The current policy is canonical-only. Historical aliases are not preserved in the runtime CLI by default. If compatibility is ever needed, an alias must be added as an explicit exception with the concrete legacy syntax that still has to be supported.

Removed Legacy Names

Input Rules

• All user-facing input must be passed only through typed CLI flags.
• --json is not part of the public CLI contract.
• User-facing parameters must not be passed through --json.
• The CLI must not accept SelectionCriteria, nested payloads, update payloads, bidding rules, or any other user-facing command input through --json.
• Typed flags and JSON blobs must not be mixed as part of one public command contract.
• If the API requires a complex object, the CLI must expose explicit flags or subcommands instead of forwarding raw JSON.

Command Formatting Rules

• Every canonical CLI command must be written strictly on a single line.
• Multi-line command formatting is not allowed.
• Shell line continuation using \ is forbidden in canonical documentation, help text, tests, and examples.

Allowed:

direct dictionaries get-geo-regions --region-ids 225,187 --fields GeoRegionId,GeoRegionName

Not allowed: splitting a canonical direct ... command over multiple shell lines with \.

Flag Design Rules

• List inputs use comma-separated CLI syntax where appropriate.
• Money and bid values are passed only in micro-rubles, exactly as Yandex Direct API long fields define them. The CLI does not accept decimal currency amounts or convert currency units; values below 100,000 trigger a validation hint suggesting the correct scale.
• Selector fields remain explicit flags, for example:
  • --id
  • --campaign-id
  • --adgroup-id
• Nested API structures must be projected into typed flags instead of blob JSON.
• Help text must not advertise JSON as an alternative input path.

Datetime Rules

• Changes timestamps must include an explicit timezone: YYYY-MM-DDTHH:MM:SSZ or an offset such as YYYY-MM-DDTHH:MM:SS+03:00.
• Other datetime parameters use their method-specific documented format.
• Datetime values must be passed as a single shell token.
• Canonical changes examples should use the Z suffix; explicit offsets are accepted and normalized to UTC.
• Canonical examples must not use quoted space-separated datetime values.

Use:

direct changes check-campaigns --timestamp 2026-04-14T00:00:00Z

Do not use: a changes timestamp without a timezone suffix, or a quoted timestamp that contains a space between the date and time.

Documentation Contract

• README must use only canonical syntax.
• README must use only single-line command examples.
• Canonical examples must not contain --json.
• Help output and tests must enforce the same contract.

Examples

Valid canonical examples:

direct campaigns get --ids 1,2,3
direct changes check-campaigns --timestamp 2026-04-14T00:00:00Z
direct keywordsresearch has-search-volume --keywords "buy laptop,buy desktop"
direct smartadtargets update --id 456 --priority HIGH
direct dynamicads set-bids --id 789 --bid 12500000 --context-bid 9000000 --priority HIGH
direct dictionaries get-geo-regions --name Moscow --region-ids 225,187 --exact-names Москва,Санкт-Петербург --fields GeoRegionId,GeoRegionName

Invalid examples include command lines that pass raw JSON flags, use shell line continuations, omit the timezone suffix from changes datetimes, or quote space-separated datetime values.

Campaigns

# Get campaigns
direct campaigns get
direct campaigns get --status ACTIVE
direct campaigns get --ids 1,2,3 --format table
direct campaigns get --fetch-all --format csv --output campaigns.csv

# Create (use --dry-run to preview the request)
direct campaigns add --name "My Campaign" --start-date 2024-02-01 --type TEXT_CAMPAIGN --budget 1000000000 --setting ADD_METRICA_TAG=YES --search-strategy HIGHEST_POSITION --network-strategy SERVING_OFF --dry-run
direct campaigns add --name "Dynamic Campaign" --start-date 2024-02-01 --type DYNAMIC_TEXT_CAMPAIGN --setting ADD_METRICA_TAG=NO --search-strategy HIGHEST_POSITION --network-strategy SERVING_OFF --dry-run
direct campaigns add --name "Smart Campaign" --start-date 2024-02-01 --type SMART_CAMPAIGN --network-strategy AVERAGE_CPC_PER_FILTER --filter-average-cpc 1000000 --counter-id 123 --dry-run

# CPA strategy (single goal): --goal-id required, --average-cpa / --bid-ceiling are micro-rubles
direct campaigns add --name "CPA Campaign" --start-date 2026-06-01 --type TEXT_CAMPAIGN --search-strategy AVERAGE_CPA --network-strategy SERVING_OFF --goal-id 1234567 --average-cpa 500000000 --bid-ceiling 1000000000 --counter-ids 111,222 --dry-run

# Multi-goal CPA via PriorityGoals (goal_id:value pairs, WSDL PriorityGoalsItem)
direct campaigns add --name "Multi-Goal CPA" --start-date 2026-06-01 --type TEXT_CAMPAIGN --search-strategy AVERAGE_CPA_MULTIPLE_GOALS --network-strategy SERVING_OFF --priority-goals 1234567:80,9876543:20 --bid-ceiling 1000000000 --dry-run

# TextCampaign/UnifiedCampaign/DynamicTextCampaign/SmartCampaign/MobileAppCampaign/CpmBannerCampaign optional controls
direct campaigns add --name "Text Controls" --start-date 2026-06-01 --type TEXT_CAMPAIGN --counter-ids 111,222 --relevant-keywords-budget-percent 40 --relevant-keywords-mode OPTIMAL --attribution-model AUTO --negative-keyword-shared-set-ids 10,11 --dry-run
direct campaigns update --id 12345 --type TEXT_CAMPAIGN --setting ADD_METRICA_TAG=NO --priority-goals 1234567:80:YES --tracking-params "utm_source=direct" --dry-run
direct campaigns add --name "Package Text" --start-date 2026-06-01 --type TEXT_CAMPAIGN --package-strategy-id 700 --package-platform-search-result YES --package-platform-product-gallery YES --package-platform-network NO --dry-run
direct campaigns add --name "Unified Controls" --start-date 2026-06-01 --type UNIFIED_CAMPAIGN --setting ADD_METRICA_TAG=YES --counter-ids 111,222 --tracking-params "utm_source=direct" --attribution-model AUTO --negative-keyword-shared-set-ids 10,11 --dry-run
direct campaigns add --name "Unified Package" --start-date 2026-06-01 --type UNIFIED_CAMPAIGN --package-strategy-id 700 --package-platform-search-result YES --package-platform-product-gallery YES --package-platform-maps NO --package-platform-search-organization-list YES --package-platform-network YES --dry-run
direct campaigns add --name "Dynamic Controls" --start-date 2026-06-01 --type DYNAMIC_TEXT_CAMPAIGN --setting ADD_METRICA_TAG=YES --dynamic-placement-search-results YES --dynamic-placement-product-gallery NO --counter-ids 111,222 --tracking-params "utm_source=direct" --attribution-model AUTO --negative-keyword-shared-set-ids 10,11 --dry-run
direct campaigns update --id 12345 --type DYNAMIC_TEXT_CAMPAIGN --setting ADD_METRICA_TAG=NO --dynamic-placement-search-results NO --priority-goals 1234567:80:YES --tracking-params "utm_source=direct" --dry-run
direct campaigns add --name "Dynamic Package" --start-date 2026-06-01 --type DYNAMIC_TEXT_CAMPAIGN --package-strategy-id 700 --dry-run
direct campaigns add --name "Smart Controls" --start-date 2026-06-01 --type SMART_CAMPAIGN --counter-id 123 --filter-average-cpc 1000000 --setting ADD_TO_FAVORITES=YES --tracking-params "utm_source=direct" --attribution-model AUTO --dry-run
direct campaigns add --name "Smart Package" --start-date 2026-06-01 --type SMART_CAMPAIGN --counter-id 123 --package-strategy-id 700 --package-platform-search YES --package-platform-network NO --dry-run
direct campaigns add --name "Mobile App Controls" --start-date 2026-06-01 --type MOBILE_APP_CAMPAIGN --setting ADD_TO_FAVORITES=YES --negative-keyword-shared-set-ids 10,11 --dry-run
direct campaigns add --name "CPM Banner Controls" --start-date 2026-06-01 --type CPM_BANNER_CAMPAIGN --setting ADD_METRICA_TAG=YES --counter-ids 111,222 --frequency-cap-impressions 5 --frequency-cap-period-days 7 --video-target VIEWS --dry-run
direct campaigns add --name "CPM Banner Strategy" --start-date 2026-06-01 --type CPM_BANNER_CAMPAIGN --network-strategy WB_MAXIMUM_IMPRESSIONS --average-cpm 120 --strategy-spend-limit 1000 --dry-run
direct campaigns update --id 12345 --type CPM_BANNER_CAMPAIGN --frequency-cap-impressions 5 --frequency-cap-period-all --dry-run

# Notification (Sms/Email) and TimeTargeting via typed CLI flags
direct campaigns add --name "Notify+Schedule" --start-date 2026-06-01 --type TEXT_CAMPAIGN --search-strategy HIGHEST_POSITION --network-strategy SERVING_OFF --notification-email ops@example.com --notification-send-warnings YES --time-targeting-schedule 1A0123456789ABCDEFGHIJKL --consider-working-weekends YES --dry-run

# TrackingParams (campaign subtype UTM / tracking query string)
direct campaigns add --name "UTM" --start-date 2026-06-01 --type TEXT_CAMPAIGN --tracking-params "utm_source=direct&utm_campaign={campaign_id}" --dry-run

# Update / lifecycle
direct campaigns update --id 12345 --name "New Name" --status SUSPENDED --budget 100000000 --start-date 2024-02-10 --end-date 2024-03-01
direct campaigns update --id 12345 --type TEXT_CAMPAIGN --tracking-params "utm_source=direct&utm_medium=cpc" --dry-run
direct campaigns suspend --id 12345
direct campaigns resume --id 12345
direct campaigns archive --id 12345
direct campaigns unarchive --id 12345
direct campaigns delete --id 12345

Ad Groups

direct adgroups get --campaign-ids 1,2,3 --limit 50
direct adgroups add --name "Group 1" --campaign-id 12345 --region-ids 1,225 --negative-keywords "repair,used" --tracking-params "utm_source=direct" --dry-run
direct adgroups add --name "Text Feed Group" --campaign-id 12345 --region-ids 1,225 --feed-id 170 --feed-category-ids 10,11 --dry-run
direct adgroups add --name "Dynamic Group" --campaign-id 12345 --type DYNAMIC_TEXT_AD_GROUP --region-ids 1,225 --domain-url example.com --autotargeting-category EXACT=YES --dry-run
direct adgroups add --name "Dynamic Feed Group" --campaign-id 12345 --type DYNAMIC_TEXT_FEED_AD_GROUP --region-ids 1,225 --feed-id 170 --autotargeting-category EXACT=YES --dry-run
direct adgroups add --name "CPM Keywords Group" --campaign-id 12345 --type CPM_BANNER_KEYWORDS_AD_GROUP --region-ids 1,225 --dry-run
direct adgroups add --name "CPM User Profile Group" --campaign-id 12345 --type CPM_BANNER_USER_PROFILE_AD_GROUP --region-ids 1,225 --dry-run
direct adgroups add --name "CPM Video Group" --campaign-id 12345 --type CPM_VIDEO_AD_GROUP --region-ids 1,225 --dry-run
direct adgroups add --name "Smart Group" --campaign-id 12345 --type SMART_AD_GROUP --region-ids 1,225 --feed-id 170 --ad-title-source FEED_NAME --ad-body-source FEED_NAME --dry-run
direct adgroups add --name "Unified Group" --campaign-id 12345 --type UNIFIED_AD_GROUP --region-ids 1,225 --offer-retargeting YES --dry-run
direct adgroups add --name "Mobile App Group" --campaign-id 12345 --type MOBILE_APP_AD_GROUP --region-ids 1,225 --store-url https://apps.apple.com/app/id123456789 --target-device-types DEVICE_TYPE_MOBILE,DEVICE_TYPE_TABLET --target-carrier WI_FI_AND_CELLULAR --target-operating-system-version 14.0 --dry-run
direct adgroups update --id 67890 --negative-keyword-shared-set-ids 10,11 --tracking-params "utm_source=direct"
direct adgroups update --id 67890 --feed-id 170 --feed-category-ids 10,11
direct adgroups update --id 67890 --domain-url example.com --autotargeting-settings-exact YES --autotargeting-settings-without-brands YES --dry-run
direct adgroups update --id 67890 --dynamic-feed --autotargeting-category EXACT=YES --dry-run
direct adgroups update --id 67890 --target-device-types DEVICE_TYPE_TABLET --target-carrier WI_FI_ONLY --target-operating-system-version 13.0
direct adgroups update --id 67890 --ad-title-source FEED_NAME --ad-body-source FEED_DESCRIPTION
direct adgroups update --id 67890 --offer-retargeting NO
direct adgroups suspend --id 67890
direct adgroups resume --id 67890
direct adgroups delete --id 67890

adgroups suspend/adgroups resume are not 1:1 WSDL mirrors: the AdGroups service has no suspend/resume method (only add/get/update/delete). They emulate "pause the group" the way the web UI and Direct Commander do — by resolving the group's ads via ads.get and suspending/resuming them via ads.suspend/ads.resume (issue #573). Two consequences:

• resume cannot tell which ads it paused apart from ads a human suspended by hand earlier — it resumes every ad currently in the group, so a mixed-status group loses any manual suspensions.
• An empty group (or one whose ads no longer exist) prints an empty SuspendResults/ResumeResults with no request sent.

Ads

direct ads get --campaign-ids 1,2,3
direct ads get --adgroup-ids 45678 --format table
direct ads add --adgroup-id 12345 --type TEXT_AD --title "Title" --text "Ad text" --href "https://example.com" --dry-run
direct ads add --adgroup-id 12345 --type TEXT_AD --title "Title" --text "Ad text" --href "https://example.com" --title2 "Second headline" --display-url-path "deals" --mobile YES --vcard-id 111 --sitelink-set-id 222 --turbo-page-id 333 --ad-extensions "444,555" --dry-run
direct ads add --adgroup-id 12345 --type TEXT_AD --title "Title" --text "Ad text" --href "https://example.com" --final-url "https://final.example.com" --video-extension-creative-id 777 --price-extension-price 123450000 --price-extension-price-qualifier FROM --price-extension-price-currency RUB --business-id 777 --prefer-vcard-over-business NO --erir-ad-description "Text ad object" --dry-run
direct ads add --adgroup-id 12345 --type RESPONSIVE_AD --texts "Text one,Text two" --titles "Title one,Title two" --image-hashes hash1,hash2 --video-extension-ids 111,222 --href "https://example.com" --price-extension-price 123450000 --price-extension-price-qualifier FROM --price-extension-price-currency RUB --business-id 777 --erir-ad-description "Responsive ad object" --dry-run
direct ads add --adgroup-id 12345 --type SHOPPING_AD --feed-id 170 --default-texts "Default product text" --sitelink-set-id 222 --ad-extensions "333,444" --business-id 777 --feed-filter-condition "CATEGORY:EQUALS_ANY:shoes|boots" --title-sources NAME,BRAND --text-sources DESCRIPTION --dry-run
direct ads add --adgroup-id 12345 --type LISTING_AD --feed-id 171 --default-texts "Default listing text" --feed-filter-condition "CATEGORY:EQUALS_ANY:appliances" --title-sources TITLE --text-sources DESCRIPTION --dry-run
direct ads add --adgroup-id 12345 --type TEXT_AD_BUILDER_AD --creative-id 123 --href "https://example.com" --turbo-page-id 456 --erir-ad-description "Builder ad object" --dry-run
direct ads add --adgroup-id 12345 --type MOBILE_APP_AD_BUILDER_AD --creative-id 123 --tracking-url "https://track.example.com" --erir-ad-description "Mobile builder ad" --dry-run
direct ads add --adgroup-id 12345 --type CPM_BANNER_AD_BUILDER_AD --creative-id 123 --href "https://example.com" --tracking-pixels "https://pixel.example.com/a,https://pixel.example.com/b" --dry-run
direct ads add --adgroup-id 12345 --type TEXT_IMAGE_AD --image-hash abcdefghijklmnopqrst --href "https://example.com" --turbo-page-id 555 --final-url "https://final.example.com" --erir-ad-description "Image ad object" --dry-run
direct ads add --adgroup-id 12345 --type DYNAMIC_TEXT_AD --text "Dynamic ad text" --image-hash abcdefghijklmnopqrst --vcard-id 111 --sitelink-set-id 222 --ad-extensions "333,444" --dry-run
direct ads add --adgroup-id 12345 --type MOBILE_APP_AD --title "Install app" --text "App promo text" --action INSTALL --tracking-url "https://track.example.com" --mobile-app-feature PRICE=YES --video-extension-creative-id 777 --erir-ad-description "Mobile app object" --dry-run
direct ads add --adgroup-id 12345 --type MOBILE_APP_IMAGE_AD --image-hash abcdefghijklmnopqrst --tracking-url "https://track.example.com" --erir-ad-description "Mobile image ad" --dry-run
direct ads add --adgroup-id 12345 --type SMART_AD_BUILDER_AD --logo-extension-hash logoabcdefghijklmnop --dry-run
direct ads update --id 99999 --type TEXT_AD --title "New Title" --text "New text" --href "https://example.com"
direct ads update --id 99999 --type TEXT_AD --image-hash abcdefghijklmnopqrst
direct ads update --id 99999 --type TEXT_AD --clear-image-hash  # remove the image (AdImageHash: null; TEXT_AD / DYNAMIC_TEXT_AD / MOBILE_APP_AD only)
direct ads update --id 99999 --type TEXT_AD --title2 "New second headline" --vcard-id 222
direct ads update --id 99999 --type TEXT_AD --callouts-add "111,222" --callouts-remove "333"
direct ads update --id 99999 --type TEXT_AD --callouts-set "444,555"
direct ads update --id 99999 --type TEXT_AD --video-extension-creative-id 777 --price-extension-price 123450000 --price-extension-price-qualifier FROM --price-extension-price-currency RUB
direct ads update --id 99999 --type TEXT_AD --final-url "https://final.example.com" --age-label AGE_18 --business-id 777 --prefer-vcard-over-business NO --erir-ad-description "Text ad object"
direct ads update --id 99999 --type DYNAMIC_TEXT_AD --text "Updated dynamic text" --callouts-add "111,222"
direct ads update --id 99999 --type MOBILE_APP_AD --mobile-app-feature PRICE=YES --mobile-app-feature CUSTOMER_RATING=NO --video-extension-creative-id 777 --erir-ad-description "Mobile app object"
direct ads update --id 99999 --type RESPONSIVE_AD --texts "Text one,Text two" --titles "Title one,Title two" --image-hashes hash1,hash2 --video-extension-ids 111,222 --href "https://example.com" --price-extension-price 123450000 --price-extension-price-qualifier FROM --price-extension-price-currency RUB
direct ads update --id 99999 --type TEXT_IMAGE_AD --final-url "https://final.example.com" --erir-ad-description "Image ad object"
direct ads update --id 99999 --type SHOPPING_AD --sitelink-set-id 222 --callouts-set "444,555" --business-id 777 --feed-filter-condition "CATEGORY:EQUALS_ANY:shoes|boots" --title-sources NAME,BRAND --text-sources DESCRIPTION --default-texts "Default product text"
direct ads update --id 99999 --type MOBILE_APP_IMAGE_AD --image-hash abcdefghijklmnopqrst --tracking-url "https://track.example.com" --erir-ad-description "Mobile image ad"
direct ads update --id 99999 --type TEXT_AD_BUILDER_AD --creative-id 123 --creative-erir-ad-description "Creative object" --href "https://example.com" --turbo-page-id 456
direct ads update --id 99999 --type SMART_AD_BUILDER_AD --logo-extension-hash logoabcdefghijklmnop --erir-ad-description "Smart builder ad"
direct ads update --id 99999 --type CPM_BANNER_AD_BUILDER_AD --creative-id 123 --href "https://example.com" --tracking-pixels "https://pixel.example.com/a,https://pixel.example.com/b"
direct ads delete --id 99999

Available TEXT_AD typed flags for ads add / ads update: --title, --text, --href, --image-hash, --clear-image-hash (update only — sets AdImageHash: null; TEXT_AD / DYNAMIC_TEXT_AD / MOBILE_APP_AD only, since TEXT_IMAGE_AD / MOBILE_APP_IMAGE_AD have a non-nillable AdImageHash), --title2, --display-url-path, --vcard-id, --sitelink-set-id, --turbo-page-id, --final-url, --video-extension-creative-id, --price-extension-*, --business-id, --prefer-vcard-over-business, and --erir-ad-description. For ads add, TextAd.PriceExtension requires --price-extension-price, --price-extension-price-qualifier, and --price-extension-price-currency when any price-extension flag is used. ads update additionally exposes --callouts-add, --callouts-remove, and --callouts-set for managing the TextAdUpdateBase.CalloutSetting (ext:AdExtensionSetting) field on an existing ad — --callouts-set replaces the whole callout list and is mutually exclusive with the incremental --callouts-add / --callouts-remove pair. Price-extension values are passed in micro-rubles, matching the Yandex Direct API long-unit format directly. ads update also supports --age-label. --mobile (default NO) and --ad-extensions are ads add-only — TextAdUpdate does not contain Mobile, and on update ad-extensions are managed through the --callouts-* flags above. TEXT_IMAGE_AD additionally accepts --turbo-page-id, --final-url, and --erir-ad-description. DYNAMIC_TEXT_AD add requires --text and supports --image-hash, --vcard-id, --sitelink-set-id, and --ad-extensions; update supports --text, --image-hash, --vcard-id, --sitelink-set-id, and --callouts-*. RESPONSIVE_AD ads add uses --texts and --titles as required comma-separated lists and also requires --href, --business-id, or both. Optional creation flags include --image-hashes, --video-extension-ids, --age-label, --display-url-path, --sitelink-set-id, --ad-extensions, --price-extension-*, and --erir-ad-description. SHOPPING_AD and LISTING_AD ads add require --feed-id and one --default-texts value. Optional creation flags include --sitelink-set-id, --ad-extensions, --business-id, repeatable --feed-filter-condition (OPERAND:OPERATOR:ARG1|ARG2), --title-sources, and --text-sources. Non-SMART AdBuilder add subtypes require --creative-id. TEXT_AD_BUILDER_AD, CPC_VIDEO_AD_BUILDER_AD, CPM_BANNER_AD_BUILDER_AD, and CPM_VIDEO_AD_BUILDER_AD require --href, --turbo-page-id, or both. Mobile app builder subtypes use --tracking-url. CPM builder subtypes also support --tracking-pixels; non-SMART AdBuilder add subtypes support --erir-ad-description. MOBILE_APP_AD add requires --title, --text, and --action; optional add fields include --mobile-app-feature FEATURE=YES|NO, --video-extension-creative-id, and --erir-ad-description. MOBILE_APP_IMAGE_AD add requires --image-hash; add/update support --tracking-url and --erir-ad-description. RESPONSIVE_AD update supports --texts, --titles, --image-hashes, --video-extension-ids, --href, --age-label, --display-url-path, --sitelink-set-id, --callouts-*, --price-extension-*, --business-id, and --erir-ad-description. SHOPPING_AD and LISTING_AD update support --sitelink-set-id, --callouts-*, --business-id, repeatable --feed-filter-condition (OPERAND:OPERATOR:ARG1|ARG2), --title-sources, --text-sources, and --default-texts. MOBILE_APP_IMAGE_AD update supports --image-hash, --tracking-url, and --erir-ad-description. SMART_AD_BUILDER_AD add supports --logo-extension-hash. AdBuilder update subtypes support --creative-id, --creative-erir-ad-description, --erir-ad-description, and subtype-specific --final-url, --href, --turbo-page-id, --tracking-url, and --tracking-pixels. SMART_AD_BUILDER_AD update supports --logo-extension-hash and --erir-ad-description.

Keywords

direct keywords get --campaign-ids 1,2,3
direct keywords add --adgroup-id 12345 --keyword "buy laptop" --bid 10500000 --context-bid 5250000 --user-param-1 segment-a --user-param-2 segment-b --dry-run
direct keywords add --adgroup-id 12345 --keyword "---autotargeting" --autotargeting-search-bid-is-auto YES --priority HIGH --autotargeting-category EXACT=YES --autotargeting-category BROADER=NO --autotargeting-brand-option WITHOUT_BRANDS=YES --dry-run
direct keywords add --adgroup-id 12345 --keyword "---autotargeting" --autotargeting-settings-exact YES --autotargeting-settings-narrow NO --autotargeting-settings-without-brands YES --dry-run
direct keywords update --id 88888 --keyword "updated keyword text"
direct keywords update --id 88888 --autotargeting-category EXACT=YES --autotargeting-category BROADER=NO --autotargeting-brand-option WITHOUT_BRANDS=YES
direct keywords update --id 88888 --autotargeting-settings-broader YES --autotargeting-settings-with-competitors-brand NO
direct keywords delete --id 88888

Batch keyword upload (CLI auto-chunks to the API limit of 10 per request):

# From a JSONL file (one keyword object per line)
direct keywords add --adgroup-id 12345 --from-file keywords.jsonl

# Inline JSON array
direct keywords add --adgroup-id 12345 --keywords-json '[{"Keyword":"buy laptop"},{"Keyword":"buy desktop"}]'

Example keywords.jsonl:

{"Keyword":"buy laptop","UserParam1":"src=ad1"}
{"Keyword":"buy desktop","UserParam2":"src=ad2"}
{"Keyword":"купить ноутбук","AdGroupId":99999}

• Row keys use WSDL CamelCase: Keyword, AdGroupId, Bid, ContextBid, UserParam1, UserParam2.
• Bid and ContextBid are documented Keywords.add fields, but they are strategy-dependent: Bid is only for manual strategies, and ContextBid is only for manual strategies with independent ad-network bid management. For automatic strategies, Yandex ignores these values and returns warning 10160, so omit them from JSONL for auto-strategy / ad-network flows.
• Autotargeting row fields are intentionally not accepted in batch mode; use single-item typed flags such as --autotargeting-search-bid-is-auto, --priority, --autotargeting-category, --autotargeting-brand-option, or --autotargeting-settings-*.
• --adgroup-id provides the default group ID; rows can override it via per-row AdGroupId.
• Each effective row must resolve Keyword and AdGroupId; unknown fields are rejected with the row number.
• API limit: 10 items per keywords.add request — see Yandex Direct docs. The CLI sends as many chunks as needed and merges AddResults.
• API limit: 200 keywords per ad group. The CLI prints a warning if any AdGroupId in the input exceeds it; the API rejects the excess as per-item errors.
• Item-level errors from the API do not abort the batch; the merged output includes successes and per-item errors.
• If a chunk fails with a network-level error mid-batch, already-created Ids are printed to stderr (Partial success before failure) so a retry doesn't duplicate them.
• --dry-run shows the first chunk's payload plus {chunks, totalItems, chunkSize}.

Reports

# Get a report (saved to file)
direct reports get --type CAMPAIGN_PERFORMANCE_REPORT --from 2024-01-01 --to 2024-01-31 --name "January Report" --fields "Date,CampaignId,Clicks,Cost" --format csv --output report.csv
direct reports get --type CUSTOM_REPORT --from 2024-01-01 --to 2024-01-31 --name "Goals Report" --fields "Date,CampaignId,GoalsRoi" --goals 12345,67890 --attribution-models AUTO --format csv --output goals-report.csv

# List available report types
direct reports list-types

Available report types: CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, CUSTOM_REPORT, REACH_AND_FREQUENCY_CAMPAIGN_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT

Other Resources

# Reference dictionaries and changes
direct dictionaries get --names Currencies,GeoRegions
direct dictionaries get-geo-regions --name Moscow --region-ids 225,187 --exact-names Москва,Санкт-Петербург --fields GeoRegionId,GeoRegionName

# Client info
direct clients get --fields ClientId,Login,Currency

# Changes
direct changes check --campaign-ids 1,2,3 --timestamp 2026-04-14T00:00:00Z --fields CampaignIds,AdGroupIds,AdIds,CampaignsStat
direct changes check-campaigns --timestamp 2026-04-14T00:00:00Z
direct changes check-dictionaries

# Keyword research and retargeting
direct keywordsresearch has-search-volume --keywords "buy laptop,buy desktop"
direct retargeting add --name "List A" --description "High intent users" --type AUDIENCE --rule "ALL:12345:30|67890:7" --dry-run
direct retargeting update --id 55 --name "Renamed" --description "Updated note" --rule "ANY:12345:30" --dry-run

# Bids and modifiers
direct bids get --campaign-ids 123 --fields CampaignId,AdGroupId,KeywordId,Bid
direct bids set --keyword-id 123 --bid 15000000
direct bids set --campaign-id 123 --context-bid 9000000 --autotargeting-search-bid-is-auto YES --priority HIGH
direct bids set-auto --keyword-id 123 --max-bid 20000000 --position PREMIUMBLOCK --scope SEARCH --dry-run
direct keywordbids set --adgroup-id 321 --search-bid 8000000 --network-bid 3000000 --autotargeting-search-bid-is-auto NO --priority NORMAL
direct keywordbids set-auto --keyword-id 321 --target-traffic-volume 100 --increase-percent 10 --bid-ceiling 12500000 --dry-run
direct bidmodifiers get --campaign-ids 123 --fields Id,CampaignId,AdGroupId,Level,Type
direct bidmodifiers add --campaign-id 123 --type DEMOGRAPHICS_ADJUSTMENT --value 150 --gender GENDER_MALE --age AGE_25_34 --dry-run
direct bidmodifiers add --campaign-id 123 --type MOBILE_ADJUSTMENT --value 120 --operating-system-type IOS --dry-run
direct bidmodifiers set --id 99 --value 130 --dry-run

# Canonical multiword groups
direct negativekeywordsharedsets update --id 123 --keywords "foo,bar"
# audiencetargets get always needs a filter — the API rejects an empty
# SelectionCriteria, so there is no whole-account paging. To sweep the account,
# run `campaigns get` first, then page audiencetargets get in batches of campaign ids.
direct audiencetargets get --campaign-ids 123 --fields Id,AdGroupId,RetargetingListId,State,ContextBid
direct audiencetargets add --adgroup-id 100 --retargeting-list-id 200 --bid 12000000 --priority HIGH --dry-run
direct audiencetargets set-bids --id 101 --context-bid 7000000 --priority LOW --dry-run
direct dynamicads add --adgroup-id 33 --name "Webpage A" --condition "URL:CONTAINS_ANY:test|shop" --condition "PAGE_CONTENT:CONTAINS:baz" --bid 3000000 --context-bid 2000000 --priority HIGH --dry-run
direct smartadtargets add --adgroup-id 55 --name "Audience A" --audience ALL_SEGMENTS --condition "CATEGORY_ID:EQUALS:42" --average-cpc 3000000 --average-cpa 4000000 --priority HIGH --available-items-only YES --dry-run
direct smartadtargets update --id 456 --priority HIGH
direct smartadtargets set-bids --id 456 --average-cpc 10500000 --average-cpa 15000000 --priority HIGH
direct dynamicads set-bids --id 789 --bid 12500000 --context-bid 9000000 --priority HIGH

# Shared bidding strategies
direct strategies get --limit 5
direct strategies add --name "Shared Clicks" --type WbMaximumClicks --weekly-spend-limit 1000000000 --bid-ceiling 30000000 --dry-run
direct strategies add --name "Custom Period Clicks" --type WbMaximumClicks --custom-period-spend-limit 1000000000 --custom-period-start-date 2026-06-01 --custom-period-end-date 2026-06-30 --custom-period-auto-continue YES --dry-run
direct strategies add --name "Exploration CPA" --type AverageCpa --average-cpa 4000000 --goal-id 123 --minimum-exploration-budget 200000000 --dry-run
direct strategies add --name "CRR Goal Values" --type AverageCrr --average-crr 10 --goal-id 123 --priority-goal 123:2000000:YES --dry-run
direct strategies update --id 42 --type WbMaximumClicks --weekly-spend-limit 35000000 --dry-run
direct strategies update --id 42 --type WbMaximumClicks --custom-period-spend-limit 35000000 --custom-period-start-date 2026-07-01 --custom-period-end-date 2026-07-31 --custom-period-auto-continue NO --dry-run
direct strategies update --id 42 --type MaxProfit --minimum-exploration-budget 0 --dry-run
direct strategies update --id 42 --priority-goal 123:2000000:YES --dry-run
direct strategies archive --id 42 --dry-run

# Dynamic feed ad targets
direct dynamicfeedadtargets get --adgroup-ids 123 --limit 5
direct dynamicfeedadtargets add --adgroup-id 33 --name "Feed slice A" --condition "CATEGORY:EQUALS:shoes" --bid 5000000 --dry-run
direct dynamicfeedadtargets set-bids --id 789 --bid 6500000 --context-bid 4000000 --dry-run

# Extensions, assets, feeds, and clients
direct sitelinks add --sitelink "Docs|https://example.com/docs|API docs|12345" --sitelink "Help|https://example.com/help|Desk" --dry-run
direct vcards add --campaign-id 555 --country "Russia" --city "Moscow" --company-name "Acme" --work-time 1#5#9#0#18#0 --phone-country-code +7 --phone-city-code 495 --phone-number 1234567 --instant-messenger-client telegram --instant-messenger-login acme_support --point-on-map-x 37.6173 --point-on-map-y 55.7558 --point-on-map-x1 37.60 --point-on-map-y1 55.74 --point-on-map-x2 37.63 --point-on-map-y2 55.77 --dry-run
direct adextensions add --callout-text "Free shipping" --dry-run
direct adimages add --name banner.png --image-data BASE64DATA --type ICON --dry-run
direct creatives add --video-id video-id --dry-run
direct feeds add --name "Feed A" --url "https://example.com/feed.xml" --business-type RETAIL --remove-utm-tags YES --feed-login feedbot --dry-run
direct feeds add --name "Feed File" --file-feed-path ./feed.xml --business-type RETAIL --dry-run
direct feeds update --id 18 --name "Feed A v2" --url "https://example.com/feed-v2.xml" --remove-utm-tags NO --clear-feed-login --clear-feed-password --dry-run
direct feeds update --id 18 --file-feed-path ./feed-v2.xml --file-feed-filename feed-v2.xml --dry-run
direct clients update --client-info "Priority client" --phone +70000000000 --notification-email user@example.com --notification-lang EN --email-subscription RECEIVE_RECOMMENDATIONS=YES --setting DISPLAY_STORE_RATING=NO --dry-run
direct clients update --erir-organization-name "Advertiser LLC" --erir-organization-kpp 770101001 --erir-organization-epay-number epay123 --erir-organization-reg-number 1027700132195 --erir-organization-oksm-number 643 --erir-organization-okved-code 62.01 --dry-run
direct clients update --erir-contract-number C-2026-01 --erir-contract-date 2026-01-15 --erir-contract-type CONTRACT --erir-contract-action-type COMMERCIAL --erir-contract-subject-type REPRESENTATION --erir-contract-is-agency-payment NO --erir-contract-price-amount 120000.5 --erir-contract-price-including-vat YES --dry-run
direct clients update --erir-contragent-name "Counterparty LLC" --erir-contragent-kpp 770201001 --erir-contragent-phone +70000000001 --erir-contragent-epay-number epay456 --erir-contragent-reg-number 1027700132196 --erir-contragent-oksm-number 643 --erir-contragent-tin-type LEGAL --erir-contragent-tin 1234567890 --dry-run
direct --login CLIENT_LOGIN clients update --phone +70000000000 --notification-email user@example.com --dry-run
direct agencyclients add-passport-organization --name "Org" --currency RUB --notification-email ops@example.com --notification-lang EN --no-send-account-news --send-warnings --dry-run
direct agencyclients add-passport-organization-member --passport-organization-login org-login --role CHIEF --invite-email user@example.com --dry-run
direct agencyclients update --client-id 42 --phone +70000000000 --notification-email user@example.com --grant EDIT_CAMPAIGNS=YES --grant IMPORT_XLS=NO --dry-run

direct agencyclients add is runtime-deprecated by Yandex Direct and is blocked by the CLI. Use direct agencyclients add-passport-organization instead.

Known Unsupported API Operation

dynamicads update is unsupported by API. The Yandex Direct dynamictextadtargets service exposes add, get, delete, suspend, resume, and setBids, but no update operation. Do not add or rely on direct dynamicads update unless Yandex exposes a real API method.

Output Formats

All get commands support --format:

direct campaigns get --format table
direct campaigns get --format csv --output campaigns.csv

Pagination

direct campaigns get --limit 10        # first 10 results
direct campaigns get --fetch-all       # all pages

⚠️ Destructive Commands

The following commands make irreversible changes — use with caution:

Commands that affect live ad delivery: suspend, resume, archive, unarchive (available on campaigns, ads), suspend, resume (also on keywords, and on adgroups as an emulation over the group's ads — see the Ad Groups section above for the resume caveat).

Commands that affect bids and spending: bids set, keywordbids set, bidmodifiers set.

Use --dry-run on add / update commands to preview the API request before sending:

direct campaigns add --name "Test" --start-date 2024-01-01 --dry-run

API Errors

Yandex Direct can return a successful HTTP response that still contains item-level Errors for one object. Direct CLI treats those responses as failed operations: it exits non-zero and prints the error code, message, and details.

Code 8800 with Object not found usually means the object is not available under the current Client-Login or account. Check the selected --login, YANDEX_DIRECT_LOGIN, or auth profile before retrying.

Testing

Four tiers of tests live under tests/:

pip install -e ".[dev]"
pytest                              # fast offline tier, parallel via xdist — no token
pytest -n0                          # same offline tier, sequential (for pdb / -s)
pytest -m integration -v            # read-only integration tests (needs token)
pytest -m integration_write -v      # write cassette replay (no token needed)
YANDEX_DIRECT_LIVE_WRITE=1 pytest -m integration_live_write -v  # live draft cassette replay (v5)
YANDEX_DIRECT_LIVE_WRITE=1 pytest -m integration_live_write -v --record-mode=rewrite  # re-record live draft cassette
YANDEX_DIRECT_V4_LIVE_REPORT_WRITE=1 pytest tests/test_v4_live_contracts.py -k _opt_in_write -v  # v4 wordstat/forecast account-level lifecycle

The v4 account-level write tier (YANDEX_DIRECT_V4_LIVE_REPORT_WRITE=1) creates real Wordstat and forecast reports in the production account and deletes them in the same run. There are no cassettes — these tests run against live API only. Created IDs are tracked in ~/.direct-cli/test-orphans.json so that if the run is interrupted between create and delete, the next invocation will retry the cleanup automatically (see tests/_orphan_store.py).

Smoke command scripts

Every CLI subcommand is classified in direct_cli/smoke_matrix.py.

Current command surface:

API Coverage And Drift Monitoring

The project now distinguishes four surfaces:

100% coverage in this project means full coverage of the supported declared canonical API surface. The API coverage report also includes a model_gaps section for live-discovered Yandex Direct services that are not yet part of that declared model. Alias groups and CLI-only helpers remain supported, but they are tracked outside the strict parity metric.

Useful maintenance commands:

python scripts/build_api_coverage_report.py
python scripts/refresh_wsdl_cache.py
python scripts/check_wsdl_drift.py

CI runs a scheduled API coverage workflow that:

• runs the fast coverage suites;
• uploads a machine-readable API coverage report artifact, including declared parity and live-discovered model gap counts;
• checks the cached WSDL files against the live Yandex Direct API on schedule.

Live sandbox write smoke

WRITE_SANDBOX smoke is a live check against the Yandex Direct sandbox. It does not replay stored HTTP traffic and it does not create new recordings. Run it only when you intentionally want to call api-sandbox.direct.yandex.ru:

set -a && source .env && set +a
scripts/test_sandbox_write.sh

The runner executes matrix commands through direct --sandbox ..., creates temporary sandbox prerequisites where possible, and cleans them up best-effort. The report contains one row per WRITE_SANDBOX command:

• PASS means the command completed against the live sandbox API.
• SANDBOX_LIMITATION means the request reached the API and hit a known sandbox-only limitation such as codes 8800, 1000, 3500, or 5004.
• FAIL means an unexpected CLI or API error.
• NOT_COVERED means the runner does not yet know how to safely build the prerequisites for that command.

The same OAuth token works for both production and the sandbox; no separate sandbox token is needed.

For v4account sandbox smoke, enable-shared-account uses YANDEX_DIRECT_V4ACCOUNT_CLIENT_LOGIN or falls back to YANDEX_DIRECT_LOGIN. account-management requires YANDEX_DIRECT_V4ACCOUNT_ACCOUNT_ID; without it the runner reports NOT_COVERED for that command.

clients.update is opt-in because it mutates client-level account metadata. Set YANDEX_DIRECT_CLIENTS_UPDATE_LOGIN to an expendable sandbox Client-Login; the runner passes it through --login and updates only ClientInfo with a unique smoke marker. Without that variable, the runner reports NOT_COVERED for clients.update.

Re-recording write cassettes

The integration_write pytest tier still replays stored write-test traffic for regression coverage. If you change those tests or their payloads and intentionally need to refresh the fixtures, regenerate them separately:

set -a && source .env && set +a        # load YANDEX_DIRECT_TOKEN / LOGIN
pytest -m integration_write -v --record-mode=rewrite

After recording, always audit the generated YAMLs for leaked secrets:

grep -r "$YANDEX_DIRECT_TOKEN" tests/cassettes/   # must return nothing
grep -r "$YANDEX_DIRECT_LOGIN" tests/cassettes/   # must return nothing

The VCR config in tests/conftest.py already strips Authorization, Client-Login, cookies and any response header containing the substring login, but manual verification is mandatory before committing.

Live draft write tests

The integration_live_write tier is manual-only and intentionally separate from sandbox cassette tests. In rewrite mode it runs against the production Yandex Direct API, but it may only create disposable draft resources and delete the exact IDs it created in the same test run. Current coverage is limited to a guarded campaign draft create -> get -> delete check.

Replay the checked-in cassette:

YANDEX_DIRECT_LIVE_WRITE=1 pytest -m integration_live_write -v

Re-record it only when you intentionally want to verify live draft behavior:

YANDEX_DIRECT_LIVE_WRITE=1 pytest -m integration_live_write -v --record-mode=rewrite

Do not add tests to this tier that accept external IDs, resume/suspend/archive existing resources, mutate bids, or touch serving campaigns.

Release Process

Build, validate and upload to PyPI:

pip install -e ".[dev]"
scripts/release_pypi.sh testpypi   # upload to TestPyPI
scripts/release_pypi.sh pypi       # upload to PyPI
scripts/release_pypi.sh all        # both

The script reads credentials from .env:

TWINE_USERNAME=__token__
TEST_PYPI_TOKEN=pypi-...
PYPI_TOKEN=pypi-...

PyPI Token Scoping

PyPI API tokens can be account-wide or project-scoped:

• Project-scoped tokens only allow uploads to the specific project they were created for. A token scoped to telethon-cli cannot upload direct-cli — you will get 403 Forbidden.
• Account-wide tokens allow uploads to any project under your account.
• For the first publication of a new project, you must use an account-wide token (project-scoped tokens cannot be created until the project exists on PyPI).
• After the first successful upload, create a project-scoped token at https://pypi.org/manage/account/token/ and replace the account-wide token in .env.

Bump version in pyproject.toml before each release — PyPI rejects duplicate versions.

License

MIT