Posted:
Дек 27, 2022
Comments:
0 Comments

Яндекс справочник api: API у Яндекс.Справочника — Клуб API Карт

Содержание

Поиск по организациям. API поиска по организациям

API возвращает список организаций, наиболее подходящих запросу. Например, по запросу «аптеки Москвы» в списке результатов отобразятся не все аптеки города, а наиболее подходящие запросу с точки зрения API.

Ниже приведен пример запроса, а также формат ответа сервиса.

https://search-maps.yandex.ru/v1/?text=Автосервис, Москва, 2 Вязовский проезд 4а&type=biz&lang=ru_RU&results=1&apikey=<API-ключ>

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

{
  "type": "FeatureCollection",
  "properties": {
    "ResponseMetaData": {
      "SearchRequest": {
        "request": "Автосервис, Москва, 2 Вязовский проезд 4а",
        "results": 1,
        "skip": 0,
        "boundedBy": [
          [
            37. 04842675, 
            55.43644829
          ],
          [
            38.17590226,
            56.04690124
          ]
        ]
      },
      "SearchResponse": {
        "found": 36,
        "boundedBy": [
          [
            37.76257841,
            55.71649343
          ],
          [
            37.76644117, 
            55.72008348 
          ]
        ],
        "display": "multiple"
      }
    }
  },
  "features": [
    {
      "type": "Feature",
      "properties": {
        "CompanyMetaData": {
          "id": "1186386819",
          "name": "Автосервис 24 часа",
          "address": "Россия, Москва, 2-й Вязовский проезд, 4А, стр. 5",
          "url": "http://автосервис-ювао.рф/",
          "Categories": [
            {
              "class": "auto repair",
              "name": "Автосервис, автотехцентр"
            }, {
              "class": "tire fitting",
              "name": "Шиномонтаж"
            }, {
              "class": "car wash",
              "name": "Автомойка"
            }
          ],
          "Phones": [
            {
              "type": "phone",
              "formatted": "+7 (495) 778-44-45"
            }, {
              "type": "phone",
              "formatted": "+7 (499) 372-00-60",
            }
          ],
          "Hours": {
            "Availabilities": [
              {
                "Everyday": true,
                "TwentyFourHours": true
              }
            ],
            "text": "ежедневно, круглосуточно",
          }
        },  
        "description": "Россия, Москва, 2-й Вязовский проезд, 4А, стр.  5",
        "name": "Автосервис 24 часа",
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          37.764661,
          55.719081
        ]
      }
    }
  ]
}

type * Обязательный параметр»}}»>

Всегда имеет значение FeatureCollection. Таким образом обеспечивается соответствие (частичное) с форматом GeoJSON.

Обязательное поле.

properties

Контейнер метаданных, описывающих запрос и ответ.

ResponseMetaData * Обязательный параметр»}}»>

Метаданные, описывающие запрос и ответ. Обязательное поле.

SearchRequest * Обязательный параметр»}}»>

Метаданные, описывающие запрос. Обязательное поле.

request * Обязательный параметр»}}»>

Строка запроса. Обязательное поле.

results

Максимальное количество возвращаемых результатов.

skip

Количество пропускаемых результатов.

boundedBy

Границы области, в которой предположительно находятся искомые объекты. Границы задаются в виде координат левого верхнего и правого нижнего углов области. Координаты указаны в последовательности «долгота, широта».

Границы области определяются сервисом автоматически.

SearchResponse * Обязательный параметр»}}»>

Метаданные, описывающие ответ. Обязательное поле.

found * Обязательный параметр»}}»>

Количество найденных объектов. Обязательное поле.

boundedBy

Границы области показа найденных объектов. Содержит координаты левого нижнего и правого верхнего углов области. Координаты указаны в последовательности «долгота, широта».

display

Рекомендации по отображению результатов поиска. Возможные значения:

  • «single» — рекомендуется отображать только первый найденный объект;

  • «multiple» — рекомендуется отображать все найденные объекты.

features * Обязательный параметр»}}»>

Контейнер результатов поиска. Обязательное поле.

type * Обязательный параметр»}}»>

Всегда имеет значение Feature. Таким образом обеспечивается соответствие (частичное) с форматом GeoJSON.

Обязательное поле.

properties * Обязательный параметр»}}»>

Информация о найденном объекте. Обязательное поле.

CompanyMetaData

Содержит сведения об отдельной организации: адрес, контактную информацию, режим работы, вид деятельности и др.

id * Обязательный параметр»}}»>

Идентификатор организации. Обязательное поле.

name * Обязательный параметр»}}»>

Название организации. Обязательное поле.

address

Адрес организации.

url

Сайт организации.

Categories

Список категорий, в которые входит организация (например, салон красоты, отель или магазин).

class

Класс категории.

name * Обязательный параметр»}}»>

Название категории. Обязательное поле.

Phones

Список телефонных номеров организации и другая контактная информация.

type

Тип контактной информации (например, телефон или факс).

formatted * Обязательный параметр»}}»>

Полный номер телефона (или факса) с кодом страны и кодом города. Обязательное поле.

Hours

Режим работы организации.

Availabilities

Описание режима. Может содержать поля:

  • Weekdays|Weekend|Everyday|Sunday|Monday.. — рабочие дни;

  • TwentyFourHours|Intervals — часы работы.

Everyday

Организация работает каждый день.

TwentyFourHours

Организация работает круглосуточно.

text * Обязательный параметр»}}»>

Описание режима работы в виде произвольного текста. Обязательное поле.

description

Текст, который рекомендуется указывать в качестве подзаголовка при отображении найденной организации.

name

Текст, который рекомендуется указывать в качестве заголовка при отображении найденной организации.

geometry * Обязательный параметр»}}»>

Описание геометрии найденного объекта. Обязательное поле.

type * Обязательный параметр»}}»>

Тип геометрии. Обязательное поле.

coordinates * Обязательный параметр»}}»>

Координаты организации в последовательности «долгота, широта». Обязательное поле.

* Обязательный параметр

О справочнике. API Яндекс Директа. Версия 5

Ограничение.

Параметр StrategyPriority скоро перестанет приниматься и возвращаться в сервисах: AudienceTargets, Bids, DynamicTextAdTargets, KeywordBids, Keywords и SmartAdTargets. Пожалуйста, обновите свои приложения до конца января 2021.

Справочник содержит описание сервисов API Яндекс Директа версии 5. Документ адресован разработчикам приложений по управлению контекстной рекламой в Директе.

Ниже перечислены сервисы и методы API:

КампанииГруппы объявленийОбъявленияКлючевые фразы и автотаргетинги

Сервис: Campaigns

Методы:

  • add
  • archive
  • delete
  • get
  • resume
  • suspend
  • unarchive
  • update

Сервис: AdGroups

Методы:

  • add
  • delete
  • get
  • update

Сервис: Ads

Методы:

  • add
  • archive
  • delete
  • get
  • moderate
  • resume
  • suspend
  • unarchive
  • update

Сервис: Keywords

Методы:

  • add
  • delete
  • get
  • resume
  • suspend
  • update
СтавкиКорректировки ставокНаборы минус-фразПредобработка ключевых фраз

Сервис: Bids

Методы:

  • get
  • set
  • setAuto

Сервис: KeywordBids

Методы:

  • get
  • set
  • setAuto

Сервис: BidModifiers

Методы:

  • add
  • delete
  • get
  • set
  • toggle

Сервис: NegativeKeywordSharedSets

Методы:

  • add
  • delete
  • get
  • update

Сервис: KeywordsResearch

Методы:

  • deduplicate
  • hasSearchVolume
ОрганизацииВизиткиИзображенияКреативы

Сервис: Businesses

Метод: get

Сервис: VCards

Методы:

  • add
  • delete
  • get

Сервис: AdImages

Методы:

  • add
  • delete
  • get

Сервис: Creatives

Методы:

  • add
  • get
ВидеоТурбо-страницыДанные из форм на Турбо-страницахБыстрые ссылки

Сервис: AdVideos

Методы:

  • add
  • get

Сервис: TurboPages

Метод: get

Сервис: Leads

Метод: get

Сервис: Sitelinks

Методы:

  • add
  • delete
  • get
РасширенияУсловия нацеливания для динамических объявлений по фидамУсловия нацеливания на аудиториюУсловия подбора аудитории

Сервис: AdExtensions

Методы:

  • add
  • delete
  • get

Сервис: DynamicFeedAdTargets

Методы:

  • add
  • delete
  • get
  • resume
  • setBids
  • suspend

Сервис: AudienceTargets

Методы:

  • add
  • delete
  • get
  • resume
  • setBids
  • suspend

Сервис: RetargetingLists

Методы:

  • add
  • delete
  • get
  • update
Условия нацеливания для смарт-баннеровУсловия нацеливания для динамических объявленийКлиентыФиды

Сервис: SmartAdTargets

Методы:

  • add
  • delete
  • get
  • resume
  • setBids
  • suspend
  • update

Сервис: DynamicTextAdTargets

Методы:

  • add
  • delete
  • get
  • resume
  • setBids
  • suspend

Сервис: Clients

Методы:

  • get
  • update

Сервис: AgencyClients

Методы:

  • add
  • get
  • update

Сервис: Feeds

Методы:

  • add
  • delete
  • get
  • update
СправочникиИзменения

Сервис: Dictionaries

Метод: get

Сервис: Changes

Методы:

  • check
  • checkCampaigns
  • checkDictionaries

Примечание.

Методы для управления общими счетами, прогноза бюджета и подбора фраз, выполнения финансовых операций доступны в API версии 4 (Live 4). См. раздел Методы документации API версии 4 (Live 4).

Была ли статья полезна?

Предыдущая

Список терминов

Следующая

AdExtensions: операции с расширениями объявлений

Об этом справочнике. API Яндекс Директа. Версия 5

Ограничение.

Параметр StrategyPriority вскоре больше не будет приниматься и возвращаться службами: AudienceTargets, Bids, DynamicTextAdTargets, KeywordBids, Keywords и SmartAdTargets. Пожалуйста, обновите свои приложения до конца января 2021 года.

В этом справочнике описаны сервисы API Яндекс.Директа версии 5. Документ предназначен для разработчиков, которые создают приложения для управления контекстной рекламой в Яндекс.Директе.

The API services and methods are listed below:

3

17 Расширение0021

17

Campaigns Groups of ads Ads Keywords and autotargetings

Service: Campaigns

Methods :

  • добавить
  • архивировать
  • удалить
  • получить
  • возобновить
  • приостановить
  • разархивировать
  • обновить

Service: AdGroups

Methods:

  • add
  • delete
  • get
  • update

Service: Ads

Methods:

  • add
  • archive
  • delete
  • get
  • умеренный
  • резюме
  • приостановить
  • разархивировать
  • обновить

Сервис: Ключевые слова

Методы:

  • add
  • delete
  • get
  • resume
  • suspend
  • update
Bids Bid adjustments Sets of negative keywords Preprocessing keywords

Сервис: Ставки

Методы:

  • получить
  • установить
  • установитьАвто

Service: KeywordBids

Methods:

  • get
  • set
  • setAuto

Service: BidModifiers

Methods:

  • add
  • delete
  • get
  • set
  • toggle

Сервис: NegativeKeywordSharedSets

Методы:

  • добавить
  • удалить
  • получить
  • обновить

Service: KeywordsResearch

Methods:

  • deduplicate
  • hasSearchVolume
Businesses vCards Images Creatives

Service: Businesses

Метод: получить

Услуга: VCards

Методы:

  • добавить
  • удалить
  • get

Service: AdImages

Methods:

  • add
  • delete
  • get

Service: Creatives

Methods:

  • add
  • get
Видео Турбо-страницы Данные из форм на Турбо-страницах Дополнительные ссылки

Сервис: Advideos

Методы:

  • Добавить
  • GET

Сервис: Сервис: Сервис

.

Методы:

  • добавить
  • удалить
  • получить
Dynamic feed ad targets Audience targets Retargeting lists

Service: AdExtensions

Methods:

  • add
  • delete
  • get

Service: DynamicFeedAdTargets

Methods:

  • добавить
  • удалить
  • получить
  • возобновить
  • setBids
  • приостановить

Service: AudienceTargets

Methods:

  • add
  • delete
  • get
  • resume
  • setBids
  • suspend

Service: RetargetingLists

Methods:

  • add
  • delete
  • get
  • обновление
Цели смарт-баннера Цели динамической текстовой рекламы Clients Feeds

Service: SmartAdTargets

Methods:

  • add
  • delete
  • get
  • resume
  • setBids
  • suspend
  • update

Service: DynamicTextAdTargets

Методы:

  • добавить
  • удалить
  • получить
  • возобновить
  • setBids
  • приостановить

Service: Clients

Methods:

  • get
  • update

Service: AgencyClients

Methods:

  • add
  • get
  • update

Service: Feeds

Methods :

  • добавить
  • удалить
  • получить
  • обновить
Reference lists The changes

Service: Dictionaries

Method: get

Service: Changes

Methods:

  • check
  • checkCampaigns
  • checkDictionaries

Примечание.

Методы управления общими учетными записями, получения прогнозов бюджета и выбора ключевых слов, а также выполнения финансовых транзакций доступны в версии 4 (Live 4) API. См. раздел Методы в документации к API версии 4 (Live 4).

Была ли статья полезной?

Предыдущий

Список терминов

Следующие

Adextensions: операции с расширениями AD

Yandex-Webmaster-API · PYPI

Установка

Установка PIP …

4 
.

Использование

=======

 из yandex_webmaster импортировать YandexWebmaster
client = YandexWebmaster('<токен_доступа>')

получить хосты

  • док — https://yandex.ru/dev/webmaster/doc/dg/reference/hosts.html
 хостов = client.get_hosts()

получить популярные поисковые запросы 

 из datetime import datetime, timedelta
date_from = datetime.now() - дельта времени (дней = 4)
date_to = дата и время. сейчас()
результат = client.get_popular_search_queries('', date_from, date_to, query_indicator='TOTAL_SHOWS')

получить поисковый запрос всю историю 

 из datetime import datetime, timedelta
date_from = datetime.now() - дельта времени (дней = 4)
date_to = дата и время.сейчас()
результат = client.get_search_query_all_history('', date_from, date_to, query_indicator='TOTAL_SHOWS', device_type_indicator='DESKTOP')

получить историю одного поискового запроса 

 из datetime import datetime, timedelta
date_from = datetime.now() - дельта времени (дней = 4)
date_to = дата и время.сейчас()
результат = client.get_single_search_query_history('', '', date_from, date_to, query_indicator='TOTAL_SHOWS', device_type_indicator='DESKTOP')

получить информацию о хосте

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/hosts-id.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
 результат = client. get_host('')

получить историю sqi

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/sqi-history.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    дата_от дата и время требуется
    дата_до дата и время требуется
 из импорта datetime datetime, timedelta
date_from = datetime.now() - дельта времени (дней = 4)
date_to = дата и время.сейчас()
результат = client.get_sqi_history('', '', date_from, date_to)

добавить хост

  • документ — https://yandex. ru/dev/webmaster/doc/dg/reference/hosts-add-site.html
  • параметров
    имя тип значение по умолчанию
    host_url ул требуется
 результат = client.add_host(host_url='')

удалить хост

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/hosts-delete.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
 результат = client.delete_host(host_id='')

получить карту сайта

  • документ — https://yandex. ru/dev/webmaster/doc/dg/reference/host-sitemaps-get.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
 результат = client.get_sitemaps(host_id='')

get_sitemap

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/host-sitemaps-get.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    sitemap_id ул требуется
 результат = client. get_sitemap(host_id='', sitemap_id='')

добавить карту сайта

  • документ — https://yandex.ru/dev/webmaster/doc/dg/reference/host-user-added-sitemaps-post.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    host_url ул требуется
 результат = client.add_sitemap(host_id='', host_url='')

удалить карту сайта

  • документ — https://yandex.ru/dev/webmaster/doc/dg/reference/host-user-added-sitemaps-post.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    sitemap_id ул требуется
 результат = client. delete_sitemap(host_id='', sitemap_id='')

получить статистику индексации

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/host-id-summary.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
 результат = client.get_indexing_stats(host_id='')

получить историю индексации

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/host-id-summary.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    дата_от ул требуется
    дата_до ул требуется
 из импорта datetime datetime, timedelta
date_from = datetime. now() - дельта времени (дней = 4)
date_to = дата и время.сейчас()
результат = client.get_indexing_history(host_id='', date_from=date_from, date_to=date_to)

получить образцы индексации

  • док — https://yandex.ru/dev/webmaster/doc/dg/reference/hosts-indexing-samples.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    предел интервал 100
    оффест интервал 0
 результат = client.get_indexing_samples(host_id='')

получить мониторинг важных URL

  • doc — https://yandex. ru/dev/webmaster/doc/dg/reference/host-id-important-urls.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
 результат = client.get_monitoring_important_urls(host_id='')

получить важную историю URL

  • док — https://yandex.ru/dev/webmaster/doc/dg/reference/host-id-important-urls.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    адрес ул требуется
 результат = client. get_important_url_history(host_id='', url='')

получить историю адресов в поиске

  • документ — https://yandex.ru/dev/webmaster/doc/dg/reference/hosts-indexing-insearch-history.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    дата_от ул требуется
    дата_до ул требуется
 из импорта datetime datetime, timedelta
date_from = datetime.now() - дельта времени (дней = 4)
date_to = дата и время.сейчас()
результат = client.get_important_url_history(host_id='', date_from=date_from, date_to=date_to)

получить образцы URL-адресов

  • doc — https://yandex. ru/dev/webmaster/doc/dg/reference/hosts-indexing-insearch-history.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    предел интервал 100
    оффест интервал 0
 результат = client.get_insearch_url_samples(host_id='', limit=limit, offset=offset)

получить историю событий

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/hosts-search-events-history.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    дата_от ул требуется
    дата_до ул требуется
 из импорта datetime datetime, timedelta
date_from = datetime. now() - дельта времени (дней = 4)
date_to = дата и время.сейчас()
результат = client.get_insearch_url_events_history(host_id='', date_from=date_from, date_to=date_to)

получить примеры событий url insearch

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/hosts-search-events-samples.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    предел интервал 100
    оффест интервал 0
 результат = client.get_insearch_url_events_samples(host_id='', limit=limit, offset=offset)

URL повторного сканирования

  • doc — https://yandex. ru/dev/webmaster/doc/dg/reference/host-recrawl-post.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    адрес ул требуется
 результат = client.recrawl_url(host_id='', url='')

получить задачу повторного сканирования

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/host-recrawl-task-get.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    идентификатор_задачи ул требуется
 результат = client. get_recrawl_task(host_id='', task_id='')

получить задачи рекраула

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/host-recrawl-get.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    дата_от дата и время требуется
    дата_до дата и время требуется
    предел интервал 100
    смещение интервал 0
 из импорта datetime datetime, timedelta
date_from = datetime. now() - дельта времени (дней = 4)
date_to = дата и время.сейчас()
результат = client.get_recrawl_tasks(
    host_id='',
    дата_от = дата_от,
    дата_до=дата_до,
    лимит=10,
    смещение=10
)

получить квоту повторного сканирования

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/host-recrawl-quota-get.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
 результат = client.get_recrawl_quota(host_id='')

сайт диагностики

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/host-diagnostics-get.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
 результат = client. diagnostic_site(host_id='')

получить образцы битых внутренних ссылок

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/host-diagnostics-get.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    Индикатор ул требуется
    предел интервал 100
    смещение интервал 0
 результат = client.get_broken_internal_links_samples(host_id='', индикатор='SITE_ERROR')

получить историю битых внутренних ссылок

  • doc — https://yandex. ru/dev/webmaster/doc/dg/reference/host-links-internal-history.html
  • параметров
    имя тип значение по умолчанию
    host_id ул требуется
    дата_от дата и время требуется
    дата_до дата и время требуется
 из импорта datetime datetime, timedelta
date_from = datetime.now() - дельта времени (дней = 4)
date_to = дата и время.сейчас()
результат = client.get_broken_internal_links_samples(host_id='', date_from=date_from, date_to=date_to)

получить образцы внешних ссылок

  • doc — https://yandex.ru/dev/webmaster/doc/dg/reference/host-links-external-samples.

    This entry was posted in Ссылочное