- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- MatchedLocation
Recherche toutes les zones géographiques 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 |
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 |
Langue préférée pour la zone géographique correspondante (au format BCP-47). |
numResults |
Nombre de correspondances à renvoyer. La valeur par défaut est 3, avec un maximum de 10. Notez que la latence peut augmenter si d'autres requêtes sont demandées. Il n'y a pas de pagination. |
maxCacheDuration |
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 " |
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 Locations.FindMatchingLocations.
Représentation JSON | |
---|---|
{
"matchedLocations": [
{
object ( |
Champs | |
---|---|
matchedLocations[] |
Ensemble de zones géographiques correspondant potentiellement à l'emplacement spécifié, classées par ordre décroissant. S'il existe une correspondance exacte, il apparaîtra en première position. |
matchTime |
Date de la dernière exécution de l'algorithme de correspondance pour cet établissement. Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: |
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 établissement.
Représentation JSON | |
---|---|
{
"location": {
object ( |
Champs | |
---|---|
location |
Zone faiblement peuplée qui constitue une correspondance potentielle. Les champs non renseignés incluent, sans s'y limiter: nom (la zone géographique correspondante ne peut pas être récupérée via |
isExactMatch |
S'agit-il d'une correspondance exacte ? |