Method: places.searchText

Búsqueda de lugares basada en una búsqueda de texto.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación 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
}
Campos
textQuery

string

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

languageCode

string

Los detalles del lugar se mostrarán con el idioma preferido, si está disponible. Si el código de idioma no se especifica o no se reconoce, se pueden mostrar detalles de 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 Unicode de país o región (CLDR) de la ubicación de la que proviene la solicitud. Este parámetro se usa para mostrar los detalles del lugar, como el nombre específico de la región, si está disponible. El parámetro puede afectar los resultados según la ley aplicable.

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

Ten en cuenta que actualmente no se admiten los códigos regionales de 3 dígitos.

rankPreference

enum (RankPreference)

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

includedType

string

El tipo de lugar solicitado. Lista completa de los tipos admitidos: https://developers.google.com/maps/documentation/places/web-service/place-types. Solo 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(techo). 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 mostrar. Si la cantidad de resultados disponibles es mayor que maxResultCount, se muestra un nextPageToken que se puede pasar a pageToken para obtener la siguiente página de resultados en solicitudes posteriores. Si se proporciona 0 o no se proporciona ningún valor, se usa un valor predeterminado de 20. El valor máximo es 20; los valores superiores a 20 se convertirán a 20. Los valores negativos mostrarán un error INVALID_ARGUMENT.

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

pageSize

integer

Opcional. La cantidad máxima de resultados por página que se pueden mostrar. Si la cantidad de resultados disponibles es mayor que pageSize, se muestra un nextPageToken que se puede pasar a pageToken para obtener la siguiente página de resultados en solicitudes posteriores. Si se proporciona 0 o no se proporciona 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 mostrarán un error INVALID_ARGUMENT.

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

pageToken

string

Opcional. Un token de página, recibido de una llamada anterior de TextSearch. 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 que se proporcionan 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 marcados con ciertos niveles de precios. Los usuarios pueden elegir cualquier combinación de niveles de precios. Opción predeterminada para seleccionar todos los niveles de precios.

strictTypeFiltering

boolean

Se usa para establecer un filtrado de tipo estricto para includedType. Si la estableces como verdadera, solo se mostrarán resultados del mismo tipo. El valor predeterminado es falso.

locationBias

object (LocationBias)

La región que se buscará. Esta ubicación funciona como un sesgo, lo que significa que se pueden mostrar resultados alrededor de una ubicación determinada. No se puede configurar junto con locationRestriction.

locationRestriction

object (LocationRestriction)

La región que se buscará. Esta ubicación funciona como una restricción que significa que no se mostrarán resultados fuera de la ubicación determinada. No se puede configurar junto con locationBias.

evOptions

object (EVOptions)

Opcional. Establece las opciones de búsqueda de VE para una solicitud de búsqueda de lugares.

routingParameters

object (RoutingParameters)

Opcional. Parámetros adicionales para enrutar a los resultados.

searchAlongRouteParameters

object (SearchAlongRouteParameters)

Opcional. Protocolo de parámetros adicionales para buscar en una ruta.

includePureServiceAreaBusinesses

boolean

Opcional. Incluir empresas puras 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 proporciona sus servicios de forma directa, pero que no los atiende en su dirección comercial. Por ejemplo, empresas como los servicios de limpieza o los plomeros. Esas empresas no tienen una dirección física ni una ubicación en Google Maps. Los lugares no mostrarán campos que incluyan location, plusCode y otros campos relacionados con la ubicación para estas empresas.

Cuerpo de la respuesta

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)

Una lista de resúmenes de ruta en la que cada entrada se asocia al lugar correspondiente en el mismo índice en el campo places. Si el resumen de planificación de ruta no está disponible para uno de los lugares, contendrá una entrada vacía. Esta lista tendrá tantas entradas como la lista de lugares, si así se solicita.

contextualContents[]

object (ContextualContent)

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

Es una lista de contenido contextual en la que cada entrada se asocia al lugar correspondiente en el mismo índice del campo de lugares. Se prefieren los contenidos que son relevantes para el textQuery en la solicitud. Si el contenido contextual no está disponible para uno de los lugares, se mostrará contenido no contextual. Solo estará vacía cuando el contenido no esté disponible para este lugar. Si se solicita, esta lista tendrá tantas entradas como la lista de lugares.

nextPageToken

string

Es un token que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo 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 consulta de texto que se especifica en la solicitud en Google Maps.

RankPreference

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

Enumeraciones
RANK_PREFERENCE_UNSPECIFIED Para una búsqueda 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 no configures rankPreference.
DISTANCE Clasifica los resultados por distancia.
RELEVANCE Ordena los resultados por relevancia. El orden se determina según la pila de clasificación normal.

LocationBias

La región que se buscará. Esta ubicación sirve como un sesgo, lo que significa que es posible que se devuelvan resultados alrededor de una ubicación determinada.

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)

Un cuadro rectangular definido por las esquinas noreste y suroeste. rectangle.high() debe ser el punto noreste de la vista del rectángulo. rectangle.low() debe ser el punto suroeste del viewport rectangular. rectangle.low().latitude() no puede ser mayor que rectangle.high().latitude(). Esto generará un rango de latitud vacío. Un viewport rectangular no puede tener un ancho superior a 180 grados.

circle

object (Circle)

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

LocationRestriction

La región que se buscará. Esta ubicación funciona como una restricción, lo que significa que no se mostrarán resultados fuera de la ubicación determinada.

Representación JSON
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  }
  // 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)

Un cuadro rectangular definido por las esquinas noreste y suroeste. rectangle.high() debe ser el punto noreste de la vista del rectángulo. rectangle.low() debe ser el punto suroeste del viewport rectangular. rectangle.low().latitude() no puede ser mayor que rectangle.high().latitude(). Esto generará un rango de latitud vacío. Un viewport rectangular no puede tener un ancho superior a 180 grados.

EVOptions

Opciones de VE que se pueden buscar de 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 filtra un lugar con una tarifa de carga inferior a la especificada.

connectorTypes[]

enum (EVConnectorType)

Opcional. La lista de tipos de conectores de VE preferidos. Se filtran los lugares que no admiten ninguno de los tipos de conectores enumerados.

SearchAlongRouteParameters

Especifica un polilinea calculado previamente de la API de Routes que define la ruta que se buscará. La búsqueda a lo largo de una ruta es similar a usar 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, opcionalmente, mediante locationBias o locationRestriction en función de tiempos de desvío mínimos desde el origen hasta el destino. Los resultados pueden ser a lo largo de una ruta alternativa, especialmente si la polilínea proporcionada no define una ruta óptima del origen al destino.

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

object (Polyline)

Obligatorio. La polilínea de la ruta

Polilínea

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

Representación JSON
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string
  // End of list of possible types for union field polyline_type.
}
Campos
Campo de unión polyline_type. Encapsula el tipo de polilínea. El valor predeterminado de la salida de la API de Routes es encoded_polyline. polyline_type puede ser solo uno de los siguientes:
encodedPolyline

string

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

ContextualContent

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

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

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

object (Review)

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

photos[]

object (Photo)

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

justifications[]

object (Justification)

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

Justificaciones para el lugar

Justificación

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

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

Representación JSON
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
Campos

Campo de unión justification.

justification puede ser una de las siguientes opciones:

reviewJustification

object (ReviewJustification)

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

businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

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

ReviewJustification

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

Justificaciones de las opiniones de los usuarios Esto destaca una sección de la opinión del usuario que le podría interesar 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

El texto que destaca la justificación. Este es un subconjunto de la opinión en sí. La palabra exacta que se destacará se marca con HighlightedTextRange. Es posible que se destaquen varias palabras en el texto.

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 de texto destacado.

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

integer

endIndex

integer

BusinessAvailabilityAttributesJustification

Experimental: Consulta https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para obtener más información. 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 servicio de entrega.

dineIn

boolean

Si un lugar ofrece servicio de comida en sus instalaciones.