- Solicitud HTTP
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- LocationBias
- LocationRestriction
- Sugerencia
- PlacePrediction
- FormattableText
- StringRange
- StructuredFormat
- QueryPrediction
Muestra predicciones para la entrada dada.
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. Personaliza los resultados según una ubicación específica. Se debe establecer uno de |
locationRestriction |
Opcional. Restringe los resultados a una ubicación específica. Se debe establecer uno de |
includedPrimaryTypes[] |
Opcional. Se incluyó el tipo de lugar principal (por ejemplo, "restaurante" o "gas_station") de https://developers.google.com/maps/documentation/places/web-service/place-types. Solo se muestra un lugar si su tipo principal está incluido en esta lista. Se pueden especificar hasta 5 valores. Si no se especifican tipos, se muestran todos los tipos de lugares. |
includedRegionCodes[] |
Opcional. Incluye solo los resultados en las regiones especificadas, con un máximo de 15 códigos regionales 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. El código de región, especificado como un código regional 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 desde el que se calculará 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á predicciones de lugar y de consulta. De lo contrario, la respuesta solo mostrará predicciones del lugar. |
sessionToken |
Opcional. Es una cadena que identifica una sesión de Autocomplete con fines de facturación. Debe ser una string en base64 segura para URL y nombre de archivo con un máximo de 36 caracteres ASCII de longitud. De lo contrario, se muestra un error INVALID_ formato. La sesión comienza cuando el usuario comienza a escribir una consulta y finaliza cuando selecciona un lugar y se realiza una llamada a Place Details o Address Validation. Cada sesión puede tener varias búsquedas, 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 una sesión, el token deja de ser válido, y 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
Protocolo 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 la relevancia. |
LocationBias
La región en la que se buscará. Los resultados pueden estar sesgados en torno a la región especificada.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
rectangle |
Es una viewport definida por una esquina noreste y una esquina 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 |
Es una viewport definida por una esquina noreste y una esquina suroeste. |
circle |
Es un círculo definido por un punto central y un radio. |
Sugerencia
Un resultado de sugerencia de Autocompletar.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
placePrediction |
Predicción de un lugar. |
queryPrediction |
Es una predicción para una consulta. |
PlacePrediction
Resultados de una predicción de Place Autocomplete.
Representación JSON |
---|
{ "place": string, "placeId": string, "text": { object ( |
Campos | |
---|---|
place |
El nombre del recurso del lugar sugerido. Este nombre se puede utilizar en otras APIs que aceptan nombres de lugares. |
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 ser el nombre y la dirección de la empresa. Se recomienda Este texto puede ser diferente del Puede estar en una combinación de idiomas si la solicitud |
structuredFormat |
Es un desglose de la predicción del lugar en texto principal que contiene el nombre del lugar y un texto secundario que contiene características específicas adicionales (como una ciudad o una región). Se recomienda |
types[] |
Lista de tipos que se aplican a este lugar de la Tabla A o 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 con tipos compartidos compartirá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 de consulta. El texto se puede usar tal como está o con formato.
Representación JSON |
---|
{
"text": string,
"matches": [
{
object ( |
Campos | |
---|---|
text |
Texto que se puede usar tal como está o que se puede formatear con |
matches[] |
Una lista de rangos de strings que identifican el punto en el que coincidió la solicitud de entrada en Estos valores son desplazamientos de caracteres Unicode de |
StringRange
Identifica una subcadena dentro de un texto dado.
Representación JSON |
---|
{ "startOffset": integer, "endOffset": integer } |
Campos | |
---|---|
startOffset |
Desplazamiento basado en cero del primer carácter Unicode de la string (inclusive) |
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 Place, el texto principal contiene el nombre específico del lugar. En el caso de las predicciones de consulta, el texto principal contiene la consulta.
El texto secundario contiene características adicionales y aclaratorias (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 de la consulta. |
secondaryText |
Representa características adicionales y aclaratorias (como una ciudad o región) para identificar aún más 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 de predicción. Este texto no representa un lugar, sino una consulta de texto que podría usarse en un extremo de búsqueda (por ejemplo, Text Search). Se recomienda Puede estar en una combinación de idiomas si las solicitudes |
structuredFormat |
Es un desglose de la predicción de la búsqueda en un texto principal que contiene la búsqueda y un texto secundario que contiene características específicas adicionales (como una ciudad o una región). Se recomienda |