HTTP-заголовки
Заголовки запроса
Authorization
Содержит OAuth-токен пользователя Яндекс Директа, от имени которого осуществляется запрос к API.
Пример:
Authorization: Bearer 0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f
Accept-Language
Язык ответных сообщений. На выбранном языке возвращаются текстовые пояснения к статусам объектов (кампаний, объявлений и др.), тексты ошибок и предупреждений. Поддерживаются следующие языки:
- en — английский;
- ru — русский;
- tr — турецкий;
Пример:
Accept-Language: ru
Если заголовок не указан или содержит язык, не поддерживаемый в API Директа, ответные сообщения формируются на английском языке.
Client-Login
Логин рекламодателя — клиента рекламного агентства. Обязателен, если запрос осуществляется от имени агентства.
Пример:
Client-Login: agrom
Use-Operator-Units: true
Расходовать баллы агентства, а не рекламодателя при выполнении запроса. См. раздел Ограничения, баллы. Заголовок допустим только в запросах от имени агентства.
Accept-Encoding: gzip
Получение тела ответа с использованием GZIP сжатия.
Payment-Token
Финансовый токен. Необходим при вызове финансовых методов.
Пример запроса:
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
Units-Used-Login
Логин представителя рекламодателя, если при выполнении запроса израсходованы баллы рекламодателя, или логин представителя агентства, если при выполнении запроса израсходованы баллы агентства.
Пример:
Units-Used-Login: ttt-agency
Пример ответа:
HTTP/1.1 200 OK
Connection:close
Content-Type:application/json; charset=utf-8
Date:Fri, 28 Nov 2014 17:07:02 GMT
RequestId:8695244274068608439
Units:10/20828/64000
Units-Used-Login:ttt-agency
Server:nginx
Transfer-Encoding:chunked
{
"result": {
...
}
}