Text Search (nueva)

Selecciona la plataforma: Android iOS JavaScript Servicio web

Desarrolladores del Espacio Económico Europeo (EEE)

Text Search (nuevo) devuelve información sobre un conjunto de lugares en función de una cadena; por ejemplo, "pizza en Buenos Aires", "tiendas de zapatos cerca de Santiago" o "Calle principal 123". El servicio responde con una lista de lugares que coinciden con la cadena de texto y con cualquier personalización de ubicación que se haya establecido.

El servicio es especialmente útil para realizar búsquedas de direcciones ambiguas en un sistema automatizado, y los componentes que no son de dirección de la cadena también pueden coincidir con empresas y direcciones. Algunos ejemplos de búsquedas de direcciones ambiguas son las direcciones con formato incorrecto o las solicitudes que incluyen componentes que no son de dirección, como nombres de empresas. Las solicitudes como los dos primeros ejemplos pueden devolver cero resultados, a menos que se establezca una ubicación, como una región, una restricción de ubicación o una preferencia de ubicación.

Text Search (nueva) es similar a Nearby Search (nueva). La principal diferencia entre ambos es que Text Search (nuevo) te permite especificar una cadena de búsqueda arbitraria, mientras que Nearby Search (nuevo) requiere un área específica en la que buscar.

"10 High Street, Reino Unido" o "123 Main Street, EE.UU." Varias "High Street" en el Reino Unido y varias "Main Street" en EE.UU. La búsqueda no devuelve los resultados deseados, a menos que se establezca una restricción de ubicación.
"ChainRestaurant New York" Varias ubicaciones de "ChainRestaurant" en Nueva York; no hay dirección ni nombre de calle.
"10 High Street, Escher UK" o "123 Main Street, Pleasanton US" Solo hay una "High Street" en la ciudad de Escher, Reino Unido, y solo una "Main Street" en la ciudad de Pleasanton, California, EE.UU.
"UniqueRestaurantName New York" Solo hay un establecimiento con este nombre en Nueva York, por lo que no se necesita una dirección para diferenciarlo.
"Pizzerías en Nueva York" Esta búsqueda contiene su restricción de ubicación, y "pizzerías" es un tipo de lugar bien definido. Devuelve varios resultados.
"+1 514-670-8700"

Esta búsqueda contiene un número de teléfono. Devuelve varios resultados para los lugares asociados a ese número de teléfono.

Solicitudes de Text Search

Una solicitud de Text Search tiene el siguiente formato:

// Specify the list of fields to return.
final List<Place.Field> placeFields = Arrays.asList(Place.Field.ID, Place.Field.DISPLAY_NAME);

// Define latitude and longitude coordinates of the search area.
LatLng southWest = new LatLng(37.38816277477739, -122.08813770258874);
LatLng northEast = new LatLng(37.39580487866437, -122.07702325966572);

// Use the builder to create a SearchByTextRequest object.
final SearchByTextRequest searchByTextRequest = SearchByTextRequest.builder("Spicy Vegetarian Food", placeFields)
  .setMaxResultCount(10)
  .setLocationRestriction(RectangularBounds.newInstance(southWest, northEast)).build();

// Call PlacesClient.searchByText() to perform the search.
// Define a response handler to process the returned List of Place objects.
placesClient.searchByText(searchByTextRequest)
    .addOnSuccessListener(response -> {
      List<Place> places = response.getPlaces();
    });

En este ejemplo, harás lo siguiente:

  • Configura la lista de campos para que incluya solo Place.Field.ID y Place.Field.DISPLAY_NAME. Esto significa que los objetos Place de la respuesta que representan cada lugar coincidente solo contienen esos dos campos.

  • Usa SearchByTextRequest.Builder para crear un objeto SearchByTextRequest que defina la búsqueda.

    • Establece la cadena de consulta de texto en "Comida vegetariana picante".

    • Establece la cantidad máxima de lugares de resultados en 10. El valor predeterminado y el máximo es 20.

    • Restringe el área de búsqueda al rectángulo definido por las coordenadas de latitud y longitud. No se devuelven coincidencias fuera de esta área.

  • Agrega un OnSuccessListener y obtén los lugares coincidentes del objeto SearchByTextResponse.

Respuestas de Text Search

La clase SearchByTextResponse representa la respuesta de una solicitud de búsqueda. Un objeto SearchByTextResponse contiene lo siguiente:

  • Es una lista de objetos Place que representan todos los lugares coincidentes, con un objeto Place por lugar coincidente.

  • Cada objeto Place solo contiene los campos definidos por la lista de campos que se pasó en la solicitud.

Por ejemplo, en la solicitud, definiste una lista de campos de la siguiente manera:

// Specify the list of fields to return.
final List<Place.Field> placeFields = Arrays.asList(Place.Field.ID, Place.Field.DISPLAY_NAME);

Esta lista de campos significa que cada objeto Place de la respuesta contiene solo el ID y el nombre de cada lugar coincidente. Luego, puedes usar los métodos Place.getId() y Place.getName() para acceder a estos campos en cada objeto Place.

Para obtener más ejemplos de cómo acceder a los datos en un objeto Place, consulta Cómo acceder a los campos de datos del objeto Place.

Parámetros obligatorios

Los parámetros obligatorios para SearchByTextRequest son los siguientes:

  • Lista de campos

    Especifica qué campos de datos de lugar se deben devolver. Pasa una lista de valores de Place.Field que especifiquen los campos de datos que se devolverán. No hay una lista predeterminada de campos devueltos en la respuesta.

    Las listas de campos son una práctica de diseño recomendada para garantizar que no solicites datos innecesarios, lo que ayuda a evitar tiempos de procesamiento y cargos de facturación adicionales.

    Especifica uno o más de los siguientes campos:

    • Los siguientes campos activan el SKU de Text Search Essentials (solo ID):

      Place.Field.DISPLAY_NAME*
          * Úsalo en lugar de Place.Field.NAME (obsoleto en la versión 4.0).
      Place.Field.ID
      Place.Field.RESOURCE_NAME*
          * Contiene el nombre del recurso de lugar con el siguiente formato: places/PLACE_ID.
           Usa DISPLAY_NAME para acceder al nombre del lugar en forma de texto.
    • Los siguientes campos activan el SKU de Text Search Pro:

      Place.Field.ACCESSIBILITY_OPTIONS*
          Úsalo en lugar de Place.Field.WHEELCHAIR_ACCESSIBLE_ENTRANCE (obsoleto).
      Place.Field.ADDRESS_COMPONENTS
      Place.Field.ADR_FORMAT_ADDRESS
      Place.Field.BUSINESS_STATUS
      Place.Field.FORMATTED_ADDRESS*
          Úsalo en lugar de Place.Field.ADDRESS (obsoleto).
      Place.Field.GOOGLE_MAPS_URI
      Place.Field.ICON_BACKGROUND_COLOR
      Place.Field.ICON_MASK_URL *
          Usa en lugar de Place.Field.ICON_URL (obsoleto).
      Place.Field.LOCATION*
          Úsalo en lugar de Place.Field.LAT_LNG (obsoleto).
      Place.Field.PHOTO_METADATAS
      Place.Field.PLUS_CODE
      Place.Field.PRIMARY_TYPE
      Place.Field.PRIMARY_TYPE_DISPLAY_NAME
      Place.Field.SHORT_FORMATTED_ADDRESS
      Place.Field.SUB_DESTINATIONS
      Place.Field.TYPES
      Place.Field.UTC_OFFSET
      Place.Field.VIEWPORT
    • Los siguientes campos activan el SKU de Text Search Enterprise:

      Place.Field.CURRENT_OPENING_HOURS
      Place.Field.CURRENT_SECONDARY_OPENING_HOURS
      Place.Field.INTERNATIONAL_PHONE_NUMBER*
          * Úsalo en lugar de Place.Field.PHONE_NUMBER, que está obsoleto.
      Place.Field.NATIONAL_PHONE_NUMBER
      Place.Field.OPENING_HOURS
      Place.Field.PRICE_LEVEL
      Place.Field.RATING
      Place.Field.SECONDARY_OPENING_HOURS
      Place.Field.USER_RATING_COUNT*
          * Úsalo en lugar de Place.Field.USER_RATINGS_TOTAL, que está obsoleto.
      Place.Field.WEBSITE_URI
    • Los siguientes campos activan el SKU de Text Search Enterprise Plus:

      Place.Field.ALLOWS_DOGS
      Place.Field.CURBSIDE_PICKUP
      Place.Field.DELIVERY
      Place.Field.DINE_IN
      Place.Field.EDITORIAL_SUMMARY
      Place.Field.EV_CHARGE_OPTIONS
      Place.Field.FUEL_OPTIONS
      Place.Field.GOOD_FOR_CHILDREN
      Place.Field.GOOD_FOR_GROUPS
      Place.Field.GOOD_FOR_WATCHING_SPORTS
      Place.Field.LIVE_MUSIC
      Place.Field.MENU_FOR_CHILDREN
      Place.Field.OUTDOOR_SEATING
      Place.Field.PARKING_OPTIONS
      Place.Field.PAYMENT_OPTIONS
      Place.Field.RESERVABLE
      Place.Field.RESTROOM
      Place.Field.REVIEWS
      Place.Field.SERVES_BEER
      Place.Field.SERVES_BREAKFAST
      Place.Field.SERVES_BRUNCH
      Place.Field.SERVES_COCKTAILS
      Place.Field.SERVES_COFFEE
      Place.Field.SERVES_DESSERT
      Place.Field.SERVES_DINNER
      Place.Field.SERVES_LUNCH
      Place.Field.SERVES_VEGETARIAN_FOOD
      Place.Field.SERVES_WINE
      Place.Field.TAKEOUT

    Para establecer el parámetro de lista de campos, llama al método setPlaceFields() cuando compiles el objeto SearchByTextRequest.

  • Consulta de texto

    Es la cadena de texto en la que se basa la búsqueda, por ejemplo, "restaurante", "calle principal 123" o "el mejor lugar para visitar en San Francisco". La API devuelve posibles coincidencias en función de esta cadena y ordena los resultados según la relevancia percibida.

    Para configurar el parámetro de consulta de texto, llama al método setTextQuery() cuando compiles el objeto SearchByTextRequest.

Parámetros opcionales

Usa el objeto SearchByTextRequest para especificar los parámetros opcionales de tu solicitud.

  • Tipo de inclusión

    Restringe los resultados a los lugares que coinciden con el tipo especificado definido por la Tabla A. Solo se puede especificar un tipo. Por ejemplo:

    • setIncludedType("bar")
    • setIncludedType("pharmacy")

    Para establecer el parámetro de tipo incluido, llama al método setIncludedType() cuando compiles el objeto SearchByTextRequest.

  • Sesgo de ubicación

    Especifica un área para la búsqueda. Esta ubicación sirve como sesgo, lo que significa que se pueden devolver resultados alrededor de la ubicación especificada, incluidos los resultados fuera del área especificada.

    Puedes especificar una restricción o una preferencia de ubicación, pero no ambas. Piensa en la restricción de ubicación como la especificación de la región en la que deben estar los resultados, y en la restricción de ubicación como la especificación de la región en la que es probable que estén los resultados o cerca de ella. Ten en cuenta que, cuando se usa la restricción de ubicación, los resultados pueden estar fuera del área especificada.

    Especifica la región como un viewport rectangular o como un círculo.

    • Un círculo se define por un punto central y un radio en metros. El radio debe estar entre 0.0 y 50000.0, ambos incluidos. Por ejemplo:

      // Define latitude and longitude coordinates of the center of the search area.
      LatLng searchCenter = new LatLng(37.38816277477739, -122.08813770258874);
      
      // Use the builder to create a SearchByTextRequest object.
      // Set the radius of the search area to 500.0 meters.
      final SearchByTextRequest searchByTextRequest = SearchByTextRequest.builder("Spicy Vegetarian Food", placeFields)
        .setMaxResultCount(10)
        .setLocationBias(CircularBounds.newInstance(searchCenter, 500.0)).build();
    • Un rectángulo es una ventana gráfica de latitud y longitud, representada como dos puntos bajos y altos diagonalmente opuestos. El punto bajo marca la esquina suroeste del rectángulo, y el punto alto representa la esquina noreste del rectángulo.

      Un viewport se considera una región cerrada, lo que significa que incluye su límite. Los límites de latitud deben estar entre -90 y 90 grados inclusive, y los límites de longitud deben estar entre -180 y 180 grados inclusive:

      • Si low = high, el viewport consta de ese único punto.
      • Si low.longitude > high.longitude, el rango de longitud se invierte (el viewport cruza la línea de longitud de 180 grados).
      • Si low.longitude = -180 grados y high.longitude = 180 grados, la ventana gráfica incluye todas las longitudes.
      • Si low.longitude = 180 grados y high.longitude = -180 grados, el rango de longitud está vacío.
      • Si low.latitude > high.latitude, el rango de latitud está vacío.

      Se deben completar los valores bajo y alto, y el cuadro representado no puede estar vacío. Un viewport vacío genera un error.

      Por ejemplo, para ver un ejemplo de una ventana gráfica rectangular, consulta Solicitudes de Text Search.

      Para establecer el parámetro de sesgo de ubicación, llama al método setLocationBias() cuando compiles el objeto SearchByTextRequest.

  • Restricción de ubicación

    Especifica un área para la búsqueda. No se muestran los resultados fuera del área especificada. Especifica la región como un viewport rectangular. Consulta la descripción de Sesgo de ubicación para obtener información sobre cómo definir la ventana gráfica.

    Puedes especificar una restricción o una preferencia de ubicación, pero no ambas. Piensa en la restricción de ubicación como la especificación de la región dentro de la cual deben estar los resultados, y en la preferencia de ubicación como la especificación de la región cerca de la cual deben estar los resultados, pero pueden estar fuera del área.

    Para establecer el parámetro de restricción de ubicación, llama al método setLocationRestriction() cuando compiles el objeto SearchByTextRequest.

  • Recuento máximo de resultados

    Especifica la cantidad máxima de resultados de lugares que se devolverán. Debe estar entre 1 y 20 (valor predeterminado), ambos incluidos.

    Para establecer el parámetro de recuento máximo de resultados, llama al método setMaxResultCount() cuando compiles el objeto SearchByTextRequest.

  • Calificación mínima

    Restringe los resultados solo a aquellos cuya calificación promedio de los usuarios sea mayor o igual a este límite. Los valores deben estar entre 0.0 y 5.0 (inclusive) en incrementos de 0.5. Por ejemplo: 0, 0.5, 1.0, …, 5.0 inclusive. Los valores se redondean al 0.5 más cercano. Por ejemplo, un valor de 0.6 elimina todos los resultados con una calificación inferior a 1.0.

    Para establecer el parámetro de calificación mínima, llama al método setMinRating() cuando compiles el objeto SearchByTextRequest.

  • Abierto ahora

    Si es true, devuelve solo los lugares que están abiertos en el momento en que se envía la búsqueda. Si es false, se muestran todas las empresas, independientemente de su estado. Los lugares que no especifican los horarios de atención en la base de datos de Google Places se muestran si estableces este parámetro en false.

    Para establecer el parámetro de abrir ahora, llama al método setOpenNow() cuando compiles el objeto SearchByTextRequest.

  • Niveles de precios

    De forma predeterminada, los resultados incluyen lugares que brindan servicios en todos los niveles de precios. Para restringir los resultados de modo que solo incluyan lugares con niveles de precios particulares, puedes pasar una lista de valores enteros que correspondan a los niveles de precios de los lugares que deseas devolver:

    • 1: El lugar ofrece servicios económicos.
    • 2: El lugar ofrece servicios a precios moderados.
    • 3: El lugar ofrece servicios costosos.
    • 4: El lugar ofrece servicios muy costosos.

    Para establecer el parámetro de niveles de precios, llama al método setPriceLevels() cuando compiles el objeto SearchByTextRequest.

  • Preferencia de clasificación

    Especifica cómo se clasifican los resultados en la respuesta según el tipo de consulta:

    • Para una búsqueda categórica, como "Restaurantes en la ciudad de Nueva York", SearchByTextRequest.RankPreference.RELEVANCE (ordenar los resultados por relevancia de la búsqueda) es el valor predeterminado. Puedes establecer la preferencia de clasificación en SearchByTextRequest.RankPreference.RELEVANCE o SearchByTextRequest.RankPreference.DISTANCE (clasificar los resultados por distancia).
    • Para una búsqueda no categórica, como "Mountain View, CA", te recomendamos que no configures el parámetro de preferencia de clasificación.

    Para establecer el parámetro de preferencia de clasificación, llama al método setRankPreference() cuando compiles el objeto SearchByTextRequest.

  • Código de la región

    Es el código de región que se usa para dar formato a la respuesta, especificado como un valor de código CLDR de dos caracteres. Este parámetro también puede tener un efecto de sesgo en los resultados de la búsqueda. No hay un valor predeterminado.

    Si el nombre del país del campo de dirección en la respuesta coincide con el código de región, se omite el código de país de la dirección.

    La mayoría de los códigos de CLDR 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 de "El Reino Unido de Gran Bretaña e Irlanda del Norte"). El parámetro puede afectar los resultados según la legislación aplicable.

    Para establecer el parámetro del código de región, llama al método setRegionCode() cuando compiles el objeto SearchByTextRequest.

  • Filtrado de tipos estricto

    Se usa con el parámetro de tipo de inclusión. Cuando se establece en true, solo se muestran los lugares que coinciden con los tipos especificados por include_type. Cuando es false (valor predeterminado), la respuesta puede contener lugares que no coinciden con los tipos especificados.

    Para configurar el parámetro de filtrado de tipo estricto, llama al método setStrictTypeFiltering() cuando compiles el objeto SearchByTextRequest.