Method: googleLocations.search

Busca todas las ubicaciones posibles que coincidan con la solicitud especificada.

Solicitud HTTP

POST https://mybusinessbusinessinformation.googleapis.com/v1alpha/googleLocations:search

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
{
  "pageSize": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "location": {
    object (Location)
  },
  "query": string
  // End of mutually exclusive fields.
}
Campos
pageSize

integer

Es la cantidad de coincidencias que se devolverán. El valor predeterminado es 3, con un máximo de 10. Ten en cuenta que la latencia puede aumentar si se solicitan más. No hay paginación.

Búsqueda Esto se puede proporcionar como un objeto de ubicación o como una consulta de cadena. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
location

object (Location)

Es la ubicación que se buscará. Si se proporciona, se encontrarán las ubicaciones que coincidan con los detalles de ubicación proporcionados, que deben incluir un valor para el título.

query

string

Es la búsqueda de texto que se realizará. Los resultados de la búsqueda de una cadena de consulta serán menos precisos que si se proporciona una ubicación exacta, pero pueden proporcionar más coincidencias inexactas.

Fin de los campos mutuamente excluyentes.

Cuerpo de la respuesta

Mensaje de respuesta para GoogleLocations.SearchGoogleLocations.

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

Representación JSON
{
  "googleLocations": [
    {
      object (GoogleLocation)
    }
  ]
}
Campos
googleLocations[]

object (GoogleLocation)

Es una colección de GoogleLocations que son coincidencias potenciales con la solicitud especificada, ordenadas de mayor a menor precisión.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/business.manage

Para obtener más información, consulta OAuth 2.0 Overview.