Method: locations.fetchVerificationOptions

Indique toutes les options de validation éligibles pour un établissement dans une langue spécifique.

Requête HTTP

POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
location

string

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

string

Obligatoire. Code de langue BCP 47 représentant la langue à utiliser pour le processus de validation. Les options disponibles varient selon les langues.
context

object (ServiceBusinessContext)

Facultatif. Informations contextuelles supplémentaires pour la validation des entreprises de services. Ne peut être appliqué qu'aux établissements dont le type d'activité est CUSTOMER_LOCATION_ONLY. La spécification d'une adresse précise pourrait permettre d'accéder à davantage d'options. Un élément INVALID_ARGUMENT est généré s'il est défini pour d'autres types d'activités.

Corps de la réponse

Message de réponse pour Verifications.FetchVerificationOptions.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "options": [
    {
      object (VerificationOption)
    }
  ]
}
Champs
options[]

object (VerificationOption)

Options de validation disponibles

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.

VerificationOption

L'option de validation indique comment valider l'établissement (indiqué par la méthode de validation) et où la validation sera envoyée (indiqué par les données d'affichage).

Représentation JSON 
{
  "verificationMethod": enum (VerificationMethod),

  // Union field DisplayData can be only one of the following:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  },
  "announcement": string
  // End of list of possible types for union field DisplayData.
}
Champs
verificationMethod

enum (VerificationMethod)

Méthode de validation de l'établissement.
Champ d'union DisplayData. Une des données d'affichage. Les données doivent correspondre à la méthode. Ce champ est vide si la méthode correspondante ne comporte aucune donnée d'affichage. DisplayData ne peut être qu'un des éléments suivants :
phoneNumber

string

À définir uniquement si la méthode est PHONE_CALL ou SMS. Numéro de téléphone auquel le code sera envoyé.
addressData

object (AddressVerificationData)

Définissez ce paramètre uniquement si la méthode est MAIL.
emailData

object (EmailVerificationData)

Définissez ce paramètre uniquement si la méthode est EMAIL.
announcement

string

Défini uniquement si la méthode est VETTED_PARTNER.

AddressVerificationData

Affichez les données de validation par courrier.

Représentation JSON 
{
  "business": string,
  "address": {
    object (PostalAddress)
  },
  "expectedDeliveryDaysRegion": integer
}
Champs
business

string

Nom de l'entreprise du marchand.
address

object (PostalAddress)

Adresse à laquelle le courrier peut être envoyé.
expectedDeliveryDaysRegion

integer

Nombre estimé de jours nécessaires à la livraison du courrier dans la région de l'adresse.

EmailVerificationData

Affichez les données pour les validations par e-mail.

Représentation JSON 
{
  "domain": string,
  "user": string,
  "isUserNameEditable": boolean
}
Champs
domain

string

Nom de domaine contenu dans l'adresse e-mail (par exemple, "gmail.com" dans foo@gmail.com).
user

string

Nom d'utilisateur compris dans l'adresse e-mail (par exemple, "foo" dans foo@gmail.com).
isUserNameEditable

boolean

Indique si le client est autorisé à fournir un autre nom d'utilisateur.