2GIS

Поиск рекламы

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

URL: http://catalog.api.2gis.ru/ads/search

Параметры запроса

Параметр Обязательное Тип Описание
key Да Строка

Уникальный ключ пользователя API.

Пример: 1234567890.

version Да Строка Указывает версию API, с которой идет работа. Возможные значения: 1.3
what Да. Не менее 2-х символов Строка

Поисковый запрос из поля «Что?». Указывается название фирмы или область деятельности фирмы. Если введено 2 символа, поиск идёт по точному совпадению, если 3 и более — по маске «abc*». Если в запросе несколько слов, по каждому слову идёт поиск по маске.

Кодировка UTF8.

Примеры:

  • офтальмолог
  • сто
  • установка окон
where Да. Не менее 2-х символов Строка

Поисковый запрос из поля «Где». Поле обязательно должно содержать название населенного пункта (Новосибирск, Омск), название населенного пункта + район (Новосибирск Центральный) или название населенного пункта + улица (Новосибирск Советская). Если не указать название населенного пункта, то поиск выполнен не будет.

Кодировка UTF8.

В случае, когда невозможно однозначно определить локацию по текстовому значению поля «Где?», поиск осуществлен не будет.

Примеры:

  • Новосибирск
  • Новосибирск, Ленина
  • Омск Ленина 5
format Нет Строка

Формат вывода профиля:

full — полный, профиль фирмы выводится аналогично методу profile,

short (используется по умолчанию) — сокращенный, профиль фирмы выводится аналогично методу search.

page Нет Число Номер запрашиваемой страницы. Значение по умолчанию: 1.
pagesize Нет Число Количество результатов поиска, выводимых на одной странице. Значение по умолчанию: 4. Ограничение: от 1 до 10.
output Нет Строка Формат ответа. Может принимать значения xml, json, jsonp. По умолчанию используется json.
callback Нет Строка

Название callback функции для jsonp-запроса. Ограничение: последовательность латинских букв, цифр и знака подчеркивания. Максимальная длина названия callback функции — 128 символов. В случае неправильного задания используется значение по умолчанию (dgCallback).

Пример: myCallback_1

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

Параметр Тип Описание
api_version Строка Версия API, с которой идет работа. Возможные значения: 1.3.
response_code Строка Код ответа API. Подробнее см. Коды ответов.
В случае успешного ответа
what Строка Поисковый запрос (поле «Что?»).
where Строка Место, по которому производился поиск.
total Число Количество филиалов, найденных по запросу.
result Массив См. Рекламная информация.
В случае ошибки
error_code Строка Код ошибки, см. Коды ошибок.
error_message Строка

Описание ошибки.

Пример: API version must be set. Supported versions are: 1.3.

Рекламная информация
Параметр Тип Описание
id Строка Уникальный идентификатор филиала. Пример: 141265769336625.
lon Строка Долгота координаты места расположения филиала. Система координат WGS84. Пример: 82.9117574728652.
lat Строка Широта координаты места расположения филиала. Система координат WGS84. Пример: 55.0346747796494.
name Строка Название филиала. Пример: Сибакадемстрой Недвижимость, агентство недвижимости.
firm_group Объект Информация о фирме, к которой относится филиал. Объект с ключами id — уникальный идентификатор фирмы и count — количество филиалов фирмы.
hash Строка Уникальный хэш, требуется для передачи в запрос на получение профиля филиала.
city_name Строка Город, к которому относится филиал.
address Строка Адрес, по которому располагается филиал. Пример: Димитрова проспект, 7 - 2 этаж.
microcomment Строка Микрокомментарий (70 символов), позволяет акцентировать внимание пользователя сервиса на определенной организации в общем списке, размещается под ее названием.я. Пример: Деревянные окна и оконные блоки под ключ.
fas_warning Строка Предупреждение ФАС. Пример: Имеются противопоказания, необходимо проконсультироваться со специалистом.
advertising Объект Объявление рекламодателя. Объект с ключами titile — заголовок (35 символов) и text — текст (70 символов) рекламного объявления. Пример использования можно посмотреть здесь.
link Объект Рекламная ссылка. Параметр присутствует только для рекламных филиалов. См. Рекламная ссылка
rubrics Массив

Список рубрик, к которым относится филиал. Массив строк. Может отсутствовать в выдаче.

Пример: ["Пряжа","Товары для творчества и рукоделия","Швейная фурнитура"].

Рекламная ссылка
Параметр Тип Описание
link Строка URL ссылки
text Строка Текст ссылки

Кроме того, если запрос был сделан с параметром format=full, то к перечисленным полям добавятся и другие поля профиля филиала.

Примеры

  • Найти рекламу по запросу «Окна» в Москве. Результат показать в коротком формате.

    Запрос: http://catalog.api.2gis.ru/ads/search?what=окна&where=Москва&version=1.3&key=1234567890

    Ответ:

  • Найти рекламу по запросу «Недвижимость» в Москве. Результат показать в полном формате.

    Запрос: http://catalog.api.2gis.ru/ads/search?what=недвижимость&where=Москва&format=full&version=1.3&key=1234567890

    Ответ: