Method: places.searchText

Búsqueda de lugares basada en búsquedas 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)
  }
}
Campos
textQuery

string

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

languageCode

string

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

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

regionCode

string

El código Unicode de país o región (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 una 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 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

Excluye 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á hacia arriba al punto 0.5(techo) más cercano. 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.

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 una nextPageToken que se puede pasar a pageToken para obtener la siguiente página de resultados en solicitudes posteriores. Si se proporciona un valor de 0 o no, 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 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 una nextPageToken que se puede pasar a pageToken para obtener la siguiente página de resultados en solicitudes posteriores. Si se proporciona un valor de 0 o no, 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.

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

priceLevels[]

enum (PriceLevel)

Se usa para restringir la búsqueda a los lugares marcados como niveles de precios determinados. 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 filtro estricto de tipos para includeType. Si la estableces como verdadera, solo se mostrarán resultados del mismo tipo. El valor predeterminado es falso.

locationBias

object (LocationBias)

La región en la 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. No se puede establecer junto con locationRestriction.

locationRestriction

object (LocationRestriction)

La región en la 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. No se puede establecer junto con locationBias.

evOptions

object (EVOptions)

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

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)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string
}
Campos
places[]

object (Place)

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

contextualContents[]

object (ContextualContent)

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

Una lista de contenido contextual en la que cada entrada se asocia al lugar correspondiente en el mismo índice en el campo "places". Se prefiere el contenido relevante para el textQuery de la solicitud. Si el contenido contextual no está disponible para uno de los lugares, mostrará contenido no contextual. Estará vacío solo cuando el contenido no esté disponible para este lugar. Esta lista debe tener tantas entradas como la lista de lugares, si se solicita.

nextPageToken

string

Un token que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo o se deja vacío, no habrá páginas posteriores.

RankPreference

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

Enumeraciones
RANK_PREFERENCE_UNSPECIFIED Para una consulta categórica como “Restaurantes en la ciudad de Nueva York”, RELEVANCE es el valor predeterminado. Para consultas no categóricas, como “Mountain View, CA” te recomendamos que no establezcas RankPreference sin configurar.
DISTANCE Clasifica los resultados por distancia.
RELEVANCE Clasifica los resultados por relevancia. Orden de clasificación determinado por pila de clasificación normal.

LocationBias

La región en la 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)

Es un cuadro rectangular definido por las esquinas noreste y suroeste. rectangle.high() debe ser el punto noreste del viewport del rectángulo. rectangle.low() debe ser el punto suroeste 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.

circle

object (Circle)

Es un círculo definido por el punto central y el radio.

LocationRestriction

La región en la 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)

Es un cuadro rectangular definido por las esquinas noreste y suroeste. rectangle.high() debe ser el punto noreste del viewport del rectángulo. rectangle.low() debe ser el punto suroeste 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.

EVOptions

Opciones de búsqueda de VE de una solicitud de búsqueda de lugar.

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

number

Opcional. Velocidad de carga mínima requerida en kilovatios. Se filtrará un lugar con una tasa de carga inferior a la especificada.

connectorTypes[]

enum (EVConnectorType)

Opcional. La lista de tipos de conectores de VE preferidos. Se filtrarán los lugares que no admitan ninguno de los tipos de conectores de la lista.

ContextualContent

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

Contenido contextual a la búsqueda de lugar

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

object (Review)

Lista de opiniones acerca de este lugar, relacionadas con la búsqueda del lugar.

photos[]

object (Photo)

Información (incluidas las referencias) sobre las fotos de este lugar, relacionadas con la consulta 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 la pregunta de por qué un lugar podría interesarle 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 podría interesarle al usuario final. Por ejemplo, si la búsqueda es "pizza a leña", la justificación de la revisió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. La palabra exacta que se debe resaltar está marcada por HighlightedTextRange. Puede haber varias palabras en el texto destacado.

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

string

highlightedTextRanges[]

object (HighlightedTextRange)

Es la lista de los rangos del texto destacado.

HighlightedTextRange

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. BusinessAvailabilityAttributes. Aquí se muestran algunos atributos que tiene una empresa que podrían interesarle 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 entregas a domicilio.

dineIn

boolean

Si un lugar ofrece opciones para comer allí.