Search - Get Search Address Reverse Batch

API обратной пакетной службы поиска по адресу поиска

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

API пакетной службы поиска отправляет пакеты запросов в ОБРАТНЫй API адреса поиска с помощью одного вызова API. Можно вызвать API обратной пакетной службы поиска для асинхронного (асинхронного) или синхронного (синхронного). Асинхронный API позволяет вызывающей службе пакетировать до 10 000 запросов и синхронизировать API до 100 запросов.

Отправка синхронного пакетного запроса

Для упрощенных пакетных запросов рекомендуется использовать синхронный API. Когда служба получает запрос, он ответит, как только вычисляются пакетные элементы и не будет возможности получить результаты позже. Синхронный API вернет ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество элементов пакета ограничено 100 для этого API.

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Отправка асинхронного пакетного запроса

Асинхронный API подходит для обработки больших объемов относительно сложных поисковых запросов.

  • Это позволяет получить результаты в отдельном вызове (возможно несколько скачиваемых файлов).
  • Асинхронный API оптимизирован для надежности и не должен выполняться во время ожидания.
  • Количество элементов пакета ограничено 10 000 для этого API.

При выполнении запроса с помощью асинхронного запроса служба по умолчанию возвращает код ответа 202 по URL-адресу перенаправления в поле "Расположение" заголовка ответа. Этот URL-адрес следует периодически проверять до тех пор, пока не будут доступны данные ответа или сведения об ошибках. Асинхронные ответы хранятся в течение 14 дней. URL-адрес перенаправления возвращает ответ 404, если используется после истечения срока действия.

Обратите внимание, что асинхронный пакетный запрос — это длительный запрос. Ниже приведена типичная последовательность операций:

  1. Клиент отправляет пакетный POST запрос на поиск по адресу Azure Maps

  2. Сервер ответит на одно из следующих действий:

    HTTP 202 Accepted — пакетный запрос принят.

    HTTP Error — произошла ошибка при обработке запроса пакетной службы. Это может быть код состояния или любой 400 Bad Request другой Error код состояния.

  3. Если пакетный запрос был принят успешно, Location заголовок в ответе содержит URL-адрес для скачивания результатов пакетного запроса. Этот универсальный код ресурса (URI) состояния выглядит следующим образом:

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Клиент выдает GET запрос на URL-адрес скачивания , полученный на шаге 3, чтобы скачать результаты пакета.

Текст POST для пакетного запроса

Для отправки обратных запросов на поисковый адрес будет использоваться POST запрос, в котором текст запроса будет содержать batchItems массив в json формате, а Content-Type заголовок будет иметь значение application/json. Ниже приведен пример текста запроса, содержащего 5 обратных запросов на поисковый адрес :

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Обратный запрос к поисковому адресу в пакете — это просто частичный URL-адрес без протокола, базового URL-адреса, пути, версии API и ключа подписки. Он может принимать любой из поддерживаемых параметров обратного URIадреса поиска. Строковые значения в обратном запросе на поисковый адрес должны быть правильно экранированы (например, символ должен быть экранирован с символом \), и он также должен быть правильно закодирован в URL-адресе.

Асинхронный API позволяет вызывающей службе пакетировать до 10 000 запросов и синхронизировать API до 100 запросов, а пакет должен содержать не менее 1 запроса.

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

Чтобы скачать асинхронные результаты пакетной обработки, отправьте GET запрос к конечной точке загрузки пакета. Этот URL-адрес загрузки можно получить из Location заголовка успешного POST пакетного запроса и выглядит следующим образом:

https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Ниже приведена типичная последовательность операций для скачивания результатов пакета:

  1. Клиент отправляет GET запрос с помощью URL-адреса скачивания.

  2. Сервер ответит на одно из следующих действий:

    HTTP 202 Accepted — пакетный запрос был принят, но все еще обрабатывается. Повторите попытку через некоторое время.

    HTTP 200 OK — пакетный запрос успешно обработан. Текст ответа содержит все результаты пакета.

Модель пакетного ответа

Возвращаемое содержимое данных аналогично асинхронным и синхронным запросам. При скачивании результатов асинхронного пакетного запроса, если пакет завершил обработку, текст ответа содержит пакетный ответ. Этот пакетный ответ содержит summary компонент, указывающий totalRequests , что были частью исходного пакетного запроса и successfulRequestsт. е. запросы, которые были выполнены успешно. Пакетный ответ также содержит batchItems массив, содержащий ответ для каждого и каждого запроса в пакетном запросе. batchItems Результаты будут содержаться в том же порядке, в котором были отправлены исходные запросы в пакетном запросе. Каждый элемент содержит batchItemsstatusCode и response поля. Каждый response из batchItems них имеет один из следующих типов:

  • SearchAddressReverseResponse — Если запрос успешно завершен.

  • Error — Если запрос завершился ошибкой. Ответ будет содержать и code в message этом случае.

Ниже приведен пример ответа пакетной службы с результатом 2 успешного выполнения и 1:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0

Параметры URI

Name In Required Type Description
format
path True
  • string

Идентификатор пакета для запроса операции.

api-version
query True
  • string

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

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

Name Required Type Description
x-ms-client-id
  • string

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

Ответы

Name Type Description
200 OK

ОК

202 Accepted

Поддерживается только для асинхронного запроса. Запрос принят: запрос был принят для обработки. Используйте URL-адрес в заголовке расположения, чтобы повторить попытку или получить доступ к результатам.

Headers

  • Location: string
Other Status Codes

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

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

AADToken

Это потоки OAuth2 Azure Active Directory . При связывании с управлением доступом на основе ролей Azure можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким Azure Maps учетной записи ресурсов или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.

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

Примечания

  • Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому ресурсу Azure Maps приложение запрашивает доступ. Это можно получить из API управления картами.

Это Authorization URL зависит от экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

  • В настоящее время Azure Active Directory версии 1.0 или 2.0 поддерживает рабочие, учебные заведения и гости, но не поддерживает личные учетные записи.

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

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

Примеры

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Sample Request

GET https://atlas.microsoft.com/search/address/reverse/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Sample Response

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivision": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivision": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivision": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}

Определения

Address

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

AddressRanges

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

BoundingBox

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

BoundingBoxCompassNotation

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

Brand

Бренд, связанный с POI

Classification

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

ClassificationName

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

DataSources

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

Entity

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

EntryPoint

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

EntryPointType

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

ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

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

GeographicEntityType

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

Geometry

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

LatLongPairAbbreviated

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

MatchType

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

OperatingHours

Часы работы для POI (точки интереса).

OperatingHoursTime

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

OperatingHoursTimeRange

Диапазон времени открытия в течение дня

PointOfInterest

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

PointOfInterestCategorySet

Категория POI

QueryType

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

Response

Результат запроса. SearchAddressResponse, если запрос успешно завершен, в противном случае — ErrorResponse.

ReverseSearchAddressBatchItem

Элемент, возвращенный вызовом обратной пакетной службы поиска по адресу поиска.

ReverseSearchAddressBatchProcessResult

Этот объект возвращается из успешного вызова службы обратной пакетной службы поиска по адресу поиска.

SearchAddressResultItem

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

SearchAddressResultType

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

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

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

Summary

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

Address

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

Name Type Description
boundingBox

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

buildingNumber
  • string

Номер здания на улице. Вместо этого используйте streetNumber.

country
  • string

Название страны

countryCode
  • string

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

countryCodeISO3
  • string

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

countrySecondarySubdivision
  • string

Округ

countrySubdivision
  • string

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

countrySubdivisionName
  • string

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

countryTertiarySubdivision
  • string

Именованной областью

crossStreet
  • string

Имя улицы, пересекаемой.

extendedPostalCode
  • string

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

freeformAddress
  • string

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

localName
  • string

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

municipality
  • string

Город / город

municipalitySubdivision
  • string

Sub / Super City

postalCode
  • string

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

routeNumbers
  • string[]

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

street
  • string

Название улицы. Вместо этого используйте streetName.

streetName
  • string

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

streetNameAndNumber
  • string

Имя и номер улицы.

streetNumber
  • string

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

AddressRanges

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

Name Type Description
from

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

rangeLeft
  • string

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

rangeRight
  • string

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

to

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

BoundingBox

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

Name Type Description
btmRightPoint

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

topLeftPoint

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

BoundingBoxCompassNotation

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

Name Type Description
entity

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

northEast
  • string

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

southWest
  • string

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

Brand

Бренд, связанный с POI

Name Type Description
name
  • string

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

Classification

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

Name Type Description
code
  • string

Свойство Code

names

Массив имен

ClassificationName

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

Name Type Description
name
  • string

Name - свойство

nameLocale
  • string

Свойство Name Locale

DataSources

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

Name Type Description
geometry

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

Entity

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

Name Type Description
position
  • string

Позиция сущности

EntryPoint

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

Name Type Description
position

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

type

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

EntryPointType

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

Name Type Description
main
  • string
minor
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

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

type
  • string

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

ErrorDetail

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

Name Type Description
additionalInfo

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

code
  • string

Код ошибки.

details

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

message
  • string

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

target
  • string

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

ErrorResponse

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

Name Type Description
error

Объект ошибки.

GeographicEntityType

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

Name Type Description
Country
  • string

Название страны

CountrySecondarySubdivision
  • string

Округ

CountrySubdivision
  • string

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

CountryTertiarySubdivision
  • string

Именованной областью

Municipality
  • string

Город / город

MunicipalitySubdivision
  • string

Sub / Super City

Neighbourhood
  • string

Районе

PostalCodeArea
  • string

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

Geometry

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

Name Type Description
id
  • string

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

LatLongPairAbbreviated

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

Name Type Description
lat
  • number

Свойство Latitude

lon
  • number

Свойство Долгота

MatchType

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

Name Type Description
AddressPoint
  • string
HouseNumberRange
  • string
Street
  • string

OperatingHours

Часы работы для POI (точки интереса).

Name Type Description
mode
  • string

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

timeRanges

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

OperatingHoursTime

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

Name Type Description
date
  • string

Представляет текущую дату календаря в часовом поясе POI, например "2019-02-07".

hour
  • integer

Часы находятся в формате 24 часа в местном времени POI; возможные значения: 0 – 23.

minute
  • integer

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

OperatingHoursTimeRange

Диапазон времени открытия в течение дня

Name Type Description
endTime

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

startTime

Точка в ближайшие 7 дней диапазона при открытии заданного poI или начала диапазона, если он был открыт до диапазона.

PointOfInterest

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

Name Type Description
brands

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

categories
  • string[]

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

categorySet

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

classifications

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

name
  • string

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

openingHours

Часы работы для POI (точки интереса).

phone
  • string

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

url
  • string

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

PointOfInterestCategorySet

Категория POI

Name Type Description
id
  • integer

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

QueryType

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

Name Type Description
NEARBY
  • string

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

NON_NEAR
  • string

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

Response

Результат запроса. SearchAddressResponse, если запрос успешно завершен, в противном случае — ErrorResponse.

Name Type Description
error

Объект ошибки.

results

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

summary

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

ReverseSearchAddressBatchItem

Элемент, возвращенный вызовом обратной пакетной службы поиска по адресу поиска.

Name Type Description
response

Результат запроса. SearchAddressReverseResponse, если запрос выполнен успешно, в противном случае — ErrorResponse.

statusCode
  • integer

Код состояния HTTP-запроса.

ReverseSearchAddressBatchProcessResult

Этот объект возвращается из успешного вызова службы обратной пакетной службы поиска по адресу поиска.

Name Type Description
batchItems

Массив, содержащий результаты пакетной обработки.

summary

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

SearchAddressResultItem

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

Name Type Description
address

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

addressRanges

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

dataSources

Необязательный раздел. Ссылочный идентификатор геометрии для использования с API get Search Polygon .

detourTime
  • integer

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

dist
  • number

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

entityType

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

entryPoints

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

id
  • string

Свойство Id

info
  • string

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

matchType

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

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

  • AddressPoint
  • HouseNumberRange
  • Улица
poi

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

position

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

score
  • number

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

type

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

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

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

SearchAddressResultType

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

  • POI
  • Улица
  • Географический регион
  • Точечный адрес
  • Диапазон адресов
  • Перекресток
Name Type Description
Address Range
  • string
Cross Street
  • string
Geography
  • string
POI
  • string
Point Address
  • string
Street
  • string

SearchSummary

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

Name Type Description
fuzzyLevel
  • integer

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

geoBias

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

limit
  • integer

Максимальное количество ответов, которые будут возвращены

numResults
  • integer

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

offset
  • integer

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

query
  • string

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

queryTime
  • integer

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

queryType

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

totalResults
  • integer

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

Summary

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

Name Type Description
successfulRequests
  • integer

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

totalRequests
  • integer

Общее количество запросов в пакете