Search - Get Reverse Geocoding Batch

Ссылка

Service:: Maps

API Version:: 2023-06-01

Используйте для отправки пакета запросов в API обратного геокодирования в одном запросе.

Get Reverse Geocoding Batch API — это HTTP-запросPOST, который отправляет пакеты до 100 запросов в API обратного геокодирования с помощью одного запроса.

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

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

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

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

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

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Объект batchItem с обратным геокодированием может принимать любой из поддерживаемых параметров URIобратного геокодирования.

Пакет должен содержать по крайней мере 1 запрос.

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

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

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

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string	Номер версии API Azure Maps

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

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Azure AD. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Azure AD безопасности в Azure Maps см. в следующих статьях.
Accept-Language		string	Язык, на котором должны возвращаться результаты поиска. Дополнительные сведения см. в разделе Поддерживаемые языки .

Имя

Обязательно

Тип

Описание

x-ms-client-id

string

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

Accept-Language

string

Язык, на котором должны возвращаться результаты поиска.

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

Текст запроса

Имя	Тип	Описание
batchItems	ReverseGeocodingBatchRequestItem[]	Список обрабатываемых запросов.

Ответы

Имя	Тип	Описание
200 OK	GeocodingBatchResponse	ОК
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

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

AADToken

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

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

Примечание

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

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

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: header

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 call containing 2 Reverse Geocoding queries

Sample Request

HTTP

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

{
  "batchItems": [
    {
      "coordinates": [
        -122.128275,
        47.639429
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        -122.341979399674,
        47.6095253501216
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Sample Response

Status code:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
              "addressLine": "1 Microsoft Way"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.128275,
                    47.639429
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.127028,
                    47.638545
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.128275,
              47.639429
            ]
          },
          "bbox": [
            -122.1359181505759,
            47.63556628242932,
            -122.1206318494241,
            47.643291717570676
          ]
        }
      ]
    },
    {
      "optionalId": "3K5O3Y832J2YV6D7XNGUSM4ECCUGDEFN172CJQNN",
      "error": {
        "code": "400 Bad Request",
        "message": "The provided coordinates in query are invalid, out of range, or not in the expected format"
      }
    }
  ]
}

Определения

Имя	Описание
Address	Адрес результата
AdminDistricts	Название подразделения в стране или регионе для адреса. Этот элемент обычно рассматривается как административное деление первого порядка, но в некоторых случаях он также содержит второе, третье или четвертое деление в стране, зависимости или регионе.
CalculationMethodEnum	Метод, который использовался для вычисления точки геокода.
ConfidenceEnum	Уровень уверенности в том, что результат геокодированного расположения является совпадением. Используйте это значение с кодом соответствия, чтобы определить более полные сведения о совпадении. Достоверность геокодированного расположения зависит от многих факторов, включая относительную важность геокодированного расположения и расположение пользователя, если указано.
CountryRegion
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
FeatureCollectionEnum	Тип объекта FeatureCollection должен иметь тип FeatureCollection.
FeaturesItem
FeatureTypeEnum	Тип компонента должен иметь тип Feature.
GeocodePoints	Коллекция точек геокодирования, которые отличаются способом вычисления и предлагаемым использованием.
GeocodingBatchResponse	Этот объект возвращается из успешного вызова пакетной службы geocoding.
GeocodingBatchResponseItem
GeoJsonPoint	Допустимый `GeoJSON Point` тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
Intersection	Адрес результата.
MatchCodesEnum	Одно или несколько совпадающих значений кода, представляющих уровень геокодирования для каждого расположения в ответе. Например, геокодированное расположение с кодами `Good` соответствия и `Ambiguous` означает, что для сведений о расположении было найдено несколько расположений геокода, а служба геокода не имеет иерархии поиска вверх для поиска совпадения. Аналогичным образом, геокодированное расположение с кодами `Ambiguous` соответствия и `UpHierarchy` подразумевает, что не удалось найти расположение геокода, совпадающее со всеми предоставленными сведениями о расположении, поэтому службе геокодирования пришлось выполнить поиск в иерархии выше и найти несколько совпадений на этом уровне. Примером результата и `UpHierarchy` является предоставление полных сведений `Ambiguous` об адресе, но служба геокодирования не может найти совпадение с адресом улицы и вместо этого возвращает сведения для нескольких значений RoadBlock. Вы можете выбрать `Good`: в расположении есть только одно совпадение, или все возвращенные совпадения считаются сильными. Например, запрос для New York возвращает несколько хороших совпадений. `Ambiguous`: расположение является одним из набора возможных совпадений. Например, при запросе адреса улицы 128 Main St., ответ может вернуть два расположения для 128 North Main St. и 128 South Main St. поскольку недостаточно информации, чтобы определить, какой вариант выбрать. `UpHierarchy`: расположение представляет собой перемещение вверх по географической иерархии. Это происходит, когда совпадение для запроса расположения не найдено, поэтому возвращается менее точный результат. Например, если не удается найти совпадение для запрошенного адреса, может быть возвращен код `UpHierarchy` соответствия с типом сущности RoadBlock.
Properties
ResultTypeEnum	Укажите нужные типы сущностей в ответе. Будут возвращены только указанные типы. Если точка не может быть сопоставлена с указанными типами сущностей, в ответе сведения о расположении не возвращаются. Значение по умолчанию — это все возможные сущности. Разделенный запятыми список типов сущностей, выбранных из следующих параметров. Адрес Окружение. ЗаполнениеPlace Почтовый индекс1 AdminDivision1 AdminDivision2 CountryRegion Эти типы сущностей упорядочены от самой конкретной сущности к наименее определенной сущности. При обнаружении сущностей нескольких типов возвращается только самая конкретная сущность. Например, если указать Address и AdminDistrict1 как типы сущностей и сущности были найдены для обоих типов, в ответе будут возвращены только сведения об сущности Address.
ReverseGeocodingBatchRequestBody	Список запросов и запросов обратного геокодирования для обработки. Список может содержать не более 100 запросов и должен содержать не менее 1 запроса.
ReverseGeocodingBatchRequestItem	Объект пакетного запроса
Summary	Сводка по пакетным запросам
UsageTypeEnum	Лучшее использование для точки геокодирования. Каждая точка геокодирования определяется как `Route` точка, `Display` точка или и то, и другое. Используйте `Route` точки, если вы создаете маршрут к расположению. Используйте `Display` точки, если отображается расположение на карте. Например, если расположением является парк, `Route` точка может указать вход в парк, куда можно войти на автомобиле, а `Display` точка может быть точкой, которая указывает центр парка.

Address

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

Имя	Тип	Описание
addressLine	string	Адресная линия, содержащая название и номер улицы
adminDistricts	AdminDistricts[]	Название подразделения в стране или регионе для адреса. Этот элемент обычно рассматривается как административное деление первого порядка, но в некоторых случаях он также содержит второе, третье или четвертое деление в стране, зависимости или регионе.
countryRegion	CountryRegion
formattedAddress	string	Свойство Formatted Address
intersection	Intersection	Адрес результата.
locality	string	свойство locality
neighborhood	string	район собственности
postalCode	string	Свойство "Почтовый индекс"

AdminDistricts

Название подразделения в стране или регионе для адреса. Этот элемент обычно рассматривается как административное деление первого порядка, но в некоторых случаях он также содержит второе, третье или четвертое деление в стране, зависимости или регионе.

Имя	Тип	Описание
name	string	Имя соответствующего поля adminDistrict, для adminDistrict[0], это может быть полное имя штата, например Вашингтон, для adminDistrict[1], это может быть полное имя округа.
shortName	string	Короткое имя соответствующего поля adminDistrict, для adminDistrict[0], это может быть короткое имя штата, например WA, для adminDistrict[1], это может быть короткое имя округа.

CalculationMethodEnum

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

Имя	Тип	Описание
Interpolation	string	Точка геокода была сопоставлена с точкой на дороге с помощью интерполяции.
InterpolationOffset	string	Точка геокодирования была сопоставлена с точкой на дороге с помощью интерполяции с дополнительным смещением для сдвига точки в сторону улицы.
Parcel	string	Точка геокодирования была сопоставлена с центром посылки.
Rooftop	string	Точка геокодирования была сопоставлена с крышей здания.

ConfidenceEnum

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

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

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

High

Имя	Тип	Описание
High	string	Если для достоверности задано значение `High`, обнаружено одно или несколько сильных совпадений. Несколько `High` соответствий достоверности сортируются в порядке ранжирования по важности, если это применимо. Например, ориентиры имеют важное значение, а адреса — нет. Если запрос включает расположение или представление, ранжирование может измениться соответствующим образом. Например, запрос расположения для "Paris" возвращает "Paris, France" и "Paris, TX" с `High` уверенностью. "Париж, Франция" всегда занимает первое место из-за важности, если расположение пользователя не указывает на то, что пользователь находится в Париже, TX или очень близко к ней, или представление карты указывает, что пользователь выполняет поиск в этой области.
Low	string
Medium	string	В некоторых ситуациях возвращаемое совпадение может быть не на том же уровне, что и информация, указанная в запросе. Например, запрос может указать сведения об адресе, а служба геокода может соответствовать только почтовому индексу. В этом случае, если служба геокодирования имеет уверенность в том, что почтовый индекс соответствует данным, для параметра достоверности устанавливается значение `Medium` , а для кода соответствия — значение `UpHierarchy` , чтобы указать, что она не может соответствовать всем сведениям и должна выполнять поиск по иерархии выше. Если сведения о расположении в запросе неоднозначны и нет дополнительных сведений для ранжирования расположений (таких как расположение пользователя или относительная важность расположения), для параметра достоверности устанавливается значение `Medium`. Например, запрос расположения для "148th Ave, Bellevue" может возвращать "148th Ave SE" и "148th Ave NE" оба с `Medium` уверенностью. Если сведения о расположении в запросе не предоставляют достаточно сведений для геокодирования определенного расположения, может быть возвращено менее точное значение расположения, а для параметра достоверности задано значение `Medium`. Например, если указан адрес, но совпадение с номером дома не найдено, может быть возвращен результат геокода с типом сущности Roadblock.

string

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

Если запрос включает расположение или представление, ранжирование может измениться соответствующим образом. Например, запрос расположения для "Paris" возвращает "Paris, France" и "Paris, TX" с High уверенностью. "Париж, Франция" всегда занимает первое место из-за важности, если расположение пользователя не указывает на то, что пользователь находится в Париже, TX или очень близко к ней, или представление карты указывает, что пользователь выполняет поиск в этой области.

Low

string

Medium

string

В некоторых ситуациях возвращаемое совпадение может быть не на том же уровне, что и информация, указанная в запросе. Например, запрос может указать сведения об адресе, а служба геокода может соответствовать только почтовому индексу. В этом случае, если служба геокодирования имеет уверенность в том, что почтовый индекс соответствует данным, для параметра достоверности устанавливается значение Medium , а для кода соответствия — значение UpHierarchy , чтобы указать, что она не может соответствовать всем сведениям и должна выполнять поиск по иерархии выше.

Если сведения о расположении в запросе неоднозначны и нет дополнительных сведений для ранжирования расположений (таких как расположение пользователя или относительная важность расположения), для параметра достоверности устанавливается значение Medium. Например, запрос расположения для "148th Ave, Bellevue" может возвращать "148th Ave SE" и "148th Ave NE" оба с Medium уверенностью.

Если сведения о расположении в запросе не предоставляют достаточно сведений для геокодирования определенного расположения, может быть возвращено менее точное значение расположения, а для параметра достоверности задано значение Medium. Например, если указан адрес, но совпадение с номером дома не найдено, может быть возвращен результат геокода с типом сущности Roadblock.

CountryRegion

Имя	Тип	Описание
ISO	string	ISO страны или региона
name	string	имя страны или региона

ErrorAdditionalInfo

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

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

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

FeatureCollectionEnum

Тип объекта FeatureCollection должен иметь тип FeatureCollection.

Имя	Тип	Описание
FeatureCollection	string

FeaturesItem

Имя	Тип	Описание
bbox	number[]	Ограничивающий прямоугольник. Используемая проекция — EPSG:3857. Дополнительные сведения см. в документе RFC 7946 .
geometry	GeoJsonPoint	Допустимый `GeoJSON Point` тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
id	string	Идентификатор возвращаемой функции
properties	Properties
type	FeatureTypeEnum	Тип компонента должен иметь тип Feature.

FeatureTypeEnum

Тип компонента должен иметь тип Feature.

Имя	Тип	Описание
Feature	string

GeocodePoints

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

Имя	Тип	Описание
calculationMethod	CalculationMethodEnum	Метод, который использовался для вычисления точки геокода.
geometry	GeoJsonPoint	Допустимый `GeoJSON Point` тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
usageTypes	UsageTypeEnum[]	Лучшее использование для точки геокодирования. Каждая точка геокодирования определяется как `Route` точка, `Display` точка или и то, и другое. Используйте `Route` точки, если вы создаете маршрут к расположению. Используйте `Display` точки, если отображается расположение на карте. Например, если расположением является парк, `Route` точка может указать вход в парк, куда можно войти на автомобиле, а `Display` точка может быть точкой, которая указывает центр парка.

GeocodingBatchResponse

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

Имя	Тип	Описание
batchItems	GeocodingBatchResponseItem[]	Массив, содержащий результаты пакета.
nextLink	string	— это ссылка на следующую страницу возвращаемых функций. Если это последняя страница, это поле отсутствует.
summary	Summary	Сводка по пакетным запросам

GeocodingBatchResponseItem

Имя	Тип	Описание
error	ErrorDetail	Сведения об ошибке.
features	FeaturesItem[]
nextLink	string	— это ссылка на следующую страницу возвращаемых функций. Если это последняя страница, это поле отсутствует.
optionalId	string	идентификатор batchItem, который будет совпадать с идентификатором в запросе.
type	FeatureCollectionEnum	Тип объекта FeatureCollection должен иметь тип FeatureCollection.

GeoJsonPoint

Допустимый GeoJSON Point тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя	Тип	Описание
bbox	number[]	Ограничивающий прямоугольник. Используемая проекция — EPSG:3857. Дополнительные сведения см. в документе RFC 7946 .
coordinates	number[]	— `Position` это массив чисел с двумя или более элементами. Первые два элемента — долгота и широта, именно в этом порядке. Высота или высота — необязательный третий элемент. Дополнительные сведения см. в документе RFC 7946 .
type	string: Point	Указывает тип элемента `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

Intersection

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

Имя	Тип	Описание
baseStreet	string	Основная улица для расположения.
displayName	string	Полное имя пересечения.
intersectionType	string	Тип пересечения.
secondaryStreet1	string	Первая пересекающаяся улица.
secondaryStreet2	string	Если таковые есть, вторая пересекающаяся улица.

MatchCodesEnum

Одно или несколько совпадающих значений кода, представляющих уровень геокодирования для каждого расположения в ответе.

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

Аналогичным образом, геокодированное расположение с кодами Ambiguous соответствия и UpHierarchy подразумевает, что не удалось найти расположение геокода, совпадающее со всеми предоставленными сведениями о расположении, поэтому службе геокодирования пришлось выполнить поиск в иерархии выше и найти несколько совпадений на этом уровне. Примером результата и UpHierarchy является предоставление полных сведений Ambiguous об адресе, но служба геокодирования не может найти совпадение с адресом улицы и вместо этого возвращает сведения для нескольких значений RoadBlock.

Вы можете выбрать

Good: в расположении есть только одно совпадение, или все возвращенные совпадения считаются сильными. Например, запрос для New York возвращает несколько хороших совпадений.

Ambiguous: расположение является одним из набора возможных совпадений. Например, при запросе адреса улицы 128 Main St., ответ может вернуть два расположения для 128 North Main St. и 128 South Main St. поскольку недостаточно информации, чтобы определить, какой вариант выбрать.

UpHierarchy: расположение представляет собой перемещение вверх по географической иерархии. Это происходит, когда совпадение для запроса расположения не найдено, поэтому возвращается менее точный результат. Например, если не удается найти совпадение для запрошенного адреса, может быть возвращен код UpHierarchy соответствия с типом сущности RoadBlock.

Имя	Тип	Описание
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Имя	Тип	Описание
address	Address	Адрес результата
confidence	ConfidenceEnum	Уровень уверенности в том, что результат геокодированного расположения является совпадением. Используйте это значение с кодом соответствия, чтобы определить более полные сведения о совпадении. Достоверность геокодированного расположения зависит от многих факторов, включая относительную важность геокодированного расположения и расположение пользователя, если оно указано.
geocodePoints	GeocodePoints[]	Коллекция точек геокодирования, которые отличаются способом вычисления и предлагаемым использованием.
matchCodes	MatchCodesEnum[]	Одно или несколько совпадающих значений кода, представляющих уровень геокодирования для каждого расположения в ответе. Например, геокодированное расположение с кодами `Good` соответствия и `Ambiguous` означает, что для сведений о расположении было найдено несколько расположений геокода, а служба геокода не выполнила поиск по иерархии для поиска совпадения. Аналогичным образом геокодированное расположение с кодами `Ambiguous` соответствия и `UpHierarchy` подразумевает, что не удалось найти расположение геокода, соответствующее всей предоставленной информации о расположении, поэтому службе геокода пришлось выполнять поиск выше иерархии и находить несколько совпадений на этом уровне. Примером результата и `UpHierarchy` является предоставление полных сведений `Ambiguous` об адресе, но служба геокода не может найти совпадение с почтовым адресом и вместо этого возвращает сведения для нескольких значений RoadBlock. Вы можете выбрать `Good`: расположение содержит только одно совпадение, или все возвращенные совпадения считаются сильными. Например, запрос для New York возвращает несколько хороших совпадений. `Ambiguous`: расположение является одним из наборов возможных совпадений. Например, при запросе адреса 128 Main St. ответ может возвращать два расположения для 128 North Main St. и 128 South Main St., так как недостаточно информации, чтобы определить, какой вариант выбрать. `UpHierarchy`: расположение представляет собой перемещение вверх по географической иерархии. Это происходит, когда совпадение для запроса расположения не найдено, поэтому возвращается менее точный результат. Например, если не удается найти совпадение для запрошенного адреса, может быть возвращен код `UpHierarchy` соответствия с типом сущности RoadBlock.
type	string	Одно из двух значений: Адрес Блокпост RoadIntersection Окружение. ЗаполнениеPlace Почтовый индекс1 AdminDivision1 AdminDivision2 CountryRegion

ResultTypeEnum

Укажите нужные типы сущностей в ответе. Будут возвращены только указанные типы. Если точка не может быть сопоставлена с указанными типами сущностей, в ответе сведения о расположении не возвращаются. Значение по умолчанию — это все возможные сущности. Разделенный запятыми список типов сущностей, выбранных из следующих параметров.

Адрес
Окружение.
ЗаполнениеPlace
Почтовый индекс1
AdminDivision1
AdminDivision2
CountryRegion

Эти типы сущностей упорядочены от самой конкретной сущности к наименее определенной сущности. При обнаружении сущностей нескольких типов возвращается только самая конкретная сущность. Например, если указать Address и AdminDistrict1 как типы сущностей и сущности были найдены для обоих типов, в ответе будут возвращены только сведения об сущности Address.

Имя	Тип	Описание
Address	string
AdminDivision1	string
AdminDivision2	string
CountryRegion	string
Neighborhood	string
PopulatedPlace	string
Postcode1	string

ReverseGeocodingBatchRequestBody

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

Имя	Тип	Описание
batchItems	ReverseGeocodingBatchRequestItem[]	Список запросов для обработки.

ReverseGeocodingBatchRequestItem

Объект пакетного запроса

Имя	Тип	Описание
coordinates	number[]	Координаты расположения, для которого требуется изменить геокод. Пример: [lon,lat]
optionalId	string	идентификатор запроса, который будет отображаться в соответствующем batchItem
resultTypes	ResultTypeEnum[]	Укажите нужные типы сущностей в ответе. Будут возвращены только указанные типы. Если точка не может быть сопоставлена с указанными типами сущностей, в ответе сведения о расположении не возвращаются. Значение по умолчанию — это все возможные сущности. Разделенный запятыми список типов сущностей, выбранных из следующих параметров. Адрес Окружение. ЗаполнениеPlace Почтовый индекс1 AdminDivision1 AdminDivision2 CountryRegion Эти типы сущностей упорядочены от самой конкретной сущности к наименее определенной сущности. При обнаружении сущностей нескольких типов возвращается только самая конкретная сущность. Например, если указать Address и AdminDistrict1 как типы сущностей и сущности были найдены для обоих типов, в ответе будут возвращены только сведения об сущности Address.
view	string	Строка, указывающая код региона или страны iso 3166-1 Alpha-2. Это приведет к изменению геополитических спорных границ и меток в соответствии с указанным пользовательским регионом.

Summary

Сводка по пакетным запросам

Имя	Тип	Описание
successfulRequests	integer	Число успешных запросов в пакете
totalRequests	integer	Общее количество запросов в пакете

UsageTypeEnum

Лучшее использование для точки геокодирования. Каждая точка геокодирования определяется как Route точка, Display точка или и то, и другое. Используйте Route точки, если вы создаете маршрут к расположению. Используйте Display точки, если отображается расположение на карте. Например, если расположением является парк, Route точка может указать вход в парк, куда можно войти на автомобиле, а Display точка может быть точкой, которая указывает центр парка.

Имя	Тип	Описание
Display	string
Route	string

Share via

Search - Get Reverse Geocoding Batch

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

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

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

Параметры URI

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

Текст запроса

Ответы

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

AADToken

Scopes

subscription-key

SAS Token

Примеры

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

Sample Request

Sample Response

Определения

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

ResultTypeEnum

ReverseGeocodingBatchRequestBody

ReverseGeocodingBatchRequestItem

Summary

UsageTypeEnum

Дополнительные ресурсы