- 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
- VerificationOption
- AddressVerificationData
- EmailVerificationData
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 |
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 ( |
Champs | |
---|---|
languageCode |
Obligatoire. Code de langue BCP 47 représentant la langue à utiliser pour le processus de validation. Les options disponibles varient selon les langues. |
context |
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 ( |
Champs | |
---|---|
options[] |
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 ( |
Champs | |
---|---|
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 |
À définir uniquement si la méthode est PHONE_CALL ou SMS. Numéro de téléphone auquel le code sera envoyé. |
addressData |
Définissez ce paramètre uniquement si la méthode est MAIL. |
emailData |
Définissez ce paramètre uniquement si la méthode est EMAIL. |
announcement |
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 ( |
Champs | |
---|---|
business |
Nom de l'entreprise du marchand. |
address |
Adresse à laquelle le courrier peut être envoyé. |
expectedDeliveryDaysRegion |
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 |
Nom de domaine contenu dans l'adresse e-mail (par exemple, "gmail.com" dans foo@gmail.com). |
user |
Nom d'utilisateur compris dans l'adresse e-mail (par exemple, "foo" dans foo@gmail.com). |
isUserNameEditable |
Indique si le client est autorisé à fournir un autre nom d'utilisateur. |