Method: googleLocations.search

Recherchez tous les établissements possibles qui correspondent à la requête spécifiée.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
pageSize

integer

Nombre de correspondances à renvoyer. La valeur par défaut est 3, avec un maximum de 10. Notez que la latence peut augmenter si vous en demandez plus. Il n'y a pas de pagination.

Requête de recherche. Il peut être fourni sous la forme d'un objet de localisation ou d'une requête de chaîne. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
location

object (Location)

Emplacement à rechercher. Si ce paramètre est spécifié, les établissements correspondant aux informations fournies sont recherchés. Ces informations doivent inclure une valeur pour le titre.

query

string

Requête textuelle à rechercher. Les résultats de recherche d'une chaîne de requête seront moins précis que si vous fournissez un emplacement exact, mais ils peuvent fournir davantage de correspondances inexactes.

Fin des champs mutuellement exclusifs.

Corps de la réponse

Message de réponse pour GoogleLocations.SearchGoogleLocations.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "googleLocations": [
    {
      object (GoogleLocation)
    }
  ]
}
Champs
googleLocations[]

object (GoogleLocation)

Ensemble de GoogleLocations correspondant potentiellement à la requête spécifiée, classées par ordre de précision décroissant.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.