Package google.mybusiness.verifications.v1

Índice

Verificaciones

Esta API permite administrar las verificaciones de ubicación en Google. Te permite administrar los recursos de [verificación] [google.mybusiness.v1.verification].

Cada [Ubicación] [google.mybusiness.businessinformation.locations.v1.Location] tiene una colección de recursos de [Verificación] [google.mybusiness.verifications], que se denomina locations/*/verifications/*.

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

Completa una verificación de PENDING.

Solo es necesaria para los métodos de verificación que no sean de AUTO. La solicitud de verificación de AUTO se convierte en VERIFIED inmediatamente después de la creación.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

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

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

Informa todas las opciones de verificación aptas para una ubicación en un idioma específico.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

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

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

Enumera las verificaciones de una ubicación, ordenadas por hora de creación.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

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

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

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

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

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

VoiceOfMerchant

Este servicio permite a los usuarios externos solicitar detalles sobre la voz del estado del comercio.

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState(GetVoiceOfMerchantStateRequest) returns (VoiceOfMerchantState)

Obtiene el estado de VoiceOfMerchant.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

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

CompleteVerificationRequest

Mensaje de solicitud para Verifications.CompleteVerifyAction.

Campos
name

string

Obligatorio. Nombre del recurso de la verificación que se debe completar.
pin

string

Obligatorio. Código PIN que recibió el comercio para completar la verificación

CompleteVerificationResponse

Mensaje de respuesta para Verifications.Complete VerificationAction.

Campos
verification

Verification

Se completó la verificación.

ComplyWithGuidelines

Indica que la ubicación no cumple con nuestros lineamientos.

Campos
recommendation_reason

RecommendationReason

Es el motivo por el que se recomienda que la ubicación cumpla con los lineamientos.

RecommendationReason

Indica por qué la ubicación se recomendó a Cumple con los lineamientos.

Enumeradores
RECOMMENDATION_REASON_UNSPECIFIED No se especifica.
BUSINESS_LOCATION_SUSPENDED La ubicación de la empresa está suspendida. Para solucionar este problema, consulta el artículo del Centro de ayuda.
BUSINESS_LOCATION_DISABLED La ubicación de la empresa está inhabilitada. Para solucionar este problema, consulta el artículo del Centro de ayuda.

FetchVerificationOptionsRequest

Mensaje de solicitud para Verifications.Fetch VerificationOptions.

Campos
location

string

Obligatorio. La ubicación que se verificará.
language_code

string

Obligatorio. 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. Las opciones disponibles varían según el idioma.
context

ServiceBusinessContext

Opcional. Información de contexto adicional para la verificación de las empresas de servicios. Solo se puede aplicar a las ubicaciones cuyo tipo de empresa es CUSTOMER_LOCATION_ONLY. Si especificas una dirección precisa, se podrían habilitar más opciones. Se mostrará INVALID_{8/} si se establece para otros tipos de ubicaciones de empresas.

FetchVerificationOptionsResponse

Mensaje de respuesta para Verifications.FetchverificationOptions.

Campos
options[]

VerificationOption

Las opciones de verificación disponibles.

GetVoiceOfMerchantStateRequest

Mensaje de solicitud para VoiceOfMerchant.GetVoiceOfMerchantState.

Campos
name

string

Obligatorio. Es el nombre del recurso de la ubicación.

ListVerificationsRequest

Mensaje de solicitud para Verifications.List Verifications.

Campos
parent

string

Obligatorio. Nombre del recurso de la ubicación a la que pertenecen las solicitudes de verificación.
page_size

int32

Cantidad de verificaciones que se deben incluir por página. El mínimo es 1 y el tamaño predeterminado y el máximo de la página es 100.
page_token

string

Si se especifica, muestra la siguiente página de verificaciones.

ListVerificationsResponse

Mensaje de respuesta para Verifications.ListVerifys.

Campos
verifications[]

Verification

Lista de verificaciones.
next_page_token

string

Si la cantidad de verificaciones supera el tamaño de la página solicitada, este campo se completará con un token para recuperar la página de verificación siguiente en una llamada posterior. Si no hay más atributos, este campo no estará presente en la respuesta.

ResolveOwnershipConflict

Este tipo no tiene campos.

Indica que la ubicación duplica otra ubicación que esté en regla.

ServiceBusinessContext

Datos adicionales para la verificación de empresas de servicios.

Campos
address

PostalAddress

Es la dirección de verificación de la ubicación. Se utiliza para habilitar más opciones de verificación o para enviar una postal.

Verificación

Una verificación representa un intento de verificación en una ubicación.

Campos
name

string

Es el nombre del recurso de la verificación.
method

VerificationMethod

Es el método de verificación.
state

State

El estado de la verificación.
create_time

Timestamp

La marca de tiempo en la que se solicitó la verificación.
announcement

string

Opcional. El anuncio de respuesta se establece solo si el método es VETTED_PARTNER.

Estado

Todos los estados de verificación posibles

Enumeradores
STATE_UNSPECIFIED Valor predeterminado, generará errores.
PENDING La verificación está pendiente.
COMPLETED Se completó la verificación.
FAILED Se produjo un error durante la verificación.

VerificationMethod

Especifica los procesos que utiliza Google para verificar una ubicación.

Enumeradores
VERIFICATION_METHOD_UNSPECIFIED Valor predeterminado, generará errores.
ADDRESS Envía una postal con un PIN de verificación a una dirección de correo postal específica. El PIN se usa para completar la verificación con Google.
EMAIL Envía un correo electrónico con un PIN de verificación a una dirección de correo electrónico específica. El PIN se usa para completar la verificación con Google.
PHONE_CALL Hacer una llamada telefónica con un PIN de verificación a un número de teléfono específico El PIN se usa para completar la verificación con Google.
SMS Envía un SMS con un PIN de verificación a un número de teléfono específico. El PIN se usa para completar la verificación con Google.
AUTO Verifica la ubicación sin que el usuario realice ninguna acción adicional. Es posible que esta opción no esté disponible en todas las ubicaciones.
VETTED_PARTNER Es posible que esta opción no esté disponible en todas las ubicaciones.

VerificationOption

La opción de verificación representa cómo verificar la ubicación (indicada por el método de verificación) y a dónde se enviará la verificación (indicada por los datos de visualización).

Campos
verification_method

VerificationMethod

Método para verificar la ubicación.
Campo de unión DisplayData. Uno de los datos de visualización. Los datos deben coincidir con el método. Estará vacío si el método correspondiente no tiene datos de visualización. Las direcciones (DisplayData) solo pueden ser una de las siguientes opciones:
phone_number

string

Solo se debe establecer si el método es PHONE_CALL o SMS. El número de teléfono al que se enviará el PIN.
address_data

AddressVerificationData

Se establece solo si el método es POST.
email_data

EmailVerificationData

Se establece solo si el método es EMAIL.
announcement

string

Se establece solo si el método es VETTED_PARTNER.

AddressVerificationData

Muestra los datos de las verificaciones por tarjeta postal.

Campos
business

string

Nombre de la empresa del comercio
address

PostalAddress

Dirección a la que se puede enviar una tarjeta postal
expected_delivery_days_region

int32

La cantidad estimada de días que se tarda en entregar una tarjeta postal a la región de la dirección.

EmailVerificationData

Muestra datos para las verificaciones por correo electrónico.

Campos
domain

string

Nombre del dominio en la dirección de correo electrónico (p. ej., "gmail.com" en foo@gmail.com)
user

string

Nombre de usuario en la dirección de correo electrónico, p. ej., "foo" en foo@gmail.com
is_user_name_editable

bool

Indica si el cliente puede proporcionar un nombre de usuario diferente.

VerificationToken

Token generado por un socio aprobado.

Campos
token_string

string

Es la string del token.

Verificar

Indica que la ubicación requiere verificación. Contiene información sobre las acciones de verificación actuales realizadas en la ubicación.

Campos
has_pending_verification

bool

Indica si ya se inició un proceso de verificación y si la ubicación puede completarlo.

VerifyLocationRequest

Mensaje de solicitud para Verifications.VerifyLocation.

Campos
name

string

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

VerificationMethod

Obligatorio. Método de verificación.
language_code

string

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

ServiceBusinessContext

Opcional. Información de contexto adicional para la verificación de las empresas de servicios. Solo es 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 los demás métodos, debe ser el mismo que se pasa a GetverificationOptions. 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:
email_address

string

Opcional. Entrada del método EMAIL. Dirección de correo electrónico a la que se debe enviar el PIN.

Una dirección de correo electrónico solo se acepta si es una de las direcciones que proporcionó FetchverificationOptions. Si el campo is_user_name_editable de [Email VerificationData] [google.mybusiness-verifications.v1.verificationOption.Email VerificationData] está configurado como verdadero, el cliente puede especificar un nombre de usuario diferente (parte local), pero debe coincidir con el nombre del dominio.
mailer_contact

string

Opcional. La entrada para el método ADDRESS Nombre del contacto al que se debe enviar el correo electrónico
phone_number

string

Opcional. Entrada para el método PHONE_CALL/SMS 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.
token

VerificationToken

Opcional. Entrada del método VETTED_PARTNER disponible para seleccionar partners.. La entrada no es necesaria para una cuenta aprobada. El token asociado a la ubicación. El token asociado a la ubicación.

VerifyLocationResponse

Mensaje de respuesta para Verifications.VerifyLocation.

Campos
verification

Verification

Es la solicitud de verificación creada.

VoiceOfMerchantState

Mensaje de respuesta para VoiceOfMerchant.GetVoiceOfMerchantState.

Campos
has_voice_of_merchant

bool

Indica si la ubicación está en regla y tiene control sobre la empresa en Google. Las modificaciones que se realicen en la ubicación se propagarán en Maps una vez que se apruebe la fase de revisión.
has_business_authority

bool

Indica si la ubicación tiene autoridad (propiedad) sobre la empresa en Google. Si es así, otra ubicación no puede tomar el control ni convertirse en la ficha dominante en Maps. Sin embargo, las modificaciones no se publicarán, a menos que se active Voice of Merchant (es decir, has_voice_of_merchant es verdadero).
Campo de unión gain_voice_of_merchant_action. Acción recomendada para la ubicación a fin de obtener control sobre la empresa en Google. Las direcciones (gain_voice_of_merchant_action) solo pueden ser una de las siguientes opciones:
wait_for_voice_of_merchant

WaitForVoiceOfMerchant

Espera para obtener Voice of Merchant. La ubicación está en proceso de revisión por motivos de calidad.
verify

Verify

Comienza o continúa el proceso de verificación.
resolve_ownership_conflict

ResolveOwnershipConflict

Esta ubicación duplica otra ubicación que esté en regla. Si tienes acceso a la ubicación en regla, usa el ID de esa ubicación para realizar operaciones. De lo contrario, solicita acceso al propietario actual.
comply_with_guidelines

ComplyWithGuidelines

La ubicación no satisface nuestros lineamientos y requiere pasos adicionales para restablecerse. Para solucionar este problema, consulte el artículo del Centro de ayuda.

WaitForVoiceOfMerchant

Este tipo no tiene campos.

Indica que la ubicación ganará la opinión del comercio después de pasar la revisión.