Se usó la API de Cloud Translation para traducir esta página.

Autocompletar (nuevo)

Selecciona la plataforma: Android iOS JavaScript Servicio web

El servicio Autocomplete (nuevo) es un servicio web que muestra predicciones de lugares y de consultas en respuesta a una solicitud HTTP. En la solicitud, especifica una cadena de búsqueda de texto y límites geográficos que controlen el área de búsqueda.

El servicio Autocomplete (nuevo) puede buscar coincidencias con palabras completas y subcadenas de la entrada para resolver nombres de lugares, direcciones y Plus Codes. Así, las aplicaciones pueden enviar consultas a medida que el usuario escribe para proporcionar predicciones de lugares y consultas en el momento.

La respuesta de la API de Autocomplete (nueva) puede contener dos tipos de predicciones:

Predicciones de lugares: Lugares como empresas, direcciones y lugares de interés, según la string de texto de entrada y el área de búsqueda especificados. Las predicciones de lugares se muestran de forma predeterminada.
Predicciones de consultas: Cadenas de consulta que coinciden con la string de texto de entrada y el área de búsqueda. Las predicciones de consulta no se muestran de forma predeterminada. Usa el parámetro de solicitud includeQueryPredictions para agregar predicciones de consultas a la respuesta.

Por ejemplo, llamas a la API usando como entrada una string que contiene una entrada parcial del usuario, "Sicilian piz", con el área de búsqueda limitada a San Francisco, CA. Luego, la respuesta contiene una lista de predicciones de lugares que coinciden con la cadena de búsqueda y el área de búsqueda, como el restaurante llamado "Sicilian Pizza Kitchen", junto con detalles sobre el lugar.

Las predicciones de lugar que se muestran están diseñadas para presentarse al usuario y ayudarlo a seleccionar el lugar deseado. Puedes realizar una solicitud a Place Details (nuevo) para obtener más información sobre cualquiera de las predicciones de lugares que se muestran.

La respuesta también puede contener una lista de predicciones de consulta que coinciden con la cadena de búsqueda y el área de búsqueda, como "Pizza siciliana y pasta". Cada predicción de consulta en la respuesta incluye el campo text, que contiene una cadena de búsqueda de texto recomendada. Usa esa cadena como entrada a Text Search (nueva) para realizar una búsqueda más detallada.

El Explorador de APIs te permite realizar solicitudes en tiempo real para que puedas familiarizarte con la API y sus opciones:

Pruébalo

Solicitudes a Autocomplete (nuevas)

Una solicitud de Autocomplete (nueva) es una solicitud HTTP POST a una URL en el formato siguiente:

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

Pasa todos los parámetros en el cuerpo de la solicitud JSON o en los encabezados como parte de la solicitud POST. Por ejemplo:

curl -X POST -d '{
  "input": "pizza",
  "locationBias": {
    "circle": {
      "center": {
        "latitude": 37.7937,
        "longitude": -122.3965
      },
      "radius": 500.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

Acerca de la respuesta

Autocomplete (nuevo) muestra un objeto JSON como respuesta. En la respuesta, figura lo siguiente:

El array suggestions contiene todos los lugares y las búsquedas previstos en función de la relevancia percibida. Cada lugar se representa con un campo placePrediction y cada consulta se representa con un campo queryPrediction.
El campo placePrediction contiene información detallada sobre la predicción de un solo lugar, incluido el ID de lugar y la descripción de texto.
El campo queryPrediction contiene información detallada sobre una sola predicción de consulta.

Nota: Autocomplete (nuevo) muestra un total de cinco predicciones, ya sea como placePredictions, queryPredictions o una combinación de ambas, según la solicitud. Por ejemplo, si la solicitud no establece includeQueryPredictions, el cuerpo de la respuesta incluirá hasta cinco placePredictions. Si la solicitud establece includeQueryPredictions, el cuerpo de la respuesta incluye hasta cinco predicciones en una combinación de placePredictions y queryPredictions.

El objeto JSON completo tiene el siguiente formato:

{
  "suggestions": [
    {
      "placePrediction": {
        "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "text": {
          "text": "Amoeba Music, Haight Street, San Francisco, CA, USA",
          "matches": [
            {
              "endOffset": 6
            }]
        },
      ...
    },
    {
      "queryPrediction": {
        "text": {
          "text": "Amoeba Music",
          "matches": [
            {
              "endOffset": 6
            }]
        },
        ...
    }
  ...]
}

Parámetros obligatorios

entrada

Cadena de texto en la que se realiza la búsqueda Especifica palabras completas y subcadenas, nombres de lugares, direcciones y Plus Codes. El servicio Autocomplete (nuevo) muestra posibles coincidencias en función de esta cadena y ordena los resultados según la relevancia percibida.

Parámetros opcionales

includedPrimaryTypes

Un lugar solo puede tener un único tipo principal de los tipos enumerados en la Tabla A o la Tabla B. Por ejemplo, el tipo principal podría ser "mexican_restaurant" o "steak_house".

De forma predeterminada, la API muestra todos los lugares según el parámetro input, independientemente del valor de tipo principal asociado con el lugar. Restringe los resultados para que sean de un tipo primario o uno principal determinado pasando el parámetro includedPrimaryTypes.

Usa este parámetro para especificar hasta cinco valores de tipo de la Tabla A o la Tabla B. Un lugar debe coincidir con uno de los valores de tipo principal especificado que se incluirán en la respuesta.

Este parámetro también puede incluir, en cambio, uno de (regions) o (cities). El conjunto de tipos (regions) filtra las áreas o divisiones, como vecindarios y códigos postales. El conjunto de tipos (cities) filtra los lugares que Google identifica como ciudad.

La solicitud se rechaza con un error INVALID_REQUEST en los siguientes casos:
- Se especifican más de cinco tipos.
- Cualquier tipo se especifica además de (cities) o (regions).
- Se especifican todos los tipos no reconocidos.
Nota: El parámetro includedPrimaryTypes solo funciona en el tipo principal del lugar, no en todos los tipos asociados con el lugar. Si bien todos los lugares tienen un tipo principal, no todos los tipos principales son compatibles con la API de Places (nueva). Los tipos admitidos incluyen los que se enumeran en la Tabla A o la Tabla B.
includeQueryPredictions

Si es true, la respuesta incluye las predicciones de lugar y de consulta. El valor predeterminado es false, lo que significa que la respuesta solo incluye predicciones de lugares.
includedRegionCodes

Incluye solo los resultados de la lista de regiones especificadas como un array de hasta 15 ccTLD ("dominio de nivel superior") de dos caracteres. Si se omite, no se aplican restricciones a la respuesta. Por ejemplo, para limitar las regiones a Alemania y Francia, haz lo siguiente:
```
    "includedRegionCodes": ["de", "fr"]
```
Si especificas locationRestriction y includedRegionCodes, los resultados se encuentran en el área de intersección de las dos configuraciones.
inputOffset

El desplazamiento de caracteres Unicode basado en cero 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.

Nota: En la versión inicial de la versión preliminar privada, esta propiedad se llamaba predictionTermOffset.
languageCode

El idioma preferido en el que se mostrarán los resultados. Los resultados pueden estar en varios idiomas si el idioma utilizado en input es diferente del valor especificado en languageCode o si el lugar que se muestra no tiene una traducción del idioma local al languageCode.
- Debes usar los códigos de idioma IETF BCP-47 para especificar el idioma preferido.
- Si no se proporciona languageCode, la API usa el valor especificado en el encabezado Accept-Language. Si no se especifica ninguno, el valor predeterminado es en. Si especificas un código de idioma no válido, la API mostrará un error INVALID_ARGUMENT.
- El idioma preferido tiene una pequeña influencia en el conjunto de resultados que la API elige mostrar y en el orden en el que se muestran. Esto también afecta la capacidad de la API de corregir errores de ortografía.
- La API intenta proporcionar una dirección que sea legible para el usuario y la población local, y que, al mismo tiempo, refleja la entrada del usuario. Las predicciones de lugares tienen un formato diferente según la entrada del usuario en cada solicitud.
  - Primero, se eligen los términos coincidentes del parámetro input mediante nombres alineados con la preferencia de idioma que indica el parámetro languageCode cuando están disponibles, mientras que, de lo contrario, se usan los nombres que mejor coinciden con la entrada del usuario.
  - Las direcciones tienen el formato del idioma local, en una secuencia de comandos que el usuario puede leer cuando es posible, solo después de que se hayan seleccionado los términos coincidentes para que coincidan con los términos del parámetro input.
  - Todas las demás direcciones se muestran en el idioma preferido una vez que se eligen los términos coincidentes para que coincidan con los del parámetro input. Si un nombre no está disponible en el idioma preferido, la API usa la coincidencia más cercana.
locationBias o locationRestriction

Puedes especificar locationBias o locationRestriction, pero no ambos, para definir el área de búsqueda. Considera que locationRestriction especifica la región en la que deben estar los resultados y locationBias la región a la que los resultados deben estar cerca, pero que pueden estar fuera del área.

Nota: Si omites locationBias y locationRestriction, la API usa la personalización de IP de forma predeterminada. Con la personalización de IP, la API usa la dirección IP del dispositivo para personalizar los resultados.
- locationBias
  
  Especifica un área de búsqueda. Esta ubicación sirve como una personalización, lo que significa que se pueden mostrar resultados alrededor de la ubicación especificada, incluso resultados fuera del área especificada.
- locationRestriction
  
  Especifica un área de búsqueda. No se muestran resultados fuera del área especificada.
Especifica la región locationBias o locationRestriction como una ventana gráfica rectangular o como un círculo.
- Un círculo se define por el punto central y el radio en metros. El radio debe ser de 0.0 a 50,000.0, inclusive. El valor predeterminado es 0.0. Para locationRestriction, debes establecer el radio en un valor superior a 0.0. De lo contrario, la solicitud no muestra resultados.
  
  Por ejemplo:
```
"locationBias": {
  "circle": {
    "center": {
      "latitude": 37.7937,
      "longitude": -122.3965
    },
    "radius": 500.0
  }
}
```
- Un rectángulo es un viewport de latitud y longitud, representado como dos puntos superiores y low opuestos en diagonal. Un viewport se considera una región cerrada, lo que significa que incluye su límite. Los límites de latitud deben variar entre -90 y 90 grados inclusive, y los límites de longitud deben variar entre -180 y 180 grados inclusive:
  - Si low = high, el viewport consta de ese solo punto.
  - Si low.longitude > high.longitude, se invierte el rango de longitud (el viewport cruza la línea de longitud de 180 grados).
  - Si low.longitude = -180 grados y high.longitude = 180 grados, el viewport incluye todas las longitudes.
  - Si low.longitude = 180 grados y high.longitude = -180 grados, el rango de longitud está vacío.
  low y high se deben completar, y el cuadro representado no puede estar vacío. Un viewport vacío genera un error.
  
  Por ejemplo, este viewport abarca por completo la ciudad de Nueva York:
```
"locationBias": {
  "rectangle": {
    "low": {
      "latitude": 40.477398,
      "longitude": -74.259087
    },
    "high": {
      "latitude": 40.91618,
      "longitude": -73.70018
    }
  }
}
```
origin

Es el punto de origen desde el que se calcula la distancia en línea recta hasta el destino (se muestra como distanceMeters). Si se omite este valor, no se mostrará la distancia en línea recta. Se deben especificar como coordenadas de latitud y longitud:
```
"origin": {
    "latitude": 40.477398,
    "longitude": -74.259087
}
```
regionCode

Es el código de región que se usa para dar formato a la respuesta, especificado como un valor ccTLD ("dominio de nivel superior") de dos caracteres. La mayoría de los códigos de ccTLD son idénticos a los códigos ISO 3166-1, con algunas excepciones notables. Por ejemplo, el ccTLD del Reino Unido es "uk" (.co.uk), mientras que su código ISO 3166-1 es "gb" (técnicamente para la entidad del "Reino Unido de Gran Bretaña e Irlanda del Norte").

Si especificas un código de región no válido, la API mostrará un error INVALID_ARGUMENT. El parámetro puede afectar los resultados según la ley aplicable.
sessionToken

Los tokens de sesión son cadenas generadas por el usuario que hacen un seguimiento de las llamadas de Autocomplete (nuevo) como “sesiones”. Autocomplete (nuevo) usa tokens de sesión para agrupar las fases de consulta y selección de una búsqueda de autocompletado del usuario en una sesión discreta con fines de facturación. Para obtener más información, consulta Tokens de sesión.

Ejemplos de Autocomplete (nuevo)

Cómo usar locationRestriction y locationBias

La API usa la personalización de IP de forma predeterminada para controlar el área de búsqueda. Con la personalización de IP, la API usa la dirección IP del dispositivo para personalizar los resultados. De manera opcional, puedes usar locationRestriction o locationBias, pero no ambos, para especificar un área de búsqueda.

locationRestriction especifica el área a buscar. No se muestran resultados fuera del área especificada. En el siguiente ejemplo, se usa locationRestriction para limitar la solicitud a un círculo de 5,000 metros de radio centrado en San Francisco:

curl -X POST -d '{
  "input": "Amoeba",
  "locationRestriction": {
    "circle": {
      "center": {
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "radius": 5000.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

Todos los resultados que se encuentran dentro de las áreas especificadas se encuentran en el array suggestions:

{
  "suggestions": [
    {
      "placePrediction": {
        "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "text": {
          "text": "Amoeba Music, Haight Street, San Francisco, CA, USA",
          "matches": [
            {
              "endOffset": 6
            }
          ]
        },
        "structuredFormat": {
          "mainText": {
            "text": "Amoeba Music",
            "matches": [
              {
                "endOffset": 6
              }
            ]
          },
          "secondaryText": {
            "text": "Haight Street, San Francisco, CA, USA"
          }
        },
        "types": [
          "home_goods_store",
          "establishment",
          "store",
          "point_of_interest",
          "electronics_store"
        ]
      }
    }
  ]
}

Con locationBias, la ubicación sirve como un sesgo, lo que significa que se pueden mostrar resultados alrededor de la ubicación especificada, incluso resultados fuera del área especificada. En el siguiente ejemplo, debes cambiar la solicitud para usar locationBias:

curl -X POST -d '{
  "input": "Amoeba",
  "locationBias": {
    "circle": {
      "center": {
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "radius": 5000.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

Los resultados ahora contienen muchos más elementos, incluso resultados fuera del radio de 5000 metros:

{
  "suggestions": [
    {
      "placePrediction": {
        "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "text": {
          "text": "Amoeba Music, Haight Street, San Francisco, CA, USA",
          "matches": [
            {
              "endOffset": 6
            }
          ]
        },
        "structuredFormat": {
          "mainText": {
            "text": "Amoeba Music",
            "matches": [
              {
                "endOffset": 6
              }
            ]
          },
          "secondaryText": {
            "text": "Haight Street, San Francisco, CA, USA"
          }
        },
        "types": [
          "electronics_store",
          "point_of_interest",
          "store",
          "establishment",
          "home_goods_store"
        ]
      }
    },
    {
      "placePrediction": {
        "place": "places/ChIJr7uwwy58hYARBY-e7-QVwqw",
        "placeId": "ChIJr7uwwy58hYARBY-e7-QVwqw",
        "text": {
          "text": "Amoeba Music, Telegraph Avenue, Berkeley, CA, USA",
          "matches": [
            {
              "endOffset": 6
            }
          ]
        },
        "structuredFormat": {
          "mainText": {
            "text": "Amoeba Music",
            "matches": [
              {
                "endOffset": 6
              }
            ]
          },
          "secondaryText": {
            "text": "Telegraph Avenue, Berkeley, CA, USA"
          }
        },
        "types": [
          "electronics_store",
          "point_of_interest",
          "establishment",
          "home_goods_store",
          "store"
        ]
      }
    },
    ...
  ]
}

Usa includePrimaryTypes

Usa el parámetro includedPrimaryTypes para especificar hasta cinco valores de tipo de la Tabla A, la Tabla B, o solo (regions) o solo (cities). Un lugar debe coincidir con uno de los valores de tipo principal especificado que se incluirán en la respuesta.

En el siguiente ejemplo, especificas una cadena input de "Soccer" y usas el parámetro includedPrimaryTypes para restringir los resultados a establecimientos de tipo "sporting_goods_store":

curl -X POST -d '{
  "input": "Soccer",
  "includedPrimaryTypes": ["sporting_goods_store"],
  "locationBias": {
    "circle": {
      "center": {
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "radius": 500.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

Si omites el parámetro includedPrimaryTypes, los resultados pueden incluir establecimientos de un tipo que no desees, como "athletic_field".

Solicita predicciones de consultas

Las predicciones de consulta no se muestran de forma predeterminada. Usa el parámetro de solicitud includeQueryPredictions para agregar predicciones de consultas a la respuesta. Por ejemplo:

curl -X POST -d '{
  "input": "Amoeba",
  "includeQueryPredictions": true,
  "locationBias": {
    "circle": {
      "center": {
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "radius": 5000.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

El array suggestions ahora contiene predicciones de lugares y predicciones de consultas, como se muestra más arriba en Acerca de la respuesta. Cada predicción de consulta incluye el campo text, que contiene una cadena de búsqueda de texto recomendada. Puedes realizar una solicitud a Text Search (nueva) para obtener más información sobre cualquiera de las predicciones de consulta que se muestran.

Nota: Las predicciones de consultas no se muestran cuando se configura el parámetro includedRegionCodes.

Usar origen

En este ejemplo, incluye origin en la solicitud como coordenadas de latitud y longitud. Cuando incluyes origin, la API incluye el campo distanceMeters en la respuesta, que contiene la distancia en línea recta desde el origin hasta el destino. En este ejemplo, se establece el origen en el centro de San Francisco:

curl -X POST -d '{
  "input": "Amoeba",
  "origin": {
    "latitude": 37.7749,
    "longitude": -122.4194
  },
  "locationRestriction": {
    "circle": {
      "center": {
        "latitude": 37.7749,
        "longitude": -122.4194
      },
      "radius": 5000.0
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete

La respuesta ahora incluye distanceMeters:

{
  "suggestions": [
    {
      "placePrediction": {
        "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko",
        "text": {
          "text": "Amoeba Music, Haight Street, San Francisco, CA, USA",
          "matches": [
            {
              "endOffset": 6
            }
          ]
        },
        "structuredFormat": {
          "mainText": {
            "text": "Amoeba Music",
            "matches": [
              {
                "endOffset": 6
              }
            ]
          },
          "secondaryText": {
            "text": "Haight Street, San Francisco, CA, USA"
          }
        },
        "types": [
          "home_goods_store",
          "establishment",
          "point_of_interest",
          "store",
          "electronics_store"
        ],
        "distanceMeters": 3012
      }
    }
  ]
}

Pruébalo

El Explorador de APIs te permite realizar solicitudes de muestra para que puedas familiarizarte con la API y sus opciones.

Selecciona el ícono de la API, , en el lado derecho de la página.
De manera opcional, puedes expandir Mostrar parámetros estándar y establecer el parámetro fields en la máscara de campo.
De manera opcional, edita el Cuerpo de la solicitud.
Selecciona el botón Ejecutar. En la ventana emergente, elige la cuenta que deseas usar para realizar la solicitud.
En el panel Explorador de API, selecciona el ícono de expansión, , para expandir la ventana del Explorador de API.

Autocompletar (nuevo)

Solicitudes a Autocomplete (nuevas)

Acerca de la respuesta

Parámetros obligatorios

entrada

Parámetros opcionales

includedPrimaryTypes

includeQueryPredictions

includedRegionCodes

inputOffset

languageCode

locationBias o locationRestriction

locationBias

locationRestriction

origin

regionCode

sessionToken

Ejemplos de Autocomplete (nuevo)

Cómo usar locationRestriction y locationBias

Usa includePrimaryTypes

Solicita predicciones de consultas

Usar origen

Pruébalo