ДокументацияAPIСообществоСоздать приложение
Войти
ads

ads.getSuggestions

Возвращает набор подсказок для различных параметров таргетинга.

Этот метод можно вызвать с ключом доступа пользователя.

Требуются права доступа: ads.

Параметры

section

string

Раздел, по которому запрашиваются подсказки. Поддерживаются следующие значения:

  • •
    countries — страны.
    • •
      q — необязательный параметр;
      • •
        1 — возвращается полный список стран;
      • •
        не задан — возвращается краткий список стран.
  • •
    regions — регионы.
    • •
      country — обязательный параметр;
    • •
      q — обязательный параметр.
  • •
    cities — города.
    • •
      country — обязательный параметр;
    • •
      q — необязательный параметр.
  • •
    districts — районы.
    • •
      cities — обязательный параметр.
  • •
    stations — станции метро.
    • •
      cities — обязательный параметр.
  • •
    streets — улицы.
    • •
      cities — обязательный параметр,
    • •
      q — обязательный параметр.
  • •
    schools — учебные заведения: школы, университеты, факультеты, кафедры.
    • •
      cities — обязательный параметр;
    • •
      q — обязательный параметр.
  • •
    interest_categories_v2 — категории интересов.
  • •
    interest_categories — устаревшие категории интересов.
  • •
    positions — должности (профессии).
    • •
      q — необязательный параметр.
  • •
    religions — религиозные взгляды.
  • •
    user_devices — устройства.
  • •
    user_os — операционные системы.
  • •
    user_browsers — интернет-браузеры.
ids

string

ID объектов, разделённые запятыми. Служит для расшифровки ID, возвращаемых в методе ads.getAdsTargeting. Если задан этот параметр, то параметры q, country, cities не должны передаваться, таким образом отменяется их обязательность для конкретного раздела. Объекты возвращаются в том же порядке, в каком они были заданы в этом параметре.

q

string

Строка-фильтр запроса.

country

string

Id страны, в которой ищутся объекты.

cities

string

Id городов, в которых ищутся объекты, разделенные запятыми.

lang

string

Язык возвращаемых строковых значений. Поддерживаемые языки:

  • •
    ru — русский;
  • •
    ua — украинский;
  • •
    en — английский.

Результат

Возвращает список объектов (подсказок), удовлетворяющих запросу.

Для разделов countries, positions, interest_categories, religions, user_devices, user_os, user_browsers ответ возвращается в виде массива объектов со следующими полями:

  • •
    id — идентификатор объекта;
  • •
    name — название объекта.

Для раздела regions ответ возвращается в виде массива объектов со следующими полями:

  • •
    id — идентификатор региона;
  • •
    name — название региона;
  • •
    type (необязательное) — название типа региона (область, автономный округ, край).

Для разделов cities, districts, streets ответ возвращается в виде массива объектов со следующими полями:

  • •
    id — идентификатор объекта;
  • •
    name — название объекта;
  • •
    parent — название города или страны, в котором находится объект.

Для раздела schools ответ возвращается в виде массива объектов со следующими полями:

  • •
    id — идентификатор учебного заведения;
  • •
    name — название учебного заведения;
  • •
    desc — полное название учебного заведения;
  • •
    type — тип учебного заведения:
    • •
      school — школа;
    • •
      university — университет;
    • •
      faculty — факультет;
    • •
      chair — кафедра.
  • •
    parent — название города, в котором находится учебное заведение.

Для раздела interests ответ возвращается в виде массива строк.

Коды ошибок

В ходе выполнения могут произойти общие ошибки.