Compartir a través de

Search - Get Geocoding

Servicio:
Maps
Versión de la API:
2025-01-01

Úselo para obtener las coordenadas de longitud y latitud de una dirección o el nombre de un lugar.

La API de Get Geocoding es una solicitud de GET HTTP 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 podría 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 presionando 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 todo lo que está por encima de los datos del 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 postales 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=2025-01-01
Con parámetros opcionales: 
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}

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.

Este parámetro no debe usarse cuando el query parámetro se incluye en la solicitud.
adminDistrict
 query

string

Parte de la subdivisión del país de una dirección, como WA.

Este parámetro no debe usarse cuando el query parámetro se incluye en la solicitud.
adminDistrict2
 query

string

El condado para la dirección estructurada, como King.

Este parámetro no debe usarse cuando el query parámetro se incluye en la solicitud.
adminDistrict3
 query

string

Área con nombre para la dirección estructurada.

Este parámetro no debe usarse cuando el query parámetro se incluye en la solicitud.
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. Al especificar este parámetro, el área geográfica se tiene en cuenta 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. Al especificar este parámetro, la ubicación del usuario se tiene en cuenta 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 ISO 3166-1 ISO 3166-2 que se especifica, por ejemplo, FR./

Este parámetro no debe usarse cuando el query parámetro se incluye en la solicitud.
locality
 query

string

La parte de localidad de una dirección, como Seattle.

Este parámetro no debe usarse cuando el query parámetro se incluye en la solicitud.
postalCode
 query

string

Parte del código postal de una dirección.

Este parámetro no debe usarse cuando el query parámetro se incluye en la solicitud.
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)

minimum: 1
maximum: 20

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 ISO 3166-1 Alpha-2 region/country. 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 la 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 obtener más información sobre el uso de la seguridad de ID de Microsoft Entra en Azure Maps, consulte Administración de la autenticación en Azure Maps.

Respuestas

Nombre Tipo Description
200 OK

GeocodingResponse

De acuerdo

Media Types: "application/geo+json"

Encabezados

x-ms-request-id: string
Other Status Codes

ErrorResponse

Error inesperado.

Media Types: "application/geo+json"

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, 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 a través de un rol integrado o de 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 encabezado para indicar a qué recurso de x-ms-client-id Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.
  • El 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 a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
  • El uso de 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 una recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o 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.

Para 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 crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle 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 cuenta de mapa de limitar el abuso de representación 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

GET https://atlas.microsoft.com/geocode?api-version=2025-01-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",
          "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

Solicitud de ejemplo

GET https://atlas.microsoft.com/geocode?api-version=2025-01-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",
          "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

Solicitud de ejemplo

GET https://atlas.microsoft.com/geocode?api-version=2025-01-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",
          "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

Solicitud de ejemplo

GET https://atlas.microsoft.com/geocode?api-version=2025-01-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 normalmente se trata 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

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 GeoJSON Point válido. 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 con codificación geográfica con códigos de coincidencia de Good y Ambiguous significa que se encontró más de 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 la jerarquía de búsqueda para encontrar una coincidencia.

Del mismo modo, una ubicación codificada geográficamente con códigos de coincidencia de Ambiguous y UpHierarchy implica que no se encontró 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 tenía que buscar en la jerarquía superior y encontrar varias coincidencias en ese nivel. Un ejemplo de un Ambiguous y UpHierarchy resultado es cuando se proporciona información de dirección completa, pero el servicio de código geográfico no puede encontrar una coincidencia para la dirección postal y, en su lugar, devuelve información para más de un valor RoadBlock.

Los valores posibles son:

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

Ambiguous: la ubicación es uno de un conjunto de posibles coincidencias. Por ejemplo, al consultar 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 UpHierarchy con un tipo de 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 punto de Route, un punto de Display 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 punto de Route puede especificar una entrada al parque donde puede entrar con un coche y un punto de Display puede ser un punto que especifique el centro del parque.

Address

Object

Dirección del resultado

Nombre Tipo Description
addressLine

string

AddressLine que incluye nombre de calle y número
adminDistricts

AdminDistricts[]

Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata 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 Código postal
streetName

string

El nombre de la calle de formattedAddress
streetNumber

string

El número en la calle, si está disponible, de formattedAddress

AdminDistricts

Object

Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata 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], este podría ser el nombre completo del estado, como Washington, For adminDistrict[1], podría ser el nombre completo del condado.
shortName

string

El 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

Enumeración

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

Valor Description
Interpolation

El punto de geocodificación se hizo coincidir con un punto de una carretera mediante interpolación.
InterpolationOffset

El punto de geocodificación se hizo coincidir con un punto de una carretera mediante interpolación con un desplazamiento adicional para desplazar el punto al lado de la calle.
Parcel

El punto de geocodificación se ha hecho coincidir con el centro de una parcela.
Rooftop

El punto de geocodificación se hizo coincidir con la azotea de un edificio.

ConfidenceEnum

Enumeración

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.

Valor Description
High

Si la confianza se establece en High, se encontraron una o más coincidencias fuertes. Las coincidencias de confianza múltiples High se ordenan en orden de clasificación por importancia cuando corresponde. 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 adecuadamente. Por ejemplo, una consulta de ubicación para "París" devuelve "París, Francia" y "París, TX" con High confianza. "París, Francia" siempre ocupa el primer lugar debido a su importancia, a menos que la ubicación de un usuario indique que el usuario está en París, TX o muy cerca de él, o la vista de mapa indique que el usuario está buscando en esa área.
Medium

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

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 en Medium. Por ejemplo, una consulta de ubicación para "148th Ave, Bellevue" puede devolver "148th Ave SE" y "148th Ave NE" 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, es posible que se devuelva un valor de ubicación menos preciso y la confianza se establezca en Medium. 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 de geocodificación con un tipo de entidad Roadblock.
Low

CountryRegion

Object
Nombre Tipo Description
ISO

string

ISO del país o región
name

string

nombre del país o región

ErrorAdditionalInfo

Object

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

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

El mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

FeatureCollectionEnum

Enumeración

El tipo de un objeto FeatureCollection debe ser FeatureCollection.

Valor Description
FeatureCollection

FeaturesItem

Object
Nombre Tipo Description
bbox

number[] (double)

Rectángulo de límite. Proyección usada: EPSG:3857. Consulte RFC 7946 para obtener más información.
geometry

GeoJsonPoint

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

string

Identificador para la característica devuelta
properties

Properties

type

FeatureTypeEnum

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

FeatureTypeEnum

Enumeración

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

Valor Description
Feature

GeocodePoints

Object

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 GeoJSON Point válido. 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 punto de Route, un punto de Display 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 punto de Route puede especificar una entrada al parque donde puede entrar con un coche y un punto de Display puede ser un punto que especifique el centro del parque.

GeocodingResponse

Object

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 hay este campo.
type

FeatureCollectionEnum

El tipo de un objeto FeatureCollection debe ser FeatureCollection.

GeoJsonPoint

Object

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

Nombre Tipo Description
bbox

number[] (double)

Rectángulo de límite. Proyección usada: EPSG:3857. Consulte RFC 7946 para obtener más información.
coordinates

number[] (double)

Un 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 de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

Intersection

Object

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 que interseca.

MatchCodesEnum

Enumeración

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 con codificación geográfica con códigos de coincidencia de Good y Ambiguous significa que se encontró más de 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 la jerarquía de búsqueda para encontrar una coincidencia.

Del mismo modo, una ubicación codificada geográficamente con códigos de coincidencia de Ambiguous y UpHierarchy implica que no se encontró 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 tenía que buscar en la jerarquía superior y encontrar varias coincidencias en ese nivel. Un ejemplo de un Ambiguous y UpHierarchy resultado es cuando se proporciona información de dirección completa, pero el servicio de código geográfico no puede encontrar una coincidencia para la dirección postal y, en su lugar, devuelve información para más de un valor RoadBlock.

Los valores posibles son:

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

Ambiguous: la ubicación es uno de un conjunto de posibles coincidencias. Por ejemplo, al consultar 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 UpHierarchy con un tipo de entidad RoadBlock.

Valor Description
Good
Ambiguous
UpHierarchy

Properties

Object
Nombre Tipo Description
address

Address

Dirección del resultado
confidence

ConfidenceEnum

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 con codificación geográfica con códigos de coincidencia de Good y Ambiguous significa que se encontró más de 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 la jerarquía de búsqueda para encontrar una coincidencia.

Del mismo modo, una ubicación codificada geográficamente con códigos de coincidencia de Ambiguous y UpHierarchy implica que no se encontró 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 tenía que buscar en la jerarquía superior y encontrar varias coincidencias en ese nivel. Un ejemplo de un Ambiguous y UpHierarchy resultado es cuando se proporciona información de dirección completa, pero el servicio de código geográfico no puede encontrar una coincidencia para la dirección postal y, en su lugar, devuelve información para más de un valor RoadBlock.

Los valores posibles son:

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

Ambiguous: la ubicación es uno de un conjunto de posibles coincidencias. Por ejemplo, al consultar 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 UpHierarchy con un tipo de entidad RoadBlock.
type

string

Uno de los valores siguientes:

  • Dirección
  • Barrera
  • RoadIntersection
  • Vecindario
  • PopulatedPlace
  • Código postal1
  • AdminDivision1
  • AdminDivision2
  • País/Región

UsageTypeEnum

Enumeración

El mejor uso para el punto de código geográfico. Cada punto de código geográfico se define como punto de Route, un punto de Display 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 punto de Route puede especificar una entrada al parque donde puede entrar con un coche y un punto de Display puede ser un punto que especifique el centro del parque.

Valor Description
Display
Route