- 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
- PhoneVerificationData
- AddressVerificationData
- EmailVerificationData
Indique toutes les options de validation éligibles pour un établissement dans une langue spécifique.
Requête HTTP
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:fetchVerificationOptions
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
name |
Nom de ressource de l'emplacement à 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 |
Code de langue BCP 47 représentant la langue à utiliser pour le processus de validation. Les options disponibles varient selon les langues. |
context |
Informations contextuelles supplémentaires pour la validation des entreprises de services. Obligatoire pour les établissements dont le type d'activité est "CUSTOMER_LOCATION_ONLY". 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
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.FetchVerificationOptions.
Représentation JSON | |
---|---|
{
"options": [
{
object ( |
Champs | |
---|---|
options[] |
Options de validation disponibles |
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.
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 : |
||
phoneData |
À définir uniquement si la méthode est PHONE_CALL ou SMS. |
|
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. |
PhoneVerificationData
Afficher des données pour les validations par téléphone (appel téléphonique ou SMS, par exemple)
Représentation JSON | |
---|---|
{ "phoneNumber": string } |
Champs | |
---|---|
phoneNumber |
Numéro de téléphone auquel le code sera envoyé. |
AddressVerificationData
Affichez les données de validation par courrier.
Représentation JSON | |
---|---|
{
"businessName": string,
"address": {
object ( |
Champs | |
---|---|
businessName |
Nom de l'entreprise du marchand. |
address |
Adresse à laquelle le courrier peut être envoyé. |
EmailVerificationData
Affichez les données pour les validations par e-mail.
Représentation JSON | |
---|---|
{ "domainName": string, "userName": string, "isUserNameEditable": boolean } |
Champs | |
---|---|
domainName |
Nom de domaine contenu dans l'adresse e-mail (par exemple, "gmail.com" dans foo@gmail.com). |
userName |
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. |