- 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
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- AddressVerificationData
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- EmailVerificationData
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
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 la procédure de validation. Les options disponibles varient selon les langues. |
context |
Facultatif. Informations contextuelles supplémentaires pour la validation des entreprises de services Ne peuvent s'appliquer qu'aux zones géographiques dont le type d'activité est CUSTOMER_LOCATION_ONLY. La spécification d'une adresse précise permet d'activer davantage d'options. INVALID_ARGUMENT sera généré s'il est défini pour d'autres types d'activité dans les zones géographiques. |
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éfinir uniquement si la méthode est MAIL. |
emailData |
À définir 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 de jours estimé nécessaire pour que le courrier soit distribué dans le pays correspondant à l'adresse. |
EmailVerificationData
Permet d'afficher les données des validations par e-mail.
Représentation JSON |
---|
{ "domain": string, "user": string, "isUserNameEditable": boolean } |
Champs | |
---|---|
domain |
Nom de domaine dans l'adresse e-mail. Ex. : "gmail.com" à l'adresse foo@gmail.com |
user |
Nom d'utilisateur dans l'adresse e-mail. Ex. : "foo" à l'adresse foo@gmail.com |
isUserNameEditable |
Indique si le client est autorisé à fournir un autre nom d'utilisateur. |