Search - Get Geocoding

Ссылка

Служба:: Maps

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

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

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

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

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

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

GET https://atlas.microsoft.com/geocode?api-version=2023-06-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	Официальная линия улицы адреса относительно области, как указано в свойствах locality или postalCode. Обычно этот элемент используется для предоставления адреса улицы или любого официального адреса. Если задан запрос, не следует использовать этот параметр.
adminDistrict	query		string	Часть адреса, разделяемая страной, например WA. Если задан запрос, не следует использовать этот параметр.
adminDistrict2	query		string	Уезд для структурированного адреса, например Кинг. Если задан запрос, не следует использовать этот параметр.
adminDistrict3	query		string	Именованной области для структурированного адреса. Если задан запрос, не следует использовать этот параметр.
bbox	query		number[]	Прямоугольная область на земле, определенная как ограничивающий прямоугольник. Стороны прямоугольников определяются значениями долготы и широты. При указании этого параметра при вычислении результатов запроса расположения учитывается географическая область. Пример: lon1,lat1,lon2,lat2
coordinates	query		number[]	Точка на земле, указанная в виде долготы и широты. При указании этого параметра учитывается расположение пользователя, и возвращаемые результаты могут быть более релевантными для пользователя. Пример: &coordinates=lon,lat
countryRegion	query		string	Сигнал для результата геокодирования в код региона или страны iso 3166-1 Alpha-2 , который указан, например FR./ Если задан запрос, не следует использовать этот параметр.
locality	query		string	Часть адреса, например Сиэтл. Если задан запрос, не следует использовать этот параметр.
postalCode	query		string	Почтовый индекс адреса. Если задан запрос, не следует использовать этот параметр.
query	query		string	Строка, содержащая сведения о расположении, например адрес или имя ориентира.
top	query		integer int32	Максимальное количество возвращаемых ответов. По умолчанию: 5, минимум: 1 и максимум: 20.
view	query		string	Строка, представляющая код региона или страны в стандарте ISO 3166-1 Alpha-2. Это приведет к изменению геополитических спорных границ и меток в соответствии с указанным пользовательским регионом. По умолчанию для параметра View задано значение "Auto", даже если вы не определили его в запросе. Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления .

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

Имя	Обязательно	Тип	Описание
Accept-Language		string	Язык, на котором должны возвращаться результаты поиска. Дополнительные сведения см. в разделе Поддерживаемые языки .
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 см. в следующих статьях .

Ответы

Имя	Тип	Описание
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, пакетов AZURE SDK или REST API.

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

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

Тип: apiKey
В: header

SAS Token

Это маркер подписанного URL-адреса, который создается из операции SAS list в ресурсе 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=2023-06-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",
          "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=2023-06-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",
          "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=2023-06-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",
          "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=2023-06-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	Тип компонента должен иметь тип Feature.
GeocodePoints	Коллекция точек геокодирования, которые отличаются способом вычисления и предлагаемым использованием.
GeocodingResponse	Этот объект возвращается из успешного вызова Geocoding
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
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` точка может быть точкой, которая указывает центр парка.

GeocodingResponse

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

Имя	Тип	Описание
features	FeaturesItem[]
nextLink	string	— это ссылка на следующую страницу возвращаемых функций. Если это последняя страница, это поле отсутствует.
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

UsageTypeEnum

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

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

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

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

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