HTTP-заголовки. Баллы api директ что это
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": { ... } }| AdditionalMetrikaCounters | CounterIds, вложенный в TextCampaign | Campaigns |
| AddRelevantPhrases | Регулируется наличием параметра RelevantKeywords, вложенного в TextCampaign: если параметр задан, показы по дополнительным релевантным фразам включены, если не задан — отключены | Campaigns |
| AgencyName | Agency, вложенный в RepresentedBy | Campaigns |
| AutoOptimization | Утратил актуальность | — |
| BonusDiscount | BalanceBonus, вложенный в CampaignFunds, вложенный в Funds (если общий счет не подключен) | Campaigns |
| CampaignCurrency | Currency | Campaigns |
| CampaignID | Id | Campaigns |
| ClickTrackingEnabled | Option со значением ADD_METRICA_TAG, вложенный в Settings, вложенный в TextCampaign | Campaigns |
| ConsiderTimeTarget | Option со значением EXCLUDE_PAUSED_COMPETING_ADS, вложенный в Settings, вложенный в TextCampaign | Campaigns |
| ContextStrategy | Network, вложенный в BiddingStrategy Соответствие вложенных параметров см. в секции Параметры стратегий. | Campaigns |
| Не поддерживается. Ставки и цены всегда указываются в валюте рекламодателя. | — | |
| Clicks | Clicks, вложенный в Statistics | Campaigns |
| DayBudget | DailyBudget. Соответствие вложенных параметров см. в секции Параметры дневного бюджета | Campaigns |
| DayBudgetEnabled | Option со значением DAILY_BUDGET_ALLOWED, вложенный в Settings, вложенный в TextCampaign | Campaigns |
| DisabledDomains | ExcludedSites | Campaigns |
| DisabledIps | BlockedIps | |
| EmailNotification | EmailSettings, вложенный в Notification Соответствие вложенных параметров см. в секции Параметры email-уведомлений. | Campaigns |
| EnableRelatedKeywords | Утратил актуальность | — |
| ExtendedAdTitleEnabled | Option со значением ENABLE_EXTENDED_AD_TITLE, вложенный в Settings, вложенный в TextCampaign | Campaigns |
| FIO | ClientInfo | Campaigns |
| IsActive, Status, StatusShow, StatusArchive, StatusActivating, StatusModerate | Status, StatusPayment, StatusClarifications и State (подробнее в разделе Статус и состояние кампании) | |
| Login | HTTP-заголовок запроса Client-Login | — |
| MaintainNetworkCPC | Option со значением MAINTAIN_NETWORK_CPC, вложенный в Settings, вложенный в TextCampaign | Campaigns |
| ManagerName | Manager, вложенный в RepresentedBy | Campaigns |
| MinusKeywords | NegativeKeywords | Campaigns |
| MobileBidAdjustment | BidModifier, вложенный в MobileAdjustment | BidModifiers |
| Name | Name | Campaigns |
| Rest | Balance, вложенный в CampaignFunds, вложенный в Funds (если общий счет не подключен) | Campaigns |
| SmsNotification | SmsSettings, вложенный в Notification. Соответствие вложенных параметров см. в секции Параметры SMS-уведомлений. | Campaigns |
| SourceCampaignID | SourceId | Campaigns |
| StartDate | StartDate | Campaigns |
| Strategy | Search, вложенный в BiddingStrategy, вложенный в TextCampaign Соответствие вложенных параметров см. в секции Параметры стратегий. | Campaigns |
| TimeTargeting | Campaigns | |
| RelevantPhrasesBudgetLimit | BudgetPercent, вложенный в RelevantKeywords, вложенный в TextCampaign | Campaigns |
| Shows | Impressions, вложенный в Statistics | Campaigns |
| StatusBehavior | Утратил актуальность | — |
| StatusContextStop | Утратил актуальность | — |
| StatusMetricaControl | Option со значением ENABLE_SITE_MONITORING, вложенный в Settings | Campaigns |
| StatusOpenStat | Campaigns | |
| Sum | Sum, вложенный в CampaignFunds, вложенный в Funds (если общий счет не подключен) Spend, вложенный в SharedAccountFunds, вложенный в Funds (если общий счет подключен) | Campaigns |
| SumAvailableForTransfer | SumAvailableForTransfer, вложенный в CampaignFunds, вложенный в Funds | Campaigns |
| AverageCPA | AverageCpa, вложенный в AverageCpa | Campaigns |
| AveragePrice | AverageCpc, вложенный в AverageCpc или WeeklyClickPackage | Campaigns |
| Регулируется наличием параметра LimitPercent, вложенного в NetworkDefault: если параметр задан, то бюджет ограничен, если нет — неограничен | Campaigns | |
| ContextLimitSum | LimitPercent, вложенный в NetworkDefault | Campaigns |
| ContextPricePercent | BidPercent, вложенный в NetworkDefault | Campaigns |
| GoalID | GoalId, вложенный в WbMaximumConversionRate, AverageCpa, RoiOptimization | Campaigns |
| ClicksPerWeek | ClicksPerWeek, вложенный в WeeklyClickPackage | |
| MaxPrice | BidCeiling, вложенный в WbMaximumClicks, WbMaximumConversionRate, AverageCpa, AverageRoi, WeeklyClickPackage | Campaigns |
| Profitability | Profitability, вложенный в AverageRoi | Campaigns |
| ReserveReturn | ReserveReturn, вложенный в AverageRoi | Campaigns |
| ROICoef | RoiCoef, вложенный в AverageRoi | Campaigns |
| StrategyName | BiddingStrategyType, вложенный в Search или Network | Campaigns |
| WeeklySumLimit | WeeklySpendLimit, вложенный в WbMaximumClicks, WbMaximumConversionRate, AverageCpc, AverageCpa, AverageRoi | Campaigns |
| MetricaSms | Значение MONITORING в параметре Events | Campaigns |
| ModerateResultSms | Значение MODERATION в параметре Events | Campaigns |
| MoneyInSms | Значение MONEY_IN в параметре Events | Campaigns |
| MoneyOutSms | Значение MONEY_OUT в параметре Events | Campaigns |
| SmsTimeFrom | TimeFrom | Campaigns |
| SmsTimeTo | TimeTo | Campaigns |
| ShowOnHolidays | SuspendOnHolidays, вложенный в HolidaysSchedule Примечание. Значение Yes параметра ShowOnHolidays соответствует значению NO параметра SuspendOnHolidays, и наоборот. | Campaigns |
| HolidayShowFrom | StartHour, вложенный в HolidaysSchedule | Campaigns |
| HolidayShowTo | EndHour, вложенный в HolidaysSchedule | Campaigns |
| DaysHours и вложенные Hours, Days, BidCoefs | Schedule | Campaigns |
| TimeZone | TimeZone (параметр верхнего уровня) | Campaigns |
| WorkingHolidays | ConsiderWorkingWeekends | Campaigns |
tech.yandex.ru
API Яндекс.Директа
Открытая бета-версия сервиса API KeywordBids, для которого мы недавно опубликовали документацию, уже работает в полной версии API Директа. Вы можете начать тестировать свои приложения, чтобы заранее подготовиться к запуску нового интерфейса назначения ставок в Яндекс.Директе.
Как вы помните, цены в Директе скоро будут рассчитываться не за позиции на поиске, а за объёмы трафика, которые соответствуют разным местам показа и дизайну объявлений. Перемена важная, но совсем не страшная — вы сможете решать все привычные задачи и при этом будете лучше ориентироваться в ценах аукциона. Вот ответы на несколько частых вопросов о запуске:
- Аукцион и ранжирование на поиске не меняются. Повышая релевантность и CTR объявлений, вы по-прежнему можете получить показы на более заметных позициях по выгодной цене за клик.Запуск нового интерфейса никак не провоцирует рост или снижение стоимости кликов на поиске — ценообразование остаётся прежним. Списываемые цены, как и сейчас, будут рассчитываться по правилам VCG-аукциона.
- Новый сервис KeywordBids предоставляет больше данных. Он отдаёт весь массив ставок и списываемых цен на поиске. Включая, к примеру, цены за показы объявлений в расширенном виде. Чем больше новых форматов и мест показа будет появляться на поиске, тем выгоднее KeywordBids будет отличаться от постепенно устаревающих методов расчёта цен за позиции.
- Сервис Bids не отключается, а в ваших приложениях ничего не сломается после запуска. Bids будет по-прежнему доступен на время переходного периода, чтобы у вас была возможность постепенно освоить работу с новым сервисом и изменить логику выставления ставок в приложениях. Это означает, что вы будете видеть ставки для позиций, в том числе, после запуска нового интерфейса назначения ставок — мы будем сопоставлять позиции с примерными объёмами трафика на своей стороне.
Когда ждать изменений в веб-интерфейсе
Мы рассчитываем обновить интерфейс назначения ставок через полторы-две недели, в двадцатых числах апреля. Про это обязательно будет отдельная новость.
16 апреля на конференции Яндекс.Директа расскажем подробности не только об этом запуске, но и о других важных новинках и планах. Посмотрите трансляцию, будет интересно!Зарегистрироваться
yandex.ru
