Package google.mybusiness.verifications.v1

Índice

Verificações

Essa API permite gerenciar verificações de local no Google. Ela permite que você gerencie recursos [google.mybusiness.v1.Verification] de [Verificação].

Cada [Local] [google.mybusiness.businessinformation.locations.v1.Location] tem um conjunto de recursos [Verificação] [google.mybusiness.verifications], chamados locations/*/verifications/*.

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

Conclua uma verificação de PENDING.

Ele só é necessário para métodos de verificação que não sejam AUTO. A solicitação de verificação de AUTO aparece VERIFIED instantaneamente após a criação.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
FetchVerificationOptions

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

Informa todas as opções de verificação qualificadas para um local em um idioma específico.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListVerifications

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

Lista as verificações de um local, ordenadas por horário de criação.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.
VerifyLocation

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

Inicia o processo de verificação de um local.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.

VoiceOfMerchant

Este serviço permite que usuários de terceiros solicitem detalhes sobre a voz do estado do comerciante.

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState(GetVoiceOfMerchantStateRequest) returns (VoiceOfMerchantState)

Recebe o estado VoiceOfMerchant.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.

CompleteVerificationRequest

Mensagem de solicitação para Verifications.CompleteVerificationAction.

Campos
name

string

Obrigatório. Nome do recurso da verificação a ser concluída.
pin

string

Obrigatório. Código PIN recebido pelo comerciante para concluir a verificação.

CompleteVerificationResponse

Mensagem de resposta para Verifications.CompleteVerificationAction.

Campos
verification

Verification

A verificação foi concluída.

ComplyWithGuidelines

Indica que o local não está em conformidade com nossas diretrizes.

Campos
recommendation_reason

RecommendationReason

Motivo pelo qual o local está sendo recomendado para obedecer às diretrizes.

RecommendationReason

Indica por que o local foi recomendado para ComplyWithGuidelines.

Enums
RECOMMENDATION_REASON_UNSPECIFIED Não especificado.
BUSINESS_LOCATION_SUSPENDED O local da empresa está suspenso. Para corrigir o problema, consulte o artigo da Central de Ajuda.
BUSINESS_LOCATION_DISABLED O local da empresa está desativado. Para corrigir o problema, consulte o artigo da Central de Ajuda.

FetchVerificationOptionsRequest

Mensagem de solicitação para Verifications.FetchVerificationOptions.

Campos
location

string

Obrigatório. O local a ser verificado.
language_code

string

Obrigatório. O código BCP 47 que representa o idioma a ser usado no processo de verificação. As opções disponíveis variam de acordo com o idioma.
context

ServiceBusinessContext

Opcional. Informações de contexto extra para a verificação de empresas de serviços. Só pode ser aplicado a locais cujo tipo de empresa é CUSTOMER_LOCATION_SOMENTE. Especificar um endereço preciso pode permitir mais opções. INVALID_ ARGUMENT será gerado se estiver definido para outros tipos de empresa de local.

FetchVerificationOptionsResponse

Mensagem de resposta para Verifications.FetchVerificationOptions.

Campos
options[]

VerificationOption

As opções de verificação disponíveis.

GetVoiceOfMerchantStateRequest

Mensagem de solicitação para VoiceOfMerchant.GetVoiceOfMerchantState.

Campos
name

string

Obrigatório. Nome de recurso do local.

ListVerificationsRequest

Mensagem de solicitação para Verifications.ListVerifications.

Campos
parent

string

Obrigatório. Nome do recurso do local a que as solicitações de verificação pertencem.
page_size

int32

Quantas verificações devem ser incluídas por página. O mínimo é 1, e o tamanho de página padrão e máximo é 100.
page_token

string

Se especificado, retorna a próxima página de verificações.

ListVerificationsResponse

Mensagem de resposta para Verifications.ListVerifications.

Campos
verifications[]

Verification

Lista de verificações.
next_page_token

string

Se o número de verificações exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de verificação em uma chamada subsequente. Se não houver mais atributos, este campo não estará presente na resposta.

ResolveOwnershipConflict

Esse tipo não tem campos.

Indica que o local duplica outro que está em situação regular.

ServiceBusinessContext

Dados adicionais para a verificação de empresas de serviços.

Campos
address

PostalAddress

O endereço de verificação do local. Ele é usado para ativar mais opções de verificação ou para enviar um cartão-postal.

Verificação

Uma verificação representa uma tentativa de verificação de um local.

Campos
name

string

Nome do recurso da verificação.
method

VerificationMethod

Método da verificação.
state

State

O estado da verificação.
create_time

Timestamp

A data e hora em que a verificação é solicitada.
announcement

string

Opcional. Anúncio de resposta definido apenas se o método for VETTED_PARTNER.

Estado

Todos os estados de verificação possíveis.

Enums
STATE_UNSPECIFIED O valor padrão resultará em erros.
PENDING A verificação está pendente.
COMPLETED A verificação foi concluída.
FAILED Falha na verificação.

VerificationMethod

Especifica os processos usados pelo Google para verificar um local.

Enums
VERIFICATION_METHOD_UNSPECIFIED O valor padrão resultará em erros.
ADDRESS Envie um cartão postal com um PIN de verificação para um endereço de correspondência específico. O PIN é usado para concluir a verificação com o Google.
EMAIL Enviar um e-mail com um PIN de verificação para um endereço de e-mail específico. O PIN é usado para concluir a verificação com o Google.
PHONE_CALL Fazer uma chamada telefônica com um PIN de verificação para um número de telefone específico. O PIN é usado para concluir a verificação com o Google.
SMS Enviar um SMS com um PIN de verificação para um número de telefone específico. O PIN é usado para concluir a verificação com o Google.
AUTO Verifique o local sem qualquer outra ação do usuário. Essa opção não está disponível para todos os locais.
VETTED_PARTNER Essa opção não está disponível para todos os locais.

VerificationOption

Essa opção indica como verificar o local (indicado pelo método de verificação) e para onde a verificação será enviada (indicada pelos dados de exibição).

Campos
verification_method

VerificationMethod

Método para verificar o local.
Campo de união DisplayData. Um dos dados de exibição. Os dados precisam corresponder ao método. Vai ser vazio se o método correspondente não tiver dados de exibição. DisplayData pode ser apenas de um dos tipos a seguir:
phone_number

string

Definir apenas se o método for PHONE_CALL ou SMS. Número de telefone para o qual o PIN será enviado.
address_data

AddressVerificationData

Defina apenas se o método for MAIL.
email_data

EmailVerificationData

Defina apenas se o método for EMAIL.
announcement

string

Definido apenas se o método for VETTED_PARTNER.

AddressVerificationData

Exiba dados para verificações por cartão-postal.

Campos
business

string

Nome da empresa do comerciante.
address

PostalAddress

Endereço para o qual um cartão-postal pode ser enviado.
expected_delivery_days_region

int32

Número esperado de dias necessários para entregar um cartão-postal na região do endereço.

EmailVerificationData

Mostrar dados para verificações por e-mail.

Campos
domain

string

Nome de domínio no endereço de e-mail, por exemplo, "gmail.com" em foo@gmail.com
user

string

Nome de usuário no endereço de e-mail, por exemplo, "foo" em foo@gmail.com
is_user_name_editable

bool

Se o cliente tem permissão para fornecer um nome de usuário diferente.

VerificationToken

Token gerado por um parceiro verificado.

Campos
token_string

string

A string do token.

Verificar

Indica que o local requer verificação. contém informações sobre as ações de verificação realizadas no local.

Campos
has_pending_verification

bool

Indica se um processo de verificação já foi iniciado e pode ser concluído pelo local.

VerifyLocationRequest

Mensagem de solicitação para Verifications.VerifyLocation.

Campos
name

string

Obrigatório. Nome de recurso do local a ser verificado.
method

VerificationMethod

Obrigatório. Método de verificação.
language_code

string

Opcional. O código BCP 47 que representa o idioma a ser usado no processo de verificação.
context

ServiceBusinessContext

Opcional. Informações de contexto extra para a verificação de empresas de serviços. Ele só é necessário para os locais cujo tipo de empresa é CUSTOMER_LOCATION_ apenas. Para a verificação de ADDRESS, o endereço será usado para enviar o cartão-postal. Para outros métodos, ele precisa ser o mesmo que é transmitido para GetVerifyOptions. INVALID_ ARGUMENT será gerado se estiver definido para outros tipos de locais da empresa.
Campo de união RequestData. Dados de entrada do usuário para um método específico, além dos dados de exibição. Os dados precisam corresponder ao método solicitado. Deixe em branco se nenhum dado for necessário. RequestData pode ser apenas de um dos tipos a seguir:
email_address

string

Opcional. A entrada para o método EMAIL. Endereço de e-mail para envio do PIN.

Um endereço de e-mail só será aceito se for um dos endereços fornecidos por FetchVerificationOptions. Se [EmailVerifyData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] tiver o valor "is_user_name_edit" definido como "true", o cliente poderá especificar um nome de usuário diferente (local-part), mas precisará corresponder ao nome de domínio.
mailer_contact

string

Opcional. A entrada para o método ADDRESS. Nome do contato para o qual o e-mail será enviado.
phone_number

string

Opcional. Entrada para o método PHONE_CALL/SMS. O número de telefone que receberá a chamada ou o envio de SMS. Precisa ser um dos números de telefone nas opções qualificadas.
token

VerificationToken

Opcional. A entrada do método VETTED_PARTNER disponível para partners. selecionados. A informação não é necessária para uma conta verificada. Token associado ao local. Token associado ao local.

VerifyLocationResponse

Mensagem de resposta para Verifications.VerifyLocation.

Campos
verification

Verification

A solicitação de verificação criada.

VoiceOfMerchantState

Mensagem de resposta para VoiceOfMerchant.GetVoiceOfMerchantState.

Campos
has_voice_of_merchant

bool

Indica se o local está em situação regular e tem controle sobre a empresa no Google. Todas as edições feitas no local serão propagadas para o Google Maps após a aprovação na fase de revisão.
has_business_authority

bool

Indica se o local tem autoridade (propriedade) sobre a empresa no Google. Se verdadeiro, outro local não pode assumir o controle e se tornar a listagem dominante no Google Maps. No entanto, as edições só serão exibidas se o Voice do comerciante for usado (ou seja, has_voice_of_merchant for verdadeira).
Campo de união gain_voice_of_merchant_action. Ação recomendada ao local para ter controle sobre a empresa no Google. gain_voice_of_merchant_action pode ser apenas de um dos tipos a seguir:
wait_for_voice_of_merchant

WaitForVoiceOfMerchant

Aguarde para usar a voz do comerciante. Para garantir a qualidade, o local está em análise.
verify

Verify

Inicie ou continue o processo de verificação.
resolve_ownership_conflict

ResolveOwnershipConflict

Este local duplica outro local que está em situação regular. Se você tiver acesso ao local em situação regular, use o ID dele para realizar operações. Caso contrário, solicite acesso ao proprietário atual.
comply_with_guidelines

ComplyWithGuidelines

O local não está em conformidade com nossas diretrizes e requer etapas adicionais para restabelecimento. Para corrigir esse problema, consulte o artigo da Central de Ajuda.

WaitForVoiceOfMerchant

Esse tipo não tem campos.

Indica que o local vai ganhar a voz do comerciante após ser aprovado na revisão.