Search - Get Search Address

  • Ссылка
Service:
Maps
API Version:
1.0

Используйте для получения координат широты и долготы адреса улицы в неструктурированном формате или входном формате запроса.

Get Search Address API — это HTTP-запросGET, возвращающий координаты широты и долготы при передаче в адресе улицы или названии места в качестве условия поиска.

Во многих случаях полная служба поиска может оказаться слишком большой, например, если вас интересует только традиционное геокодирование. Поиск также можно получить доступ исключительно для поиска адреса. Геокодирование выполняется путем попадания в конечную точку геокода только с указанным адресом или частичным адресом. Индекс поиска геокодирования будет запрашиваться для всех данных, превышающих уровень улиц. Никакие pois не возвращаются. Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все, от точных адресов улиц или улиц или пересечений, а также более высокого уровня географических регионов, таких как центры города, округа, штаты и т. д.

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}
With optional parameters: 
GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Параметры URI

Имя В Обязательно Тип Описание
format
 path True

ResponseFormat

Требуемый формат ответа. Значение может быть либо json , либо xml.
api-version
 query True

string

Номер версии API Azure Maps
query
 query True

string

Адрес для поиска (например, "1 Microsoft way, Redmond, WA") должен быть правильно закодирован.
btmRight
 query

string

Нижняя правая позиция ограничивающего прямоугольника. Например, 37,553,-122,453
countrySet
 query

string[]

Разделенная запятыми строка кодов стран и регионов, например FR,ES. При этом поиск будет ограничен указанными странами или регионами.
entityType
 query

GeographicEntityType

Указывает уровень фильтрации, выполняемой по географическим регионам. Сужает поиск указанных типов сущностей geography, например возвращает только муниципалитет. Полученный ответ будет содержать идентификатор geography, а также совпадающий тип сущности. Если указать несколько сущностей в виде списка, разделенного запятыми, конечная точка вернет наименьшую доступную сущность. Возвращаемый идентификатор геометрии можно использовать для получения геометрии этой географической области с помощью API получения Поиск многоугольников. Следующие параметры игнорируются при установке entityType:

  • heading
  • number
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
extendedPostalCodesFor
 query

SearchIndexes[]

Индексы, для которых в результаты должны быть включены расширенные почтовые индексы.

Доступные индексы:

Addr = диапазоны адресов

Geo = Geographies

PAD = точечные адреса

POI = точки интереса

Str = Улицы

XStr = cross Streets (пересечения)

Значение должно быть разделенным запятыми списком типов индексов (в любом порядке) или None без индексов.

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

Примеры использования

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона.
language
 query

string

Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию.

Дополнительные сведения см. в разделе Поддерживаемые языки .
lat
 query

number

double

Широта, где результаты должны быть смещены. Например, 37,337
limit
 query

integer

Максимальное количество возвращаемых ответов. По умолчанию: 10, минимум: 1 и максимум: 100
lon
 query

number

double

Долгота, где результаты должны быть смещены. Например, -121,89
ofs
 query

integer

Начальная смещение возвращаемых результатов в полном результирующем наборе. Значение по умолчанию: 0
radius
 query

integer

Радиус в метрах до для ограничения результатов определенной областью
topLeft
 query

string

Верхняя левая позиция ограничивающего прямоугольника. Например, 37,553,-122,453
typeahead
 query

boolean

Логическое. Если установлен флаг typeahead, запрос будет интерпретирован как частичные входные данные, а поиск перейдет в прогнозный режим.
view
 query

LocalizedMapView

Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию параметр View имеет значение Unified, даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное указание параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которой доступны карты, изображения и другие данные и содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN.

Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления.

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя Тип Описание
200 OK

SearchAddressResult

ОК
Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.

Примечание

  • Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами .
  • объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID.
  • Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.
  • Использование веб-пакета SDK для Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.
  • Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании учетной записи Azure Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение может получить доступ ко всем REST API. Иными словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.

Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к Azure Maps REST API, чтобы ключ можно было безопасно хранить.

Type: apiKey
In: query

SAS Token

Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Sample Request

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Sample Response

Status code:
200 
{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Определения

Имя Описание
Address

Адрес результата
AddressRanges

Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.
BoundingBox

Окно просмотра, которое охватывает результат, представленный левой верхней и нижней правой координатами окна просмотра.
BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.
Brand

Торговая марка, связанная с poi
Classification

Классификация возвращаемого poI
ClassificationName

Имя классификации
DataSources

Необязательный раздел. Идентификаторы ссылок для использования с API Get Поиск Polygon.
Entity

Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.
EntryPoint

Точка входа для возвращаемого poI.
EntryPointType

Тип точки входа. Значение может быть main или дополнительным.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Сообщение об ошибке
GeographicEntityType

Тип сущности Geography. Отображается только в том случае, если сущность была запрошена и доступна.
Geometry

Сведения о геометрической форме результата. Присутствует, только если тип == Geography.
LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
LocalizedMapView

Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию для параметра View задано значение Unified, даже если вы не определили его в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное определение параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которых доступны карты, изображения и другие данные, а также содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN.

Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления .
MatchType

Типы совпадений для операции обратного поиска по адресу.
OperatingHours

Часы работы для POI (достопримечательностей).
OperatingHoursTime

Представляет дату и время
OperatingHoursTimeRange

Открытый диапазон времени для дня
PointOfInterest

Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.
PointOfInterestCategorySet

Категория POI
QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.
ResponseFormat

Требуемый формат ответа. Значение может быть либо json , либо xml.
SearchAddressResult

Этот объект возвращается из успешных вызовов Поиск.
SearchAddressResultItem

Результирующий объект для ответа API Поиск.
SearchAddressResultType

Одно из двух значений:

  • POI
  • Улица
  • Географический регион
  • Точечный адрес
  • Диапазон адресов
  • Перекресток
SearchIndexes

Индексы, для которых в результаты должны быть включены расширенные почтовые индексы.

Доступные индексы:

Addr = диапазоны адресов

Geo = Geographies

PAD = точечные адреса

POI = точки интереса

Str = Улицы

XStr = cross Streets (пересечения)

Значение должно быть разделенным запятыми списком типов индексов (в любом порядке) или None без индексов.

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

Примеры использования

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона.
SearchSummary

Объект Summary для ответа API Поиск.

Address

Адрес результата

Имя Тип Описание
boundingBox

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.
buildingNumber

string

Номер здания на улице. НЕ РЕКОМЕНДУЕТСЯ, используйте streetNumber.
country

string

название страны или региона
countryCode

string

Страна (примечание. Это двухбуквенный код, а не название страны или региона.)
countryCodeISO3

string

Код страны ISO alpha-3
countrySecondarySubdivision

string

Округ
countrySubdivision

string

Область, республика, край
countrySubdivisionCode

string

countrySubdivisionCode с префиксом countryCode ( countryCode-countrySubdivisionCode ) и дефисом формируется код ISO 3166-2. Примеры: TX для Техаса, SCT для Шотландии и ON для Онтарио.
countrySubdivisionName

string

Полное имя первого уровня административной иерархии страны или региона. Это поле отображается только в том случае, если countrySubdivision представлено в сокращенном виде. Поддерживается только для США, Канады и Соединенного Королевства.
countryTertiarySubdivision

string

Именованной области
crossStreet

string

Название пересекаемой улицы.
extendedPostalCode

string

Расширенный почтовый индекс (доступность зависит от региона).
freeformAddress

string

Адресная строка, отформатированная в соответствии с правилами форматирования страны или региона источника результата, или, в случае страны или региона, полного названия страны или региона.
localName

string

Компонент адреса, представляющий имя географической области или местности, которая группирует несколько адресуемых объектов для целей адресации, не являясь административной единицей. Это поле используется для построения freeformAddress свойства . localName представляет почтовый муниципалитет. В зависимости от расположения — localName это общеизвестное название города или города. Для общего названия города используйте localName вместо municipality.
municipality

string

Город или город
Примечание. municipality Представляет жилой муниципалитет. В зависимости от расположения значение municipality может отличаться от общего названия города или города. Для общего названия города или города рекомендуется localName использовать значение вместо municipality значения .
municipalitySubdivision

string

Sub / Super City
neighbourhood

string

Район — это географически локализованная область в пределах города или города с отличительными характеристиками и социальными взаимодействиями между жителями.
postalCode

string

Почтовый индекс/ почтовый индекс
routeNumbers

string[]

Коды, используемые для однозначной идентификации улицы
street

string

Название улицы. НЕ РЕКОМЕНДУЕТСЯ, используйте streetName.
streetName

string

Название улицы.
streetNameAndNumber

string

Название и номер улицы.
streetNumber

string

Номер здания на улице.

AddressRanges

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

Имя Тип Описание
from

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
rangeLeft

string

Диапазон адресов на левой стороне улицы.
rangeRight

string

Диапазон адресов на правой стороне улицы.
to

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

BoundingBox

Окно просмотра, которое охватывает результат, представленный левой верхней и нижней правой координатами окна просмотра.

Имя Тип Описание
btmRightPoint

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
topLeftPoint

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.

Имя Тип Описание
entity

Entity

Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.
northEast

string

Северо-восточная широта, координата долготы ограничивающего прямоугольника в виде с плавающей точкой с разделиниями-запятыми
southWest

string

Юго-западная широта, координата долготы ограничивающего прямоугольника в виде с плавающей точкой, разделенной запятыми

Brand

Торговая марка, связанная с poi

Имя Тип Описание
name

string

Название торговой марки

Classification

Классификация возвращаемого poI

Имя Тип Описание
code

string

Свойство Code
names

ClassificationName[]

Массив имен

ClassificationName

Имя классификации

Имя Тип Описание
name

string

Name - свойство
nameLocale

string

Свойство "Языковой стандарт имени"

DataSources

Необязательный раздел. Идентификаторы ссылок для использования с API Get Поиск Polygon.

Имя Тип Описание
geometry

Geometry

Сведения о геометрической форме результата. Присутствует, только если тип == Geography.

Entity

Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.

Имя Тип Описание
position

string

Сущность Position

EntryPoint

Точка входа для возвращаемого poI.

Имя Тип Описание
position

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
type

EntryPointType

Тип точки входа. Значение может быть main или дополнительным.

EntryPointType

Тип точки входа. Значение может быть main или дополнительным.

Имя Тип Описание
main

string

minor

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект error.

GeographicEntityType

Тип сущности Geography. Отображается только в том случае, если сущность была запрошена и доступна.

Имя Тип Описание
Country

string

название страны или региона
CountrySecondarySubdivision

string

Округ
CountrySubdivision

string

Область, республика, край
CountryTertiarySubdivision

string

Именованной области
Municipality

string

Город или город
MunicipalitySubdivision

string

Sub / Super City
Neighbourhood

string

Районе
PostalCodeArea

string

Почтовый индекс/ почтовый индекс

Geometry

Сведения о геометрической форме результата. Присутствует, только если тип == Geography.

Имя Тип Описание
id

string

Передайте его как geometryId в API получения Поиск Polygon, чтобы получить геометрическую информацию для этого результата.

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".

Имя Тип Описание
lat

number

Свойство Latitude
lon

number

Свойство Longitude

LocalizedMapView

Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию для параметра View задано значение Unified, даже если вы не определили его в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное определение параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которых доступны карты, изображения и другие данные, а также содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN.

Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления .

Имя Тип Описание
AE

string

Объединенные Арабские Эмираты (арабское представление)
AR

string

Аргентина (аргентинское представление)
Auto

string

Данные карт возвращаются с учетом IP-адреса запроса.
BH

string

Бахрейн (арабское представление)
IN

string

Индия (индийское представление)
IQ

string

Ирак (арабское представление)
JO

string

Иордан (арабское представление)
KW

string

Кувейт (арабское представление)
LB

string

Ливан (арабское представление)
MA

string

Марокко (марокканское представление)
OM

string

Оман (арабское представление)
PK

string

Пакистан (пакистанское представление)
PS

string

Палестинская Автономия (арабское представление)
QA

string

Катар (арабское представление)
SA

string

Саудовская Аравия (арабское представление)
SY

string

Сирия (арабское представление)
Unified

string

Унифицированное представление (прочие)
YE

string

Йемен (арабское представление)

MatchType

Типы совпадений для операции обратного поиска по адресу.

Имя Тип Описание
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Часы работы для POI (достопримечательностей).

Имя Тип Описание
mode

string

Значение, используемое в запросе: none или nextSevenDays
timeRanges

OperatingHoursTimeRange[]

Список диапазонов времени на следующие 7 дней

OperatingHoursTime

Представляет дату и время

Имя Тип Описание
date

string

Представляет текущую дату календаря в часовом поясе POI, например 07.02.2019.
hour

integer

Часы в 24-часовом формате по местному времени POI; Возможные значения: от 0 до 23.
minute

integer

Минуты относятся к местному времени POI; Возможные значения: от 0 до 59.

OperatingHoursTimeRange

Открытый диапазон времени для дня

Имя Тип Описание
endTime

OperatingHoursTime

Точка в диапазоне следующих 7 дней при закрытии заданного POI или начало диапазона, если он был закрыт до диапазона.
startTime

OperatingHoursTime

Точка в диапазоне следующих 7 дней, когда открывается данный poI, или начало диапазона, если он был открыт до диапазона.

PointOfInterest

Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.

Имя Тип Описание
brands

Brand[]

Массив торговых марок. Имя торговой марки для возвращаемого poI.
categories

string[]

Массив категорий
categorySet

PointOfInterestCategorySet[]

Список наиболее конкретных категорий POI
classifications

Classification[]

Массив классификации
name

string

Имя свойства POI
openingHours

OperatingHours

Часы работы для POI (достопримечательностей).
phone

string

Свойство номера телефона
url

string

Свойство URL-адреса веб-сайта

PointOfInterestCategorySet

Категория POI

Имя Тип Описание
id

integer

Идентификатор категории

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.

Имя Тип Описание
NEARBY

string

Поиск выполнено вокруг определенной широты и долготы с заданным радиусом
NON_NEAR

string

Поиск выполнялась глобально без смещения к определенной широте и долготе без определенного радиуса

ResponseFormat

Требуемый формат ответа. Значение может быть либо json , либо xml.

Имя Тип Описание
json

string

Формат обмена данными нотации объектов JavaScript
xml

string

Язык расширяемой разметки

SearchAddressResult

Этот объект возвращается из успешных вызовов Поиск.

Имя Тип Описание
results

SearchAddressResultItem[]

Список результатов Поиск API.
summary

SearchSummary

Объект Summary для ответа API Поиск

SearchAddressResultItem

Результирующий объект для ответа API Поиск.

Имя Тип Описание
address

Address

Адрес результата
addressRanges

AddressRanges

Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.
dataSources

DataSources

Необязательный раздел. Идентификатор геометрии ссылки для использования с API получения Поиск Polygon.
detourTime

integer

Время объезда в секундах. Возвращается только для вызовов API Поиск Вдоль маршрута.
dist

number

Расстояние по прямой линии между результатом и расположением геобия в метрах.
entityType

GeographicEntityType

Тип сущности Geography. Отображается только в том случае, если сущность была запрошена и доступна.
entryPoints

EntryPoint[]

Массив точек входа. Они описывают типы входов, доступных на месте. Тип может быть "main" для main входов, таких как входная дверь или вестибюль, и "незначительный" для боковых и задних дверей.
id

string

Свойство Id
info

string

Сведения об исходном источнике данных result. Используется для запросов в службу поддержки.
matchType

MatchType

Сведения о типе соответствия.

Одно из двух значений:

  • Адресная точка
  • HouseNumberRange
  • Улица
poi

PointOfInterest

Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.
position

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon".
score

number

Значение в результирующем наборе, указывающее относительную оценку сопоставления между результатами. С его помощью можно определить, что результат x в два раза выше, чем результат y, если значение x равно 2x значению y. Значения различаются в разных запросах и предназначены только как относительное значение для одного результирующих наборов.
type

SearchAddressResultType

Одно из двух значений:

  • POI
  • Улица
  • Географический регион
  • Точечный адрес
  • Диапазон адресов
  • Перекресток
viewport

BoundingBox

Окно просмотра, которое охватывает результат, представленный левой верхней и нижней правой координатами окна просмотра.

SearchAddressResultType

Одно из двух значений:

  • POI
  • Улица
  • Географический регион
  • Точечный адрес
  • Диапазон адресов
  • Перекресток
Имя Тип Описание
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchIndexes

Индексы, для которых в результаты должны быть включены расширенные почтовые индексы.

Доступные индексы:

Addr = диапазоны адресов

Geo = Geographies

PAD = точечные адреса

POI = точки интереса

Str = Улицы

XStr = cross Streets (пересечения)

Значение должно быть разделенным запятыми списком типов индексов (в любом порядке) или None без индексов.

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

Примеры использования

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона.

Имя Тип Описание
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchSummary

Объект Summary для ответа API Поиск.

Имя Тип Описание
fuzzyLevel

integer

Максимальный уровень нечеткости, необходимый для предоставления результатов.
geoBias

LatLongPairAbbreviated

Указание того, что внутренняя поисковая система применила геопространственный смещение для улучшения ранжирования результатов. В некоторых методах на это можно повлиять, задав параметры lat и lon, если они доступны. В других случаях она является чисто внутренней.
limit

integer

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

integer

Количество результатов в ответе.
offset

integer

Начальная смещение возвращаемых результатов в полном результирующем наборе.
query

string

Параметр запроса, который использовался для получения этих результатов поиска.
queryTime

integer

Время, затраченное на разрешение запроса, в миллисекундах.
queryType

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.
totalResults

integer

Общее число найденных результатов.