Search - Get Search Fuzzy
Используйте, если вам нужен поисковый запрос, который может обрабатывать сочетания адресов и маркеров POI.
Get Search Fuzzy
API (бесплатная форма Поиск), HTTP-запросGET
, который легко обрабатывает сочетание поиска POI и геокодирования. Это API Поиск свободной формы, который обрабатывает нечеткие входные данные, содержащие любое сочетание маркеров адреса или POI, в качестве канонического поиска в одной строке. Он также может быть взвешен контекстно-информативным положением (пара lat/lon) или полностью ограничен координатами и радиусом или может выполняться в более общем случае без точки привязки географического смещения.
Мы настоятельно рекомендуем использовать параметр countrySet, чтобы указать только страны или регионы, для которых требуется охват приложения, так как по умолчанию будет выполняться поиск по всему миру, что может привести к возврату ненужных результатов.
Например: countrySet
=US,FR
Полный список всех поддерживаемых стран и регионов см. в Поиск покрытия.
Большинство запросов Поиск по умолчанию maxFuzzyLevel
равно =2, чтобы повысить производительность, а также уменьшить необычные результаты. Это новое значение по умолчанию можно переопределить по мере необходимости для каждого запроса, передав параметр maxFuzzyLevel
запроса =3 или 4.
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&minFuzzyLevel={minFuzzyLevel}&maxFuzzyLevel={maxFuzzyLevel}&idxSet={idxSet}&brandSet={brandSet}&connectorSet={connectorSet}&entityType={entityType}&view={view}&openingHours=nextSevenDays
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
format
|
path | True |
Требуемый формат ответа. Значение может быть либо json , либо xml. |
|
api-version
|
query | True |
string |
Номер версии API Azure Maps |
query
|
query | True |
string |
Применимая строка запроса (например, "seattle", "pizza"). Можно также указать в виде строки, разделенной запятыми, состоящей из широты и долготы (например, "47,641268, -122,125679"). Должен быть правильно закодирован URL-адрес. |
brand
|
query |
string[] |
Разделенный запятыми список торговых марок, который можно использовать для ограничения результата определенными брендами. Порядок элементов не имеет значения. При указании нескольких торговых марок возвращаются только результаты, принадлежащие (по крайней мере) одному из предоставленных списков. Торговые марки, содержащие "," в их названии должны быть заключены в кавычки. Примеры использования brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Запятая",Строка |
|
btm
|
query |
string |
Нижняя правая позиция ограничивающего прямоугольника. Например, 37,553,-122,453 |
|
category
|
query |
integer[] |
Разделенный запятыми список идентификаторов наборов категорий, который можно использовать для ограничения результата определенными категориями точек интереса. Порядок идентификации не имеет значения. Максимальное количество значений, поддерживаемых
|
|
connector
|
query |
Разделенный запятыми список типов соединителей, которые можно использовать для ограничения результата электрическими транспортными станциями, поддерживающими определенные типы соединителей. Порядок элементов не имеет значения. Если указано несколько типов соединителей, будут возвращены только результаты, принадлежащие (по крайней мере) одному из предоставленных списков. Доступные типы соединителей:
Примеры использования connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
Разделенная запятыми строка кодов стран и регионов, например FR,ES. При этом поиск будет ограничен указанными странами или регионами. |
|
entity
|
query |
Указывает уровень фильтрации, выполняемой по географическим регионам. Сужает поиск указанных типов сущностей geography, например возвращает только муниципалитет. Полученный ответ будет содержать идентификатор geography, а также совпадающий тип сущности. Если указать несколько сущностей в виде списка, разделенного запятыми, конечная точка вернет наименьшую доступную сущность. Возвращаемый идентификатор геометрии можно использовать для получения геометрии этой географической области с помощью API получения Поиск polygon. Следующие параметры игнорируются при установке entityType:
|
||
extended
|
query |
Индексы, для которых в результаты должны быть включены расширенные почтовые индексы. Доступные индексы: Addr = диапазоны адресов Geo = Geographies PAD = точечные адреса POI = точки интереса Str = Улицы XStr = cross Streets (пересечения) Значение должно быть разделенным запятыми списком типов индексов (в любом порядке) или None без индексов. По умолчанию расширенные почтовые индексы включаются для всех индексов, кроме географических. Расширенные списки почтовых индексов для географических регионов могут быть довольно длинными, поэтому их необходимо явно запрашивать при необходимости. Примеры использования extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона. |
||
idx
|
query |
Разделенный запятыми список индексов, которые должны использоваться для поиска. Порядок элементов не имеет значения. Доступные индексы: Addr = Интерполяция диапазона адресов, Geo = Geographies, PAD = Point Addresss, POI = Точки интереса, Str = Streets, Xstr = Cross Streets (пересечения) |
||
language
|
query |
string |
Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в разделе Поддерживаемые языки . |
|
lat
|
query |
number double |
Широта, где результаты должны быть смещены. Например, 37,337 |
|
limit
|
query |
integer |
Максимальное количество возвращаемых ответов. По умолчанию: 10, минимум: 1 и максимум: 100 |
|
lon
|
query |
number double |
Долгота, где результаты должны быть смещены. Например, -121,89 |
|
max
|
query |
integer |
Максимальный используемый уровень нечеткости. По умолчанию: 2, минимум: 1 и максимум: 4
Поисковая система начнет искать совпадения на уровне, определенном minFuzzyLevel, и прекратит поиск на уровне, указанном параметром maxFuzzyLevel. |
|
min
|
query |
integer |
Минимальный используемый уровень нечеткости. По умолчанию: 1, минимум: 1 и максимум: 4
Поисковая система начнет искать совпадения на уровне, определенном minFuzzyLevel, и прекратит поиск на уровне, указанном параметром maxFuzzyLevel. |
|
ofs
|
query |
integer |
Начальная смещение возвращаемых результатов в полном результирующем наборе. Значение по умолчанию: 0 |
|
opening
|
query |
Часы работы для POI (точки интереса). Доступность часов работы зависит от доступных данных. Если значение не прошло, информация о часах работы не будет возвращена. Поддерживаемое значение: nextSevenDays |
||
radius
|
query |
integer |
Радиус в метрах до для ограничения результатов определенной областью |
|
top
|
query |
string |
Верхняя левая позиция ограничивающего прямоугольника. Например, 37,553,-122,453 |
|
typeahead
|
query |
boolean |
Логическое. Если установлен флаг typeahead, запрос будет интерпретирован как частичные входные данные, а поиск перейдет в прогнозный режим. |
|
view
|
query |
Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр 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 |
ОК |
|
Other Status Codes |
Произошла непредвиденная ошибка. |
Безопасность
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 позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.
- Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
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, чтобы ключ можно было безопасно хранить.
Тип:
apiKey
В:
query
SAS Token
Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.
С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Тип:
apiKey
В:
header
Примеры
Search City Seattle
Образец запроса
GET https://atlas.microsoft.com/search/fuzzy/json?api-version=1.0&query=seattle&openingHours=nextSevenDays
Пример ответа
{
"summary": {
"query": "seattle",
"queryType": "NON_NEAR",
"queryTime": 66,
"numResults": 10,
"offset": 0,
"totalResults": 3720,
"fuzzyLevel": 1
},
"results": [
{
"type": "Geography",
"id": "US/GEO/p0/188055",
"score": 2.531,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60323,
"lon": -122.33028
},
"viewport": {
"topLeftPoint": {
"lat": 47.7344,
"lon": -122.4594
},
"btmRightPoint": {
"lat": 47.48106,
"lon": -122.22497
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-0000596ae8ed"
}
}
},
{
"type": "Geography",
"id": "US/GEO/p0/183911",
"score": 2.382,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.55342,
"lon": -122.25007
},
"viewport": {
"topLeftPoint": {
"lat": 47.58995,
"lon": -122.26723
},
"btmRightPoint": {
"lat": 47.5169,
"lon": -122.23291
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-00006553f33d"
}
}
},
{
"type": "POI",
"id": "ZA/POI/p0/449288",
"score": 2.226,
"info": "search:ta:710009004165863-ZA",
"poi": {
"name": "Seattle Coffee Co - Groote Kerk Sentrum",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Kloof Street",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "8001",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Kloof Street, Gardens, City of Cape Town, Western Cape, 8001",
"localName": "Gardens"
},
"position": {
"lat": -33.92917,
"lon": 18.41178
},
"viewport": {
"topLeftPoint": {
"lat": -33.92827,
"lon": 18.4107
},
"btmRightPoint": {
"lat": -33.93007,
"lon": 18.41286
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.92907,
"lon": 18.41162
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/449396",
"score": 2.226,
"info": "search:ta:710009004163591-ZA",
"poi": {
"name": "Seattle Coffee Co - Pietermaritzburg",
"phone": "+(27)-(33)-3458486",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "9",
"streetName": "Armitage Road",
"municipalitySubdivision": "Pietermaritzburg City, Pietermaritzburg",
"municipality": "Pietermaritzburg",
"countrySecondarySubdivision": "The Msunduzi",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "3201",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Armitage Road 9, Athlone, The Msunduzi, KwaZulu-Natal, 3201",
"localName": "Athlone"
},
"position": {
"lat": -29.58611,
"lon": 30.37508
},
"viewport": {
"topLeftPoint": {
"lat": -29.58521,
"lon": 30.37405
},
"btmRightPoint": {
"lat": -29.58701,
"lon": 30.37611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -29.58668,
"lon": 30.37531
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/451868",
"score": 2.226,
"info": "search:ta:710009002195538-ZA",
"poi": {
"name": "Seattle Coffee Co - Bedford Village",
"phone": "+(27)-(84)-5451111",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Van Buuren Road",
"municipalitySubdivision": "Bedfordview",
"municipality": "Germiston",
"countrySecondarySubdivision": "Ekurhuleni",
"countrySubdivisionCode": "Gauteng",
"postalCode": "2007",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Van Buuren Road, Bedfordview, Ekurhuleni, Gauteng, 2007",
"localName": "Bedfordview"
},
"position": {
"lat": -26.18009,
"lon": 28.13544
},
"viewport": {
"topLeftPoint": {
"lat": -26.17919,
"lon": 28.13444
},
"btmRightPoint": {
"lat": -26.18099,
"lon": 28.13644
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -26.18006,
"lon": 28.13636
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/488888",
"score": 2.226,
"info": "search:ta:710009002102639-ZA",
"poi": {
"name": "Seattle Coffee Co - Caltex Starstop Milly's",
"phone": "+(27)-(13)-2560340",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipality": "Wonderfontein",
"countrySecondarySubdivision": "Emakhazeni",
"countrySubdivisionCode": "Mpumalanga",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Wonderfontein, Emakhazeni, Mpumalanga"
},
"position": {
"lat": -25.68842,
"lon": 30.21291
},
"viewport": {
"topLeftPoint": {
"lat": -25.68752,
"lon": 30.21191
},
"btmRightPoint": {
"lat": -25.68932,
"lon": 30.21391
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -25.68913,
"lon": 30.21343
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489433",
"score": 2.226,
"info": "search:ta:710009002184068-ZA",
"poi": {
"name": "Seattle Coffee Co - Southcoast Mall",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79937,
"lon": 30.40569
},
"viewport": {
"topLeftPoint": {
"lat": -30.79847,
"lon": 30.40464
},
"btmRightPoint": {
"lat": -30.80027,
"lon": 30.40674
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.7994,
"lon": 30.40618
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489976",
"score": 2.226,
"info": "search:ta:710009004261897-ZA",
"poi": {
"name": "Seattle Cofee Co",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79801,
"lon": 30.40557
},
"viewport": {
"topLeftPoint": {
"lat": -30.79711,
"lon": 30.40452
},
"btmRightPoint": {
"lat": -30.79891,
"lon": 30.40662
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.79784,
"lon": 30.40523
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/490056",
"score": 2.226,
"info": "search:ta:710009004149612-ZA",
"poi": {
"name": "Seattle Coffee Co - Constantia Village",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Constantia Main Road",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7708",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Constantia Main Road, Constantia, City of Cape Town, Western Cape, 7708",
"localName": "Constantia"
},
"position": {
"lat": -34.02087,
"lon": 18.44503
},
"viewport": {
"topLeftPoint": {
"lat": -34.01997,
"lon": 18.44394
},
"btmRightPoint": {
"lat": -34.02177,
"lon": 18.44612
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -34.02017,
"lon": 18.44476
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/494340",
"score": 2.226,
"info": "search:ta:710009004152570-ZA",
"poi": {
"name": "Seattle Coffee Co - Canal Walk Shopping Centre",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Century Boulevard",
"municipalitySubdivision": "Milnerton",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7441",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Century Boulevard, Century City, City of Cape Town, Western Cape, 7441",
"localName": "Century City"
},
"position": {
"lat": -33.89348,
"lon": 18.5122
},
"viewport": {
"topLeftPoint": {
"lat": -33.89258,
"lon": 18.51112
},
"btmRightPoint": {
"lat": -33.89438,
"lon": 18.51328
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.8943,
"lon": 18.51328
}
}
]
}
]
}
Определения
Имя | Описание |
---|---|
Address |
Адрес результата |
Address |
Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов. |
Bounding |
Окно просмотра, которое охватывает результат, представленный левой верхней и нижней правой координатами окна просмотра. |
Bounding |
Ограничивающий прямоугольник расположения. |
Brand |
Торговая марка, связанная с poi |
Classification |
Классификация возвращаемого poI |
Classification |
Имя классификации |
Data |
Необязательный раздел. Идентификаторы ссылок для использования с API Get Поиск Polygon. |
Electric |
Разделенный запятыми список типов соединителей, которые можно использовать для ограничения результата электрическими транспортными станциями, поддерживающими определенные типы соединителей. Порядок элементов не имеет значения. Если указано несколько типов соединителей, будут возвращены только результаты, принадлежащие (по крайней мере) одному из предоставленных списков. Доступные типы соединителей:
Примеры использования connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению. |
Entry |
Точка входа для возвращаемого poI. |
Entry |
Тип точки входа. Значение может быть main или дополнительным. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Geographic |
Тип сущности Geography. Отображается только в том случае, если сущность была запрошена и доступна. |
Geometry |
Сведения о геометрической форме результата. Присутствует, только если тип == Geography. |
Lat |
Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon". |
Localized |
Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию для параметра View задано значение Unified, даже если вы не определили его в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное определение параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которых доступны карты, изображения и другие данные, а также содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN. Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления . |
Match |
Типы совпадений для операции обратного поиска по адресу. |
Operating |
Часы работы для POI (достопримечательностей). |
Operating |
Часы работы для POI (точки интереса). Доступность часов работы зависит от доступных данных. Если это не пройдено, информация о часах работы не будет возвращена. Поддерживаемое значение: nextSevenDays |
Operating |
Представляет дату и время |
Operating |
Открытый диапазон времени для дня |
Point |
Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации. |
Point |
Категория POI |
Query |
Тип возвращаемого запроса: NEARBY или NON_NEAR. |
Response |
Требуемый формат ответа. Значение может быть либо json , либо xml. |
Search |
Этот объект возвращается из успешного вызова Поиск. |
Search |
Результирующий объект для ответа API Поиск. |
Search |
Одно из двух значений:
|
Search |
Индексы, для которых в результаты должны быть включены расширенные почтовые индексы. Доступные индексы: Addr = диапазоны адресов Geo = Geographies PAD = точечные адреса POI = точки интереса Str = Улицы XStr = cross Streets (пересечения) Значение должно быть разделенным запятыми списком типов индексов (в любом порядке) или None без индексов. По умолчанию расширенные почтовые индексы включаются для всех индексов, кроме географических. Расширенные списки почтовых индексов для географических регионов могут быть довольно длинными, поэтому их необходимо явно запрашивать при необходимости. Примеры использования extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона. |
Search |
Объект Summary для ответа API Поиск. |
Address
Адрес результата
Имя | Тип | Описание |
---|---|---|
boundingBox |
Ограничивающий прямоугольник расположения. |
|
buildingNumber |
string |
Номер здания на улице. НЕ РЕКОМЕНДУЕТСЯ, используйте streetNumber. |
country |
string |
название страны или региона |
countryCode |
string |
Страна (примечание. Это двухбуквенный код, а не название страны или региона.) |
countryCodeISO3 |
string |
Код страны ISO alpha-3 |
countrySecondarySubdivision |
string |
Округ |
countrySubdivision |
string |
Область, республика, край |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
Полное имя первого уровня административной иерархии страны или региона. Это поле отображается только в том случае, если countrySubdivision представлено в сокращенном виде. Поддерживается только для США, Канады и Соединенного Королевства. |
countryTertiarySubdivision |
string |
Именованной области |
crossStreet |
string |
Название пересекаемой улицы. |
extendedPostalCode |
string |
Расширенный почтовый индекс (доступность зависит от региона). |
freeformAddress |
string |
Адресная строка, отформатированная в соответствии с правилами форматирования страны или региона источника результата, или, в случае страны или региона, полного названия страны или региона. |
localName |
string |
Компонент адреса, представляющий имя географической области или местности, которая группирует несколько адресуемых объектов для целей адресации, не являясь административной единицей. Это поле используется для построения |
municipality |
string |
Город или город |
municipalitySubdivision |
string |
Sub / Super City |
neighbourhood |
string |
Район — это географически локализованная область в пределах города или города с отличительными характеристиками и социальными взаимодействиями между жителями. |
postalCode |
string |
Почтовый индекс/ почтовый индекс |
routeNumbers |
string[] |
Коды, используемые для однозначной идентификации улицы |
street |
string |
Название улицы. НЕ РЕКОМЕНДУЕТСЯ, используйте streetName. |
streetName |
string |
Название улицы. |
streetNameAndNumber |
string |
Название и номер улицы. |
streetNumber |
string |
Номер здания на улице. |
AddressRanges
Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов.
Имя | Тип | Описание |
---|---|---|
from |
Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon". |
|
rangeLeft |
string |
Диапазон адресов на левой стороне улицы. |
rangeRight |
string |
Диапазон адресов на правой стороне улицы. |
to |
Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon". |
BoundingBox
Окно просмотра, которое охватывает результат, представленный левой верхней и нижней правой координатами окна просмотра.
Имя | Тип | Описание |
---|---|---|
btmRightPoint |
Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon". |
|
topLeftPoint |
Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon". |
BoundingBoxCompassNotation
Ограничивающий прямоугольник расположения.
Имя | Тип | Описание |
---|---|---|
entity |
Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению. |
|
northEast |
string |
Северо-восточная широта, координата долготы ограничивающего прямоугольника в виде с плавающей точкой с разделиниями-запятыми |
southWest |
string |
Юго-западная широта, координата долготы ограничивающего прямоугольника в виде с плавающей точкой, разделенной запятыми |
Brand
Торговая марка, связанная с poi
Имя | Тип | Описание |
---|---|---|
name |
string |
Название торговой марки |
Classification
Классификация возвращаемого poI
Имя | Тип | Описание |
---|---|---|
code |
string |
Свойство Code |
names |
Массив имен |
ClassificationName
Имя классификации
Имя | Тип | Описание |
---|---|---|
name |
string |
Name - свойство |
nameLocale |
string |
Свойство "Языковой стандарт имени" |
DataSources
Необязательный раздел. Идентификаторы ссылок для использования с API Get Поиск Polygon.
Имя | Тип | Описание |
---|---|---|
geometry |
Сведения о геометрической форме результата. Присутствует, только если тип == Geography. |
ElectricVehicleConnector
Разделенный запятыми список типов соединителей, которые можно использовать для ограничения результата электрическими транспортными станциями, поддерживающими определенные типы соединителей. Порядок элементов не имеет значения. Если указано несколько типов соединителей, будут возвращены только результаты, принадлежащие (по крайней мере) одному из предоставленных списков.
Доступные типы соединителей:
-
StandardHouseholdCountrySpecific
— Это стандартные соединители для определенного региона. Все они являются однофазным переменным и стандартным напряжением и стандартным амперажем. См. также: Вилка & типов сокетов — мировые стандарты. -
IEC62196Type1
- Соединитель типа 1, как определено в стандарте IEC 62196-2. Также называется Yazaki после первоначального производителя или SAE J1772 после стандарта, который впервые опубликовал его. В основном используется в сочетании с однофазной инфраструктурой 120 В или до 240 В. -
IEC62196Type1CCS
— Комбинированный соединитель на основе типа 1, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 1 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку. -
IEC62196Type2CableAttached
- Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в виде кабеля и разъема, прикрепленного к точке зарядки. -
IEC62196Type2Outlet
- Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в качестве сокета, установленного в точке зарядки. -
IEC62196Type2CCS
— Комбинированный соединитель на основе типа 2, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 2 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку. -
IEC62196Type3
- Соединитель типа 3, как определено в стандарте IEC 62196-2. Также называется Scame после первоначального производителя. В основном используется в сочетании с однофазной или трехфазной инфраструктурой до 420 В. -
Chademo
- Соединитель CHAdeMO, названный в честь ассоциации, созданной Токийской электрической компанией и промышленными партнерами. Из-за этого также называется соединителем TEPCO. Он поддерживает быструю зарядку постоянного тока. -
IEC60309AC1PhaseBlue
- Промышленный синий соединитель — это соединитель, определенный в стандарте IEC 60309. Это иногда называется как некоторое сочетание стандарта, цвета и тот факт, что является однофазным соединителем. Соединитель обычно имеет конфигурацию "P+N+E, 6h". -
IEC60309DCWhite
- Промышленный белый соединитель — это соединитель dc, определенный в стандарте IEC 60309. -
Tesla
- Соединитель Tesla является региональным соединителем Tesla Supercharger. Т.е. он ссылается либо на собственный соединитель Tesla, иногда называемый Tesla Port в основном ограниченным Северная Америка или измененным типом 2 (DC над типом 2) в Европе.
Примеры использования
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Имя | Тип | Описание |
---|---|---|
Chademo |
string |
Соединитель CHAdeMO назван в честь ассоциации, созданной Токийской электрической электростанцией и промышленными партнерами. Из-за этого также называется соединителем TEPCO. Он поддерживает быструю зарядку постоянного тока. |
IEC60309AC1PhaseBlue |
string |
Промышленный синий соединитель — это соединитель, определенный в стандарте IEC 60309. Это иногда называется как некоторое сочетание стандарта, цвета и тот факт, что является однофазным соединителем. Соединитель обычно имеет конфигурацию "P+N+E, 6h". |
IEC60309DCWhite |
string |
Промышленный белый соединитель — это соединитель dc, определенный в стандарте IEC 60309. |
IEC62196Type1 |
string |
Соединитель типа 1, как определено в стандарте IEC 62196-2. Также называется Yazaki после первоначального производителя или SAE J1772 после стандарта, который впервые опубликовал его. В основном используется в сочетании с однофазной инфраструктурой 120 В или до 240 В. |
IEC62196Type1CCS |
string |
Комбинированный соединитель на основе типа 1, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 1 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку. |
IEC62196Type2CCS |
string |
Комбинированный соединитель на основе типа 2, как определено в стандарте IEC 62196-3. Соединитель основан на соединителе типа 2 , как определено в стандарте IEC 62196-2, с двумя дополнительными контактами постоянного тока (DC), чтобы обеспечить быструю зарядку. |
IEC62196Type2CableAttached |
string |
Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в виде кабеля и разъема, прикрепленного к точке зарядки |
IEC62196Type2Outlet |
string |
Соединитель типа 2, как определено в стандарте IEC 62196-2. Предоставляется в качестве сокета, установленного в точке зарядки. |
IEC62196Type3 |
string |
Соединитель типа 3, как определено в стандарте IEC 62196-2. Также называется Scame после первоначального производителя. В основном используется в сочетании с однофазной или трехфазной инфраструктурой до 420 В. |
StandardHouseholdCountrySpecific |
string |
Это стандартные соединители для домашних хозяйств для определенного региона. Все они являются однофазным переменным и стандартным напряжением и стандартным амперажем. См. также: Типы сокетов plug & — мировые стандарты |
Tesla |
string |
Соединитель Tesla является региональным соединителем Tesla Supercharger. Т.е. он ссылается либо на собственный соединитель Tesla, иногда называемый Tesla Port в основном ограниченным Северная Америка или измененным типом 2 (DC над типом 2) в Европе. |
Entity
Источник типа сущности ограничивающего прямоугольника. Для обратного геокодирования это всегда равно положению.
Имя | Тип | Описание |
---|---|---|
position |
string |
Сущность Position |
EntryPoint
Точка входа для возвращаемого poI.
Имя | Тип | Описание |
---|---|---|
position |
Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon". |
|
type |
Тип точки входа. Значение может быть main или дополнительным. |
EntryPointType
Тип точки входа. Значение может быть main или дополнительным.
Имя | Тип | Описание |
---|---|---|
main |
string |
|
minor |
string |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
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 |
Свойство Долгота |
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 |
Список диапазонов времени на следующие 7 дней |
OperatingHoursRange
Часы работы для POI (точки интереса). Доступность часов работы зависит от доступных данных. Если это не пройдено, информация о часах работы не будет возвращена. Поддерживаемое значение: nextSevenDays
Имя | Тип | Описание |
---|---|---|
nextSevenDays |
string |
Показывает часы работы на следующей неделе, начиная с текущего дня по местному времени POI. |
OperatingHoursTime
Представляет дату и время
Имя | Тип | Описание |
---|---|---|
date |
string |
Представляет текущую дату календаря в часовом поясе POI, например 07.02.2019. |
hour |
integer |
Часы в 24-часовом формате по местному времени POI; Возможные значения: от 0 до 23. |
minute |
integer |
Минуты относятся к местному времени POI; Возможные значения: от 0 до 59. |
OperatingHoursTimeRange
Открытый диапазон времени для дня
Имя | Тип | Описание |
---|---|---|
endTime |
Точка в диапазоне следующих 7 дней при закрытии заданного POI или начало диапазона, если он был закрыт до диапазона. |
|
startTime |
Точка в диапазоне следующих 7 дней, когда открывается данный poI, или начало диапазона, если он был открыт до диапазона. |
PointOfInterest
Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации.
Имя | Тип | Описание |
---|---|---|
brands |
Brand[] |
Массив торговых марок. Имя торговой марки для возвращаемого poI. |
categories |
string[] |
Массив категорий |
categorySet |
Список наиболее конкретных категорий POI |
|
classifications |
Массив классификации |
|
name |
string |
Имя свойства POI |
openingHours |
Часы работы для POI (достопримечательностей). |
|
phone |
string |
Свойство "Номер телефона" |
url |
string |
Свойство URL-адреса веб-сайта |
PointOfInterestCategorySet
Категория POI
Имя | Тип | Описание |
---|---|---|
id |
integer |
Идентификатор категории |
QueryType
Тип возвращаемого запроса: NEARBY или NON_NEAR.
Имя | Тип | Описание |
---|---|---|
NEARBY |
string |
Поиск выполнялись вокруг определенной широты и долготы с определенным радиусом |
NON_NEAR |
string |
Поиск выполняется глобально, без смещений на определенную широту и долготу, без определенного радиуса |
ResponseFormat
Требуемый формат ответа. Значение может быть либо json , либо xml.
Имя | Тип | Описание |
---|---|---|
json |
string |
|
xml |
string |
SearchAddressResult
Этот объект возвращается из успешного вызова Поиск.
Имя | Тип | Описание |
---|---|---|
results |
Список результатов Поиск API. |
|
summary |
Объект Summary для ответа API Поиск |
SearchAddressResultItem
Результирующий объект для ответа API Поиск.
Имя | Тип | Описание |
---|---|---|
address |
Адрес результата |
|
addressRanges |
Описывает диапазон адресов по обе стороны улицы для результата поиска. Включаются координаты начального и конечного расположений диапазона адресов. |
|
dataSources |
Необязательный раздел. Идентификатор геометрии ссылки для использования с API получения Поиск polygon. |
|
detourTime |
integer |
Время объезда в секундах. Возвращается только для вызовов API маршрута Поиск. |
dist |
number |
Прямое расстояние между результатом и расположением геобия в метрах. |
entityType |
Тип сущности Geography. Отображается только в том случае, если entityType был запрошен и доступен. |
|
entryPoints |
Массив точек входа. Они описывают типы входов, доступных на месте. Тип может быть "main" для main входов, таких как входная дверь или вестибюль, и "дополнительный" для боковых и задних дверей. |
|
id |
string |
Свойство Id |
info |
string |
Сведения об исходном источнике данных result. Используется для запросов на поддержку. |
matchType |
Сведения о типе соответствия. Одно из двух значений:
|
|
poi |
Сведения о возвращенных poI, включая такие сведения, как имя, телефон, URL-адрес и классификации. |
|
position |
Расположение, представленное в виде широты и долготы с использованием коротких имен "lat" & "lon". |
|
score |
number |
Значение в результирующем наборе, указывающее относительную оценку соответствия между результатами. Это позволяет определить, что результат x в два раза выше, чем результат y, если значение x равно 2x значению y. Значения зависят от запросов и предназначены только как относительное значение для одного результирующих наборов. |
type |
Одно из двух значений:
|
|
viewport |
Окно просмотра, охватывающее результат, представленный верхней левой и нижней правой координатами окна просмотра. |
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 |
Указание того, что внутренняя поисковая система применила геопространственный уклон для улучшения ранжирования результатов. В некоторых методах на это можно повлиять, задав параметры lat и lon там, где они доступны. В других случаях это чисто внутренний. |
|
limit |
integer |
Максимальное число ответов, которые будут возвращены |
numResults |
integer |
Количество результатов в ответе. |
offset |
integer |
Начальная смещение возвращаемых результатов в полном результирующем наборе. |
query |
string |
Параметр запроса, который использовался для получения этих результатов поиска. |
queryTime |
integer |
Время, затраченное на разрешение запроса, в миллисекундах. |
queryType |
Тип возвращаемого запроса: NEARBY или NON_NEAR. |
|
totalResults |
integer |
Общее число найденных результатов. |