- 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
- VerificationToken
Lance le processus de validation d'un établissement.
Requête HTTP
POST https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
name |
Obligatoire. 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 |
Obligatoire. Méthode de validation. |
languageCode |
Facultatif. Code de langue BCP 47 représentant la langue à utiliser pour le processus de validation. |
context |
Facultatif. Informations contextuelles supplémentaires pour la validation des entreprises de services. Il n'est obligatoire que 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 à GetVerificationOptions. 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 : |
|
emailAddress |
Facultatif. Valeur saisie pour la méthode EMAIL. 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 de [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] est défini sur "true", le client peut indiquer un nom d'utilisateur différent (local-part), mais il doit correspondre au nom de domaine. |
mailerContact |
Facultatif. Valeur saisie pour la méthode ADDRESS. Nom du contact auquel le message doit être envoyé. |
phoneNumber |
Facultatif. Valeur saisie pour la méthode PHONE_CALL/SMS. Numéro de téléphone à appeler ou auquel un SMS doit être envoyé. Il doit s'agir de l'un des numéros de téléphone figurant dans les options éligibles. |
token |
Facultatif. Les données saisies pour la méthode VETTED_PARTNER sont disponibles pour sélectionner les partners.. Cette saisie n'est pas nécessaire pour un compte approuvé. Jeton associé à l'établissement. Jeton associé à l'établissement. |
Corps de la réponse
Message de réponse pour Verifications.VerifyLocation.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{
"verification": {
object ( |
Champs | |
---|---|
verification |
Demande de validation créée. |
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/business.manage
Pour en savoir plus, consultez la présentation d'OAuth 2.0.
VerificationToken
Jeton généré par un partenaire approuvé.
Représentation JSON |
---|
{ "tokenString": string } |
Champs | |
---|---|
tokenString |
Chaîne du jeton. |