Package google.mybusiness.verifications.v1

Index

Vérifications

Cette API permet de gérer la validation des établissements sur Google. Elle vous permet de gérer les ressources [google.mybusiness.v1.Verification] pour [Verification].

Chaque établissement [google.mybusiness.businessinformation.locations.v1.Location] dans [Location] possède un ensemble de ressources [google.mybusiness.verifications] [Validation], intitulée locations/*/verifications/*.

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

Effectue une validation PENDING.

Elle n'est nécessaire que pour les méthodes de validation autres que AUTO. La demande de validation de AUTO est instantanément VERIFIED après sa création.

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.
FetchVerificationOptions

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

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

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.
ListVerifications

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

Répertorier les validations d'un établissement, classées par heure de création.

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.
VerifyLocation

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

Lance le processus de validation d'un établissement.

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.

VoiceOfMerchant

Ce service permet aux utilisateurs tiers de demander des informations concernant l'état "voix du marchand".

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState(GetVoiceOfMerchantStateRequest) returns (VoiceOfMerchantState)

Récupère l'état VoiceOfMerchant.

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.

CompleteVerificationRequest

Message de requête pour Verifications.CompleteVerificationAction.

Champs
name

string

Obligatoire. Nom de ressource de la validation à effectuer.
pin

string

Obligatoire. Code PIN reçu par le marchand pour terminer la validation.

CompleteVerificationResponse

Message de réponse pour Verifications.CompleteVerificationAction.

Champs
verification

Verification

Validation terminée.

ComplyWithGuidelines

Indique que l'établissement ne respecte pas nos consignes.

Champs
recommendation_reason

RecommendationReason

Raison pour laquelle l'emplacement est recommandé afin de respecter les consignes.

RecommendationReason

Indique pourquoi l'établissement a été recommandé à ComplyWithGuidelines.

Enums
RECOMMENDATION_REASON_UNSPECIFIED Non spécifié.
BUSINESS_LOCATION_SUSPENDED L'établissement est suspendu. Pour résoudre ce problème, consultez cet article du Centre d'aide.
BUSINESS_LOCATION_DISABLED L'établissement est désactivé. Pour résoudre ce problème, consultez cet article du Centre d'aide.

FetchVerificationOptionsRequest

Message de requête pour Verifications.FetchVerificationOptions.

Champs
location

string

Obligatoire. Établissement à valider.
language_code

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

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.

FetchVerificationOptionsResponse

Message de réponse pour Verifications.FetchVerificationOptions.

Champs
options[]

VerificationOption

Options de validation disponibles

GetVoiceOfMerchantStateRequest

Message de requête pour VoiceOfMerchant.GetVoiceOfMerchantState.

Champs
name

string

Obligatoire. Nom de ressource de l'emplacement.

ListVerificationsRequest

Message de requête pour Verifications.ListVerifications.

Champs
parent

string

Obligatoire. Nom de ressource de l'établissement auquel appartiennent les demandes de validation.
page_size

int32

Nombre de validations à inclure par page. La valeur minimale est 1. La taille de page par défaut et maximale est 100.
page_token

string

Si une valeur est spécifiée, affiche la page de vérifications suivante.

ListVerificationsResponse

Message de réponse pour Verifications.ListVerifications.

Champs
verifications[]

Verification

Liste des vérifications.
next_page_token

string

Si le nombre de vérifications dépasse la taille de page demandée, ce champ sera renseigné avec un jeton permettant de récupérer la page de validation suivante lors d'un prochain appel. S'il n'y a plus d'attributs, ce champ ne sera pas présent dans la réponse.

ResolveOwnershipConflict

Ce type ne comporte aucun champ.

Indique que l'établissement est un doublon d'un autre établissement en règle.

ServiceBusinessContext

Données supplémentaires pour la validation de l'établissement de services.

Champs
address

PostalAddress

Adresse de validation de l'établissement. Elle permet d'activer d'autres options de validation ou d'envoyer un courrier.

Validation

La validation correspond à une tentative de validation d'un établissement.

Champs
name

string

Nom de ressource de la validation.
method

VerificationMethod

Méthode de vérification.
state

State

État de la vérification.
create_time

Timestamp

Code temporel de la demande de validation.
announcement

string

Facultatif. Annonce de réponse définie uniquement si la méthode est VETTED_PARTNER.

État

Tous les états de validation possibles.

Enums
STATE_UNSPECIFIED Valeur par défaut, cela entraîne des erreurs.
PENDING La validation est en attente.
COMPLETED La vérification est terminée.
FAILED Échec de la vérification.

VerificationMethod

Spécifie les processus utilisés par Google pour valider un établissement.

Enums
VERIFICATION_METHOD_UNSPECIFIED Valeur par défaut, cela entraîne des erreurs.
ADDRESS Envoyez une carte postale contenant un code d'accès à une adresse postale spécifique. Ce code permet d'effectuer la validation auprès de Google.
EMAIL Envoyez un e-mail contenant un code de validation à une adresse e-mail spécifique. Ce code permet d'effectuer la validation auprès de Google.
PHONE_CALL Utilisez un code de validation via un appel téléphonique vers un numéro de téléphone spécifique. Ce code permet d'effectuer la validation auprès de Google.
SMS Envoyez un code de validation par SMS à un numéro de téléphone spécifique. Ce code permet d'effectuer la validation auprès de Google.
AUTO Validez l'établissement sans action supplémentaire de la part de l'utilisateur. Cette option n'est peut-être pas disponible pour toutes les zones géographiques.
VETTED_PARTNER Cette option n'est peut-être pas disponible pour toutes les zones géographiques.

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).

Champs
verification_method

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 :
phone_number

string

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

AddressVerificationData

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

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.

Champs
business

string

Nom de l'entreprise du marchand.
address

PostalAddress

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

int32

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.

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).
is_user_name_editable

bool

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

VerificationToken

Jeton généré par un partenaire approuvé.

Champs
token_string

string

Chaîne du jeton.

Valider

Indique que l'établissement doit être validé. Contient des informations sur les actions de validation en cours effectuées sur l'établissement.

Champs
has_pending_verification

bool

Indique si une procédure de validation a déjà commencé et peut être effectuée par l'établissement.

VerifyLocationRequest

Message de requête pour Verifications.VerifyLocation.

Champs
name

string

Obligatoire. Nom de ressource de l'emplacement à valider.
method

VerificationMethod

Obligatoire. Méthode de validation.
language_code

string

Facultatif. Code de langue BCP 47 représentant la langue à utiliser pour le processus de validation.
context

ServiceBusinessContext

Facultatif. Informations contextuelles supplémentaires pour la validation des entreprises de services. Il n'est obligatoire que pour les établissements dont le type d'activité est "CUSTOMER_LOCATION_ONLY". Pour la validation de l'adresse ADDRESS, celle-ci sera utilisée pour l'envoi du courrier. Pour les autres méthodes, elle doit être identique à celle transmise à GetVerificationOptions. Un élément 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-le vide si aucune donnée n'est nécessaire. RequestData ne peut être qu'un des éléments suivants :
email_address

string

Facultatif. Valeur saisie pour la méthode EMAIL. Adresse e-mail à laquelle le code secret doit être envoyé.

Une adresse e-mail n'est acceptée que si elle fait partie des adresses fournies par FetchVerificationOptions. Si la valeur "is_user_name_editor" de [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] est définie sur "true", le client peut indiquer un nom d'utilisateur différent (local-part), mais doit correspondre au nom de domaine.
mailer_contact

string

Facultatif. Valeur saisie pour la méthode ADDRESS. Nom du contact auquel le message doit être envoyé.
phone_number

string

Facultatif. Valeur saisie pour la méthode PHONE_CALL/SMS. 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 figurant dans les options éligibles.
token

VerificationToken

Facultatif. Les données saisies pour la méthode VETTED_PARTNER sont disponibles pour sélectionner les partners.. Cette saisie n'est pas nécessaire pour un compte approuvé. Jeton associé à l'établissement. Jeton associé à l'établissement.

VerifyLocationResponse

Message de réponse pour Verifications.VerifyLocation.

Champs
verification

Verification

Demande de validation créée.

VoiceOfMerchantState

Message de réponse pour VoiceOfMerchant.GetVoiceOfMerchantState.

Champs
has_voice_of_merchant

bool

Indique si l'établissement est en règle et contrôle sa diffusion sur Google. Toutes les modifications apportées à l'établissement seront appliquées sur Maps une fois la phase d'examen terminée.
has_business_authority

bool

Indique si l'établissement est désigné comme propriétaire de l'établissement sur Google. Si la valeur est "true", un autre établissement ne peut pas prendre le relais et devenir la fiche dominante sur Maps. Toutefois, les modifications ne seront pas publiées, à moins que la voix du marchand ne soit obtenue (par exemple, has_voice_of_merchant est défini sur true).
Champ d'union gain_voice_of_merchant_action. Action recommandée pour l'établissement afin de prendre le contrôle de celui-ci sur Google. gain_voice_of_merchant_action ne peut être qu'un des éléments suivants :
wait_for_voice_of_merchant

WaitForVoiceOfMerchant

Attendez pour obtenir Voix du marchand. L'établissement est en cours d'examen pour des raisons de qualité.
verify

Verify

Démarrez ou poursuivez la procédure de validation.
resolve_ownership_conflict

ResolveOwnershipConflict

Cet établissement correspond à un autre établissement en règle. Si vous avez accès à l'établissement en règle, utilisez l'ID correspondant pour effectuer des opérations. Sinon, demandez l'accès au propriétaire actuel.
comply_with_guidelines

ComplyWithGuidelines

L'établissement ne respecte pas nos consignes. Des mesures supplémentaires sont nécessaires pour qu'il soit rétabli. Pour résoudre ce problème, consultez cet article du Centre d'aide.

WaitForVoiceOfMerchant

Ce type ne comporte aucun champ.

Indique que l'établissement recevra la voix du marchand après avoir réussi l'avis.