Search - Get Geocoding Batch

Служба:: Maps

Версия API:: 2026-01-01

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

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

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

POST https://atlas.microsoft.com/geocode:batch?api-version={api-version}

Текст 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
    }
  ]
}

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

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

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

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

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

POST {endpoint}/geocode:batch?api-version=2026-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Hostname сервиса Azure Maps. Используйте `https://atlas.microsoft.com` для публичного облака Azure. Чтобы определить конкретную географию Azure Maps или суверенное облако, см. Azure Maps geographic scope.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

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

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

Имя

Обязательно

Тип

Описание

x-ms-client-id

string

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

Accept-Language

string

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

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

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

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

Ответы

Имя	Тип	Описание
200 OK	GeocodingBatchResponse	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

GeocodingBatchResponse

Запрос выполнен успешно.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

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

AadToken

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

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

Note

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

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

Области

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

subscription-key

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

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

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

Тип: apiKey
В: header

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

A Geocoding Batch API call containing 2 Geocoding queries

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

HTTP

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

{
  "batchItems": [
    {
      "addressLine": "15127 NE 24th Street, Redmond, WA 98052",
      "top": 2,
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "query": "Pike Pl",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

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

Код состояния:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King County"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
              "streetName": "NE 24th St",
              "streetNumber": "15127",
              "addressLine": "15127 NE 24th St"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.138669,
                    47.630359
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.1387383,
                    47.630563
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.138669,
              47.630359
            ]
          },
          "bbox": [
            -122.14631082421619,
            47.62649628242932,
            -122.1310271757838,
            47.634221717570675
          ]
        }
      ]
    },
    {
      "error": {
        "code": "Conflicting Parameters",
        "message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'locality' was passed"
      }
    }
  ]
}

Определения

Имя	Описание
Address	Адрес результата
AddressAdminDistrictsItem	Имя подразделения в стране или регионе для адреса.
AddressCountryRegion	Страна или регион с ее названием и кодом ISO.
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
CalculationMethodEnum	Метод, используемый для вычисления точки геокода.
ConfidenceEnum	Уровень уверенности, что результат географического расположения соответствует. Используйте это значение с кодом соответствия, чтобы определить более полную информацию о совпадении. Достоверность геокодированного расположения основана на многих факторах, включая относительную важность геокодированного расположения и расположения пользователя, если указано.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Детали ошибки.
FeatureCollectionEnum	Указывает тип `GeoJSON`. Единственным поддерживаемым типом объекта является `FeatureCollection`. Дополнительные сведения см. в RFC 7946.
FeaturesItem	Объект особенности.
FeaturesItemProperties	Свойства объекта.
FeatureTypeEnum	Тип компонента должен быть компонентом.
GeocodePointsItem	Точка геокода.
GeocodingBatchRequestBody	Список запросов/запросов к геокодированию адресов для обработки. Список может содержать не более 100 запросов и должен содержать не менее 1 запроса.
GeocodingBatchRequestItem	Объект Batch Query
GeocodingBatchResponse	Этот объект возвращается из успешного вызова пакетной службы Geocoding.
GeocodingBatchResponseItem	Пакетный ответ.
GeocodingBatchResponseSummary	Сводка для пакетного запроса
GeoJsonObjectType	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.
GeoJsonPoint	Допустимый тип геометрии `GeoJSON Point`. Дополнительные сведения см. в RFC 7946.
Intersection	Адрес результата.
MatchCodesEnum	Энум, представляющий код совпадения.
UsageTypeEnum	Энум, представляющий тип употребления.

Address

Объект

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

Имя	Тип	Описание
addressLine	string	AddressLine, который включает название и номер улицы
adminDistricts	AddressAdminDistrictsItem[]	Имя подразделения в стране или регионе для адреса. Обычно этот элемент рассматривается как первое административное подразделение порядка, но в некоторых случаях он также содержит второй, третий или четвертый отдел порядка в стране, зависимости или регионе.
countryRegion	AddressCountryRegion	Страна или регион с ее названием и кодом ISO.
formattedAddress	string	Свойство форматированного адреса
intersection	Intersection	Адрес результата.
locality	string	Населённый пункт
neighborhood	string	Недвижимость по соседству
postalCode	string	Свойство почтового индекса
streetName	string	Название улицы из formattedAddress
streetNumber	string	Номер на улице, если таковой имеется, из formattedAddress

AddressAdminDistrictsItem

Объект

Имя подразделения в стране или регионе для адреса.

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

AddressCountryRegion

Объект

Страна или регион с ее названием и кодом ISO.

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

Azure.Core.Foundations.Error

Объект

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

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

CalculationMethodEnum

Перечисление

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

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

ConfidenceEnum

Перечисление

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

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

Значение Описание

High

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

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

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

Medium

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

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

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

Low

ErrorAdditionalInfo

Объект

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

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

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

FeatureCollectionEnum

Перечисление

Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.

Значение	Описание
FeatureCollection	Указывает тип объекта `GeoJSONFeatureCollection`.

FeaturesItem

Объект

Объект особенности.

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

FeaturesItemProperties

Объект

Свойства объекта.

Имя	Тип	Описание
address	Address	Адрес результата
confidence	ConfidenceEnum	Уровень уверенности, что результат географического расположения соответствует. Используйте это значение с кодом соответствия, чтобы определить более полную информацию о совпадении. Достоверность геокодированного расположения основана на многих факторах, включая относительную важность геокодированного расположения и расположения пользователя, если указано.
geocodePoints	GeocodePointsItem[]	Коллекция точек геокода, отличающихся от способа их вычисления и их предлагаемого использования.
matchCodes	MatchCodesEnum[]	Одно или несколько совпадающих значений кода, представляющих уровень геокодирования для каждого расположения в ответе. Например, геокодированное расположение с кодами соответствия `Good` и `Ambiguous` означает, что для сведений о расположении было найдено несколько расположений геокода, а служба геокодов не искала совпадения. Аналогичным образом геокодированное расположение с кодами соответствия `Ambiguous` и `UpHierarchy` подразумевает, что расположение геокода не удалось найти, которое соответствовало всем предоставленным сведениям о расположении, поэтому служба геокодов должна была выполнять поиск по иерархии и находить несколько совпадений на этом уровне. Пример `Ambiguous` и результата `UpHierarchy` заключается в предоставлении полных сведений об адресе, но служба геокодов не может найти совпадение для адреса улицы и вместо этого возвращает сведения для нескольких значений RoadBlock. Возможны следующие значения: `Good`: расположение имеет только одно совпадение или все возвращенные совпадения считаются сильными. Например, запрос на нью-йорк возвращает несколько хороших совпадений. `Ambiguous`: расположение является одним из возможных совпадений. Например, когда вы запрашиваете адрес улицы 128 Main St., ответ может вернуть два расположения для 128 Северо-Главной и 128 Южный Главный Санкт, так как недостаточно информации, чтобы определить, какой вариант выбрать. `UpHierarchy`: расположение представляет перемещение по географической иерархии. Это происходит, когда совпадение для запроса расположения не найдено, поэтому возвращается менее точный результат. Например, если не удается найти совпадение для запрошенного адреса, может быть возвращен код соответствия `UpHierarchy` с типом сущности RoadBlock.
type	string	Один из: * Адрес * Дорожный блок * Перекрёсток дороги * Район * Населённое место * Почтовый индекс1 * Административный отдел 1 * Административное отделение 2 * Регион страны

FeatureTypeEnum

Перечисление

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

Значение	Описание
Feature	Указывает тип объекта компонента `GeoJSON`.

GeocodePointsItem

Объект

Точка геокода.

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

GeocodingBatchRequestBody

Объект

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

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

GeocodingBatchRequestItem

Объект

Объект Batch Query

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

GeocodingBatchResponse

Объект

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

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

GeocodingBatchResponseItem

Объект

Пакетный ответ.

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

GeocodingBatchResponseSummary

Объект

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

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

GeoJsonObjectType

Перечисление

Указывает тип GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

Значение	Описание
Point	`GeoJSON Point` геометрии.
MultiPoint	`GeoJSON MultiPoint` геометрии.
LineString	`GeoJSON LineString` геометрии.
MultiLineString	`GeoJSON MultiLineString` геометрии.
Polygon	`GeoJSON Polygon` геометрии.
MultiPolygon	`GeoJSON MultiPolygon` геометрии.
GeometryCollection	`GeoJSON GeometryCollection` геометрии.
Feature	Объект `GeoJSON Feature`.
FeatureCollection	Объект `GeoJSON FeatureCollection`.

GeoJsonPoint

Объект

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

Имя	Тип	Описание
bbox	number[] (double)	Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946.
coordinates	number[] (double)	`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	Двусмысленный
UpHierarchy	UpHierarchy

UsageTypeEnum

Перечисление

Энум, представляющий тип употребления.

Значение	Описание
Display	Display
Route	Маршрут