Search - Get Search Fuzzy Batch
Use para enviar un lote de consultas a la API aproximada de Búsqueda en una única solicitud asincrónica.
La Get Search Fuzzy Batch
API es y la solicitud HTTP GET
que envía lotes de consultas a Búsqueda API aproximada en una sola llamada API asincrónica. Puede llamar a Búsqueda API de Batch aproximada para que se ejecute de forma asincrónica (asincrónica) o sincrónica (sincrónica). La API asincrónica permite al autor de la llamada procesar por lotes hasta 10 000 consultas y sincronizar la API hasta 100 consultas.
Enviar solicitud por lotes sincrónica
Se recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes está limitado a 100 para esta API.
POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
Enviar solicitud por lotes asincrónica
La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de búsqueda relativamente complejas.
- Permite la recuperación de resultados en una llamada independiente (se pueden realizar varias descargas).
- La API asincrónica está optimizada para la confiabilidad y no se espera que se ejecute en un tiempo de espera.
- El número de elementos por lotes está limitado a 10 000 para esta API.
Cuando realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.
Tenga en cuenta que la solicitud por lotes asincrónica es una operación de larga duración. Esta es una secuencia típica de operaciones:
- El cliente envía una solicitud de Batch
POST
aproximada de Búsqueda a Azure Maps.
POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}
El servidor responderá con uno de los siguientes elementos:
HTTP
202 Accepted
: se ha aceptado la solicitud por lotes.HTTP
Error
: se produjo un error al procesar la solicitud de Batch. Esto podría ser un400 Bad Request
código de estado o cualquier otroError
.Si la solicitud por lotes se aceptó correctamente, el
Location
encabezado de la respuesta contiene la dirección URL para descargar los resultados de la solicitud por lotes. Este URI de estado es similar al siguiente:
GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- El cliente emite una
GET
solicitud en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados del lote.
Cuerpo POST para la solicitud por lotes
Para enviar las consultas aproximadas de búsqueda, usará una POST
solicitud en la que el cuerpo de la solicitud contendrá la batchItems
matriz en formato y el Content-Type
encabezado se establecerá application/json
en json
. Este es un cuerpo de solicitud de ejemplo que contiene 5 consultas aproximadas de búsqueda :
{
"batchItems": [
{"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"},
{"query": "?query=Statue Of Liberty&limit=2"},
{"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"},
{"query": "?query=Space Needle"},
{"query": "?query=pizza&limit=10"}
]
}
Una consulta aproximada de búsqueda en un lote es simplemente una dirección URL parcial sin el protocolo, la dirección URL base, la ruta de acceso, la versión de api y la clave de suscripción. Puede aceptar cualquiera de los parámetros de URI de búsqueda aproximada admitidos. Los valores de cadena de la consulta aproximada de búsqueda deben tener un escape correcto (por ejemplo, " el carácter debe ser de escape con \ ) y también debe estar codificado correctamente con dirección URL.
La API asincrónica permite al autor de la llamada procesar por lotes hasta 10 000 consultas y sincronizar la API hasta 100 consultas, y el lote debe contener al menos 1 consulta.
Descarga de resultados de lotes asincrónicos
Para descargar los resultados del lote asincrónico, emitirá una GET
solicitud al punto de conexión de descarga por lotes. Esta dirección URL de descarga se puede obtener del Location
encabezado de una solicitud por lotes correcta POST
y tiene el siguiente aspecto:
https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
Esta es la secuencia típica de operaciones para descargar los resultados del lote:
El cliente envía una
GET
solicitud mediante la dirección URL de descarga.El servidor responderá con uno de los siguientes elementos:
HTTP
202 Accepted
: se aceptó la solicitud por lotes, pero todavía se está procesando. Inténtelo de nuevo en algún momento.HTTP
200 OK
: solicitud por lotes procesada correctamente. El cuerpo de la respuesta contiene todos los resultados del lote.
Modelo de respuesta por lotes
El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un summary
componente que indica que totalRequests
formaron parte de la solicitud por lotes original y successfulRequests
es decir, las consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una batchItems
matriz que contiene una respuesta para cada consulta y cada consulta de la solicitud por lotes.
batchItems
Contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento de batchItems
contiene statusCode
y response
campos. Cada response
elemento de batchItems
es de uno de los siguientes tipos:
SearchAddressResult
- Si la consulta se completó correctamente.Error
- Si se produjo un error en la consulta. La respuesta contendrá uncode
elemento y enmessage
este caso.
Esta es una respuesta por lotes de ejemplo con 2 resultados correctos y 1 con errores :
{
"summary": {
"successfulRequests": 2,
"totalRequests": 3
},
"batchItems": [
{
"statusCode": 200,
"response":
{
"summary": {
"query": "atm"
},
"results": [
{
"type": "POI",
"poi": {
"name": "ATM at Wells Fargo"
},
"address": {
"country": "United States Of America",
"freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
}
}
]
}
},
{
"statusCode": 200,
"response":
{
"summary": {
"query": "statue of liberty"
},
"results": [
{
"type": "POI",
"poi": {
"name": "Statue of Liberty"
},
"address": {
"country": "United States Of America",
"freeformAddress": "New York, NY 10004"
}
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
GET https://atlas.microsoft.com/search/fuzzy/batch/{format}?api-version=1.0
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
string |
Identificador de lote para consultar la operación. |
api-version
|
query | True |
string |
Número de versión de la API de Azure Maps. |
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 |
Aceptar |
|
202 Accepted |
Solo se admite para la solicitud asincrónica. Solicitud aceptada: la solicitud se ha aceptado para su procesamiento. Use la dirección URL en el encabezado de ubicación para reintentar o acceder a los resultados. Encabezados Location: string |
|
Other Status Codes |
Se ha producido un error inesperado. |
Seguridad
AADToken
Estos son los Microsoft Entra flujos de OAuth 2.0. 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. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio 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 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 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 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 Plataforma de identidad de Microsoft, consulte introducción a 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 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 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 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
A Search Fuzzy Batch API GET call containing 5 Search Fuzzy API queries
Solicitud de ejemplo
GET https://atlas.microsoft.com/search/fuzzy/batch/11111111-2222-3333-4444-555555555555?api-version=1.0
Respuesta de muestra
{
"batchItems": [
{
"statusCode": 200,
"response": {
"summary": {
"query": "atm",
"queryType": "NON_NEAR",
"queryTime": 5,
"numResults": 5,
"offset": 0,
"totalResults": 262,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.639769,
"lon": -122.128362
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/3656546",
"score": 2.671,
"dist": 1336.1815386162032,
"info": "search:ta:840539002005905-US",
"poi": {
"name": "US Bank ATM-MONEYPASS",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "14808",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "14808 NE 24th St, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63229,
"lon": -122.14232
},
"viewport": {
"topLeftPoint": {
"lat": 47.63319,
"lon": -122.14365
},
"btmRightPoint": {
"lat": 47.63139,
"lon": -122.14099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63154,
"lon": -122.1423
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/8673325",
"score": 2.671,
"dist": 1206.8488178244172,
"info": "search:ta:840539002022072-US",
"poi": {
"name": "US Bank ATM NATIONAL ASSOCIATION",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "15000",
"streetName": "Northeast 24Th Street",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525522",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63265,
"lon": -122.14052
},
"viewport": {
"topLeftPoint": {
"lat": 47.63355,
"lon": -122.14185
},
"btmRightPoint": {
"lat": 47.63175,
"lon": -122.13919
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14056
}
},
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14058
}
},
{
"type": "main",
"position": {
"lat": 47.63156,
"lon": -122.14048
}
},
{
"type": "main",
"position": {
"lat": 47.6324,
"lon": -122.13938
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/2736315",
"score": 2.671,
"dist": 864.7591776519859,
"info": "search:ta:840539002187855-US",
"poi": {
"name": "US Bank ATM-MONEYPASS",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "15521",
"streetName": "Bel Red Rd",
"municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue",
"municipality": "Redmond, Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525501",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63259,
"lon": -122.1328
},
"viewport": {
"topLeftPoint": {
"lat": 47.63349,
"lon": -122.13413
},
"btmRightPoint": {
"lat": 47.63169,
"lon": -122.13147
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63255,
"lon": -122.13275
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/3656412",
"score": 2.67,
"dist": 2140.198538580941,
"info": "search:ta:840539001998867-US",
"poi": {
"name": "US Bank ATM NATIONAL ASSOCIATION",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1128",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62069,
"lon": -122.13213
},
"viewport": {
"topLeftPoint": {
"lat": 47.62159,
"lon": -122.13346
},
"btmRightPoint": {
"lat": 47.61979,
"lon": -122.1308
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62069,
"lon": -122.13236
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/2736876",
"score": 2.67,
"dist": 2140.198538580941,
"info": "search:ta:840539001396789-US",
"poi": {
"name": "US Bank ATM",
"phone": "+(1)-(800)-8722657",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"url": "www.usbank.com",
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1128",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62069,
"lon": -122.13213
},
"viewport": {
"topLeftPoint": {
"lat": 47.62159,
"lon": -122.13346
},
"btmRightPoint": {
"lat": 47.61979,
"lon": -122.1308
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62069,
"lon": -122.13236
}
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"query": "statue of liberty",
"queryType": "NON_NEAR",
"queryTime": 37,
"numResults": 2,
"offset": 0,
"totalResults": 18,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9189660",
"score": 6.942,
"info": "search:ta:840369001174316-US",
"poi": {
"name": "Statue of Liberty",
"categorySet": [
{
"id": 7376003
}
],
"classifications": [
{
"code": "IMPORTANT_TOURIST_ATTRACTION",
"names": [
{
"nameLocale": "en-US",
"name": "monument"
},
{
"nameLocale": "en-US",
"name": "important tourist attraction"
}
]
}
]
},
"address": {
"municipalitySubdivision": "New York",
"municipality": "New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "New York, NY 10004",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.68955,
"lon": -74.04483
},
"viewport": {
"topLeftPoint": {
"lat": 40.69045,
"lon": -74.04602
},
"btmRightPoint": {
"lat": 40.68865,
"lon": -74.04364
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.69001,
"lon": -74.04683
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/3264566",
"score": 6.942,
"info": "search:ta:840019000670588-US",
"poi": {
"name": "Statue of Liberty",
"phone": "+(1)-(205)-9700251",
"categorySet": [
{
"id": 7376003
}
],
"url": "www.1bsa.org",
"classifications": [
{
"code": "IMPORTANT_TOURIST_ATTRACTION",
"names": [
{
"nameLocale": "en-US",
"name": "important tourist attraction"
}
]
}
]
},
"address": {
"streetNumber": "516",
"streetName": "Liberty Pkwy",
"municipalitySubdivision": "Vestavia Hills",
"municipality": "Vestavia Hills, Birmingham",
"countrySecondarySubdivision": "Jefferson",
"countryTertiarySubdivision": "Leeds",
"countrySubdivisionCode": "AL",
"postalCode": "35242",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242",
"localName": "Vestavia Hills",
"countrySubdivisionName": "Alabama"
},
"position": {
"lat": 33.48234,
"lon": -86.70719
},
"viewport": {
"topLeftPoint": {
"lat": 33.48324,
"lon": -86.70827
},
"btmRightPoint": {
"lat": 33.48144,
"lon": -86.70611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 33.48129,
"lon": -86.7065
}
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"query": "starbucks",
"queryType": "NON_NEAR",
"queryTime": 35,
"numResults": 10,
"offset": 0,
"totalResults": 17,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.639769,
"lon": -122.128362
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/153678",
"score": 2.671,
"dist": 1206.8488178244172,
"info": "search:ta:840531000006554-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8695816",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15000",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525522",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15000 NE 24th St, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63265,
"lon": -122.14052
},
"viewport": {
"topLeftPoint": {
"lat": 47.63355,
"lon": -122.14185
},
"btmRightPoint": {
"lat": 47.63175,
"lon": -122.13919
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14056
}
},
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14058
}
},
{
"type": "main",
"position": {
"lat": 47.63156,
"lon": -122.14048
}
},
{
"type": "main",
"position": {
"lat": 47.6324,
"lon": -122.13938
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/152316",
"score": 2.67,
"dist": 2315.294397491255,
"info": "search:ta:840539000484552-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-6436471",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/store/15097",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15600",
"streetName": "NE 8th St",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98008",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15600 NE 8th St, Bellevue, WA 98008",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61896,
"lon": -122.12945
},
"viewport": {
"topLeftPoint": {
"lat": 47.61986,
"lon": -122.13078
},
"btmRightPoint": {
"lat": 47.61806,
"lon": -122.12812
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.619,
"lon": -122.12945
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167545",
"score": 2.67,
"dist": 1979.2222952267998,
"info": "search:ta:840539001950429-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-7470690",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "1350",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62212,
"lon": -122.13179
},
"viewport": {
"topLeftPoint": {
"lat": 47.62302,
"lon": -122.13312
},
"btmRightPoint": {
"lat": 47.62122,
"lon": -122.13046
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62213,
"lon": -122.13236
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/168519",
"score": 2.67,
"dist": 2490.3337046455963,
"info": "search:ta:840539001015090-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-4556500",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "https://www.starbucks.com/store-locator/store/15901",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "1645",
"streetName": "140th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98005",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62626,
"lon": -122.15487
},
"viewport": {
"topLeftPoint": {
"lat": 47.62716,
"lon": -122.1562
},
"btmRightPoint": {
"lat": 47.62536,
"lon": -122.15354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62645,
"lon": -122.15446
}
},
{
"type": "minor",
"position": {
"lat": 47.62579,
"lon": -122.15377
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/152428",
"score": 2.668,
"dist": 3529.7080738812224,
"info": "search:ta:840539001033722-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-3789496",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "180",
"streetName": "148th Ave SE",
"municipalitySubdivision": "West Lake Hills, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "180 148th Ave SE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60901,
"lon": -122.14
},
"viewport": {
"topLeftPoint": {
"lat": 47.60991,
"lon": -122.14133
},
"btmRightPoint": {
"lat": 47.60811,
"lon": -122.13867
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.60901,
"lon": -122.14008
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167147",
"score": 2.668,
"dist": 3479.393294615887,
"info": "search:ta:840539000326896-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8619198",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "7425",
"streetName": "166th Ave NE",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980526288",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "7425 166th Ave NE, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67055,
"lon": -122.12001
},
"viewport": {
"topLeftPoint": {
"lat": 47.67145,
"lon": -122.12135
},
"btmRightPoint": {
"lat": 47.66965,
"lon": -122.11867
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.67069,
"lon": -122.11889
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/153695",
"score": 2.667,
"dist": 3622.441074618729,
"info": "search:ta:840531000006551-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8822881",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/store/15022",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "7625",
"streetName": "170th Ave NE",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980520910",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "7625 170th Ave NE, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67086,
"lon": -122.11392
},
"viewport": {
"topLeftPoint": {
"lat": 47.67176,
"lon": -122.11526
},
"btmRightPoint": {
"lat": 47.66996,
"lon": -122.11258
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.67073,
"lon": -122.1135
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167420",
"score": 2.667,
"dist": 3818.293513029088,
"info": "search:ta:840539000640782-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8853323",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "17246",
"streetName": "Redmond Way",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980524403",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "17246 Redmond Way, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67174,
"lon": -122.10976
},
"viewport": {
"topLeftPoint": {
"lat": 47.67264,
"lon": -122.1111
},
"btmRightPoint": {
"lat": 47.67084,
"lon": -122.10842
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6706,
"lon": -122.11026
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/153686",
"score": 2.666,
"dist": 4009.922205147074,
"info": "search:ta:840531000006548-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8859590",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15738",
"streetName": "Redmond Way Pad 3 Redmond Center",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980523873",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67583,
"lon": -122.12877
},
"viewport": {
"topLeftPoint": {
"lat": 47.67673,
"lon": -122.13011
},
"btmRightPoint": {
"lat": 47.67493,
"lon": -122.12743
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.67456,
"lon": -122.12887
}
},
{
"type": "main",
"position": {
"lat": 47.67668,
"lon": -122.12829
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/168511",
"score": 2.666,
"dist": 3987.80992387863,
"info": "search:ta:840531000006669-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8818265",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "6617",
"streetName": "132Nd Ave Ne Bridle Trails Shopping Center",
"municipalitySubdivision": "Kirkland, Bridle Trails",
"municipality": "Kirkland",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98033",
"extendedPostalCode": "980338234",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033",
"localName": "Kirkland",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66514,
"lon": -122.16599
},
"viewport": {
"topLeftPoint": {
"lat": 47.66604,
"lon": -122.16733
},
"btmRightPoint": {
"lat": 47.66424,
"lon": -122.16465
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.666,
"lon": -122.16669
}
},
{
"type": "minor",
"position": {
"lat": 47.66553,
"lon": -122.16405
}
}
]
}
]
}
}
],
"summary": {
"successfulRequests": 3,
"totalRequests": 3
}
}
Definiciones
Nombre | Description |
---|---|
Address |
Dirección del resultado |
Address |
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. |
Bounding |
Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla. |
Bounding |
Cuadro de límite de la ubicación. |
Brand |
La marca asociada a la POI |
Classification |
Clasificación de la POI que se devuelve |
Classification |
Nombre de la clasificación |
Data |
Sección opcional. Identificadores de referencia para su uso con get Búsqueda Polygon API. |
Entity |
Origen del tipo de entidad del rectángulo de selección. Para la geocodificación inversa, siempre es igual a la posición. |
Entry |
Punto de entrada para el PUNTO de interés que se devuelve. |
Entry |
Tipo de punto de entrada. El valor puede ser principal o secundario. |
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Geographic |
Tipo de entidad Geography. Solo se presenta cuando se solicitó entityType y está disponible. |
Geometry |
Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography. |
Lat |
Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon". |
Match |
Tipos de coincidencias para una operación de búsqueda de direcciones inversas. |
Operating |
Horario de apertura de un POI (Puntos de interés). |
Operating |
Representa una fecha y hora |
Operating |
Intervalo de tiempo de apertura para un día |
Point |
Detalles de la POI devuelta, incluida la información como el nombre, el teléfono, la dirección URL y las clasificaciones. |
Point |
Categoría poi |
Query |
Tipo de consulta que se devuelve: NEARBY o NON_NEAR. |
Response |
Resultado de la consulta. SearchAddressResult si la consulta se completó correctamente, ErrorResponse de lo contrario. |
Search |
Un elemento devuelto desde Búsqueda llamada al servicio Batch de direcciones. |
Search |
Este objeto se devuelve de una llamada correcta al servicio Batch de direcciones Búsqueda. |
Search |
Objeto result para una respuesta de API de Búsqueda. |
Search |
Uno de los valores siguientes:
|
Search |
Objeto summary para una respuesta de api de Búsqueda. |
Summary |
Resumen de los resultados de la solicitud por lotes |
Address
Dirección del resultado
Nombre | Tipo | Description |
---|---|---|
boundingBox |
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 |
|
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 forma abreviada. 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 direcciones 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 |
municipality |
string |
Ciudad/Ciudad |
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[] |
Los 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 |
Una ubicación representada como 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 |
Una ubicación representada como 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 |
Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon". |
|
topLeftPoint |
Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon". |
BoundingBoxCompassNotation
Cuadro de límite de la ubicación.
Nombre | Tipo | Description |
---|---|---|
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 devuelve
Nombre | Tipo | Description |
---|---|---|
code |
string |
Propiedad code |
names |
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 get Búsqueda Polygon API.
Nombre | Tipo | Description |
---|---|---|
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 el PUNTO de interés que se devuelve.
Nombre | Tipo | Description |
---|---|---|
position |
Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon". |
|
type |
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 |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Los detalles del error. |
|
message |
string |
El mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
GeographicEntityType
Tipo de entidad Geography. Solo se presenta 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) |
MatchType
Tipos de coincidencias 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 |
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 |
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 |
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 el POI que se va a devolver. |
categories |
string[] |
Matriz de categorías |
categorySet |
Lista de las categorías de POI más específicas |
|
classifications |
Matriz de clasificación |
|
name |
string |
Nombre de la propiedad POI |
openingHours |
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 |
Response
Resultado de la consulta. SearchAddressResult si la consulta se completó correctamente, ErrorResponse de lo contrario.
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
|
results |
Lista de resultados de la API de Búsqueda. |
|
summary |
Objeto summary para una respuesta de api de Búsqueda |
SearchAddressBatchItem
Un elemento devuelto desde Búsqueda llamada al servicio Batch de direcciones.
Nombre | Tipo | Description |
---|---|---|
response |
Resultado de la consulta. SearchAddressResult si la consulta se completó correctamente, ErrorResponse de lo contrario. |
|
statusCode |
integer |
Código de estado de la solicitud HTTP. |
SearchAddressBatchProcessResult
Este objeto se devuelve de una llamada correcta al servicio Batch de direcciones Búsqueda.
Nombre | Tipo | Description |
---|---|---|
batchItems |
Matriz que contiene los resultados del lote. |
|
summary |
Resumen de los resultados de la solicitud por lotes |
SearchAddressResultItem
Objeto result para una respuesta de API de Búsqueda.
Nombre | Tipo | 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. |
|
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 |
Tipo de entidad Geography. Solo se presenta cuando se solicitó entityType y está disponible. |
|
entryPoints |
Matriz de EntryPoints. Los que describen los tipos de entradas disponibles en la ubicación. El tipo puede ser "main" 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 solicitudes de soporte técnico. |
matchType |
Información sobre el tipo de coincidencia. Uno de los valores siguientes:
|
|
poi |
Detalles de la POI devuelta, incluida la información como el nombre, el teléfono, la dirección URL y las clasificaciones. |
|
position |
Una ubicación representada como una 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á pensado como un valor relativo para un conjunto de resultados. |
type |
Uno de los valores siguientes:
|
|
viewport |
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 |
SearchSummary
Objeto summary para una respuesta de api de Búsqueda.
Nombre | Tipo | Description |
---|---|---|
fuzzyLevel |
integer |
Nivel máximo aproximado necesario para proporcionar resultados. |
geoBias |
Indicación de cuándo 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 |
Tipo de consulta que se devuelve: NEARBY o NON_NEAR. |
|
totalResults |
integer |
Número total de resultados encontrados. |
Summary
Resumen de los resultados de la solicitud por lotes
Nombre | Tipo | Description |
---|---|---|
successfulRequests |
integer |
Número de solicitudes correctas en el lote |
totalRequests |
integer |
Número total de solicitudes en el lote |