Method: locations.verify

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

string

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 (VerificationMethod),
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  },

  // Union field RequestData can be only one of the following:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  }
  // End of list of possible types for union field RequestData.
}
Champs
method

enum (VerificationMethod)

Obligatoire. Méthode de validation.
languageCode

string

Facultatif. Code de langue BCP 47 représentant la langue à utiliser pour la procédure de validation.
context

object (ServiceBusinessContext)

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 ADDRESS, l'adresse sera utilisée pour l'envoi du courrier. Pour les autres méthodes, il doit être identique à celui transmis à GetVerificationOptions. 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 ce champ vide si aucune donnée n'est nécessaire. RequestData ne peut être qu'un des éléments suivants :
emailAddress

string

Facultatif. Entrée pour la méthode EMAIL. Adresse e-mail à laquelle le code doit être envoyé.

L'adresse e-mail n'est acceptée que si elle fait partie des adresses fournies par locations.fetchVerificationOptions. Si le champ [EmailVerificationData] Pour [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] défini sur "true", le client peut spécifier un autre nom d'utilisateur (local-part), mais il doit correspondre au nom de domaine.
mailerContact

string

Facultatif. Valeur saisie pour la méthode ADDRESS. Nom du contact auquel l'e-mail doit être envoyé.
phoneNumber

string

Facultatif. Entrée 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 des options éligibles.
token

object (VerificationToken)

Facultatif. Entrée pour la méthode VETTED_PARTNER disponible pour certains partenaires. La saisie n'est pas nécessaire pour un compte validé. 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 (Verification)
  }
}
Champs
verification

object (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

string

Chaîne du jeton.