Method: accounts.locations.verify

Lance la procédure 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

string

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:
  "emailInput": {
    object (EmailInput)
  },
  "addressInput": {
    object (AddressInput)
  },
  "phoneInput": {
    object (PhoneInput)
  }
  // End of list of possible types for union field RequestData.
}
Champs
method

enum (VerificationMethod)

Méthode de validation.
languageCode

string

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

object (ServiceBusinessContext)

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 ADDRESS, l'adresse sera utilisée pour l'envoi du courrier. Pour les autres méthodes, il doit être identique à celui transmis à locations.fetchVerificationOptions. 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 :
emailInput

object (EmailInput)

Entrée pour la méthode EMAIL.
addressInput

object (AddressInput)

Valeur saisie pour la méthode ADDRESS.
phoneInput

object (PhoneInput)

Entrée 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 (Verification)
  }
}
Champs
verification

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

Entrée pour la validation de l'adresse e-mail

Représentation JSON 
{
  "emailAddress": string
}
Champs
emailAddress

string

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 "isUserNameEditable" est défini sur "true" pour EmailVerificationData, le client peut spécifier un nom d'utilisateur différent (local-part), mais doit correspondre au nom de domaine.

AddressInput

Entrée pour la validation de l'adresse ADDRESS.

Représentation JSON 
{
  "mailerContactName": string
}
Champs
mailerContactName

string

Nom du contact auquel l'e-mail doit être envoyé.

PhoneInput

Entrée pour la validation par PHONE_CALL/SMS.

Représentation JSON 
{
  "phoneNumber": string
}
Champs
phoneNumber

string

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.