- 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
- EmailInput
- AddressInput
- PhoneInput
Lance le processus de validation d'un établissement.
Requête HTTP
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:verify
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
name |
Nom de ressource de l'emplacement à valider. |
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON | |
---|---|
{ "method": enum ( |
Champs | ||
---|---|---|
method |
Méthode de validation. |
|
languageCode |
Code de langue BCP 47 représentant la langue à utiliser pour le processus de validation. |
|
context |
Informations contextuelles supplémentaires pour la validation des entreprises de services. Obligatoire pour les établissements dont le type d'activité est "CUSTOMER_LOCATION_ONLY". Pour la validation de l'adresse ADDRESS, celle-ci sera utilisée pour l'envoi du courrier. Pour les autres méthodes, elle doit être identique à celle transmise à locations.fetchVerificationOptions. Un élément INVALID_ARGUMENT est généré s'il est défini pour d'autres types d'établissements. |
|
Champ d'union RequestData . Données d'entrée utilisateur pour une méthode spécifique, en plus des données d'affichage. Les données doivent correspondre à la méthode demandée. Laissez-le vide si aucune donnée n'est nécessaire. RequestData ne peut être qu'un des éléments suivants : |
||
emailInput |
Valeur saisie pour la méthode EMAIL. |
|
addressInput |
Valeur saisie pour la méthode ADDRESS. |
|
phoneInput |
Informations saisies pour la méthode PHONE_CALL/SMS |
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 Verifications.VerifyLocation.
Représentation JSON | |
---|---|
{
"verification": {
object ( |
Champs | |
---|---|
verification |
Demande de validation créée. |
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.
EmailInput
Données saisies pour la validation de l'adresse e-mail EMAIL.
Représentation JSON | |
---|---|
{ "emailAddress": string } |
Champs | |
---|---|
emailAddress |
Adresse e-mail à laquelle le code secret doit être envoyé. Une adresse e-mail n'est acceptée que si elle fait partie des adresses fournies par locations.fetchVerificationOptions. Si isUserNameEditable est défini sur "true" pour |
AddressInput
Données saisies pour la validation de l'adresse ADDRESS.
Représentation JSON | |
---|---|
{ "mailerContactName": string } |
Champs | |
---|---|
mailerContactName |
Nom du contact auquel le message doit être envoyé. |
PhoneInput
Entrée pour la validation PHONE_CALL/SMS.
Représentation JSON | |
---|---|
{ "phoneNumber": string } |
Champs | |
---|---|
phoneNumber |
Numéro de téléphone à appeler ou auquel envoyer un SMS. Il doit s'agir de l'un des numéros de téléphone figurant dans les options éligibles. |