Документация на метод "analizreklamyyandex"
API для инструмента «Анализ количества рекламных объявлений в выдаче Яндекса»:
URL: https://tools.pixelplus.ru/api/analizreklamyyandex
Для создания задачи необходимо сформировать POST-запрос и отправить его на URL метода с обязательными GET-параметром key и POST-параметрами описанными ниже. Система поставит задачу в очередь выполнения и вернет идентификатор отчета: report_id. Для получения результата проверки позиций необходимо отправить GET запрос с параметрами key и report_id.
Принимает параметры:
GET:
- key — ключ доступа к API (обязательный);
- report_id — Идентификатор отчета;
POST:
- queries — список запросов (обязательный);
- lr — регион по Яндексу (обязательный);
Максимальное количество запросов — 100:
Возвращает JSON с массивом:
В случае успеха:
{
"request": {
"queries": [
"запрос"
],
"lr": "Регион по Яндексу",
"csv": false
},
"response": {
"запрос": {
"countPromotion": {
"top": Кол-во рекламных объявлений над поиком или "Нет в выдаче",
"low": Кол-во рекламных объявлений под поиком или "Нет в выдаче",
"direct": Кол-во Яндекс директа или "Нет в выдаче",
"all": Кол-во органики в выдаче
},
"position": {
"Яндекс.Маркет среди выдачи (место)": "Позиция или Нет в выдаче",
"Яндекс.Видео (место)": "Позиция или Нет в выдаче",
"Яндекс.Картинки (место)": "Позиция или Нет в выдаче",
"Яндекс.Путешествия (место)": "Позиция или Нет в выдаче",
"Яндекс.Коллекции (место)": "Позиция или Нет в выдаче",
"Яндекс.Авиабилеты (место)": "Позиция или Нет в выдаче",
"Яндекс.Новости (место)": "Позиция или Нет в выдаче",
"Яндекс.Погода (место)": "Позиция или Нет в выдаче",
"Яндекс.Карты (место)": "Позиция или Нет в выдаче",
"Яндекс.Почта (место)": "Позиция или Нет в выдаче",
"Яндекс.Музыка (место)": "Позиция или Нет в выдаче",
"Яндекс.Афиша (место)": "Позиция или Нет в выдаче",
"taxi.yandex.ru (место)": "Позиция или Нет в выдаче",
"Яндекс.Такси (место)": "Позиция или Нет в выдаче",
"Яндекс.Деньги (место)": "Позиция или Нет в выдаче",
"Яндекс.Диск (место)": "Позиция или Нет в выдаче",
"Яндекс.Недвижимость (место)": "Позиция или Нет в выдаче",
"realty.yandex.ru (место)": "Позиция или Нет в выдаче",
"Яндекс.Работа (место)": "Позиция или Нет в выдаче",
"Яндекс.Таланты (место)": "Позиция или Нет в выдаче",
"Яндекс.Толока (место)": "Позиция или Нет в выдаче",
"Авто.ру (место)": "Позиция или Нет в выдаче",
"Яндекс.Телефония (место)": "Позиция или Нет в выдаче",
"Яндекс.Доставка (место)": "Позиция или Нет в выдаче",
"Яндекс.Еда (место)": "Позиция или Нет в выдаче"
},
"koldunshiki": "Список Колдунщиков через запятую"
}
}
}
В случае неудачи:
- {"error":"In progress","code":50} — задание с таким идентификатором еще не выполнено;
- {"error":"To much requests","code":"-67"} — задано слишком много запросов;
- {"error":"Not enough daily limits","code":-68} — недостаточно дневных лимитов;
- {"error":"Not enough hourly limits","code":-80} — недостаточно часовых лимитов;
- {"error":"Not enough weekly limits","code":-81} — недостаточно недельных лимитов;
- {"error":"Not enough monthly limits","code":-82} — недостаточно месячных лимитов;
- {"error":"Not enough yearly limits","code":-83} — недостаточно годовых лимитов;
- {"error":"access denided","code":-1} — если не задан ключ доступа;
- {"error":"access denided","code":-2} — если неверно задан ключ доступа;
- {"error":"unknown method","code":-3} — если неверно задано название метода;
- {"error":"Processing error","code":-104} — инструмент завершился с фатальной ошибкой;
- {"error":"Limits run out","code":-105} — во время выполнения инструмента закончились лимиты;
- {"error":"The process was canceled by a user","code":-106} — задача отменена пользователем;
- {"error":"The process took more than 6 hours and was canceled","code":-107} — инструмент очень долго работал в фоне и мы автоматически завершили процесс;
- {"error":"Processing error":-125} — непредвиденная ошибка;
Пример получения данных с данного API:
{
"request": {
"queries": [
"пиксель тулс",
"seo",
"разработка сайтов"
],
"lr": "213",
"csv": false
},
"response": {
"пиксель тулс": {
"countPromotion": {
"top": "Нет в выдаче",
"low": "Нет в выдаче",
"direct": "Нет в выдаче",
"all": 10
},
"position": {
"Яндекс.Маркет среди выдачи (место)": "Нет в выдаче",
"Яндекс.Видео (место)": "Нет в выдаче",
"Яндекс.Картинки (место)": "Нет в выдаче",
"Яндекс.Путешествия (место)": "Нет в выдаче",
"Яндекс.Коллекции (место)": "Нет в выдаче",
"Яндекс.Авиабилеты (место)": "Нет в выдаче",
"Яндекс.Новости (место)": "Нет в выдаче",
"Яндекс.Погода (место)": "Нет в выдаче",
"Яндекс.Карты (место)": 5,
"Яндекс.Почта (место)": "Нет в выдаче",
"Яндекс.Музыка (место)": "Нет в выдаче",
"Яндекс.Афиша (место)": "Нет в выдаче",
"taxi.yandex.ru (место)": "Нет в выдаче",
"Яндекс.Такси (место)": "Нет в выдаче",
"Яндекс.Деньги (место)": "Нет в выдаче",
"Яндекс.Диск (место)": "Нет в выдаче",
"Яндекс.Недвижимость (место)": "Нет в выдаче",
"realty.yandex.ru (место)": "Нет в выдаче",
"Яндекс.Работа (место)": "Нет в выдаче",
"Яндекс.Таланты (место)": "Нет в выдаче",
"Яндекс.Толока (место)": "Нет в выдаче",
"Авто.ру (место)": "Нет в выдаче",
"Яндекс.Телефония (место)": "Нет в выдаче",
"Яндекс.Доставка (место)": "Нет в выдаче",
"Яндекс.Еда (место)": "Нет в выдаче"
},
"koldunshiki": "Доп. информация справа"
},
"seo": {
"countPromotion": {
"top": 1,
"low": 5,
"direct": "Нет в выдаче",
"all": 10
},
"position": {
"Яндекс.Маркет среди выдачи (место)": "Нет в выдаче",
"Яндекс.Видео (место)": "Нет в выдаче",
"Яндекс.Картинки (место)": "Нет в выдаче",
"Яндекс.Путешествия (место)": "Нет в выдаче",
"Яндекс.Коллекции (место)": "Нет в выдаче",
"Яндекс.Авиабилеты (место)": "Нет в выдаче",
"Яндекс.Новости (место)": "Нет в выдаче",
"Яндекс.Погода (место)": "Нет в выдаче",
"Яндекс.Карты (место)": "Нет в выдаче",
"Яндекс.Почта (место)": "Нет в выдаче",
"Яндекс.Музыка (место)": "Нет в выдаче",
"Яндекс.Афиша (место)": "Нет в выдаче",
"taxi.yandex.ru (место)": "Нет в выдаче",
"Яндекс.Такси (место)": "Нет в выдаче",
"Яндекс.Деньги (место)": "Нет в выдаче",
"Яндекс.Диск (место)": "Нет в выдаче",
"Яндекс.Недвижимость (место)": "Нет в выдаче",
"realty.yandex.ru (место)": "Нет в выдаче",
"Яндекс.Работа (место)": "Нет в выдаче",
"Яндекс.Таланты (место)": "Нет в выдаче",
"Яндекс.Толока (место)": "Нет в выдаче",
"Авто.ру (место)": "Нет в выдаче",
"Яндекс.Телефония (место)": "Нет в выдаче",
"Яндекс.Доставка (место)": "Нет в выдаче",
"Яндекс.Еда (место)": "Нет в выдаче"
},
"koldunshiki": "МКБ, Чаты с организациями справа"
},
"разработка сайтов": {
"countPromotion": {
"top": 4,
"low": 4,
"direct": 4,
"all": 10
},
"position": {
"Яндекс.Маркет среди выдачи (место)": "Нет в выдаче",
"Яндекс.Видео (место)": "Нет в выдаче",
"Яндекс.Картинки (место)": "Нет в выдаче",
"Яндекс.Путешествия (место)": "Нет в выдаче",
"Яндекс.Коллекции (место)": "Нет в выдаче",
"Яндекс.Авиабилеты (место)": "Нет в выдаче",
"Яндекс.Новости (место)": "Нет в выдаче",
"Яндекс.Погода (место)": "Нет в выдаче",
"Яндекс.Карты (место)": "Нет в выдаче",
"Яндекс.Почта (место)": "Нет в выдаче",
"Яндекс.Музыка (место)": "Нет в выдаче",
"Яндекс.Афиша (место)": "Нет в выдаче",
"taxi.yandex.ru (место)": "Нет в выдаче",
"Яндекс.Такси (место)": "Нет в выдаче",
"Яндекс.Деньги (место)": "Нет в выдаче",
"Яндекс.Диск (место)": "Нет в выдаче",
"Яндекс.Недвижимость (место)": "Нет в выдаче",
"realty.yandex.ru (место)": "Нет в выдаче",
"Яндекс.Работа (место)": "Нет в выдаче",
"Яндекс.Таланты (место)": "Нет в выдаче",
"Яндекс.Толока (место)": "Нет в выдаче",
"Авто.ру (место)": "Нет в выдаче",
"Яндекс.Телефония (место)": "Нет в выдаче",
"Яндекс.Доставка (место)": "Нет в выдаче",
"Яндекс.Еда (место)": "Нет в выдаче"
},
"koldunshiki": "МКБ, Чаты с организациями справа"
}
}
}