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

languageCode

string

Los detalles del lugar se mostrarán en el idioma preferido si están disponibles. Si no se especifica el código de idioma o no se reconoce, se pueden mostrar detalles del lugar 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 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

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 valor máximo de 0.5(límite) 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 que se pueden mostrar por página. 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 utiliza el valor predeterminado de 20. El valor máximo es 20; los valores superiores a 20 se forzarán a 20. Los valores negativos mostrarán un error INVALID_{8/}.

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

pageSize

integer

Opcional. La cantidad máxima de resultados que se pueden mostrar por página. 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 utiliza el 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_{8/}.

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 pagina, todos los parámetros excepto pageToken, pageSize y 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_ formato.

priceLevels[]

enum (PriceLevel)

Se usa para restringir la búsqueda a lugares marcados con determinados 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 el filtrado de tipos estricto para includeType. Si se configura como true, 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 sesgo, lo que significa que podrían devolverse resultados en torno a 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 sirve 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. Configura las opciones de búsqueda de VE para una solicitud de búsqueda de lugar.

Cuerpo de la respuesta

Protocolo 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)

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

Una lista de contenidos contextuales en la que cada entrada se asocia al lugar correspondiente en el mismo índice en el campo "places". Se prefiere el contenido relevante para textQuery en la solicitud. Si el contenido contextual no está disponible para uno de los lugares, se mostrará contenido no contextual. Estará en blanco 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 este campo se omite o está vacío, no habrá páginas posteriores.

RankPreference

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

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

LocationBias

La región en la que se buscará. Esta ubicación sirve como sesgo, lo que significa que podrían devolverse resultados en torno a 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 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(). El resultado será un rango de latitud vacío. Un viewport rectangular no puede tener un ancho superior a 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 sirve 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 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(). El resultado será 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 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 tarifa especificada.

connectorTypes[]

enum (EVConnectorType)

Opcional. La lista de tipos de conectores de VE preferidos. Se filtrará un lugar que no admita ninguno de los tipos de conectores que figuran en la lista.

ContextualContent

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

Contenido contextual con 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, contexual a la búsqueda del lugar.

photos[]

object (Photo)

Información (incluidas las referencias) sobre las fotos del lugar, contexual 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 detalles.

Justificaciones para el lugar.

Justificación

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

Justificaciones para el lugar. Las justificaciones responden a 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 detalles.

businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

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

ReviewJustification

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

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

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

object (HighlightedText)

review

object (Review)

La opinión de la que se genera el texto destacado.

HighlightedText

El texto que se destaca por la justificación. Este es un subconjunto de la opinión en sí. La palabra exacta que se destacará está marcada con HighlightedTextRange. Es posible que haya 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 del 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 detalles. justificaciones de BusinessAvailabilityAttributes. Aquí se muestran algunos atributos que tiene una empresa y que podrían interesar a los usuarios finales.

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.

dineIn

boolean

Si un lugar ofrece el consumo en el lugar.