Compartir a través de

Search - Get Search Address Structured

  • Referencia
Servicio:
Maps
Versión de la API:
1.0

Use para obtener coordenadas de latitud y longitud de una dirección postal en un formato de entrada de consulta o no estructurado.
La Get Search Address Structured API (geocodificación de direcciones estructuradas) es una solicitud HTTP GET que devuelve coordenadas de latitud y longitud de una dirección postal en un formato de entrada de consulta o no estructurado.

El índice de búsqueda de geocodificación se consultará para ver todo lo que está por encima de los datos del nivel de calle. No se devolverá ningún 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, estados, etc.

GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&countryCode={countryCode}
Con parámetros opcionales: 
GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&language={language}&countryCode={countryCode}&limit={limit}&ofs={ofs}&streetNumber={streetNumber}&streetName={streetName}&crossStreet={crossStreet}&municipality={municipality}&municipalitySubdivision={municipalitySubdivision}&countryTertiarySubdivision={countryTertiarySubdivision}&countrySecondarySubdivision={countrySecondarySubdivision}&countrySubdivision={countrySubdivision}&postalCode={postalCode}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
format
 path True

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.
api-version
 query True

string

Número de versión de la API de Azure Maps.
countryCode
 query True

string

La parte de código de país o región de 2 o 3 letras ISO3166-1 de una dirección. Por ejemplo, Estados Unidos.
countrySecondarySubdivision
 query

string

País o región de la dirección estructurada
countrySubdivision
 query

string

Parte de subdivisión de país o región de una dirección
countryTertiarySubdivision
 query

string

Área con nombre para la dirección estructurada
crossStreet
 query

string

Nombre de la calle cruzada de la dirección estructurada
entityType
 query

GeographicEntityType

Especifica el nivel de filtrado realizado en zonas geográficas. Limita la búsqueda de tipos de entidad geography especificados, por ejemplo, devolver solo municipio. La respuesta resultante contendrá el identificador geográfico, así como el tipo de entidad coincidente. Si proporciona más de una entidad como una lista separada por comas, el punto de conexión devolverá la "entidad más pequeña disponible". El identificador de geometría devuelto se puede usar para obtener la geometría de esa geografía a través de Get Búsqueda Polygon API. Los parámetros siguientes se omiten cuando se establece entityType:

  • encabezado
  • number
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
extendedPostalCodesFor
 query

SearchIndexes[]

Índices para los que se deben incluir códigos postales extendidos en los resultados.

Los índices disponibles son:

Addr = Intervalos de direcciones

Geo = Geographies

PAD = Direcciones de punto

POI = Puntos de interés

Str = Calles

XStr = Calles cruzadas (intersecciones)

El valor debe ser una lista separada por comas de tipos de índice (en cualquier orden) o None para ningún índice.

De forma predeterminada, los códigos postales extendidos se incluyen para todos los índices excepto Geo. Las listas de códigos postales extendidos para zonas geográficas pueden ser bastante largas, por lo que deben solicitarse explícitamente cuando sea necesario.

Ejemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

El código postal extendido se devuelve como una propiedad extendedPostalCode de una dirección. La disponibilidad depende de la región.
language
 query

string

Idioma en el que se deben devolver los resultados de búsqueda. Debe ser una de las etiquetas de idioma IETF admitidas, sin distinción entre mayúsculas y minúsculas. Cuando los datos del idioma especificado no están disponibles para un campo específico, se usa el idioma predeterminado.

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

integer

Número máximo de respuestas que se devolverán. Valor predeterminado: 10, mínimo: 1 y máximo: 100
municipality
 query

string

La parte municipal de una dirección
municipalitySubdivision
 query

string

Subdivisión municipal (sub/super city) para la dirección estructurada
ofs
 query

integer

Desplazamiento inicial de los resultados devueltos dentro del conjunto de resultados completo. Valor predeterminado: 0
postalCode
 query

string

Parte del código postal de una dirección
streetName
 query

string

Parte del nombre de calle de una dirección
streetNumber
 query

string

Parte del número de calle de una dirección
view
 query

LocalizedMapView

El parámetro View (también denominado parámetro "región de usuario") le permite mostrar los mapas correctos para un determinado país o región para regiones controvertidas geopolíticamente. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unificado", incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado a acceder a través de Azure Maps. Ejemplo: view=IN.

Consulte Vistas admitidas para obtener más información y para ver las vistas disponibles.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Microsoft Entra ID. 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 Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre Tipo Description
200 OK

SearchAddressResult

Aceptar
Other Status Codes

ErrorResponse

Se ha producido un error inesperado.

Seguridad

AADToken

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

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de 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 Azure Maps la aplicación solicita acceso. 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 Microsoft Entra ID.
  • 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, CLI, SDK de Azure o 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 Plataforma de identidad de Microsoft, consulte Plataforma de identidad de Microsoft información general.

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 cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

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 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 está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de 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 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 mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Search address in Redmond, WA in structured form

Solicitud de ejemplo

GET https://atlas.microsoft.com/search/address/structured/json?api-version=1.0&countryCode=US&streetNumber=15127&streetName=NE%2024th%20Street&municipality=Redmond&postalCode=98052

Respuesta de muestra

status code:
200 
{
  "summary": {
    "query": "15127 98052 ne redmond wa",
    "queryType": "NON_NEAR",
    "queryTime": 57,
    "numResults": 1,
    "offset": 0,
    "totalResults": 34,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 47.30129317913035,
      "lon": -120.88247999999997
    }
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/37974392",
      "score": 8.074,
      "dist": 101274.64693865852,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Earlmount, Avondale, Ames Lake, Adelaide",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 98052",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Definiciones

Nombre Description
Address

Dirección del resultado
AddressRanges

Describe el intervalo de direcciones en ambos lados de la calle para obtener un resultado de búsqueda. Se incluyen las coordenadas de las ubicaciones inicial y final del intervalo de direcciones.
BoundingBox

Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla.
BoundingBoxCompassNotation

Cuadro de límite de la ubicación.
Brand

La marca asociada a la POI
Classification

Clasificación de la POI que se va a devolver
ClassificationName

Nombre de la clasificación
DataSources

Sección opcional. Identificadores de referencia para su uso con la API Get Búsqueda Polygon.
Entity

Origen del tipo de entidad del rectángulo de selección. Para la geocodificación inversa, siempre es igual a la posición.
EntryPoint

Punto de entrada para la POI que se va a devolver.
EntryPointType

Tipo de punto de entrada. El valor puede ser principal o secundario.
ErrorAdditionalInfo

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

Detalle del error.
ErrorResponse

Respuesta de error
GeographicEntityType

Tipo de entidad Geography. Solo está presente cuando se solicitó entityType y está disponible.
Geometry

Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography.
LatLongPairAbbreviated

Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".
LocalizedMapView

El parámetro View (también denominado parámetro "región de usuario") le permite mostrar los mapas correctos para un determinado país o región para regiones controvertidas geopolíticamente. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unificado", incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado a acceder a través de Azure Maps. Ejemplo: view=IN.

Consulte Vistas admitidas para obtener más información y para ver las vistas disponibles.
MatchType

Tipos de coincidencia para una operación de búsqueda de direcciones inversas.
OperatingHours

Horario de apertura de un POI (Puntos de interés).
OperatingHoursTime

Representa una fecha y hora
OperatingHoursTimeRange

Intervalo de tiempo de apertura para un día
PointOfInterest

Detalles de la POI devuelta, incluida la información como el nombre, el teléfono, la dirección URL y las clasificaciones.
PointOfInterestCategorySet

Categoría poi
QueryType

Tipo de consulta que se devuelve: NEARBY o NON_NEAR.
ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.
SearchAddressResult

Este objeto se devuelve de una Búsqueda llamadas correctas.
SearchAddressResultItem

Objeto result para una respuesta de API de Búsqueda.
SearchAddressResultType

Uno de los valores siguientes:

  • POI
  • Calle
  • Geography
  • Dirección del punto
  • Intervalo de direcciones
  • Cruce
SearchIndexes

Índices para los que se deben incluir códigos postales extendidos en los resultados.

Los índices disponibles son:

Addr = Intervalos de direcciones

Geo = Geographies

PAD = Direcciones de punto

POI = Puntos de interés

Str = Calles

XStr = Calles cruzadas (intersecciones)

El valor debe ser una lista separada por comas de tipos de índice (en cualquier orden) o None para ningún índice.

De forma predeterminada, los códigos postales extendidos se incluyen para todos los índices excepto Geo. Las listas de códigos postales extendidos para zonas geográficas pueden ser bastante largas, por lo que deben solicitarse explícitamente cuando sea necesario.

Ejemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

El código postal extendido se devuelve como una propiedad extendedPostalCode de una dirección. La disponibilidad depende de la región.
SearchSummary

Objeto de resumen de una respuesta de API de Búsqueda.

Address

Dirección del resultado

Nombre Tipo Description
boundingBox

BoundingBoxCompassNotation

Cuadro de límite de la ubicación.
buildingNumber

string

Número de edificio en la calle. EN DESUSO, use streetNumber en su lugar.
country

string

nombre de país o región
countryCode

string

País (Nota: Se trata de un código de dos letras, no un nombre de país o región).
countryCodeISO3

string

Código de país ISO alfa-3
countrySecondarySubdivision

string

County
countrySubdivision

string

Estado o provincia
countrySubdivisionCode

string

countrySubdivisionCode prefijo por countryCode ( countryCode-countrySubdivisionCode ) y el guión forma el código ISO 3166-2. Ejemplos: TX para Texas, SCT para Escocia y ON para Ontario.
countrySubdivisionName

string

Nombre completo de un primer nivel de jerarquía administrativa de país o región. Este campo solo aparece en caso de que countrySubdivision se presente en un formulario abreviado. Solo se admite para ESTADOS UNIDOS, Canadá y Reino Unido.
countryTertiarySubdivision

string

Área con nombre
crossStreet

string

Nombre de la calle que se cruza.
extendedPostalCode

string

Código postal extendido (la disponibilidad depende de la región).
freeformAddress

string

Una línea de dirección con formato según las reglas de formato del país o región de origen de un resultado, o en el caso de un país o región, su nombre completo de país o región.
localName

string

Componente de dirección que representa el nombre de un área geográfica o localidad que agrupa varios objetos direccionables con fines de direccionamiento, sin ser una unidad administrativa. Este campo se usa para compilar la freeformAddress propiedad . localName representa el municipio postal. Dependiendo de la ubicación, localName es el nombre comúnmente conocido de una ciudad o ciudad. Para el nombre conocido de una ciudad o ciudad, use localName en lugar de municipality.
municipality

string

Ciudad/Ciudad
Nota: municipality representa el municipio residencial. Dependiendo de la ubicación, el municipality valor puede diferir del nombre conocido de una ciudad o ciudad. Para el nombre conocido de la ciudad o ciudad, se sugiere que el localName valor se use en lugar del municipality valor.
municipalitySubdivision

string

Sub/Super City
neighbourhood

string

Un barrio es una zona geográficamente localizada dentro de una ciudad o ciudad con características distintivas e interacciones sociales entre los habitantes.
postalCode

string

Código postal/código postal
routeNumbers

string[]

Códigos usados para identificar inequívocamente la calle
street

string

Nombre de la calle. EN DESUSO, use streetName en su lugar.
streetName

string

Nombre de la calle.
streetNameAndNumber

string

Nombre y número de la calle.
streetNumber

string

Número de edificio en la calle.

AddressRanges

Describe el intervalo de direcciones en ambos lados de la calle para obtener un resultado de búsqueda. Se incluyen las coordenadas de las ubicaciones inicial y final del intervalo de direcciones.

Nombre Tipo Description
from

LatLongPairAbbreviated

Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".
rangeLeft

string

Intervalo de direcciones en el lado izquierdo de la calle.
rangeRight

string

Intervalo de direcciones en el lado derecho de la calle.
to

LatLongPairAbbreviated

Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".

BoundingBox

Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla.

Nombre Tipo Description
btmRightPoint

LatLongPairAbbreviated

Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".
topLeftPoint

LatLongPairAbbreviated

Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".

BoundingBoxCompassNotation

Cuadro de límite de la ubicación.

Nombre Tipo Description
entity

Entity

Origen del tipo de entidad del rectángulo de selección. Para la geocodificación inversa, siempre es igual a la posición.
northEast

string

Latitud norte-este,coordenada de longitud del rectángulo delimitador como floats separados por comas
southWest

string

Latitud sur-oeste, coordenada de longitud del rectángulo delimitador como floats separados por comas

Brand

La marca asociada a la POI

Nombre Tipo Description
name

string

Nombre de la marca

Classification

Clasificación de la POI que se va a devolver

Nombre Tipo Description
code

string

Propiedad code
names

ClassificationName[]

Matriz de nombres

ClassificationName

Nombre de la clasificación

Nombre Tipo Description
name

string

Name (propiedad)
nameLocale

string

Name Locale (propiedad)

DataSources

Sección opcional. Identificadores de referencia para su uso con la API Get Búsqueda Polygon.

Nombre Tipo Description
geometry

Geometry

Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography.

Entity

Origen del tipo de entidad del rectángulo de selección. Para la geocodificación inversa, siempre es igual a la posición.

Nombre Tipo Description
position

string

Entidad position

EntryPoint

Punto de entrada para la POI que se va a devolver.

Nombre Tipo Description
position

LatLongPairAbbreviated

Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".
type

EntryPointType

Tipo de punto de entrada. El valor puede ser principal o secundario.

EntryPointType

Tipo de punto de entrada. El valor puede ser principal o secundario.

Nombre Tipo Description
main

string

minor

string

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.

GeographicEntityType

Tipo de entidad Geography. Solo está presente cuando se solicitó entityType y está disponible.

Nombre Tipo Description
Country

string

nombre de país o región
CountrySecondarySubdivision

string

County
CountrySubdivision

string

Estado o provincia
CountryTertiarySubdivision

string

Área con nombre
Municipality

string

Ciudad/Ciudad
MunicipalitySubdivision

string

Sub/Super City
Neighbourhood

string

Barrio
PostalCodeArea

string

Código postal/código postal

Geometry

Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography.

Nombre Tipo Description
id

string

Pase esto como geometryId a get Búsqueda Polygon API para capturar información de geometría para este resultado.

LatLongPairAbbreviated

Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".

Nombre Tipo Description
lat

number

Latitude (propiedad)
lon

number

Longitud (propiedad)

LocalizedMapView

El parámetro View (también denominado parámetro "región de usuario") le permite mostrar los mapas correctos para un determinado país o región para regiones controvertidas geopolíticamente. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unificado", incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado a acceder a través de Azure Maps. Ejemplo: view=IN.

Consulte Vistas admitidas para obtener más información y para ver las vistas disponibles.

Nombre Tipo Description
AE

string

Emiratos Árabes Unidos (vista árabe)
AR

string

Argentina (vista argentina)
Auto

string

Devuelva los datos del mapa según la dirección IP de la solicitud.
BH

string

Baréin (vista árabe)
IN

string

India (vista india)
IQ

string

Irak (vista árabe)
JO

string

Jordania (vista árabe)
KW

string

Kuwait (vista árabe)
LB

string

Líbano (vista árabe)
MA

string

Marruecos (vista marroquí)
OM

string

Omán (vista árabe)
PK

string

Pakistán (vista pakistaní)
PS

string

Autoridad Nacional Palestina (vista árabe)
QA

string

Catar (vista árabe)
SA

string

Arabia Saudí (vista árabe)
SY

string

Siria (vista árabe)
Unified

string

Vista unificada (otros)
YE

string

Yemen (vista árabe)

MatchType

Tipos de coincidencia para una operación de búsqueda de direcciones inversas.

Nombre Tipo Description
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Horario de apertura de un POI (Puntos de interés).

Nombre Tipo Description
mode

string

Valor usado en la solicitud: none o "nextSevenDays"
timeRanges

OperatingHoursTimeRange[]

Lista de intervalos de tiempo para los próximos 7 días

OperatingHoursTime

Representa una fecha y hora

Nombre Tipo Description
date

string

Representa la fecha actual del calendario en la zona horaria poi, por ejemplo, "2019-02-07".
hour

integer

Las horas tienen el formato de 24 horas en la hora local de un POI; los valores posibles son 0 - 23.
minute

integer

Los minutos se encuentran en la hora local de un POI; los valores posibles son 0 - 59.

OperatingHoursTimeRange

Intervalo de tiempo de apertura para un día

Nombre Tipo Description
endTime

OperatingHoursTime

El punto en el intervalo de 7 días siguiente cuando se cierra una poi determinada, o el principio del intervalo si se cerró antes del intervalo.
startTime

OperatingHoursTime

El punto en el intervalo de 7 días siguiente cuando se abre una poi determinada, o el principio del intervalo si se abrió antes del intervalo.

PointOfInterest

Detalles de la POI devuelta, incluida la información como el nombre, el teléfono, la dirección URL y las clasificaciones.

Nombre Tipo Description
brands

Brand[]

Matriz de marcas. Nombre de la marca para la poi que se va a devolver.
categories

string[]

Matriz de categorías
categorySet

PointOfInterestCategorySet[]

Lista de las categorías de POI más específicas
classifications

Classification[]

Matriz de clasificación
name

string

Nombre de la propiedad POI
openingHours

OperatingHours

Horario de apertura de un POI (Puntos de interés).
phone

string

Propiedad de número de teléfono
url

string

Propiedad URL del sitio web

PointOfInterestCategorySet

Categoría poi

Nombre Tipo Description
id

integer

Id. de categoría

QueryType

Tipo de consulta que se devuelve: NEARBY o NON_NEAR.

Nombre Tipo Description
NEARBY

string

Búsqueda se realizó alrededor de una determinada latitud y longitud con un radio definido
NON_NEAR

string

Búsqueda se realizó globalmente, sin sesgos en una determinada latitud y longitud, y sin radio definido

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

Nombre Tipo Description
json

string

Formato de intercambio de datos de notación de objetos JavaScript
xml

string

Lenguaje de marcado extensible

SearchAddressResult

Este objeto se devuelve de una Búsqueda llamadas correctas.

Nombre Tipo Description
results

SearchAddressResultItem[]

Una lista de los resultados de la API de Búsqueda.
summary

SearchSummary

Objeto summary para una respuesta de API de Búsqueda

SearchAddressResultItem

Objeto result para una respuesta de API de Búsqueda.

Nombre Tipo Description
address

Address

Dirección del resultado
addressRanges

AddressRanges

Describe el intervalo de direcciones en ambos lados de la calle para obtener un resultado de búsqueda. Se incluyen las coordenadas de las ubicaciones inicial y final del intervalo de direcciones.
dataSources

DataSources

Sección opcional. Id. de geometría de referencia para su uso con get Búsqueda Polygon API.
detourTime

integer

Tiempo de desvío en segundos. Solo se devuelve para las llamadas a Búsqueda Along Route API.
dist

number

Distancia recta entre el resultado y la ubicación de geobias en metros.
entityType

GeographicEntityType

Tipo de entidad Geography. Solo está presente cuando se solicitó entityType y está disponible.
entryPoints

EntryPoint[]

Matriz de EntryPoints. Los que describen los tipos de entradas disponibles en la ubicación. El tipo puede ser "principal" para las entradas principales, como una puerta principal, o un vestíbulo, y "menor", para puertas laterales y traseras.
id

string

Propiedad Id
info

string

Información sobre el origen de datos original del resultado. Se usa para las solicitudes de soporte técnico.
matchType

MatchType

Información sobre el tipo de coincidencia.

Uno de los valores siguientes:

  • AddressPoint
  • HouseNumberRange
  • Calle
poi

PointOfInterest

Detalles de la POI devuelta, incluida información como el nombre, el teléfono, la dirección URL y las clasificaciones.
position

LatLongPairAbbreviated

Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".
score

number

Valor de un conjunto de resultados para indicar la puntuación de coincidencia relativa entre los resultados. Puede usarlo para determinar que el resultado x es el doble de probabilidad de ser tan relevante como resultado y si el valor de x es 2x el valor de y. Los valores varían entre las consultas y solo están diseñados como un valor relativo para un conjunto de resultados.
type

SearchAddressResultType

Uno de los valores siguientes:

  • POI
  • Calle
  • Geography
  • Dirección del punto
  • Intervalo de direcciones
  • Cruce
viewport

BoundingBox

Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla.

SearchAddressResultType

Uno de los valores siguientes:

  • POI
  • Calle
  • Geography
  • Dirección del punto
  • Intervalo de direcciones
  • Cruce
Nombre Tipo Description
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchIndexes

Índices para los que se deben incluir códigos postales extendidos en los resultados.

Los índices disponibles son:

Addr = Intervalos de direcciones

Geo = Geographies

PAD = Direcciones de punto

POI = Puntos de interés

Str = Calles

XStr = Calles cruzadas (intersecciones)

El valor debe ser una lista separada por comas de tipos de índice (en cualquier orden) o None para ningún índice.

De forma predeterminada, los códigos postales extendidos se incluyen para todos los índices excepto Geo. Las listas de códigos postales extendidos para zonas geográficas pueden ser bastante largas, por lo que deben solicitarse explícitamente cuando sea necesario.

Ejemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

El código postal extendido se devuelve como una propiedad extendedPostalCode de una dirección. La disponibilidad depende de la región.

Nombre Tipo Description
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchSummary

Objeto de resumen de una respuesta de API de Búsqueda.

Nombre Tipo Description
fuzzyLevel

integer

Nivel máximo aproximado necesario para proporcionar resultados.
geoBias

LatLongPairAbbreviated

Indicación cuando el motor de búsqueda interno ha aplicado un sesgo geoespacial para mejorar la clasificación de los resultados. En algunos métodos, esto puede verse afectado estableciendo los parámetros lat y lon cuando están disponibles. En otros casos es puramente interno.
limit

integer

Número máximo de respuestas que se devolverán
numResults

integer

Número de resultados en la respuesta.
offset

integer

Desplazamiento inicial de los resultados devueltos dentro del conjunto de resultados completo.
query

string

Parámetro de consulta que se usó para generar estos resultados de búsqueda.
queryTime

integer

Tiempo dedicado a resolver la consulta, en milisegundos.
queryType

QueryType

Tipo de consulta que se devuelve: NEARBY o NON_NEAR.
totalResults

integer

Número total de resultados encontrados.