Method: places.autocomplete

Devuelve predicciones para la entrada proporcionada.

Solicitud HTTP

POST https://places.googleapis.com/v1/places:autocomplete

La URL usa la sintaxis de la transcodificación de gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "input": string,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "includedPrimaryTypes": [
    string
  ],
  "includedRegionCodes": [
    string
  ],
  "languageCode": string,
  "regionCode": string,
  "origin": {
    object (LatLng)
  },
  "inputOffset": integer,
  "includeQueryPredictions": boolean,
  "sessionToken": string,
  "includePureServiceAreaBusinesses": boolean,
  "includeFutureOpeningBusinesses": boolean
}
Campos
input

string

Obligatorio. Es la cadena de texto en la que se realizará la búsqueda.
locationBias

object (LocationBias)

Opcional. Personaliza los resultados según una ubicación especificada.

Se debe establecer como máximo uno de los valores locationBias o locationRestriction. Si no se configura ninguno de los dos, los resultados se personalizarán según la dirección IP, lo que significa que la dirección IP se asignará a una ubicación imprecisa y se usará como un indicador de personalización.
locationRestriction

object (LocationRestriction)

Opcional. Restringe los resultados a una ubicación especificada.

Se debe establecer como máximo uno de los valores locationBias o locationRestriction. Si no se configura ninguno de los dos, los resultados se personalizarán según la dirección IP, lo que significa que la dirección IP se asignará a una ubicación imprecisa y se usará como un indicador de personalización.
includedPrimaryTypes[]

string

Opcional. Tipo de lugar principal incluido (por ejemplo, "restaurant" o "gas_station") en Place Types (Tipos de lugar) (https://developers.google.com/maps/documentation/places/web-service/place-types), o solo (regions), o solo (cities). Un lugar solo se muestra si su tipo principal se incluye en esta lista. Se pueden especificar hasta 5 valores. Si no se especifican tipos, se devuelven todos los tipos de Place.
includedRegionCodes[]

string

Opcional. Solo se incluyen los resultados en las regiones especificadas, que se indican con hasta 15 códigos de región CLDR de dos caracteres. Un conjunto vacío no restringirá los resultados. Si se configuran locationRestriction y includedRegionCodes, los resultados se ubicarán en el área de intersección.
languageCode

string

Opcional. Es el idioma en el que se mostrarán los resultados. El valor predeterminado es en-US. Los resultados pueden estar en varios idiomas si el idioma que se usa en input es diferente de languageCode o si el lugar devuelto no tiene una traducción del idioma local a languageCode.
regionCode

string

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, 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 region_code_restriction.
origin

object (LatLng)

Opcional. Es el punto de origen desde el que se calcula la distancia geodésica hasta el destino (se devuelve como distanceMeters). Si se omite este valor, no se devolverá la distancia geodésica.
inputOffset

integer

Opcional. Es un desplazamiento de caracteres Unicode basado en cero de input que indica la posición del cursor en input. La posición del cursor puede influir en las predicciones que se muestran.

Si está vacío, el valor predeterminado es la longitud de input.
includeQueryPredictions

boolean

Opcional. Si es verdadero, la respuesta incluirá predicciones de lugares y de búsquedas. De lo contrario, la respuesta solo devolverá predicciones de lugares.
sessionToken

string

Opcional. Es una cadena que identifica una sesión de Autocomplete para fines de facturación. Debe ser una cadena base64 segura para URLs y nombres de archivos con un máximo de 36 caracteres ASCII. De lo contrario, se muestra un error INVALID_ARGUMENT.

La sesión comienza cuando el usuario comienza a escribir una búsqueda y termina 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 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 sessionToken, o si reutilizas un token de sesión, la sesión se cobrará como si no se hubiera proporcionado un token de sesión (cada solicitud se factura por separado).

Recomendamos los siguientes lineamientos:

  • Usa tokens de sesión para todas las llamadas a Place Autocomplete.
  • Genera un token nuevo para cada sesión. Se recomienda usar un UUID de versión 4.
  • Asegúrate de que las credenciales que se usan para todas las solicitudes de Place Autocomplete, Place Details y Address Validation dentro de una sesión pertenezcan al mismo proyecto de la consola de Google Cloud.
  • Asegúrate de pasar un token de sesión único para cada sesión nueva. Si usas el mismo token para más de una sesión, cada solicitud se facturará de forma individual.
includePureServiceAreaBusinesses

boolean

Opcional. Incluye las empresas exclusivamente de servicio en el área si el campo se establece como verdadero. Una empresa exclusivamente de servicio en el área es una empresa que visita a los clientes o les entrega sus productos directamente, pero que no los atiende en su dirección comercial. Por ejemplo, empresas de servicios de limpieza o de plomería. Esos negocios no tienen una dirección física ni una ubicación en Google Maps. Places no devolverá campos como location, plusCode y otros campos relacionados con la ubicación para estas empresas.
includeFutureOpeningBusinesses

boolean

Opcional. Si es verdadero, incluye las empresas que aún no abrieron, pero que lo harán en el futuro.

Cuerpo de la respuesta

Es el 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 (Suggestion)
    }
  ]
}
Campos
suggestions[]

object (Suggestion)

Contiene una lista de sugerencias, ordenadas de forma descendente según su relevancia.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/maps-platform.places.autocomplete
  • https://www.googleapis.com/auth/maps-platform.places
  • https://www.googleapis.com/auth/cloud-platform

LocationBias

Es la región en la que se realizará la búsqueda. Los resultados pueden estar sesgados en torno a la región especificada.

Representación JSON 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Campos

Campo de unión type.

type puede ser una de las siguientes opciones:
rectangle

object (Viewport)

Es una ventana gráfica definida por una esquina noreste y una suroeste.
circle

object (Circle)

Es un círculo definido por un punto central y un radio.

LocationRestriction

Es la región en la que se realizará la búsqueda. Los resultados se restringirán a la región especificada.

Representación JSON 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Campos

Campo de unión type.

type puede ser una de las siguientes opciones:
rectangle

object (Viewport)

Es una ventana gráfica definida por una esquina noreste y una suroeste.
circle

object (Circle)

Es un círculo definido por un punto central y un radio.

Sugerencia

Es un resultado de sugerencia de Autocomplete.

Representación JSON 
{

  // Union field kind can be only one of the following:
  "placePrediction": {
    object (PlacePrediction)
  },
  "queryPrediction": {
    object (QueryPrediction)
  }
  // End of list of possible types for union field kind.
}
Campos

Campo de unión kind.

kind puede ser una de las siguientes opciones:
placePrediction

object (PlacePrediction)

Es una predicción para un lugar.
queryPrediction

object (QueryPrediction)

Es una predicción para una búsqueda.

PlacePrediction

Son los resultados de la predicción de Place Autocomplete.

Representación JSON 
{
  "place": string,
  "placeId": string,
  "text": {
    object (FormattableText)
  },
  "structuredFormat": {
    object (StructuredFormat)
  },
  "types": [
    string
  ],
  "distanceMeters": integer
}
Campos
place

string

Es el nombre del recurso del lugar sugerido. Este nombre se puede usar en otras APIs que acepten nombres de lugares.
placeId

string

Es el identificador único del lugar sugerido. Este identificador se puede usar en otras APIs que acepten IDs de lugar.
text

object (FormattableText)

Contiene el nombre legible del resultado devuelto. En el caso de los resultados de establecimientos, suele ser el nombre y la dirección de la empresa.

Se recomienda text para los desarrolladores que desean mostrar un solo elemento de la IU. Los desarrolladores que deseen mostrar dos elementos de la IU separados, pero relacionados, tal vez quieran usar structuredFormat en su lugar. Son dos formas diferentes de representar una predicción de lugar. Los usuarios no deben intentar analizar structuredFormat en text ni viceversa.

Este texto puede ser diferente del displayName que devuelve places.get.

Puede estar en varios idiomas si la solicitud input y languageCode están en idiomas diferentes o si el lugar no tiene una traducción del idioma local a languageCode.
structuredFormat

object (StructuredFormat)

Es un desglose de la predicción de lugar en texto principal que contiene el nombre del lugar y texto secundario que contiene características adicionales para la desambiguación (como una ciudad o una región).

Se recomienda usar structuredFormat para los desarrolladores que desean mostrar dos elementos de la IU separados, pero relacionados. Los desarrolladores que deseen mostrar un solo elemento de la IU pueden usar text en su lugar. Son dos formas diferentes de representar una predicción de lugar. Los usuarios no deben intentar analizar structuredFormat en text ni viceversa.
types[]

string

Es la lista de tipos que se aplican a este lugar de la tabla A o 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 con tipos compartidos tendrán características similares.
distanceMeters

integer

Longitud de la geodésica en metros desde origin si se especifica origin. Es posible que algunas predicciones, como las rutas, no completen este campo.

FormattableText

Es el texto que representa una predicción de lugar o de búsqueda. El texto se puede usar tal como está o con formato.

Representación JSON 
{
  "text": string,
  "matches": [
    {
      object (StringRange)
    }
  ]
}
Campos
text

string

Texto que se puede usar tal como está o con formato matches.
matches[]

object (StringRange)

Es una lista de rangos de cadenas que identifican dónde coincidió la solicitud de entrada en text. Los rangos se pueden usar para formatear partes específicas de text. Es posible que las subcadenas no coincidan exactamente con input si la coincidencia se determinó según criterios distintos de la coincidencia de cadenas (por ejemplo, correcciones ortográficas o transliteraciones).

Estos valores son desplazamientos de caracteres Unicode de text. Se garantiza que los rangos se ordenan en valores de desplazamiento crecientes.

StringRange

Identifica una subcadena dentro de un texto determinado.

Representación JSON 
{
  "startOffset": integer,
  "endOffset": integer
}
Campos
startOffset

integer

Es el desplazamiento basado en cero del primer carácter Unicode de la cadena (inclusive).
endOffset

integer

Es el desplazamiento basado en cero del último carácter Unicode (exclusivo).

StructuredFormat

Contiene un desglose de una predicción de lugar o de búsqueda en texto principal y texto secundario.

En el caso de las predicciones de lugares, el texto principal contiene el nombre específico del lugar. En el caso de las predicciones de búsquedas, el texto principal contiene la búsqueda.

El texto secundario contiene características adicionales de desambiguación (como una ciudad o una región) para identificar mejor el lugar o refinar la búsqueda.

Representación JSON 
{
  "mainText": {
    object (FormattableText)
  },
  "secondaryText": {
    object (FormattableText)
  }
}
Campos
mainText

object (FormattableText)

Representa el nombre del lugar o la búsqueda.
secondaryText

object (FormattableText)

Representa características adicionales de desambiguación (como una ciudad o región) para identificar mejor el lugar o refinar la búsqueda.

QueryPrediction

Son los resultados de la predicción de Autocomplete de la búsqueda.

Representación JSON 
{
  "text": {
    object (FormattableText)
  },
  "structuredFormat": {
    object (StructuredFormat)
  }
}
Campos
text

object (FormattableText)

Es el texto predicho. Este texto no representa un lugar, sino una búsqueda de texto que se podría usar en un endpoint de búsqueda (por ejemplo, Text Search).

Se recomienda text para los desarrolladores que desean mostrar un solo elemento de la IU. Los desarrolladores que deseen mostrar dos elementos de la IU separados, pero relacionados, tal vez quieran usar structuredFormat en su lugar. Son dos formas diferentes de representar una predicción de búsqueda. Los usuarios no deben intentar analizar structuredFormat en text ni viceversa.

Puede estar en varios idiomas si la solicitud input y languageCode están en idiomas diferentes o si parte de la búsqueda no tiene una traducción del idioma local a languageCode.
structuredFormat

object (StructuredFormat)

Es un desglose de la predicción de la búsqueda en texto principal que contiene la búsqueda y texto secundario que contiene funciones adicionales de desambiguación (como una ciudad o una región).

Se recomienda usar structuredFormat para los desarrolladores que desean mostrar dos elementos de la IU separados, pero relacionados. Los desarrolladores que deseen mostrar un solo elemento de la IU pueden usar text en su lugar. Son dos formas diferentes de representar una predicción de búsqueda. Los usuarios no deben intentar analizar structuredFormat en text ni viceversa.