Method: locations.verify

Inicia o processo de verificação de uma unidade.

Solicitação HTTP

POST https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

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

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "method": enum (VerificationMethod),
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  },
  "trustedPartnerToken": string
  // End of mutually exclusive fields.
}
Campos
method

enum (VerificationMethod)

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

languageCode

string

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

context

object (ServiceBusinessContext)

Opcional. Informações de contexto extra para a verificação de empresas de serviços. Ele é obrigatório apenas para os locais em que o tipo de empresa é CUSTOMER_LOCATION_ONLY. Para a verificação de ENDEREÇO, o endereço será usado para enviar o cartão-postal. Para outros métodos, ele precisa ser igual ao que é transmitido para GetVerificationOptions. INVALID_ARGUMENT será gerado se ele for definido para outros tipos de locais de empresas.

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 não houver dados. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
emailAddress

string

Opcional. A entrada para o método EMAIL. Endereço de e-mail para onde o PIN deve ser enviado.

Um endereço de e-mail só será aceito se for um dos endereços fornecidos por locations.fetchVerificationOptions. Se [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] tiver isUserNameEditable definido como verdadeiro, o cliente poderá especificar um nome de usuário diferente (parte local), mas que corresponda ao nome de domínio.

mailerContact

string

Opcional. A entrada para o método ADDRESS. Nome do contato para quem o e-mail deve ser enviado.

phoneNumber

string

Opcional. A entrada para o método PHONE_CALL/SMS. O número de telefone para o qual a chamada ou o SMS deve ser enviado. Ele precisa ser um dos números de telefone nas opções qualificadas.

token

object (VerificationToken)

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

trustedPartnerToken

string

A entrada para o método TRUSTED_PARTNER, o token de verificação associado ao local.

Fim dos campos mutuamente exclusivos.

Corpo da resposta

Mensagem de resposta para Verifications.VerifyLocation.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "verification": {
    object (Verification)
  }
}
Campos
verification

object (Verification)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

VerificationToken

Token gerado por um parceiro aprovado.

Representação JSON
{
  "tokenString": string
}
Campos
tokenString

string

A string do token.