HTTP-заголовки. Яндекс апи директ


API Директа — Доступ — Технологии Яндекса

Приложение (программа, скрипт и др.) выполняет запрос к API от имени пользователя Директа — рекламодателя или рекламного агентства — и управляет данными, принадлежащими этому пользователю.

Доступ приложения к данным пользователя возможен при выполнении следующих условий:

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

  2. Пользователь Директа является прямым рекламодателем, рекламным агентством или клиентом рекламного агентства, которому агентство разрешило доступ к его данным.

    Примечание.
    • Если агентство предоставило клиенту доступ в веб-интерфейс только на чтение, то и через API клиент сможет только получать данные.

    • Если агентство предоставило клиенту право на редактирование кампаний, то клиент сможет управлять своими кампаниями как в веб-интерфейсе, так и через API.

  3. От имени пользователя создана хотя бы одна рекламная кампания в веб-интерфейсе.
  4. Пользователь принял условия пользовательского соглашения на странице API сервиса Яндекс.Директ.
  5. Пользователь разрешил приложению выполнять запросы от своего имени.

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

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

Ограничение доступа по IP-адресу

Доступ к API можно ограничить по IP-адресу, что повышает информационную безопасность. Список разрешенных IP-адресов пользователь может указать на странице Настройки API на вкладке Параметры.

Формат взаимодействия

Доступ к API предоставляется через криптографический протокол SSL. Установка SSL-соединения обязательна для вызова методов API.

API Яндекс.Директа поддерживает два способа взаимодействия:

Запросы JSON меньше нагружают сервер и быстрее обрабатываются.

tech.yandex.ru

API Директа — HTTP-заголовки — Технологии Яндекса

Заголовки запроса

Authorization

Содержит OAuth-токен пользователя Яндекс.Директа, от имени которого осуществляется запрос к API.

Пример:

Authorization: Bearer 0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f Accept-Language

Язык ответных сообщений. На выбранном языке возвращаются текстовые пояснения к статусам объектов (кампаний, объявлений и др.), тексты ошибок и предупреждений. Поддерживаются следующие языки:

  • en — английский;
  • ru — русский;
  • tr — турецкий;
  • uk — украинский.

Пример:

Accept-Language: ru

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

Client-Login

Логин рекламодателя — клиента рекламного агентства. Обязателен, если запрос осуществляется от имени агентства.

Пример:

Client-Login: agrom Use-Operator-Units: true Расходовать баллы агентства, а не рекламодателя при выполнении запроса. См. раздел Ограничения. Заголовок допустим только в запросах от имени агентства.

Пример запроса

POST /json/v5/ads/ HTTP/1.1 Host: api.direct.yandex.com Authorization: Bearer 0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f Accept-Language: ru Client-Login: agrom Use-Operator-Units: true Content-Type: application/json; charset=utf-8 { "method":"add", "params": { ... } }

Заголовки ответа

RequestId

Уникальный идентификатор запроса (строка), присвоенный сервером API Директа. Возвращается как для успешных, так и для ошибочных запросов.

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

Пример:

RequestId:8695244274068608439 Units

Количество баллов: 1) израсходовано при выполнении запроса, 2) доступный остаток суточного лимита, 3) суточный лимит. См. раздел Ограничения.

Пример:

Units: 10/20828/64000

Пример ответа

HTTP/1.1 200 OK Connection:keep-alive Content-Type:application/json Date:Fri, 28 Nov 2014 17:07:02 GMT RequestId:8695244274068608439 Units: 10/20828/64000 Server:nginx Transfer-Encoding:chunked { "result": { ... } }

tech.yandex.ru

API Директа — Варианты использования — Технологии Яндекса

Ведение рекламных кампаний

Программный интерфейс позволяет эффективно управлять сложными и масштабными рекламными кампаниями с большим количеством объявлений и ключевых фраз. С помощью API можно автоматизировать рутинные операции — например, периодическое обновление цен клика по определенному алгоритму. API также позволяет создавать удобные пользовательские инструменты для просмотра и редактирования кампаний: чтобы внести изменения, не нужно ждать загрузки страниц, как в веб-интерфейсе.

Интеграция с бизнес-приложениями С помощью API Директа можно управлять рекламой на основе информации о товарах и услугах из вашей базы данных, например:
  • автоматически генерировать большие массивы ключевых фраз, добавляя в них названия конкретных брендов или моделей товаров — по таким уточненным фразам цены клика ниже, а кликабельность и конверсия выше, чем по «обобщенным»;
  • останавливать и возобновлять показы объявлений в зависимости от наличия товаров на складе;
  • обновлять тексты объявлений при изменении цены товара;
  • автоматически формировать объявления о проведении акций и распродаж; повышать объем трафика для таких объявлений.
A/B-тестирование объявлений

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

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

Полный список доступных операций приведен в документации.

tech.yandex.ru


Смотрите также