Method: accounts.locations.findMatches

Recherche tous les lieux possibles correspondant à l'établissement spécifié. Cette opération n'est valide que si l'établissement n'a pas été validé.

Requête HTTP

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Nom de ressource de l'établissement pour lequel rechercher des correspondances.

Corps de la requête

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

Représentation JSON 
{
  "languageCode": string,
  "numResults": integer,
  "maxCacheDuration": string
}
Champs
languageCode

string

Langue préférée pour l'emplacement correspondant (au format BCP-47).
numResults

integer

Nombre de correspondances à renvoyer. La valeur par défaut est 3, avec un maximum de 10. Notez que la latence peut augmenter si davantage sont demandés. Il n'y a pas de pagination.
maxCacheDuration

string (Duration format)

Obsolète. Ce champ est ignoré pour toutes les requêtes.

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".

Corps de la réponse

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

Message de réponse pour Location.FindMatchingLocations.

Représentation JSON 
{
  "matchedLocations": [
    {
      object (MatchedLocation)
    }
  ],
  "matchTime": string
}
Champs
matchedLocations[]

object (MatchedLocation)

Ensemble de zones géographiques pouvant correspondre à la zone spécifiée, classées du plus proche au moins pertinent. S'il existe une correspondance exacte, elle s'affichera en première position.
matchTime

string (Timestamp format)

Date de la dernière exécution de l'algorithme de mise en correspondance pour cet établissement.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

MatchedLocation

Représente une correspondance possible avec un emplacement.

Représentation JSON 
{
  "location": {
    object (Location)
  },
  "isExactMatch": boolean
}
Champs
location

object (Location)

Zone géographique partiellement remplie qui constitue une correspondance potentielle. Les champs non renseignés incluent, sans s'y limiter: name (l'établissement correspondant ne peut pas être récupéré via locations.get ni locations.batchGet). storeCode; Détails de la zone de couverture de serviceArea labels; adWordsLocationExtensions photos
isExactMatch

boolean

S'agit-il d'une correspondance exacte ?