- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- VerificationOption
- PhoneVerificationData
- AddressVerificationData
- EmailVerificationData
Informa todas las opciones de verificación aptas para una ubicación en un idioma específico.
Solicitud HTTP
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:fetchVerificationOptions
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros | |
|---|---|
name |
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 | |
|---|---|
{
"languageCode": string,
"context": {
object ( |
|
| Campos | |
|---|---|
languageCode |
Es el código de idioma BCP 47 que representa el idioma que se utilizará en el proceso de verificación. Las opciones disponibles varían según el idioma. |
context |
Información de contexto adicional para la verificación de empresas de servicios. Obligatorio para las ubicaciones cuyo tipo de empresa es CUSTOMER_LOCATION_ONLY. Se mostrará INVALID_ARGUMENT si se establece para otros tipos de ubicaciones de empresas. |
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Mensaje de respuesta para Verifications.Fetch VerificationOptions.
| Representación JSON | |
|---|---|
{
"options": [
{
object ( |
|
| Campos | |
|---|---|
options[] |
Las opciones de verificación disponibles. |
Alcances de la autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/plus.business.managehttps://www.googleapis.com/auth/business.manage
Para obtener más información, consulta la descripción general de OAuth 2.0.
VerificationOption
La opción de verificación representa cómo verificar la ubicación (indicada con el método de verificación) y a dónde se enviará la verificación (indicado con datos en pantalla).
| Representación JSON | |
|---|---|
{ "verificationMethod": enum ( |
|
| Campos | ||
|---|---|---|
verificationMethod |
Es el método para verificar la ubicación. |
|
Campo de unión DisplayData. Uno de los datos de la pantalla. Los datos deben coincidir con el método. Estará vacío si el método correspondiente no tiene ningún dato de la pantalla. Las direcciones (DisplayData) solo pueden ser una de las siguientes opciones: |
||
phoneData |
Se establece solo si el método es PHONE_CALL o SMS. |
|
addressData |
Se establece solo si el método es mail. |
|
emailData |
Se establece solo si el método es EMAIL. |
|
PhoneVerificationData
Mostrar datos para las verificaciones por teléfono, p.ej., llamada telefónica, SMS.
| Representación JSON | |
|---|---|
{ "phoneNumber": string } |
|
| Campos | |
|---|---|
phoneNumber |
Número de teléfono al que se enviará el PIN. |
AddressVerificationData
Mostrar datos para las verificaciones a través de una postal
| Representación JSON | |
|---|---|
{
"businessName": string,
"address": {
object ( |
|
| Campos | |
|---|---|
businessName |
Nombre de la empresa del comercio. |
address |
Dirección a la que se puede enviar una postal. |
EmailVerificationData
Mostrar datos para las verificaciones por correo electrónico
| Representación JSON | |
|---|---|
{ "domainName": string, "userName": string, "isUserNameEditable": boolean } |
|
| Campos | |
|---|---|
domainName |
Nombre de dominio en la dirección de correo electrónico. p.ej., "gmail.com" en foo@gmail.com |
userName |
Indica el nombre de usuario en la dirección de correo electrónico. p.ej., “foo” en foo@gmail.com |
isUserNameEditable |
Indica si el cliente puede proporcionar un nombre de usuario diferente. |