Search - Get Geocoding Batch

Ссылка

Служба:: Maps

Версия API:: 2023-06-01

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

API Get Geocoding Batch — это HTTP-запрос POST , который отправляет пакеты до 100 запросов в API geocoding в одном запросе.

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

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

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

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

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

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

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

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

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

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

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

POST https://atlas.microsoft.com/geocode: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	GeocodingBatchRequestItem[]	Список запросов для обработки.

Ответы

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

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

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, CLI, пакетов SDK для Azure или REST API.
Использование веб-пакета SDK для Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.
Дополнительные сведения о платформе удостоверений Майкрософт см. в статье Обзор платформы удостоверений Майкрософт.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

subscription-key

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

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

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

Тип: apiKey
В: header

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

A Geocoding Batch API call containing 2 Geocoding queries

Образец запроса

HTTP

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

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2,
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Пример ответа

Код состояния:: 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
          ]
        }
      ]
    },
    {
      "error": {
        "code": "Conflicting Parameters",
        "message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'addressLine' was passed"
      }
    }
  ]
}

Определения

Имя	Описание
Address	Адрес результата
AdminDistricts	Название подразделения в стране или регионе для адреса. Этот элемент обычно рассматривается как административное деление первого порядка, но в некоторых случаях он также содержит второе, третье или четвертое подразделение порядка в стране, зависимости или регионе.
CalculationMethodEnum	Метод, который использовался для вычисления точки геокода.
ConfidenceEnum	Уровень уверенности в том, что результат геокодированного расположения является совпадением. Используйте это значение с кодом соответствия, чтобы определить более полные сведения о совпадении. Достоверность геокодированного расположения зависит от многих факторов, включая относительную важность геокодированного расположения и расположение пользователя, если оно указано.
CountryRegion
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
FeatureCollectionEnum	Тип объекта FeatureCollection должен иметь тип FeatureCollection.
FeaturesItem
FeatureTypeEnum	Тип компонента должен иметь тип Feature.
GeocodePoints	Коллекция точек геокода, которые отличаются способом их вычисления и предлагаемым использованием.
GeocodingBatchRequestBody	Список запросов и запросов геокодирования адресов для обработки. Список может содержать не более 100 запросов и должен содержать не менее 1 запроса.
GeocodingBatchRequestItem	Объект пакетного запроса
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
Summary	Сводка по пакетным запросам
UsageTypeEnum	Лучше всего использовать точку геокода. Каждая точка геокода определяется как `Route` точка, `Display` точка или и то, и другое. Используйте `Route` точки при создании маршрута к расположению. Используйте `Display` точки, если отображается расположение на карте. Например, если расположением является парк, `Route` точка может указать вход в парк, куда можно въехать на автомобиле, а `Display` точка может быть точкой, указывающей центр парка.

Address

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

Имя	Тип	Описание
addressLine	string	AddressLine, включающая название и номер улицы
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` точка может быть точкой, указывающей центр парка.

GeocodingBatchRequestBody

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

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

GeocodingBatchRequestItem

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

Имя	Тип	Default value	Описание
addressLine	string		Официальная линия улицы адреса относительно области, как указано в свойствах locality или postalCode. Обычно этот элемент используется для предоставления адреса улицы или любого официального адреса. Если задан запрос, не следует использовать этот параметр.
adminDistrict	string		Часть подраздела страны в адресе, например WA. Если задан запрос, не следует использовать этот параметр.
adminDistrict2	string		Округ для структурированного адреса, например Кинг. Если задан запрос, не следует использовать этот параметр.
adminDistrict3	string		Именованной области для структурированного адреса. Если задан запрос, не следует использовать этот параметр.
bbox	number[]		Прямоугольная область на земле, определяемая как ограничивающий объект прямоугольника. Стороны прямоугольников определяются значениями долготы и широты. Дополнительные сведения см. в разделе Типы расположений и областей. При указании этого параметра при вычислении результатов запроса расположения учитывается географическая область. Пример: [lon1, lat1, lon2, lat2]
coordinates	number[]		Точка на земле, указанная в виде долготы и широты. При указании этого параметра учитывается расположение пользователя, и возвращаемые результаты могут быть более релевантными для пользователя. Пример: [lon, lat]
countryRegion	string		Сигнал для результата геокодирования в коде региона или страны альфа-2 iso 3166-1 , например FR./ Если задан запрос, не следует использовать этот параметр.
locality	string		Часть адреса, например Сиэтл. Если задан запрос, не следует использовать этот параметр.
optionalId	string		идентификатор запроса, который будет отображаться в соответствующем batchItem
postalCode	string		Почтовый индекс адреса. Если задан запрос, не следует использовать этот параметр.
query	string		Строка, содержащая сведения о расположении, например адрес или имя ориентира.
top	integer	5	Максимальное количество возвращаемых ответов. По умолчанию: 5, минимум: 1 и максимум: 20.
view	string	auto	Строка, указывающая код региона или страны iso 3166-1 Alpha-2. Это приведет к изменению геополитических спорных границ и меток в соответствии с указанным пользовательским регионом.

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

Summary

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

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

UsageTypeEnum

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

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

Поделиться через

Search - Get Geocoding Batch

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

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

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

Параметры URI

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

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

Ответы

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

AADToken

Области

subscription-key

SAS Token

Примеры

A Geocoding Batch API call containing 2 Geocoding queries

Образец запроса

Пример ответа

Определения

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchRequestBody

GeocodingBatchRequestItem

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

Summary

UsageTypeEnum

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