- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Niveaux d'accès des autorisations
- VerificationToken
Lance la procédure 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'établissement à 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 la procédure de validation. |
context |
Facultatif. Informations contextuelles supplémentaires pour la validation des entreprises de services. Il n'est requis que pour les établissements dont le type d'activité est CUSTOMER_LOCATION_ONLY. Pour la validation de l'ADRESSE, l'adresse sera utilisée pour envoyer une carte postale. Pour les autres méthodes, il doit être identique à celui transmis à GetVerificationOptions. INVALID_ARGUMENT sera renvoyé s'il est défini pour d'autres types d'établissements. |
| Données saisies par l'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 ce champ vide si aucune donnée n'est nécessaire. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
emailAddress |
Facultatif. Entrée pour la méthode EMAIL. Adresse e-mail à laquelle le code doit être envoyé. Une adresse e-mail n'est acceptée que si elle fait partie des adresses fournies par locations.fetchVerificationOptions. Si [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] a défini isUserNameEditable sur "true", le client peut spécifier un autre nom d'utilisateur (partie locale), mais il doit correspondre au nom de domaine. |
mailerContact |
Facultatif. Entrée de la méthode ADDRESS. Nom du contact auquel l'e-mail doit être envoyé. |
phoneNumber |
Facultatif. Entrée pour la méthode PHONE_CALL/SMS. 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. |
token |
Facultatif. L'entrée pour la méthode VETTED_PARTNER est disponible pour certains partenaires. L'entrée n'est pas nécessaire pour un compte validé. Jeton associé à l'emplacement. Jeton associé à l'emplacement. |
trustedPartnerToken |
Entrée pour la méthode TRUSTED_PARTNER. Jeton de validation associé à l'établissement. |
| Fin des champs mutuellement exclusifs. | |
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 |
La 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 plus d'informations, consultez la OAuth 2.0 Overview.
VerificationToken
Jeton généré par un partenaire approuvé.
| Représentation JSON |
|---|
{ "tokenString": string } |
| Champs | |
|---|---|
tokenString |
Chaîne de jeton. |