Text Search (nueva)

Selecciona la plataforma: Android iOS JavaScript Servicio web

Esta función requiere que habilites la API de Places (nueva), la nueva generación de la API de Places. Para obtener más información, consulta Cómo habilitar las APIs.

Text Search 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 establecida.

El servicio es especialmente útil para realizar consultas de direcciones ambiguas en un sistema automatizado, y los componentes de la cadena sin dirección pueden coincidir con empresas y direcciones. Algunos ejemplos de consultas de direcciones ambiguas son las direcciones con formato incorrecto o las solicitudes que incluyen componentes sin 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 región, restricción de ubicación o sesgo de ubicación).

"10 High Street, UK" o "123 Main Street, EE.UU."	varias "High Street" en el Reino Unido; varias "Main Street" en EE.UU. La consulta no muestra resultados deseables, a menos que se establezca una restricción de ubicación.
"Restaurante de cadena de Nueva York"	Varias ubicaciones de "Restaurante de cadena" en Nueva York, sin dirección ni nombre
"10 High Street, Escher UK" o "123 Main Street, Pleasanton US"	Solo una "High Street" en la ciudad de Escher, en el Reino Unido, y una sola "Calle Principal" en la ciudad estadounidense de Pleasanton, California.
"NombreDeRestaurante exclusivo Nueva York"	Solo hay un establecimiento con este nombre en Nueva York; no es necesario contar con una dirección para diferenciarlos.
"pizzas en Nueva York"	Esta consulta contiene su restricción de ubicación, y "pizzería" es un tipo de lugar bien definido. Muestra varios resultados.
"[phone]"	Esta consulta contiene un número de teléfono. Devuelve varios resultados para los lugares asociados con ese número de teléfono. Nota: Para obtener mejores resultados cuando buscas un número de teléfono, incluye el código de país seguido de un espacio y configura el parámetro regionCode para que coincida con el código de país.

Cómo obtener una lista de lugares con una búsqueda de texto

Realiza una solicitud de Text Search llamando a GMSPlacesClient searchByTextWithRequest: y pasando un objeto GMSPlaceSearchByTextRequest que defina los parámetros de la solicitud y un método de devolución de llamada del tipo GMSPlaceSearchByTextResultCallback para procesar la respuesta.

El objeto GMSPlaceSearchByTextRequest especifica todos los parámetros obligatorios y opcionales para la solicitud. Entre los parámetros obligatorios, se incluyen los siguientes:

• La lista de campos que se debe mostrar en el objeto GMSPlace, también llamada máscara de campo, según lo define GMSPlaceProperty. Si no especificas al menos un campo en la lista de campos o si omites la lista de campos, la llamada mostrará un error.
• La consulta de texto.

En este ejemplo de solicitud de búsqueda de texto, se especifica que los objetos GMSPlace de respuesta contienen el nombre y el ID del lugar de cada objeto GMSPlace en los resultados de la búsqueda. También filtra la respuesta para que solo se muestren lugares del tipo "restaurante".

Swift

// Create the GMSPlaceSearchByTextRequest object.
let myProperties = [GMSPlaceProperty.name, GMSPlaceProperty.placeID].map {$0.rawValue}
let request = GMSPlaceSearchByTextRequest(textQuery:"pizza in New York", placeProperties:myProperties)
request.isOpenNow = true
request.includedType = "restaurant"
request.maxResultCount = 5
request.minRating = 3.5
request.rankPreference = .distance
request.isStrictTypeFiltering = true
request.locationBias =  GMSPlaceCircularLocationOption(CLLocationCoordinate2DMake(40.7, -74.0), 200.0)

// Array to hold the places in the response
var placeResults: [GMSPlace] = []

let callback: GMSPlaceSearchByTextResultCallback = { [weak self] results, error in
  guard let self, error == nil else {
    if let error {
      print(error.localizedDescription)
    }
    return
  }
  guard let results = results as? [GMSPlace] else {
    return
  }
  placeResults = results
}

GMSPlacesClient.shared().searchByText(with: request, callback: callback)

Objective‑C

// Create the GMSPlaceSearchByTextRequest object.
GMSPlaceSearchByTextRequest *request =
    [[GMSPlaceSearchByTextRequest alloc] initWithTextQuery:@"pizza in New York" placeProperties:@[GMSPlacePropertyName, GMSPlacePropertyPlaceID]];
request.isOpenNow = YES;
request.includedType = @"restaurant";
request.maxResultCount = 5;
request.minRating = 3.5;
request.rankPreference = GMSPlaceSearchByTextRankPreferenceDistance;
request.isStrictTypeFiltering = YES;
request.priceLevels = @[ @(kGMSPlacesPriceLevelFree), @(kGMSPlacesPriceLevelCheap) ];
request.locationBias = GMSPlaceCircularLocationOption(CLLocationCoordinate2DMake(40.7, -74.0), 200.0);

// Array to hold the places in the response
_placeResults = [NSArray array];

// Create the GMSPlaceSearchByTextRequest object.
[_placesClient searchByTextWithRequest:request
    callback:^(NSArray<GMSPlace *> *_Nullable placeResults, NSError * _Nullable error) {
      if (error != nil) {
        NSLog(@"An error occurred %@", [error localizedDescription]);
        return;
      } else {
        if (placeResults.count > 0) {
          // Get list of places.
          _placeResults = placeResults;
      }
    }
  }
];

GooglePlacesSwift

let restriction = RectangularLocationRestriction(
      northEast: CLLocationCoordinate2D(latitude: 20, longitude: 30),
      southWest: CLLocationCoordinate2D(latitude: 40, longitude: 50)
)
let searchByTextRequest = SearchByTextRequest(
        textQuery: "pizza in New York",
        placeProperties: [ .name, .placeID ],
        locationRestriction: restriction,
        includedType: .restaurant,
        maxResultCount: 5,
        minRating: 3.5,
        priceLevels: [ .moderate, .inexpensive ],
        isStrictTypeFiltering: true
)
switch await placesClient.searchByText(with: searchByTextRequest) {
case .success(let places):
  // Handle places
case .failure(let placesError):
  // Handle error
}

Respuestas de Text Search

La API de Text Search muestra un array de coincidencias en forma de objetos GMSPlace, con un objeto GMSPlace por cada lugar coincidente.

Nota: Los campos del objeto GMSPlace de respuesta no pueden estar vacíos. Por ejemplo, si la lista de campos incluye GMSPlacePropertyPhotos para solicitar el campo photos en respuesta y el campo photos en la respuesta está vacío, se omite del objeto GMSPlace de respuesta.

Junto con los campos de datos, el objeto GMSPlace en la respuesta contiene las siguientes funciones de miembro:

• isOpen calcula si un lugar está abierto en un momento determinado.
• isOpenAtDate calcula si un lugar está abierto en una fecha determinada.

Nota: Estas funciones solo están disponibles cuando habilitas el SDK de Places para iOS. No están disponibles cuando habilitas el SDK de Places para iOS (nuevo). Para obtener más información, consulta Cómo elegir tu versión del SDK.

Parámetros obligatorios

Usa el objeto GMSPlaceSearchByTextRequest para especificar los parámetros necesarios para la búsqueda.

• Lista de campos

  Especifica qué propiedades de datos de lugar deseas devolver. Pasa una lista de propiedades GMSPlace en la que se especifican los campos de datos que se mostrarán. Si omites la máscara de campo, la solicitud mostrará un error.

  Las listas de campos constituyen 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 innecesarios.

  Especifica uno o más de los siguientes campos:

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

    GMSPlacePropertyPlaceID, GMSPlacePropertyName

  • Los siguientes campos activan el SKU de Text Search (Basic):

    GMSPlacePropertyAddressComponents, GMSPlacePropertyBusinessStatus, GMSPlacePropertyFormattedAddress, GMSPlacePropertyIconBackgroundColor, GMSPlacePropertyIconImageURL, GMSPlacePropertyCoordinate, GMSPlacePropertyPhotos, GMSPlacePropertyPlusCode, GMSPlacePropertyTypes, GMSPlacePropertyUTCOffsetMinutes, GMSPlacePropertyViewport y GMSPlacePropertyWheelchairAccessibleEntrance

  • Los siguientes campos activan el SKU de Text Search (Advanced):

    GMSPlacePropertyCurrentOpeningHours, GMSPlacePropertySecondaryOpeningHours, GMSPlacePropertyPhoneNumber, GMSPlacePropertyPriceLevel, GMSPlacePropertyRating, GMSPlacePropertyOpeningHours, GMSPlacePropertyUserRatingsTotal y GMSPlacePropertyWebsite

  • Los siguientes campos activan el SKU de Text Search (Preferred):

    GMSPlacePropertyCurbsidePickup, GMSPlacePropertyDelivery, GMSPlacePropertyDineIn, GMSPlacePropertyEditorialSummary, GMSPlacePropertyReservable, GMSPlacePropertyReviews, GMSPlacePropertyServesBeer, GMSPlacePropertyServesBreakfast, GMSPlacePropertyServesBrunch, GMSPlacePropertyServesDinner, GMSPlacePropertyServesLunch, GMSPlacePropertyServesVegetarianFood, GMSPlacePropertyServesWine y GMSPlacePropertyTakeout

• textQuery

  Es la cadena de texto en la que se busca, por ejemplo: "restaurante", "calle principal 123" o "mejor lugar para visitar en San Francisco".

Parámetros opcionales

Usa el objeto GMSPlaceSearchByTextRequest para especificar los parámetros opcionales de la búsqueda.

• includedType

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

  • request.includedType = "bar"
  • request.includedType = "pharmacy"
  Nota: Los valores de la Tabla B solo se muestran en la respuesta. No puedes usar los valores de la Tabla B como filtro.

• isOpenNow

  Si es true, muestra solo los lugares que están abiertos en el momento en que se envía la consulta. Si es false, muestra todas las empresas, independientemente de su estado abierto. 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.

• isStrictTypeFiltering

  Se usa con el parámetro includeType. Cuando se establece en true, solo se muestran los lugares que coinciden con los tipos especificados por includeType. Cuando es falso, el valor predeterminado, la respuesta puede contener lugares que no coinciden con los tipos especificados.

• 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.

  Puedes especificar locationRestriction o locationBias, pero no ambos. 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.
  Nota: El parámetro locationBias se puede anular si textQuery contiene una ubicación explícita, como Market in Barcelona. En este caso, se ignora locationBias.

  Especifique la región 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 estar entre 0.0 y 50,000.0, inclusive. El radio predeterminado es 0.0. Por ejemplo:

    request.locationBias =  GMSPlaceCircularLocationOption(CLLocationCoordinate2DMake(40.7, -74.0), 200.0)
    

  • Un rectángulo es un viewport de latitud y longitud, representado como dos puntos bajos y altos en diagonal. El punto inferior marca la esquina suroeste del rectángulo y el punto alto representa la esquina nordeste 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 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.
    • Si low.latitude > high.latitude, el rango de latitud está vacío.

• locationRestriction

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

  Puedes especificar locationRestriction o locationBias, pero no ambos. 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.

• maxResultCount

  Especifica la cantidad máxima de resultados de lugares que se mostrarán. Debe ser un valor entre 1 y 20 (valor predeterminado) inclusive.

• minRating

  Restringe los resultados solo a aquellos cuya calificación promedio de los usuarios es mayor o igual que 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 punto 0.5 más cercano. Por ejemplo, un valor de 0.6 elimina todos los resultados con una calificación inferior a 1.0.

• priceLevels

  Restringe la búsqueda a los lugares marcados en determinados niveles de precios. La opción predeterminada es seleccionar todos los niveles de precios.

  Especifica un array de uno o más valores definidos por PriceLevel.

  Nota: PRICE_LEVEL_FREE no se permite en una solicitud. Solo se usa para propagar la respuesta.

  Por ejemplo:

  request.priceLevels = [GMSPlacesPriceLevel.moderate.rawValue, GMSPlacesPriceLevel.cheap.rawValue]

• rankPreference

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

  • Para una consulta categórica como "Restaurantes en la ciudad de Nueva York", .relevance (resultados de clasificación por relevancia de búsqueda) es el valor predeterminado. Puedes establecer rankPreference en .relevance o .distance (clasificar los resultados por distancia).
  • Para una consulta no categórica, como "Mountain View, CA", te recomendamos que no configures rankPreference.

• regionCode

  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 la dirección en la respuesta coincide con el código de región, el código de país se omite de la dirección.

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

Mostrar atribuciones en tu aplicación

Cuando tu app muestra información obtenida de GMSPlacesClient, como fotos y opiniones, también debe mostrar las atribuciones requeridas.

Por ejemplo, la propiedad reviews del objeto GMSPlacesClient contiene un array de hasta cinco objetos GMSPlaceReview. Cada objeto GMSPlaceReview puede contener atribuciones y atribuciones de autor. Si muestras la opinión en tu app, también debes mostrar cualquier atribución o atribución de autor.

Para obtener más información, consulta la documentación sobre las atribuciones.