Документация
API версии 4 и Live 4
Методы
Отключенные методы

О чем вы хотите спросить у службы поддержки?

Варианты использования и возможности API Директа подробно описаны в документации. Если вы не нашли ответ на свой вопрос, обратитесь к нашим специалистам — мы обязательно вас проконсультируем.

Пожалуйста, выберите из списка ниже или слева интересующий вас вопрос. Выбирая подходящие темы, вы увидите либо ответ на свой вопрос, либо форму для обращения.

Частые вопросы по работе с API Директа

Что такое API Яндекс.Директа и в каких целях его можно использовать?

API сервиса Яндекс.Директ предоставляет программный доступ к данным и позволяет создавать приложения для управления рекламными кампаниями. Через API внешние приложения добавляют и редактируют кампании, объявления, фразы, задают ставки, получают статистику показов.

API Директа предназначен в первую очередь для рекламных агентств и прямых рекламодателей — торговых компаний, предприятий сферы услуг и других. Разработка собственных приложений позволяет им в полной мере реализовать собственные подходы к ведению рекламных кампаний, своевременно получать статистические отчеты, точнее прогнозировать бюджеты.

Подробнее о вариантах использования API...

Есть ли разница в управлении рекламной кампанией через API и через веб-интерфейс?

Все изменения, сделанные через API, отражаются в ваших рекламных кампаниях.

Есть ли готовые программы, использующие API Директа?

Поскольку разные компании подходят к управлению рекламой по-разному, на рынке появилось множество решений для управления рекламой на основе API Яндекс.Директа.

Многие рекламные агентства предлагают своим клиентам инструменты для автоматического управления рекламой в Директе, а также оптимизируют с их помощью собственные рабочие процессы. Все эти инструменты построены на методах API Директа.

У Яндекса также есть готовые решения на основе API Яндекс.Директа:

  • Программа Директ Коммандер — предназначена для управления масштабными рекламными кампаниями в удобном интерфейсе.
  • Мобильный Директ для iPhone и Android — предоставляет рекламодателям возможность управлять своими кампаниями максимально оперативно.
Какие технологии поддерживаются в API?

Запросы к API Директа выполняются по протоколу HTTPS методом POST. Входные и выходные структуры данных передаются в теле запроса и ответа.

API Директа поддерживает два формата взаимодействия: JSON и SOAP.

Для авторизации используетcя протокол OAuth 2.0: в запросах необходимо указывать авторизационный токен.

Сколько стоит использование API?

Подключение к API Директа и его использование является бесплатным.

Как подключиться к API?
Доступ для приложения

Разработчику приложения необходимо выполнить процедуру регистрации приложения.

Запрос к API выполняется от имени пользователя Директа — рекламодателя или рекламного агентства. В запросе необходимо указывать авторизационный токен — специальный код, разрешающий приложению операции с данными этого пользователя.

Доступ для пользователя

Чтобы получить токен, приложение должно перенаправить пользователя на страницу запроса доступа. Пользователь авторизуется на Яндексе (под своим логином в Директе) и нажимает кнопку Подтвердить. Остальные действия выполняются автоматически приложением и сервером Яндекса.

См. также

Кто должен подавать заявку?

Регистрацию приложения на сервисе Яндекс.OAuth и создание заявки на доступ к API Директа выполняет разработчик приложения. Пользователям приложения не нужно проходить эту процедуру.

Если вы приобрели или используете готовую программу, регистрировать приложение и заполнять заявку не нужно.

Как получить токен для пользователя?

Чтобы получить токен, приложение должно перенаправить пользователя на специальную страницу OAuth-сервера Яндекса — страницу запроса доступа. Пользователь авторизуется на Яндексе (под своим логином в Директе) и подтверждает доступ приложения к своим данным. OAuth-сервер Яндекса генерирует токен и передает его приложению.

Процедура получения токена подробно описана в руководстве по OAuth-авторизации.

Примечание. На этапе разработки приложения вы можете вручную получить отладочный токен от имени тестового пользователя. См. раздел Отладочный токен руководства по OAuth-авторизации.

См. также

Почему токен стал недействительным?

Токен может стать недействительным, например, если пользователь сменил пароль на Яндексе. Полный список причин приведен в разделе Прекращение действия токена. В этом случае требуется получить новый токен.

Для работы в приложении мы рекомендуем зарегистрировать в Директе отдельного представителя и получить для него токен. См. раздел Рекомендации по созданию представителей документации API версии 5.

Как я могу увеличить количество доступных мне баллов?

Вы можете увеличить количество доступных вам баллов, оптимизируя ваши рекламные кампании: добавляя и уточняя ключевые слова, работая с текстом объявления с целью увеличения его CTR, а также увеличивая минимальные ставки. Баллы пересчитываются и начисляются раз в сутки.

См. также

Приведите примеры кода для программных клиентов API Яндекс.Директа

Примеры приложений на различных языках программирования представлены в документации:

Perl
PHP
Python
Авторизация
Отчеты
Как скачать файл отчета?

Информацию о доступных отчетах можно узнать с помощью метода GetReportList. Скрипт для загрузки готового отчета можно создать на основе примера, приведенного в документации.

С какой частотой можно вызывать методы GetReportList и GetForecastList?

Проверку готовности отчетов следует выполнять в одном потоке, не чаще 1 раза в 10–30 секунд. Рекомендуется увеличивать интервал перед каждой следующей проверкой, например: 10, 20, 40, ... секунд. Подробнее см. в разделе Требования к приложению.

С какой частотой можно обновлять ставки?

Рекомендации по частоте обновления ставок приведены в разделе Требования к приложению.

Как можно вывести XML-код запроса и ответа сервера?

В целях обнаружения ошибок и отладки иногда требуется вывести SOAP-запрос клиента и SOAP-ответ сервера.

Для Perl:

my $client = SOAP::Lite->service($client->on_debug(sub {print @_}));
Как узнавать об изменениях в API Директа?

Чтобы получать информацию об изменениях в API Директа:

Список изменений по версиям API представлен в следующих разделах:

Где найти документацию версии 5?

Документация версии 5 находится по адресу https://tech.yandex.ru/direct/doc/dg/.

Чем отличается версия 5 от версий 4 и Live 4?

Полную информацию об изменениях в версии 5 по сравнению с предыдущими версиями, а также о соответствии методов и их параметров вы найдете в Руководстве по переходу.