Method: accounts.locations.verify

Inicia el proceso de verificación de una ubicación.

Solicitud HTTP

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:verify

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Nombre del recurso de la ubicación que se verificará.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "method": enum (VerificationMethod),
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  },

  // Union field RequestData can be only one of the following:
  "emailInput": {
    object (EmailInput)
  },
  "addressInput": {
    object (AddressInput)
  },
  "phoneInput": {
    object (PhoneInput)
  }
  // End of list of possible types for union field RequestData.
}
Campos
method

enum (VerificationMethod)

Método de verificación.
languageCode

string

Es el código de idioma según la norma BCP 47 que representa el idioma que se utilizará en el proceso de verificación.
context

object (ServiceBusinessContext)

Información de contexto adicional para la verificación de las empresas de servicios. Obligatorio para las ubicaciones cuyo tipo de empresa es CUSTOMER_LOCATION_ONLY. Para la verificación de ADDRESS, la dirección se utilizará para enviar la tarjeta postal. Para otros métodos, debe ser el mismo que se pasa a locations.fetch VerificationOptions. Se mostrará INVALID_{8/} si se configura para otros tipos de ubicaciones de la empresa.
Campo de unión RequestData. Son los datos de entrada del usuario para el método específico, además de los datos de visualización. Los datos deben coincidir con el método solicitado. Déjalo vacío si no se necesitan datos. Las direcciones (RequestData) solo pueden ser una de las siguientes opciones:
emailInput

object (EmailInput)

Entrada del método EMAIL.
addressInput

object (AddressInput)

La entrada para el método ADDRESS
phoneInput

object (PhoneInput)

Entrada para el método PHONE_CALL/SMS

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Mensaje de respuesta para Verifications.VerifyLocation.

Representación JSON 
{
  "verification": {
    object (Verification)
  }
}
Campos
verification

object (Verification)

Es la solicitud de verificación creada.

Alcances de la autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

EmailInput

Entrada para la verificación de EMAIL

Representación JSON 
{
  "emailAddress": string
}
Campos
emailAddress

string

Dirección de correo electrónico a la que se debe enviar el PIN.

Solo se acepta una dirección de correo electrónico si es una de las direcciones proporcionadas por locations.fetch VerificationOptions. Si el elemento EmailVerificationData tiene isUserNameEditable configurado como verdadero, el cliente puede especificar un nombre de usuario diferente (parte local), pero debe coincidir con el nombre de dominio.

AddressInput

Entrada para la verificación de ADDRESS

Representación JSON 
{
  "mailerContactName": string
}
Campos
mailerContactName

string

Nombre del contacto al que se debe enviar el correo electrónico

PhoneInput

Entrada para la verificación por PHONE_CALL/SMS.

Representación JSON 
{
  "phoneNumber": string
}
Campos
phoneNumber

string

El número de teléfono al que se debe llamar o al que se debe enviar el SMS. Debe ser uno de los números de teléfono de las opciones aptas.