Search - Get Geocoding

Referencia

Servicio:: Maps

Versión de la API:: 2023-06-01

Use para obtener coordenadas de longitud y latitud de una dirección o nombre de una calle de un lugar.

La Get Geocoding API es una solicitud HTTP GET que devuelve las coordenadas de longitud y latitud de la ubicación en la que se busca.

En muchos casos, el servicio de búsqueda completo puede ser demasiado, por ejemplo, si solo está interesado en la geocodificación tradicional. También se puede acceder a la búsqueda de direcciones exclusivamente. La geocodificación se realiza al presionar el punto de conexión de geocodificación con solo la dirección o la dirección parcial en cuestión. El índice de búsqueda de geocodificación se consultará para conocer todo lo que está por encima de los datos de nivel de calle. No se devolverá ningún punto de interés (POIs). Tenga en cuenta que el geocodificador es muy tolerante a errores tipográficos y direcciones incompletas. También controlará todo, desde direcciones exactas o calles o intersecciones, así como zonas geográficas de nivel superior, como centros de ciudad, condados y estados. La respuesta también devuelve propiedades de dirección detalladas, como la calle, el código postal, el municipio y la información de país o región.

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

Con parámetros opcionales:

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	Número de versión de la API de Azure Maps.
addressLine	query		string	Línea de calle oficial de una dirección relativa al área, según lo especificado por la localidad, o postalCode, propiedades. El uso típico de este elemento sería proporcionar una dirección postal o cualquier dirección oficial. Si se da una consulta, no debe usar este parámetro.
adminDistrict	query		string	Parte de la subdivisión de país de una dirección, como WA. Si se da una consulta, no debe usar este parámetro.
adminDistrict2	query		string	El condado para la dirección estructurada, como King. Si se da una consulta, no debe usar este parámetro.
adminDistrict3	query		string	Área con nombre para la dirección estructurada. Si se da una consulta, no debe usar este parámetro.
bbox	query		number[]	Un área rectangular en la tierra definida como un objeto de rectángulo delimitador. Los lados de los rectángulos se definen mediante valores de longitud y latitud. Cuando se especifica este parámetro, se tiene en cuenta el área geográfica al calcular los resultados de una consulta de ubicación. Ejemplo: lon1,lat1,lon2,lat2
coordinates	query		number[]	Punto de la tierra especificado como longitud y latitud. Cuando se especifica este parámetro, se tiene en cuenta la ubicación del usuario y los resultados devueltos pueden ser más relevantes para el usuario. Ejemplo: &coordinates=lon,lat
countryRegion	query		string	Señal para el resultado de la geocodificación a un código de país o región alfa-2 ISO 3166-1 que se especifica, por ejemplo, FR./ Si se da una consulta, no debe usar este parámetro.
locality	query		string	La parte de localidad de una dirección, como Seattle. Si se da una consulta, no debe usar este parámetro.
postalCode	query		string	Parte del código postal de una dirección. Si se da una consulta, no debe usar este parámetro.
query	query		string	Cadena que contiene información sobre una ubicación, como una dirección o un nombre de punto de referencia.
top	query		integer int32	Número máximo de respuestas que se devolverán. Valor predeterminado: 5, mínimo: 1 y máximo: 20.
view	query		string	Cadena que representa un código de país o región ISO 3166-1 Alfa-2. Esto modificará los bordes y etiquetas disputados geopolíticas para alinearse con la región de usuario especificada. De forma predeterminada, el parámetro View se establece en "Auto", incluso si no lo ha definido en la solicitud. Consulte Vistas admitidas para obtener más información y ver las vistas disponibles.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Accept-Language		string	Idioma en el que se deben devolver los resultados de búsqueda. Consulte Idiomas admitidos para obtener más información.
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Azure AD. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de Azure AD en Azure Maps, consulte los siguientes artículos para obtener instrucciones.

Nombre

Requerido

Tipo

Description

Accept-Language

string

Idioma en el que se deben devolver los resultados de búsqueda.

Consulte Idiomas admitidos para obtener más información.

x-ms-client-id

string

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Azure AD. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de Azure AD en Azure Maps, consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	GeocodingResponse	Aceptar Media Types: "application/geo+json" Encabezados x-ms-request-id: string
Other Status Codes	ErrorResponse	Se ha producido un error inesperado. Media Types: "application/geo+json"

Nombre

Tipo

Description

200 OK

GeocodingResponse

Aceptar

Media Types: "application/geo+json"

Encabezados

x-ms-request-id: string

Other Status Codes

ErrorResponse

Se ha producido un error inesperado.

Media Types: "application/geo+json"

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Nota

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.
Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra.
El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
Para obtener más información sobre la plataforma de identidad de Microsoft, consulte Introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Se trata de una clave compartida que se aprovisiona al crear un recurso de Azure Maps a través del plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de las API REST de Azure Maps donde esta clave se puede almacenar de forma segura.

Tipo: apiKey
En: header

SAS Token

Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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
      ]
    }
  ]
}

Definiciones

Nombre	Description
Address	Dirección del resultado
AdminDistricts	Nombre de subdivisión en el país o región de una dirección. Este elemento se trata normalmente como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región.
CalculationMethodEnum	Método que se usó para calcular el punto de código geográfico.
ConfidenceEnum	El nivel de confianza de que el resultado de la ubicación geocodificada es una coincidencia. Use este valor con el código de coincidencia para determinar para obtener información más completa sobre la coincidencia. La confianza de una ubicación geocodificada se basa en muchos factores, incluida la importancia relativa de la ubicación geocodificada y la ubicación del usuario, si se especifica.
CountryRegion
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
FeatureCollectionEnum	El tipo de un objeto FeatureCollection debe ser FeatureCollection.
FeaturesItem
FeatureTypeEnum	El tipo de una característica debe ser Característica.
GeocodePoints	Colección de puntos de código geográfico que difieren en cómo se calcularon y su uso sugerido.
GeocodingResponse	Este objeto se devuelve de una llamada de geocodificación correcta.
GeoJsonPoint	Un tipo de geometría válido `GeoJSON Point` . Consulte RFC 7946 para obtener más información.
Intersection	Dirección del resultado.
MatchCodesEnum	Uno o varios valores de código coincidentes que representan el nivel de geocodificación para cada ubicación de la respuesta. Por ejemplo, una ubicación geocodificada con códigos de coincidencia de y `Ambiguous` significa que se encontró más de `Good` una ubicación de código geográfico para la información de ubicación y que el servicio de geocódigo no tenía búsqueda en la jerarquía superior para encontrar una coincidencia. Del mismo modo, una ubicación geocodificada con códigos de coincidencia de `Ambiguous` e `UpHierarchy` implica que no se pudo encontrar una ubicación de código geográfico que coincida con toda la información de ubicación proporcionada, por lo que el servicio de geocódigo tuvo que buscar en la jerarquía y encontrar varias coincidencias en ese nivel. Un ejemplo de un `Ambiguous` resultado y `UpHierarchy` es cuando se proporciona información de dirección completa, pero el servicio de geocódigo no puede encontrar una coincidencia para la dirección postal y, en su lugar, devuelve información para más de un valor de RoadBlock. Los valores posibles son: `Good`: la ubicación tiene solo una coincidencia o todas las coincidencias devueltas se consideran coincidencias seguras. Por ejemplo, una consulta para Nueva York devuelve varias coincidencias Good. `Ambiguous`: la ubicación es uno de un conjunto de posibles coincidencias. Por ejemplo, cuando se consulta la dirección postal 128 Main St., la respuesta puede devolver dos ubicaciones para 128 North Main St. y 128 South Main St. porque no hay suficiente información para determinar qué opción elegir. `UpHierarchy`: la ubicación representa un movimiento hacia arriba de la jerarquía geográfica. Esto ocurre cuando no se encontró una coincidencia para la solicitud de ubicación, por lo que se devuelve un resultado menos preciso. Por ejemplo, si no se encuentra una coincidencia para la dirección solicitada, se puede devolver un código de coincidencia de con un tipo de `UpHierarchy` entidad RoadBlock.
Properties
UsageTypeEnum	El mejor uso para el punto de código geográfico. Cada punto de código geográfico se define como un `Route` punto, un `Display` punto o ambos. Use `Route` puntos si va a crear una ruta a la ubicación. Use `Display` puntos si muestra la ubicación en un mapa. Por ejemplo, si la ubicación es un parque, un `Route` punto puede especificar una entrada al parque donde puede entrar con un coche y un `Display` punto puede ser un punto que especifique el centro del parque.

Address

Dirección del resultado

Nombre	Tipo	Description
addressLine	string	AddressLine que incluye el nombre de la calle y el número
adminDistricts	AdminDistricts[]	Nombre de subdivisión en el país o región de una dirección. Este elemento se suele tratar como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región.
countryRegion	CountryRegion
formattedAddress	string	Propiedad Address con formato
intersection	Intersection	Dirección del resultado.
locality	string	locality (propiedad)
neighborhood	string	propiedad del vecindario
postalCode	string	Propiedad Postal Code

AdminDistricts

Nombre de subdivisión en el país o región de una dirección. Este elemento se trata normalmente como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región.

Nombre	Tipo	Description
name	string	El nombre del campo adminDistrict correspondiente, Para adminDistrict[0], podría ser el nombre completo del estado, como Washington, For adminDistrict[1], podría ser el nombre completo del condado.
shortName	string	Nombre corto del campo adminDistrict correspondiente, Para adminDistrict[0], podría ser un nombre corto de estado como WA, For adminDistrict[1], podría ser el nombre corto del condado.

CalculationMethodEnum

Método que se usó para calcular el punto de código geográfico.

Nombre	Tipo	Description
Interpolation	string	El punto de código geográfico se ha emparejado con un punto de una carretera mediante interpolación.
InterpolationOffset	string	El punto de código geográfico se ha emparejado con un punto de una carretera mediante interpolación con un desplazamiento adicional para desplazar el punto al lado de la calle.
Parcel	string	El punto de geocódigo se ha emparejado con el centro de una parcela.
Rooftop	string	El punto de geocódigo se ha emparejado con la azotea de un edificio.

ConfidenceEnum

El nivel de confianza de que el resultado de la ubicación geocodificada es una coincidencia. Use este valor con el código de coincidencia para determinar para obtener información más completa sobre la coincidencia.

La confianza de una ubicación geocodificada se basa en muchos factores, incluida la importancia relativa de la ubicación geocodificada y la ubicación del usuario, si se especifica.

Nombre Tipo Description

High

Nombre	Tipo	Description
High	string	Si la confianza se establece `High`en , se encontraron una o varias coincidencias fuertes. Varias `High` coincidencias de confianza se ordenan en orden clasificado por importancia cuando corresponda. Por ejemplo, los puntos de referencia tienen importancia, pero las direcciones no. Si una solicitud incluye una ubicación o una vista, la clasificación puede cambiar correctamente. Por ejemplo, una consulta de ubicación para "París" devuelve "París, Francia" y "París, TX" ambos con `High` confianza. "París, Francia" siempre se clasifica primero debido a la importancia, a menos que una ubicación de usuario indique que el usuario está en París, TX o muy cerca de París, TX o la vista de mapa indica que el usuario está buscando en esa área.
Low	string
Medium	string	En algunas situaciones, la coincidencia devuelta puede no estar en el mismo nivel que la información proporcionada en la solicitud. Por ejemplo, una solicitud puede especificar información de dirección y el servicio de código geográfico solo puede coincidir con un código postal. En este caso, si el servicio de código geográfico tiene la confianza de que el código postal coincide con los datos, la confianza se establece `Medium` en y el código de coincidencia se establece `UpHierarchy` en para especificar que no pudo coincidir con toda la información y tuvo que buscar en la jerarquía. Si la información de ubicación de la consulta es ambigua y no hay información adicional para clasificar las ubicaciones (como la ubicación del usuario o la importancia relativa de la ubicación), la confianza se establece `Medium`en . Por ejemplo, una consulta de ubicación para "148th Ave, Bellevue" puede devolver "148th Ave SE" y "148th Ave NE" ambos con `Medium` confianza. Si la información de ubicación de la consulta no proporciona suficiente información para geocodificar una ubicación específica, se puede devolver un valor de ubicación menos preciso y la confianza se establece `Medium`en . Por ejemplo, si se proporciona una dirección, pero no se encuentra una coincidencia para el número de casa, se puede devolver el resultado del código geográfico con un tipo de entidad Roadblock.

string

Si la confianza se establece Highen , se encontraron una o varias coincidencias fuertes. Varias High coincidencias de confianza se ordenan en orden clasificado por importancia cuando corresponda. Por ejemplo, los puntos de referencia tienen importancia, pero las direcciones no.

Si una solicitud incluye una ubicación o una vista, la clasificación puede cambiar correctamente. Por ejemplo, una consulta de ubicación para "París" devuelve "París, Francia" y "París, TX" ambos con High confianza. "París, Francia" siempre se clasifica primero debido a la importancia, a menos que una ubicación de usuario indique que el usuario está en París, TX o muy cerca de París, TX o la vista de mapa indica que el usuario está buscando en esa área.

Low

string

Medium

string

En algunas situaciones, la coincidencia devuelta puede no estar en el mismo nivel que la información proporcionada en la solicitud. Por ejemplo, una solicitud puede especificar información de dirección y el servicio de código geográfico solo puede coincidir con un código postal. En este caso, si el servicio de código geográfico tiene la confianza de que el código postal coincide con los datos, la confianza se establece Medium en y el código de coincidencia se establece UpHierarchy en para especificar que no pudo coincidir con toda la información y tuvo que buscar en la jerarquía.

Si la información de ubicación de la consulta es ambigua y no hay información adicional para clasificar las ubicaciones (como la ubicación del usuario o la importancia relativa de la ubicación), la confianza se establece Mediumen . Por ejemplo, una consulta de ubicación para "148th Ave, Bellevue" puede devolver "148th Ave SE" y "148th Ave NE" ambos con Medium confianza.

Si la información de ubicación de la consulta no proporciona suficiente información para geocodificar una ubicación específica, se puede devolver un valor de ubicación menos preciso y la confianza se establece Mediumen . Por ejemplo, si se proporciona una dirección, pero no se encuentra una coincidencia para el número de casa, se puede devolver el resultado del código geográfico con un tipo de entidad Roadblock.

CountryRegion

Nombre	Tipo	Description
ISO	string	ISO de país o región
name	string	nombre del país o región

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FeatureCollectionEnum

El tipo de un objeto FeatureCollection debe ser FeatureCollection.

Nombre	Tipo	Description
FeatureCollection	string

FeaturesItem

Nombre	Tipo	Description
bbox	number[]	Rectángulo de selección. Proyección usada: EPSG:3857. Consulte RFC 7946 para obtener más información.
geometry	GeoJsonPoint	Un tipo de geometría válido `GeoJSON Point` . Consulte RFC 7946 para obtener más información.
id	string	Identificador de la característica devuelta
properties	Properties
type	FeatureTypeEnum	El tipo de una característica debe ser Característica.

FeatureTypeEnum

El tipo de una característica debe ser Característica.

Nombre	Tipo	Description
Feature	string

GeocodePoints

Colección de puntos de código geográfico que difieren en cómo se calcularon y su uso sugerido.

Nombre	Tipo	Description
calculationMethod	CalculationMethodEnum	Método que se usó para calcular el punto de código geográfico.
geometry	GeoJsonPoint	Un tipo de geometría válido `GeoJSON Point` . Consulte RFC 7946 para obtener más información.
usageTypes	UsageTypeEnum[]	El mejor uso para el punto de código geográfico. Cada punto de código geográfico se define como un `Route` punto, un `Display` punto o ambos. Use `Route` puntos si va a crear una ruta a la ubicación. Use `Display` puntos si muestra la ubicación en un mapa. Por ejemplo, si la ubicación es un parque, un `Route` punto puede especificar una entrada al parque donde puede entrar con un coche y un `Display` punto puede ser un punto que especifique el centro del parque.

GeocodingResponse

Este objeto se devuelve de una llamada de geocodificación correcta.

Nombre	Tipo	Description
features	FeaturesItem[]
nextLink	string	es el vínculo a la página siguiente de las características devueltas. Si es la última página, no se trata de este campo.
type	FeatureCollectionEnum	El tipo de un objeto FeatureCollection debe ser FeatureCollection.

GeoJsonPoint

Un tipo de geometría válido GeoJSON Point . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
bbox	number[]	Rectángulo de selección. Proyección usada: EPSG:3857. Consulte RFC 7946 para obtener más información.
coordinates	number[]	A `Position` es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. Altitud/Elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type	string: Point	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

Intersection

Dirección del resultado.

Nombre	Tipo	Description
baseStreet	string	Calle principal para la ubicación.
displayName	string	Nombre completo de la intersección.
intersectionType	string	Tipo de intersección.
secondaryStreet1	string	La primera intersección de la calle.
secondaryStreet2	string	Si existe, la segunda calle intersecta.

MatchCodesEnum

Uno o varios valores de código coincidentes que representan el nivel de geocodificación para cada ubicación de la respuesta.

Por ejemplo, una ubicación geocodificada con códigos de coincidencia de y Ambiguous significa que se encontró más de Good una ubicación de código geográfico para la información de ubicación y que el servicio de geocódigo no tenía búsqueda en la jerarquía superior para encontrar una coincidencia.

Del mismo modo, una ubicación geocodificada con códigos de coincidencia de Ambiguous e UpHierarchy implica que no se pudo encontrar una ubicación de código geográfico que coincida con toda la información de ubicación proporcionada, por lo que el servicio de geocódigo tuvo que buscar en la jerarquía y encontrar varias coincidencias en ese nivel. Un ejemplo de un Ambiguous resultado y UpHierarchy es cuando se proporciona información de dirección completa, pero el servicio de geocódigo no puede encontrar una coincidencia para la dirección postal y, en su lugar, devuelve información para más de un valor de RoadBlock.

Los valores posibles son:

Good: la ubicación tiene solo una coincidencia o todas las coincidencias devueltas se consideran coincidencias seguras. Por ejemplo, una consulta para Nueva York devuelve varias coincidencias Good.

Ambiguous: la ubicación es uno de un conjunto de posibles coincidencias. Por ejemplo, cuando se consulta la dirección postal 128 Main St., la respuesta puede devolver dos ubicaciones para 128 North Main St. y 128 South Main St. porque no hay suficiente información para determinar qué opción elegir.

UpHierarchy: la ubicación representa un movimiento hacia arriba de la jerarquía geográfica. Esto ocurre cuando no se encontró una coincidencia para la solicitud de ubicación, por lo que se devuelve un resultado menos preciso. Por ejemplo, si no se encuentra una coincidencia para la dirección solicitada, se puede devolver un código de coincidencia de con un tipo de UpHierarchy entidad RoadBlock.

Nombre	Tipo	Description
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Nombre	Tipo	Description
address	Address	Dirección del resultado
confidence	ConfidenceEnum	El nivel de confianza de que el resultado de la ubicación geocodificada es una coincidencia. Use este valor con el código de coincidencia para determinar para obtener información más completa sobre la coincidencia. La confianza de una ubicación geocodificada se basa en muchos factores, incluida la importancia relativa de la ubicación geocodificada y la ubicación del usuario, si se especifica.
geocodePoints	GeocodePoints[]	Colección de puntos de código geográfico que difieren en cómo se calcularon y su uso sugerido.
matchCodes	MatchCodesEnum[]	Uno o varios valores de código coincidentes que representan el nivel de geocodificación para cada ubicación de la respuesta. Por ejemplo, una ubicación geocodificada con códigos de coincidencia de y `Ambiguous` significa que se encontró más de `Good` una ubicación de código geográfico para la información de ubicación y que el servicio de geocódigo no tenía búsqueda en la jerarquía superior para encontrar una coincidencia. Del mismo modo, una ubicación geocodificada con códigos de coincidencia de `Ambiguous` e `UpHierarchy` implica que no se pudo encontrar una ubicación de código geográfico que coincida con toda la información de ubicación proporcionada, por lo que el servicio de geocódigo tuvo que buscar en la jerarquía y encontrar varias coincidencias en ese nivel. Un ejemplo de un `Ambiguous` resultado y `UpHierarchy` es cuando se proporciona información de dirección completa, pero el servicio de geocódigo no puede encontrar una coincidencia para la dirección postal y, en su lugar, devuelve información para más de un valor de RoadBlock. Los valores posibles son: `Good`: la ubicación tiene solo una coincidencia o todas las coincidencias devueltas se consideran coincidencias seguras. Por ejemplo, una consulta para Nueva York devuelve varias coincidencias Good. `Ambiguous`: la ubicación es uno de un conjunto de posibles coincidencias. Por ejemplo, cuando se consulta la dirección postal 128 Main St., la respuesta puede devolver dos ubicaciones para 128 North Main St. y 128 South Main St. porque no hay suficiente información para determinar qué opción elegir. `UpHierarchy`: la ubicación representa un movimiento hacia arriba de la jerarquía geográfica. Esto ocurre cuando no se encontró una coincidencia para la solicitud de ubicación, por lo que se devuelve un resultado menos preciso. Por ejemplo, si no se encuentra una coincidencia para la dirección solicitada, se puede devolver un código de coincidencia de con un tipo de `UpHierarchy` entidad RoadBlock.
type	string	Uno de los valores siguientes: Dirección Barrera RoadIntersection Vecindario PopulatedPlace Código postal1 AdminDivision1 AdminDivision2 CountryRegion

UsageTypeEnum

El mejor uso para el punto de código geográfico. Cada punto de código geográfico se define como un Route punto, un Display punto o ambos. Use Route puntos si va a crear una ruta a la ubicación. Use Display puntos si muestra la ubicación en un mapa. Por ejemplo, si la ubicación es un parque, un Route punto puede especificar una entrada al parque donde puede entrar con un coche y un Display punto puede ser un punto que especifique el centro del parque.

Nombre	Tipo	Description
Display	string
Route	string

Compartir a través de

Search - Get Geocoding

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Ámbitos

subscription-key

SAS Token

Ejemplos

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

Solicitud de ejemplo

Respuesta de muestra

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

Solicitud de ejemplo

Respuesta de muestra

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

Solicitud de ejemplo

Respuesta de muestra

Search landmark Empire State Building by query

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingResponse

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

UsageTypeEnum

Recursos adicionales