- Solicitud HTTP
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- LocationBias
- LocationRestriction
- Sugerencia
- PlacePrediction
- FormattableText
- StringRange
- StructuredFormat
- QueryPrediction
Muestra predicciones para la entrada especificada.
Solicitud HTTP
POST https://places.googleapis.com/v1/places:autocomplete
La URL usa la sintaxis de la transcodificación gRPC.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "input": string, "locationBias": { object ( |
Campos | |
---|---|
input |
Obligatorio. Cadena de texto en la que se realiza la búsqueda |
locationBias |
Opcional. Personalizar resultados en función de una ubicación específica Se debe establecer |
locationRestriction |
Opcional. Restringe los resultados a una ubicación específica. Se debe establecer |
includedPrimaryTypes[] |
Opcional. Se incluyó el tipo de lugar principal (por ejemplo, "restaurante" o "gas_station") de la Tabla A o la Tabla B en los Tipos de Lugar (https://developers.google.com/maps/documentation/places/web-service/place-types), o solo (regiones) o solo (ciudades). Un sitio solo se devuelve si su tipo principal se incluye en esta lista. Se pueden especificar hasta 5 valores. Si no se especifican tipos, se muestran todos los tipos de lugar. |
includedRegionCodes[] |
Opcional. Solo incluye resultados en las regiones especificadas, con un máximo de 15 códigos de región CLDR de dos caracteres. Un conjunto vacío no restringirá los resultados. Si se configuran |
languageCode |
Opcional. El idioma en el que se mostrarán los resultados. La configuración predeterminada es en-US. Los resultados pueden estar en varios idiomas si el idioma utilizado en |
regionCode |
Opcional. Es el código de región, especificado como un código de región CLDR de dos caracteres. Esto afecta el formato de la dirección y la clasificación de los resultados, y puede influir en los resultados que se muestran. Esto no restringe los resultados a la región especificada. Para restringir los resultados a una región, usa |
origin |
Opcional. Punto de origen a partir del cual se calcula la distancia geodésica hasta el destino (se muestra como |
inputOffset |
Opcional. Un desplazamiento de caracteres Unicode basado en cero de Si está vacío, el valor predeterminado es la longitud de |
includeQueryPredictions |
Opcional. Si es verdadero, la respuesta incluirá las predicciones de Places y de consultas. De lo contrario, la respuesta solo mostrará predicciones de Places. |
sessionToken |
Opcional. Es una cadena que identifica una sesión de Autocomplete con fines de facturación. Debe ser una string base64 segura de URL y nombre de archivo con un máximo de 36 caracteres ASCII de longitud. De lo contrario, se muestra un error INVALID_ARGUMENT. La sesión se inicia cuando el usuario comienza a escribir una consulta y termina cuando selecciona un lugar y se realiza una llamada a Place Details o Address Validation. Cada sesión puede tener varias consultas, seguidas de una solicitud de Place Details o Address Validation. Las credenciales que se usan para cada solicitud dentro de una sesión deben pertenecer al mismo proyecto de la consola de Google Cloud. Una vez que finaliza la sesión, el token deja de ser válido. tu app debe generar un token nuevo para cada sesión. Si se omite el parámetro Recomendamos los siguientes lineamientos:
|
Cuerpo de la respuesta
Proto de respuesta para places.autocomplete.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"suggestions": [
{
object ( |
Campos | |
---|---|
suggestions[] |
Contiene una lista de sugerencias, ordenadas de forma descendente según su relevancia. |
LocationBias
La región en la que se buscará. Los resultados pueden estar sesgados en función de la región especificada.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
rectangle |
Un viewport definido por una esquina noreste y suroeste |
circle |
Es un círculo definido por un punto central y un radio. |
LocationRestriction
La región en la que se buscará. Los resultados se restringirán a la región especificada.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
rectangle |
Un viewport definido por una esquina noreste y suroeste |
circle |
Es un círculo definido por un punto central y un radio. |
Sugerencia
Un resultado de sugerencia de Autocomplete.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
placePrediction |
Es una predicción de un lugar. |
queryPrediction |
Una predicción para una consulta. |
PlacePrediction
Resultados de predicciones de Place Autocomplete.
Representación JSON |
---|
{ "place": string, "placeId": string, "text": { object ( |
Campos | |
---|---|
place |
El nombre del recurso del sitio sugerido. Este nombre se puede usar en otras APIs que aceptan nombres de lugar. |
placeId |
Es el identificador único del lugar sugerido. Este identificador se puede usar en otras APIs que aceptan IDs de lugar. |
text |
Contiene el nombre legible del resultado que se muestra. Para los resultados de establecimientos, suele incluir el nombre y la dirección de la empresa. Se recomienda Este texto puede ser diferente del valor Puede estar en varios idiomas si la solicitud |
structuredFormat |
Un desglose de la predicción del lugar en texto principal que contiene el nombre del lugar y un texto secundario que contenga características adicionales que desambiguan (como una ciudad o región). Se recomienda |
types[] |
Lista de los tipos que se aplican a este lugar de la Tabla A o de la Tabla B en https://developers.google.com/maps/documentation/places/web-service/place-types. Un tipo es una categorización de un lugar. Los lugares que se compartan con tipos de lugares tendrán características similares. |
distanceMeters |
La longitud de la línea geodésica en metros desde |
FormattableText
Texto que representa una predicción de lugar o consulta. El texto se puede utilizar tal como está o con formato.
Representación JSON |
---|
{
"text": string,
"matches": [
{
object ( |
Campos | |
---|---|
text |
Texto que se puede utilizar tal como está o que se puede utilizar con el formato |
matches[] |
Una lista de rangos de cadenas que identifican el lugar en el que la solicitud de entrada coincidió en Estos valores son desplazamientos de caracteres Unicode de |
StringRange
Identifica una subcadena dentro de un texto determinado.
Representación JSON |
---|
{ "startOffset": integer, "endOffset": integer } |
Campos | |
---|---|
startOffset |
Desplazamiento basado en cero del primer carácter Unicode de la string (inclusiva). |
endOffset |
Desplazamiento basado en cero del último carácter Unicode (exclusivo). |
StructuredFormat
Contiene un desglose de una predicción de lugar o de consulta en texto principal y texto secundario.
Para las predicciones de Places, el texto principal contiene el nombre específico del Place. Para las predicciones de consulta, el texto principal contiene la consulta.
El texto secundario contiene características adicionales que desambiguan (como una ciudad o región) para identificar aún más el lugar o definir mejor la consulta.
Representación JSON |
---|
{ "mainText": { object ( |
Campos | |
---|---|
mainText |
Representa el nombre del lugar o la consulta. |
secondaryText |
Representa características adicionales que desambiguan (como una ciudad o región) para identificar mejor el lugar o definir mejor la consulta. |
QueryPrediction
Resultados de la predicción para una predicción del autocompletado de consultas.
Representación JSON |
---|
{ "text": { object ( |
Campos | |
---|---|
text |
Es el texto predicho. Este texto no representa un lugar, sino una consulta de texto que podría usarse en un punto final de búsqueda (por ejemplo, Text Search). Se recomienda Puede estar en varios idiomas si la solicitud |
structuredFormat |
Un desglose de la predicción de la consulta en texto principal que contiene la consulta y el texto secundario, que contiene atributos adicionales que desambiguan (como una ciudad o región). Se recomienda |