Search - Get Search Fuzzy
Используйте, когда вам нужен поисковый запрос, который может обрабатывать комбинации адресов и токенов POI.
API Get Search Fuzzy (Free Form Search) — HTTP-запрос GET , который легко обрабатывает комбинацию поиска POI и геокодирования. Это API поиска в свободной форме, который обрабатывает нечеткие входные данные, содержащие любую комбинацию адресов или токенов POI, в качестве канонического «поиска по одной строке». Он также может быть взвешен с помощью контекстуального положения (пара широта/долгота) или полностью ограничен координатой и радиусом, или может быть выполнен в более общем виде без какого-либо геосмещения точки привязки.
Мы настоятельно рекомендуем вам использовать параметр '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=Фу brandSet=Foo,Батончик brandSet="A,B,C Запятая",Бар |
|
|
btm
|
query |
string |
Нижнее правое положение ограничивающего прямоугольника. Например, 37.553,-122.453 |
|
|
category
|
query |
integer[] |
Разделенный запятыми список идентификаторов наборов категорий, который можно использовать для ограничения результата определенными категориями Points of Interest. Порядок удостоверения личности не имеет значения. Максимальное количество поддерживаемых
|
|
|
connector
|
query |
Разделенный запятыми список типов разъемов, который можно использовать для ограничения результата до станции электромобиля, поддерживающей определенные типы разъемов. Порядок товаров не имеет значения. Если указано несколько типов соединителей, будут возвращены только результаты, принадлежащие (по крайней мере) одному из предоставленного списка. Доступные типы разъемов:
Примеры использования: ConnectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableCableAttached |
||
|
country
|
query |
string[] |
Строка кодов страны/региона, разделенная запятыми, например, FR,ES. Это ограничит поиск указанными странами/регионами |
|
|
entity
|
query |
Указывает уровень фильтрации, выполняемой по географическим регионам. Сужает поиск по указанным типам географических объектов, например, возвращает только муниципалитет. Результирующий ответ будет содержать идентификатор географии, а также соответствующий тип сущности. Если вы укажете несколько сущностей в виде списка, разделенного запятыми, конечная точка вернет «наименьшую доступную сущность». Возвращенный идентификатор геометрии можно использовать для получения геометрии этой географии с помощью API Get Search Polygon . При задании entityType следующие параметры игнорируются:
|
||
|
extended
|
query |
Индексы, для которых расширенные почтовые индексы должны быть включены в результаты. Доступные индексы: Addr = Диапазоны адресов Гео = География PAD = Адреса точек POI = Достопримечательности Str = Улицы XStr = Поперечные улицы (перекрестки) Значение должно быть списком типов индексов, разделенных запятыми (в любом порядке) или None для отсутствия индексов. По умолчанию расширенные почтовые индексы включены для всех индексов, кроме Geo. Расширенные списки почтовых индексов для географических регионов могут быть довольно длинными, поэтому их необходимо явно запрашивать при необходимости. Примеры использования: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона. |
||
|
idx
|
query |
Разделенный запятыми список индексов, которые следует использовать для поиска. Порядок товаров не имеет значения. Доступные индексы: Addr = интерполяция диапазона адресов, Geo = география, PAD = точечные адреса, POI = точки интереса, Str = улицы, Xstr = перекрестки улиц (перекрестков) |
||
|
language
|
query |
string |
Язык, на котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых языковых тегов IETF, нечувствителен к регистру. Когда данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Пожалуйста, обратитесь к разделу Поддерживаемые языки для получения подробной информации. |
|
|
lat
|
query |
number (double) |
Широта, на которой результаты должны быть смещены. Например, 37.337 |
|
|
limit
|
query |
integer minimum: 1maximum: 100 |
Максимальное количество ответов, которое будет возвращено. По умолчанию: 10, минимум: 1 и максимум: 100 |
|
|
lon
|
query |
number (double) |
Долгота, где результаты должны быть смещены. Например, -121.89 |
|
|
max
|
query |
integer minimum: 1maximum: 4 |
Максимальный уровень нечеткости, который будет использоваться. По умолчанию: 2, минимум: 1 и максимум: 4
Поисковая система начнет поиск совпадения на уровне, определенном minFuzzyLevel, и прекратит поиск на уровне, указанном maxFuzzyLevel. |
|
|
min
|
query |
integer minimum: 1maximum: 4 |
Минимальный уровень нечеткости, который будет использоваться. По умолчанию: 1, минимум: 1 и максимум: 4
Поисковая система начнет поиск совпадения на уровне, определенном minFuzzyLevel, и прекратит поиск на уровне, указанном maxFuzzyLevel. |
|
|
ofs
|
query |
integer minimum: 0maximum: 1900 |
Начальное смещение возвращенных результатов в пределах полного результирующего набора. По умолчанию: 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 см. в статье Управление проверкой подлинности в Azure Maps. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
ХОРОШО |
|
| Other Status Codes |
Произошла непредвиденная ошибка. |
Безопасность
AADToken
Это потоки Microsoft Entra OAuth 2.0 . В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ с помощью встроенной роли или настраиваемой роли, состоящей из одного или нескольких разрешений на доступ к REST API Azure Maps.
Для реализации сценариев рекомендуется ознакомиться с концепциями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям видимости.
Замечание
- Это определение безопасности требует ,
x-ms-client-idчтобы заголовок указывал, к какому ресурсу Azure Maps приложение запрашивает доступ. Его можно получить с помощью API управления картами . - Это
Authorization URLотносится к экземпляру общедоступного облака Azure. Суверенные облака имеют уникальные URL-адреса авторизации и конфигурации идентификаторов Microsoft Entra. - Управление доступом на основе ролей Azure настраивается из плоскости управления Azure через портал Azure, PowerShell, интерфейс командной строки, Azure SDK или 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. Другими словами, этот ключ может быть использован в качестве мастер-ключа в учетной записи, на которую они выданы.
Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к REST API Azure Maps, чтобы обеспечить безопасное хранение ключа.
Тип:
apiKey
В:
query
SAS Token
Это маркер подписанного URL-адреса, который создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure через портал Azure, PowerShell, CLI, Azure SDK или REST API.
С помощью этого маркера любое приложение может получить доступ с помощью элементов управления доступом на основе ролей Azure и детального контроля срока действия, скорости и регионов использования конкретного маркера. Другими словами, токен SAS может быть использован для того, чтобы позволить приложениям контролировать доступ более безопасным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи Map , чтобы ограничить злоупотребление рендерингом и регулярно обновлять токен 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 Search Polygon . |
|
Electric |
Разделенный запятыми список типов разъемов, который можно использовать для ограничения результата до станции электромобиля, поддерживающей определенные типы разъемов. Порядок товаров не имеет значения. Если указано несколько типов соединителей, будут возвращены только результаты, принадлежащие (по крайней мере) одному из предоставленного списка. Доступные типы разъемов:
Примеры использования: ConnectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableCableAttached |
| Entity |
Тип сущности источник ограничивающего прямоугольника. Для обратного геокодирования это всегда равно позиции. |
|
Entry |
Точка входа для возвращаемого POI. |
|
Entry |
Тип точки входа. Значение может быть как основным , так и второстепенным. |
|
Error |
Ошибка управления ресурсами дополнительная информация. |
|
Error |
Детали ошибки. |
|
Error |
Ответ на ошибку |
|
Geographic |
Тип объекта geography. Присутствует только в том случае, если entityType был запрошен и доступен. |
| Geometry |
Информация о геометрической форме результата. Присутствует только если тип == География. |
|
Lat |
Местоположение, представленное в виде широты и долготы с помощью кратких имен 'lat' и 'lon'. |
|
Localized |
Параметр View (также называемый параметром "user region") позволяет отображать правильные карты для определенной страны/региона для геополитически спорных регионов. Разные страны и регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которые будет обслуживаться приложением. По умолчанию параметр View имеет значение "Unified", даже если вы не указали его в запросе. Вы несете ответственность за определение местоположения пользователей, а затем за правильную настройку параметра View для этого расположения. В качестве альтернативы у вас есть возможность установить 'View=Auto', который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, в том числе касающимися картографирования, страны или региона, где доступны карты, изображения и другие данные и содержимое третьих лиц, к которым у вас есть доступ через Azure Maps. Пример: view=IN. Пожалуйста, обратитесь к Поддерживаемым представлениям для получения подробной информации и просмотра доступных Представлений. |
|
Match |
Типы совпадений для операции обратного поиска адреса. |
|
Operating |
Часы работы POI (Points of Interest). |
|
Operating |
Часы работы POI (точек интереса). Доступность часов работы зависит от имеющихся данных. Если не пройдено, информация о часах работы не возвращается. Поддерживаемое значение: nextSevenDays |
|
Operating |
Представляет дату и время |
|
Operating |
Открытый временной диапазон на сутки |
|
Point |
Сведения о возвращенных POI, включая такую информацию, как имя, телефон, URL-адрес и классификация. |
|
Point |
Категория POI |
|
Query |
Тип возвращаемого запроса: NEARBY или NON_NEAR. Важно: Это свойство устарело и может быть опущено в ответе. |
|
Response |
Желаемый формат ответа. Значение может быть как json , так и xml. |
|
Search |
Этот объект возвращается в результате успешных вызовов Search. |
|
Search |
Объект result для ответа API поиска. |
|
Search |
Один из:
|
|
Search |
Индексы, для которых расширенные почтовые индексы должны быть включены в результаты. Доступные индексы: Addr = Диапазоны адресов Гео = География PAD = Адреса точек POI = Достопримечательности Str = Улицы XStr = Поперечные улицы (перекрестки) Значение должно быть списком типов индексов, разделенных запятыми (в любом порядке) или None для отсутствия индексов. По умолчанию расширенные почтовые индексы включены для всех индексов, кроме Geo. Расширенные списки почтовых индексов для географических регионов могут быть довольно длинными, поэтому их необходимо явно запрашивать при необходимости. Примеры использования: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона. |
|
Search |
Объект summary для ответа Search API. |
Address
Адрес результата.
| Имя | Тип | Описание |
|---|---|---|
| boundingBox |
Определяет ограничивающий прямоугольник для местоположения. Это свойство возвращается только API-интерфейсами обратного поиска адреса. Все остальные API поиска возвращают свойство |
|
| buildingNumber |
string |
Номер дома на улице.
Важно: Это свойство является устаревшим. Вместо этого используйте |
| country |
string |
Название страны/региона. |
| countryCode |
string |
Двухбуквенный алфавитный код, определённый стандартом ISO 3166-1 Alpha-2 для обозначения страны/региона и зависимых территорий. |
| countryCodeISO3 |
string |
Трёхбуквенный алфавитный код, определённый стандартом ISO 3166-1 Alpha-3 для обозначения страны/региона и зависимых территорий. |
| countrySecondarySubdivision |
string |
Административное деление второго уровня внутри страны/региона. Он обозначает подразделение, расположенное ниже основного подразделения, например, штата или провинции, но выше меньших единиц, таких как муниципалитеты или районы. Примеры включают округ в Соединённых Штатах и округ в Соединённом Королевстве. |
| countrySubdivision |
string |
Основное административное деление внутри страны, например, государство, провинция. Он используется для обозначения подразделения первого уровня ниже национального уровня. |
| countrySubdivisionCode |
string |
Это свойство недоступно в |
| countrySubdivisionName |
string |
Представляет полное название административного подразделения первого уровня (например, штат, провинция или регион) внутри страны или региона. Это свойство включено только в том случае, когда значение |
| countryTertiarySubdivision |
string |
Административное деление третьего уровня внутри страны/региона. Он обеспечивает ещё более тонкую детализацию, чем вторичное подразделение (например, округ или округ). Примеры включают муниципалитеты, такие как город, посёлок, деревня, боро или тауншип, а также районы — меньшую, неформальную географическую зону в пределах муниципалитета, такие как Капитолий-Хилл, Грин-Лейк и Уоллингфорд в Сиэтле. |
| crossStreet |
string |
Название улицы, которую пересекают. Это свойство доступно только в |
| extendedPostalCode |
string |
Расширенный почтовый индекс означает формат почтового индекса, который выходит за рамки стандартного набора цифр для повышения точности определения местоположения. Он часто используется в системах, таких как код U.S. ZIP+4 или аналогичных расширенных форматах в других странах и регионах. Доступность зависит от региона. Недоступно в |
| freeformAddress |
string |
Строка адреса, отформатированная согласно правилам форматирования страны/региона происхождения результата, или, в случае страны/региона, полного названия страны/региона. |
| localName |
string |
Компонент адреса, представляющий название географической области или населенного пункта, который группирует несколько адресуемых объектов для целей адресации, не являясь административной единицей. Это поле используется для создания |
| municipality |
string |
Город / Поселок |
| municipalitySubdivision |
string |
Подразделение в пределах муниципалитета. Он представляет собой меньшую административную или географическую единицу внутри города, посёлка или другого муниципального образования. |
| neighbourhood |
string |
Район — это географически локализованная территория в черте города или поселка с отличительными характеристиками и социальным взаимодействием между жителями. |
| postalCode |
string |
К адресу добавляется серия цифр или букв (или обеих), чтобы помочь определить конкретную географическую область. Почтовый индекс — это американская версия почтового индекса, другие страны и регионы используют другие форматы, такие как Postcode, PIN Code и PLZ. |
| routeNumbers |
string[] |
Коды использовались для однозначной идентификации улицы. Доступно только для API обратного поиска адреса. |
| street |
string |
Название улицы.
Важно: Это свойство является устаревшим. Вместо этого используйте |
| streetName |
string |
Название улицы. |
| streetNameAndNumber |
string |
Название и номер улицы. Доступно только для API обратного поиска адреса. |
| 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 |
Свойство Name Locale |
DataSources
Необязательный раздел. Ссылочные идентификаторы для использования с API Get Search Polygon .
| Имя | Тип | Описание |
|---|---|---|
| geometry |
Информация о геометрической форме результата. Присутствует только если тип == География. |
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 по имени оригинального производителя. В основном используется в сочетании с однофазной инфраструктурой до 240 В или с трехфазной инфраструктурой до 420 В. -
Chademo- Разъем CHAdeMO назван в честь ассоциации, образованной Токийской электроэнергетической компанией и промышленными партнерами. Из-за этого он также известен как разъем TEPCO. Он поддерживает быструю зарядку постоянным током. -
IEC60309AC1PhaseBlue- Промышленный синий разъем — это разъем, определенный в стандарте IEC 60309. Его иногда называют неким сочетанием стандарта, цвета и того факта, что это однофазный разъем. Разъем обычно имеет конфигурацию "P+N+E, 6h". -
IEC60309DCWhite- Промышленный белый разъем — это разъем постоянного тока, определенный в стандарте IEC 60309. -
Tesla- Разъем Tesla — это специфичный для региона разъем Tesla Supercharger. Т.е. это относится либо к проприетарному разъему Tesla, иногда упоминаемому как Tesla Port, в основном ограниченному Северной Америкой, либо к модифицированному Type 2 (DC over Type 2) в Европе.
Примеры использования:
ConnectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableCableAttached
| Значение | Описание |
|---|---|
| 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 по имени оригинального производителя. В основном используется в сочетании с однофазной инфраструктурой до 240 В или с трехфазной инфраструктурой до 420 В. |
| Chademo |
Разъем CHAdeMO назван в честь ассоциации, образованной Токийской электроэнергетической компанией и индустриальными партнерами. Из-за этого он также известен как разъем TEPCO. Он поддерживает быструю зарядку постоянным током. |
| IEC60309AC1PhaseBlue |
Промышленный синий разъем — это разъем, определенный в стандарте IEC 60309. Его иногда называют неким сочетанием стандарта, цвета и того факта, что это однофазный разъем. Разъем обычно имеет конфигурацию "P+N+E, 6h". |
| IEC60309DCWhite |
Промышленный белый разъем — это разъем постоянного тока, определенный в стандарте IEC 60309. |
| Tesla |
Разъем Tesla — это региональный разъем Tesla Supercharger. Т.е. это относится либо к проприетарному разъему Tesla, иногда упоминаемому как Tesla Port, в основном ограниченному Северной Америкой, либо к модифицированному Type 2 (DC over Type 2) в Европе. |
Entity
Тип сущности источник ограничивающего прямоугольника. Для обратного геокодирования это всегда равно позиции.
| Значение | Описание |
|---|---|
| position |
Сущность позиции |
EntryPoint
Точка входа для возвращаемого POI.
| Имя | Тип | Описание |
|---|---|---|
| position |
Местоположение, представленное в виде широты и долготы с помощью кратких имен 'lat' и 'lon'. |
|
| type |
Тип точки входа. Значение может быть как основным , так и второстепенным. |
EntryPointType
Тип точки входа. Значение может быть как основным , так и второстепенным.
| Значение | Описание |
|---|---|
| main | |
| minor |
ErrorAdditionalInfo
Ошибка управления ресурсами дополнительная информация.
| Имя | Тип | Описание |
|---|---|---|
| info |
object |
Дополнительная информация. |
| type |
string |
Тип дополнительной информации. |
ErrorDetail
Детали ошибки.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Ошибка дополнительная информация. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Цель ошибки. |
ErrorResponse
Ответ на ошибку
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
GeographicEntityType
Тип объекта geography. Присутствует только в том случае, если entityType был запрошен и доступен.
| Значение | Описание |
|---|---|
| Country |
Название страны/региона |
| CountrySubdivision |
Штат или провинция |
| CountrySecondarySubdivision |
Графство |
| CountryTertiarySubdivision |
Именованная территория |
| Municipality |
Город / Поселок |
| MunicipalitySubdivision |
Саб / Супер Сити |
| Neighbourhood |
Округа |
| PostalCodeArea |
Почтовый индекс / почтовый индекс |
Geometry
Информация о геометрической форме результата. Присутствует только если тип == География.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Передайте его как geometryId в API Get Search Polygon , чтобы получить информацию о геометрии для этого результата. |
LatLongPairAbbreviated
Местоположение, представленное в виде широты и долготы с помощью кратких имен 'lat' и 'lon'.
| Имя | Тип | Описание |
|---|---|---|
| lat |
number (double) |
Свойство Latitude |
| lon |
number (double) |
Свойство долготы |
LocalizedMapView
Параметр View (также называемый параметром "user region") позволяет отображать правильные карты для определенной страны/региона для геополитически спорных регионов. Разные страны и регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которые будет обслуживаться приложением. По умолчанию параметр View имеет значение "Unified", даже если вы не указали его в запросе. Вы несете ответственность за определение местоположения пользователей, а затем за правильную настройку параметра View для этого расположения. В качестве альтернативы у вас есть возможность установить 'View=Auto', который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, в том числе касающимися картографирования, страны или региона, где доступны карты, изображения и другие данные и содержимое третьих лиц, к которым у вас есть доступ через Azure Maps. Пример: view=IN.
Пожалуйста, обратитесь к Поддерживаемым представлениям для получения подробной информации и просмотра доступных Представлений.
| Значение | Описание |
|---|---|
| AE |
Объединенные Арабские Эмираты (арабский вид) |
| AR |
Аргентина (аргентинский взгляд) |
| BH |
Бахрейн (арабский вид) |
| IN |
Индия (индийский взгляд) |
| IQ |
Ирак (арабский взгляд) |
| JO |
Иордания (арабский вид) |
| KW |
Кувейт (арабский вид) |
| LB |
Ливан (арабский взгляд) |
| MA |
Марокко (марокканский вид) |
| OM |
Оман (арабский вид) |
| PK |
Пакистан (взгляд Пакистана) |
| PS |
Палестинская автономия (арабский взгляд) |
| QA |
Катар (арабский вид) |
| SA |
Саудовская Аравия (арабский взгляд) |
| SY |
Сирия (арабский взгляд) |
| US |
Соединенные Штаты Америки |
| YE |
Йемен (арабский взгляд) |
| Auto |
Возвращает данные карты на основе IP-адреса запроса. |
| Unified |
Единое представление (другие) |
MatchType
Типы совпадений для операции обратного поиска адреса.
| Значение | Описание |
|---|---|
| AddressPoint | |
| HouseNumberRange | |
| Street |
OperatingHours
Часы работы POI (Points of Interest).
| Имя | Тип | Описание |
|---|---|---|
| mode |
string |
Значение, используемое в запросе: none или "nextSevenDays" |
| timeRanges |
Список временных диапазонов на следующие 7 дней |
OperatingHoursRange
Часы работы POI (точек интереса). Доступность часов работы зависит от имеющихся данных. Если не пройдено, информация о часах работы не возвращается. Поддерживаемое значение: nextSevenDays
| Значение | Описание |
|---|---|
| nextSevenDays |
Показывает часы работы на следующую неделю, начиная с текущего дня по местному времени POI. |
OperatingHoursTime
Представляет дату и время
| Имя | Тип | Описание |
|---|---|---|
| date |
string |
Представляет текущую календарную дату в часовом поясе POI, например "2019-02-07". |
| hour |
integer |
Часы указаны в 24-часовом формате по местному времени интересующего пункта; Возможные значения: 0 - 23. |
| minute |
integer |
Минуты указываются по местному времени интересующего пункта; Возможные значения: от 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 (Points of Interest). |
|
| phone |
string |
Свойство номера телефона |
| url |
string |
Свойство URL сайта |
PointOfInterestCategorySet
Категория POI
| Имя | Тип | Описание |
|---|---|---|
| id |
integer |
ID категории |
QueryType
Тип возвращаемого запроса: NEARBY или NON_NEAR.
Важно: Это свойство устарело и может быть опущено в ответе.
| Значение | Описание |
|---|---|
| NEARBY |
Поиск проводился на определённой широте и долготе с определённым радиусом. |
| NON_NEAR |
Поиск выполнялся глобально, без смещения в сторону определенной широты и долготы, и без определенного радиуса |
ResponseFormat
Желаемый формат ответа. Значение может быть как json , так и xml.
| Значение | Описание |
|---|---|
| json | |
| xml |
SearchAddressResult
Этот объект возвращается в результате успешных вызовов Search.
| Имя | Тип | Описание |
|---|---|---|
| results |
Список результатов поиска API. |
|
| summary |
Объект сводки для ответа API поиска |
SearchAddressResultItem
Объект result для ответа API поиска.
| Имя | Тип | Описание |
|---|---|---|
| address |
Адрес результата. |
|
| addressRanges |
Описывает диапазон адресов по обеим сторонам улицы для получения результата поиска. Включены координаты начального и конечного местоположений диапазона адресов. |
|
| dataSources |
Необязательный раздел. Идентификатор ссылочной геометрии для использования с API Get Search Polygon . |
|
| detourTime |
integer |
Время объезда в секундах. Возвращается только для вызовов API поиска вдоль маршрута. |
| dist |
number (double) |
Расстояние по прямой между результатом и местоположением геосмещения в метрах. |
| entityType |
Тип объекта geography. Присутствует только в том случае, если entityType был запрошен и доступен. |
|
| entryPoints |
Массив точек входа. Они описывают типы входов, доступных в данном месте. Тип может быть «основным» для главных входов, таких как парадная дверь или вестибюль, и «второстепенным», для боковых и черных дверей. |
|
| id |
string |
Свойство id |
| info |
string |
Информация об исходном источнике данных Результата. Используется для запросов в службу поддержки. |
| matchType |
Информация о типе матча. Один из:
|
|
| poi |
Сведения о возвращенных POI, включая такую информацию, как имя, телефон, URL-адрес и классификация. |
|
| position |
Местоположение, представленное в виде широты и долготы с помощью кратких имен 'lat' и 'lon'. |
|
| score |
number (double) |
Значение в результирующем наборе, указывающее относительный показатель сопоставления между результатами. Это можно использовать для определения того, что результат x с вероятностью будет в два раза более релевантным, чем результат y, если значение x в 2 раза превышает значение y. Значения варьируются в зависимости от запроса и подразумеваются только как относительные значения для одного результирующего набора. Важно: Это свойство устарело и может быть опущено в ответе. |
| type |
Один из:
|
|
| viewport |
Видовой экран, который охватывает результат, представленный верхним левым и нижним правыми координатами окна просмотра. |
SearchAddressResultType
Один из:
- ПОИ
- Улица
- География
- Адрес точки
- Диапазон адресов
- Кросс-стрит
| Значение | Описание |
|---|---|
| POI | |
| Street | |
| Geography | |
| Point Address | |
| Address Range | |
| Cross Street |
SearchIndexes
Индексы, для которых расширенные почтовые индексы должны быть включены в результаты.
Доступные индексы:
Addr = Диапазоны адресов
Гео = География
PAD = Адреса точек
POI = Достопримечательности
Str = Улицы
XStr = Поперечные улицы (перекрестки)
Значение должно быть списком типов индексов, разделенных запятыми (в любом порядке) или None для отсутствия индексов.
По умолчанию расширенные почтовые индексы включены для всех индексов, кроме Geo. Расширенные списки почтовых индексов для географических регионов могут быть довольно длинными, поэтому их необходимо явно запрашивать при необходимости.
Примеры использования:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=None
Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона.
| Значение | Описание |
|---|---|
| Addr | |
| Geo | |
| PAD | |
| POI | |
| Str | |
| Xstr |
SearchSummary
Объект summary для ответа Search API.
| Имя | Тип | Описание |
|---|---|---|
| fuzzyLevel |
integer |
Максимальный уровень нечеткости, необходимый для предоставления результатов. |
| geoBias |
Указание на то, что внутренняя поисковая система применила геопространственное смещение для улучшения ранжирования результатов. В некоторых методах на это можно повлиять, установив параметры широты и долготы, если они доступны. В остальных случаях она носит чисто внутренний характер. |
|
| limit |
integer |
Максимальное количество ответов, которые будут возвращены |
| numResults |
integer |
Количество результатов в ответе. |
| offset |
integer |
Начальное смещение возвращенных результатов в пределах полного набора результатов. |
| query |
string |
Параметр запроса, который использовался для создания этих результатов поиска. |
| queryTime |
integer |
Время, затраченное на решение запроса, в миллисекундах. |
| queryType |
Тип возвращаемого запроса: NEARBY или NON_NEAR. Важно: Это свойство устарело и может быть опущено в ответе. |
|
| totalResults |
integer |
Общее количество найденных Результатов. |