Search - Get Geocoding

Служба:: Maps

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

Используется для получения координат долготы и широты улицы, адреса или названия населенного пункта.

API Get Geocoding — это запрос HTTP GET, который возвращает координаты долготы и широты поиска расположения.

Во многих случаях полная служба поиска может быть слишком много, например, если вы заинтересованы только в традиционном геокодирование. Поиск также можно получить только для поиска адресов. Геокодирование выполняется путем попадания в конечную точку геокодирования только с адресом или частичным адресом. Индекс поиска геокодирования будет запрашиваться для всех данных над данными уровня улицы. Не будет возвращена точка интереса (POIS). Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все от точных уличных адресов или улиц или пересечений, а также более высокого уровня географических регионов, таких как городские центры, округа и штаты. Ответ также возвращает подробные свойства адреса, такие как улица, почтовый индекс, муниципалитет и информация о стране или регионе.

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01

С использованием необязательных параметров:

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

Параметры URI

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string	Номер версии API Azure Maps.
addressLine	query		string	Официальная линия улицы адреса относительно области, как указано в регионе, или почтовый индекс, свойства. Обычное использование этого элемента — предоставить адрес улицы или любой официальный адрес. Этот параметр не следует использовать, если он `query` включен в запрос.
adminDistrict	query		string	Часть подразделения страны, например WA. Этот параметр не следует использовать, если он `query` включен в запрос.
adminDistrict2	query		string	Округ для структурированного адреса, например King. Этот параметр не следует использовать, если он `query` включен в запрос.
adminDistrict3	query		string	Именованной области для структурированного адреса. Этот параметр не следует использовать, если он `query` включен в запрос.
bbox	query		number[]	Прямоугольная область на земле, определенная как ограничивающий прямоугольник. Стороны прямоугольников определяются значениями долготы и широты. При указании этого параметра географическая область учитывается при вычислении результатов запроса расположения. Пример: lon1,lat1,lon2,lat2
coordinates	query		number[]	Точка на земле, указанная в виде долготы и широты. При указании этого параметра учетная запись пользователя учитывается, а возвращаемые результаты могут быть более актуальными для пользователя. Пример: координаты &=lon,lat
countryRegion	query		string	Сигнал для результата геокодирования в iso 3166-1 Alpha-2 регион/код страны, указанный например FR./ Этот параметр не следует использовать, если он `query` включен в запрос.
locality	query		string	Часть адреса, например Сиэтл. Этот параметр не следует использовать, если он `query` включен в запрос.
postalCode	query		string	Почтовый индекс адреса. Этот параметр не следует использовать, если он `query` включен в запрос.
query	query		string	Строка, содержащая сведения о расположении, например адрес или имя ориентира.
top	query		integer (int32) minimum: 1 maximum: 20	Максимальное количество возвращаемых ответов. По умолчанию: 5, минимум: 1 и максимум: 20.
view	query		string	Строка, представляющая код региона илистраны ISO 3166-1 Альфа-2. Это изменит геополитические спорные границы и метки, чтобы выровняться с указанным регионом пользователя. По умолчанию параметр View имеет значение Auto, даже если он не определен в запросе. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.

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

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

Имя

Обязательно

Тип

Описание

Accept-Language

string

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

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

x-ms-client-id

string

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

Ответы

Имя	Тип	Описание
200 OK	GeocodingResponse	ХОРОШО Media Types: "application/geo+json" Заголовки x-ms-request-id: string
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка. Media Types: "application/geo+json"

Имя

Тип

Описание

200 OK

GeocodingResponse

ХОРОШО

Media Types: "application/geo+json"

Заголовки

x-ms-request-id: string

Other Status Codes

ErrorResponse

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

Media Types: "application/geo+json"

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

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-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

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

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

Тип: apiKey
В: header

Примеры

Search detail address 15127 NE 24th Street, Redmond, WA

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Search detail address 15127 NE 24th Street, Redmond, WA by query

Search landmark Empire State Building by query

Search detail address 15127 NE 24th Street, Redmond, WA

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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

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

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

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

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

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

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "Medium",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by query

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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&query=15127 NE 24th Street Redmond WA

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

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

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search landmark Empire State Building by query

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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01&query=empire state building

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

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

Content-Type: application/geo+json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "New York"
        },
        "type": "PointOfInterest",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98580932617188,
                40.748435974121094
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98580932617188,
          40.748435974121094
        ]
      },
      "bbox": [
        -73.98590850830078,
        40.74833679199219,
        -73.98571014404297,
        40.74853515625
      ]
    },
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            },
            {
              "shortName": "New York County"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "Manhattan"
        },
        "type": "LandmarkBuilding",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98500061035156,
                40.74815368652344
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98500061035156,
          40.74815368652344
        ]
      },
      "bbox": [
        -73.98710632324219,
        40.747314453125,
        -73.98412322998047,
        40.74958038330078
      ]
    }
  ]
}

Определения

Имя	Описание
Address	Адрес результата
AdminDistricts	Имя подразделения в стране или регионе для адреса. Обычно этот элемент рассматривается как первое административное подразделение порядка, но в некоторых случаях он также содержит второй, третий или четвертый отдел порядка в стране, зависимости или регионе.
CalculationMethodEnum	Метод, используемый для вычисления точки геокода.
ConfidenceEnum	Уровень уверенности, что результат географического расположения соответствует. Используйте это значение с кодом соответствия, чтобы определить более полную информацию о совпадении. Достоверность геокодированного расположения основана на многих факторах, включая относительную важность геокодированного расположения и расположения пользователя, если указано.
CountryRegion
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
FeatureCollectionEnum	Тип объекта FeatureCollection должен быть FeatureCollection.
FeaturesItem
FeatureTypeEnum	Тип компонента должен быть компонентом.
GeocodePoints	Коллекция точек геокода, отличающихся от способа их вычисления и их предлагаемого использования.
GeocodingResponse	Этот объект возвращается из успешного вызова Geocoding
GeoJsonPoint	Допустимый тип геометрии `GeoJSON Point`. Дополнительные сведения см. в RFC 7946.
Intersection	Адрес результата.
MatchCodesEnum	Одно или несколько совпадающих значений кода, представляющих уровень геокодирования для каждого расположения в ответе. Например, геокодированное расположение с кодами соответствия `Good` и `Ambiguous` означает, что для сведений о расположении было найдено несколько расположений геокода, а служба геокодов не искала совпадения. Аналогичным образом геокодированное расположение с кодами соответствия `Ambiguous` и `UpHierarchy` подразумевает, что расположение геокода не удалось найти, которое соответствовало всем предоставленным сведениям о расположении, поэтому служба геокодов должна была выполнять поиск по иерархии и находить несколько совпадений на этом уровне. Пример `Ambiguous` и результата `UpHierarchy` заключается в предоставлении полных сведений об адресе, но служба геокодов не может найти совпадение для адреса улицы и вместо этого возвращает сведения для нескольких значений RoadBlock. Возможные значения: `Good`: расположение имеет только одно совпадение или все возвращенные совпадения считаются сильными. Например, запрос на нью-йорк возвращает несколько хороших совпадений. `Ambiguous`: расположение является одним из возможных совпадений. Например, когда вы запрашиваете адрес улицы 128 Main St., ответ может вернуть два расположения для 128 Северо-Главной и 128 Южный Главный Санкт, так как недостаточно информации, чтобы определить, какой вариант выбрать. `UpHierarchy`: расположение представляет перемещение по географической иерархии. Это происходит, когда совпадение для запроса расположения не найдено, поэтому возвращается менее точный результат. Например, если не удается найти совпадение для запрошенного адреса, может быть возвращен код соответствия `UpHierarchy` с типом сущности RoadBlock.
Properties
UsageTypeEnum	Лучше всего использовать для точки геокода. Каждая точка геокода определяется как точка `Route`, точка `Display` или оба. Используйте `Route` точки, если вы создаете маршрут к расположению. Используйте `Display` точки, если отображается расположение на карте. Например, если расположение является парком, точка `Route` может указать вход в парк, где можно войти с автомобилем, и `Display` точка может быть точкой, которая указывает центр парка.

Address

Object

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

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

AdminDistricts

Object

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

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

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

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

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

Medium

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

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

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

Low

CountryRegion

Object

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

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

Ответ на ошибку

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

FeatureCollectionEnum

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

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

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

FeaturesItem

Object

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

FeatureTypeEnum

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

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

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

GeocodePoints

Object

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

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

GeocodingResponse

Object

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

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

GeoJsonPoint

Object

Допустимый тип геометрии 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

Object

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

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

MatchCodesEnum

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

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

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

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

Возможные значения:

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

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

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

Значение	Описание
Good
Ambiguous
UpHierarchy

Properties

Object

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

UsageTypeEnum

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

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

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

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

Search - Get Geocoding

Параметры URI

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

Ответы

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

AADToken

Области

subscription-key

SAS Token

Примеры

Search detail address 15127 NE 24th Street, Redmond, WA

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

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

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

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

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

Search detail address 15127 NE 24th Street, Redmond, WA by query

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

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

Search landmark Empire State Building by query

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

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

Определения

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingResponse

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

UsageTypeEnum