Method: places.searchText

Búsqueda de lugares basada en consultas de texto.

Solicitud HTTP

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

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
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "pageSize": integer,
  "pageToken": string,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  },
  "routingParameters": {
    object (RoutingParameters)
  },
  "searchAlongRouteParameters": {
    object (SearchAlongRouteParameters)
  },
  "includePureServiceAreaBusinesses": boolean,
  "includeFutureOpeningBusinesses": boolean
}
Campos
textQuery

string

Obligatorio. Es la consulta de texto para la búsqueda textual.

languageCode

string

Los detalles del lugar se mostrarán en el idioma preferido, si está disponible. Si no se especifica o no se reconoce el código de idioma, es posible que se devuelvan los detalles del lugar en cualquier idioma, con preferencia por el inglés si existen esos detalles.

Lista actual de idiomas admitidos: https://developers.google.com/maps/faq#languagesupport.

regionCode

string

Es el código de país o región de Unicode (CLDR) de la ubicación de donde proviene la solicitud. Este parámetro se usa para mostrar los detalles del lugar, como el nombre del lugar específico de la región, si está disponible. El parámetro puede afectar los resultados según la legislación aplicable.

Para obtener más información, consulta https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

Ten en cuenta que, por el momento, no se admiten los códigos de región de 3 dígitos.

rankPreference

enum (RankPreference)

Cómo se clasificarán los resultados en la respuesta.

includedType

string

Es el tipo de lugar solicitado. Lista completa de los tipos admitidos: https://developers.google.com/maps/documentation/places/web-service/place-types. Solo se admite un tipo incluido.

openNow

boolean

Se usa para restringir la búsqueda a los lugares que están abiertos en ese momento. El valor predeterminado es falso.

minRating

number

Filtra los resultados cuya calificación promedio de los usuarios sea estrictamente inferior a este límite. Un valor válido debe ser un número de punto flotante entre 0 y 5 (inclusive) con una cadencia de 0.5, es decir, [0, 0.5, 1.0, ..., 5.0] inclusive. La calificación de entrada se redondeará al 0.5 más cercano(límite superior). Por ejemplo, una calificación de 0.6 eliminará todos los resultados con una calificación inferior a 1.0.

maxResultCount
(deprecated)

integer

Obsoleto: Usa pageSize en su lugar.

Es la cantidad máxima de resultados por página que se pueden devolver. Si la cantidad de resultados disponibles es mayor que maxResultCount, se devuelve un nextPageToken que se puede pasar a pageToken para obtener la siguiente página de resultados en las solicitudes posteriores. Si se proporciona 0 o ningún valor, se usa un valor predeterminado de 20. El valor máximo es 20; los valores superiores a 20 se convertirán en 20. Los valores negativos devolverán un error INVALID_ARGUMENT.

Si se especifican maxResultCount y pageSize, se ignorará maxResultCount.

pageSize

integer

Opcional. Es la cantidad máxima de resultados por página que se pueden devolver. Si la cantidad de resultados disponibles es mayor que pageSize, se devuelve un nextPageToken que se puede pasar a pageToken para obtener la siguiente página de resultados en las solicitudes posteriores. Si se proporciona 0 o ningún valor, se usa un valor predeterminado de 20. El valor máximo es 20; los valores superiores a 20 se establecerán en 20. Los valores negativos devolverán un error INVALID_ARGUMENT.

Si se especifican maxResultCount y pageSize, se ignorará maxResultCount.

pageToken

string

Opcional. Es un token de página, recibido desde una llamada a TextSearch anterior. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, todos los parámetros que no sean pageToken, pageSize y maxResultCount proporcionados a TextSearch deben coincidir con la llamada inicial que proporcionó el token de página. De lo contrario, se muestra un error INVALID_ARGUMENT.

priceLevels[]

enum (PriceLevel)

Se usa para restringir la búsqueda a lugares que están marcados con ciertos niveles de precios. Los usuarios pueden elegir cualquier combinación de niveles de precios. De forma predeterminada, se seleccionan todos los niveles de precios.

strictTypeFiltering

boolean

Se usa para establecer un filtrado de tipo estricto para includedType. Si se establece como verdadero, solo se devolverán los resultados del mismo tipo. La configuración predeterminada es falso.

locationBias

object (LocationBias)

Es la región en la que se realizará la búsqueda. Esta ubicación sirve como sesgo, lo que significa que se podrían devolver resultados en torno a la ubicación determinada. No se puede establecer junto con locationRestriction.

locationRestriction

object (LocationRestriction)

Es la región en la que se realizará la búsqueda. Esta ubicación funciona como una restricción, lo que significa que no se mostrarán los resultados que se encuentren fuera de ella. No se puede establecer junto con locationBias.

evOptions

object (EVOptions)

Opcional. Establece las opciones de VE que se pueden buscar en una solicitud de búsqueda de lugares.

routingParameters

object (RoutingParameters)

Opcional. Son parámetros adicionales para enrutar a los resultados.

searchAlongRouteParameters

object (SearchAlongRouteParameters)

Opcional. Es el proto de parámetros adicionales para buscar a lo largo de una ruta.

includePureServiceAreaBusinesses

boolean

Opcional. Incluye empresas exclusivamente de servicio en el área si el campo se establece en 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 o una ubicación en Google Maps. Places no devolverá campos como location, plusCode y otros relacionados con la ubicación de estas empresas.

includeFutureOpeningBusinesses

boolean

Opcional. Si se establece como verdadero, se incluyen las empresas que aún no están abiertas, pero que abrirán en el futuro.

Cuerpo de la respuesta

Es el proto de respuesta para places.searchText.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string,
  "searchUri": string
}
Campos
places[]

object (Place)

Es una lista de lugares que cumplen con los criterios de búsqueda de texto del usuario.

routingSummaries[]

object (RoutingSummary)

Es una lista de resúmenes de rutas en la que cada entrada se asocia con el lugar correspondiente en el mismo índice del campo places. Si el resumen de rutas no está disponible para uno de los lugares, contendrá una entrada vacía. Esta lista tendrá tantas entradas como la lista de lugares, si se solicita.

contextualContents[]

object (ContextualContent)

Experimental: Consulta https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para obtener más detalles.

Es una lista de contenidos contextuales en la que cada entrada se asocia con el lugar correspondiente en el mismo índice del campo places. Se prefiere el contenido que sea relevante para el textQuery de la solicitud. Si el contenido contextual no está disponible para uno de los lugares, se devolverá contenido no contextual. Solo estará vacío cuando el contenido no esté disponible para este lugar. Esta lista tendrá tantas entradas como la lista de lugares, si se solicita.

nextPageToken

string

Es un token que se puede enviar como pageToken para recuperar la página siguiente. Si este campo se omite o está vacío, no habrá páginas siguientes.

searchUri

string

Un vínculo permite que el usuario realice una búsqueda con la misma búsqueda de texto que se especifica en la solicitud en Google Maps.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

RankPreference

Cómo se clasificarán los resultados en la respuesta.

Enums
RANK_PREFERENCE_UNSPECIFIED Para una consulta categórica, como "Restaurantes en la ciudad de Nueva York", RELEVANCE es el valor predeterminado. Para las búsquedas no categóricas, como "Mountain View, CA", te recomendamos que dejes rankPreference sin configurar.
DISTANCE Clasifica los resultados por distancia.
RELEVANCE Clasifica los resultados por relevancia. El orden de clasificación se determina según la pila de clasificación normal.

LocationBias

Es la región en la que se realizará la búsqueda. Esta ubicación sirve como sesgo, lo que significa que se podrían devolver resultados en torno a la ubicación determinada.

Representación JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of mutually exclusive fields.
}
Campos
La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
rectangle

object (Viewport)

Es un cuadro rectangular definido por las esquinas noreste y suroeste. rectangle.high() debe ser el punto noreste del viewport rectangular. rectangle.low() debe ser el punto sudoeste del viewport del rectángulo. rectangle.low().latitude() no puede ser mayor que rectangle.high().latitude(). Esto dará como resultado un rango de latitud vacío. Un viewport rectangular no puede tener más de 180 grados de ancho.

circle

object (Circle)

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

Fin de los campos mutuamente excluyentes.

LocationRestriction

Es la región en la que se realizará la búsqueda. Esta ubicación funciona como una restricción, lo que significa que no se mostrarán los resultados que se encuentren fuera de ella.

Representación JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "rectangle": {
    object (Viewport)
  }
  // End of mutually exclusive fields.
}
Campos
La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
rectangle

object (Viewport)

Es un cuadro rectangular definido por las esquinas noreste y suroeste. rectangle.high() debe ser el punto noreste del viewport rectangular. rectangle.low() debe ser el punto sudoeste del viewport del rectángulo. rectangle.low().latitude() no puede ser mayor que rectangle.high().latitude(). Esto dará como resultado un rango de latitud vacío. Un viewport rectangular no puede tener más de 180 grados de ancho.

Fin de los campos mutuamente excluyentes.

EVOptions

Son las opciones de VE que se pueden buscar en una solicitud de búsqueda de lugares.

Representación JSON
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
Campos
minimumChargingRateKw

number

Opcional. Es la tasa de carga mínima requerida en kilovatios. Se filtran los lugares con una velocidad de carga inferior a la especificada.

connectorTypes[]

enum (EVConnectorType)

Opcional. Es la lista de tipos de conectores de VE preferidos. Se filtran los lugares que no admiten ninguno de los tipos de conectores indicados.

SearchAlongRouteParameters

Especifica una polilínea calculada previamente de la API de Routes que define la ruta que se buscará. La búsqueda a lo largo de una ruta es similar al uso de la opción de solicitud locationBias o locationRestriction para sesgar los resultados de la búsqueda. Sin embargo, mientras que las opciones locationBias y locationRestriction te permiten especificar una región para sesgar los resultados de la búsqueda, esta opción te permite sesgar los resultados a lo largo de una ruta de viaje.

No se garantiza que los resultados se encuentren a lo largo de la ruta proporcionada, sino que se clasifican dentro del área de búsqueda definida por la polilínea y, de manera opcional, por el locationBias o el locationRestriction en función de los tiempos mínimos de desvío desde el origen hasta el destino. Los resultados podrían estar a lo largo de una ruta alternativa, en especial si la polilínea proporcionada no define una ruta óptima desde el origen hasta el destino.

Representación JSON
{
  "polyline": {
    object (Polyline)
  }
}
Campos
polyline

object (Polyline)

Obligatorio. Es la polilínea de la ruta.

Polilínea

Es una polilínea de ruta. Solo admite una polilínea codificada, que se puede pasar como una cadena y que incluye compresión con una pérdida mínima. Este es el resultado predeterminado de la API de Routes.

Representación JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "encodedPolyline": string
  // End of mutually exclusive fields.
}
Campos
Encapsula el tipo de polilínea. El resultado predeterminado de la API de Routes es encoded_polyline. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
encodedPolyline

string

Una polilínea codificada, como la que devuelve la API de Routes de forma predeterminada. Consulta las herramientas de codificador y decodificador.

Fin de los campos mutuamente excluyentes.

ContextualContent

Es el contenido contextual de la búsqueda de lugar.

Representación JSON
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
Campos
reviews[]

object (Review)

Es una lista de opiniones sobre este lugar, contextuales a la búsqueda del lugar.

photos[]

object (Photo)

Información (incluidas las referencias) sobre las fotos de este lugar, contextualizada para la búsqueda del lugar.

justifications[]

object (Justification)

Justificaciones del lugar.

Justificación

Justificaciones del lugar. Las justificaciones responden a la pregunta de por qué un lugar podría interesar a un usuario final.

Representación JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of mutually exclusive fields.
}
Campos
La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
reviewJustification

object (ReviewJustification)

businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

Fin de los campos mutuamente excluyentes.

ReviewJustification

Justificaciones de las opiniones de los usuarios Esto destaca una sección de la opinión del usuario que podría interesarle a un usuario final. Por ejemplo, si la búsqueda es "pizza a la leña", la justificación de la opinión destaca el texto relevante para la búsqueda.

Representación JSON
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
Campos
highlightedText

object (HighlightedText)

review

object (Review)

La opinión a partir de la cual se genera el texto destacado.

HighlightedText

Es el texto que se destaca en la justificación. Este es un subconjunto de la opinión en sí. La palabra exacta que se debe destacar se marca con HighlightedTextRange. Podría haber varias palabras en el texto que se está destacando.

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

string

highlightedTextRanges[]

object (HighlightedTextRange)

Es la lista de los rangos del texto destacado.

HighlightedTextRange

Es el rango del texto destacado.

Representación JSON
{
  "startIndex": integer,
  "endIndex": integer
}
Campos
startIndex

integer

endIndex

integer

BusinessAvailabilityAttributesJustification

Justificaciones de BusinessAvailabilityAttributes. Aquí se muestran algunos atributos que tiene una empresa y que podrían interesar a un usuario final.

Representación JSON
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
Campos
takeout

boolean

Si un lugar ofrece comida para llevar.

delivery

boolean

Si un lugar ofrece entrega a domicilio

dineIn

boolean

Si un lugar ofrece consumo en el establecimiento.