Package google.mybusiness.verifications.v1

Индекс

Проверки

Этот API позволяет управлять проверкой местоположения в Google. Он позволяет вам управлять ресурсами [Verification] [google.mybusiness.v1.Verification].

Каждое [Location] [google.mybusiness.businessinformation.locations.v1.Location] содержит набор ресурсов [Verification] [google.mybusiness.verifications] с именами locations/*/verifications/* .

Полная проверка

rpc CompleteVerification( CompleteVerificationRequest ) returns ( CompleteVerificationResponse )

Завершает PENDING проверку.

Это необходимо только для AUTO методов проверки. Запрос на AUTO мгновенно VERIFIED после создания.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

FetchVerificationOptions

rpc FetchVerificationOptions( FetchVerificationOptionsRequest ) returns ( FetchVerificationOptionsResponse )

Сообщает обо всех подходящих вариантах проверки для местоположения на определенном языке.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

Список проверок

rpc ListVerifications( ListVerificationsRequest ) returns ( ListVerificationsResponse )

Список проверок местоположения, упорядоченный по времени создания.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

Проверить местоположение

rpc VerifyLocation( VerifyLocationRequest ) returns ( VerifyLocationResponse )

Запускает процесс проверки местоположения.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

VoiceOfMerchant

Эта услуга позволяет пользователям 3P запрашивать подробную информацию о состоянии продавца.

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState( GetVoiceOfMerchantStateRequest ) returns ( VoiceOfMerchantState )

Получает состояние VoiceOfMerchant.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

Завершить запрос на проверку

Сообщение запроса для Verifications.CompleteVerificationAction.

Поля
name

string

Необходимый. Имя ресурса для завершения проверки.

pin

string

Необходимый. ПИН-код, полученный продавцом для завершения проверки.

ПолныйVerificationResponse

Ответное сообщение для Verifications.CompleteVerificationAction.

Поля
verification

Verification

Завершенная проверка.

Соблюдать рекомендации

Указывает на то, что местоположение не соответствует нашим правилам .

Поля
recommendation_reason

RecommendationReason

Причина, по которой рекомендуется, чтобы это место соответствовало рекомендациям.

РекомендацияПричина

Указывает, почему расположение было рекомендовано ComplyWithGuidelines.

Перечисления
RECOMMENDATION_REASON_UNSPECIFIED Не указан.
BUSINESS_LOCATION_SUSPENDED Бизнес-локация заблокирована. Чтобы устранить эту проблему, обратитесь к статье Справочного центра .
BUSINESS_LOCATION_DISABLED Местоположение компании отключено. Чтобы устранить эту проблему, обратитесь к статье Справочного центра .

FetchVerificationOptionsRequest

Сообщение запроса для Verifications.FetchVerificationOptions.

Поля
location

string

Необходимый. Местоположение для проверки.

language_code

string

Необходимый. Код языка BCP 47, представляющий язык, который будет использоваться в процессе проверки. Доступные параметры зависят от языка.

context

ServiceBusinessContext

Необязательный. Дополнительная контекстная информация для проверки предприятий сферы услуг. Может применяться только к филиалам с типом бизнеса CUSTOMER_LOCATION_ONLY. Указание точного адреса может предоставить больше возможностей. INVALID_ARGUMENT будет выброшен, если он установлен для других типов местоположений.

FetchVerificationOptionsResponse

Ответное сообщение для Verifications.FetchVerificationOptions.

Поля
options[]

VerificationOption

Доступные варианты проверки.

GetVoiceOfMerchantStateRequest

Сообщение запроса для VoiceOfMerchant.GetVoiceOfMerchantState.

Поля
name

string

Необходимый. Имя ресурса местоположения.

Список проверокЗапрос

Сообщение запроса для Verifications.ListVerifications.

Поля
parent

string

Необходимый. Имя ресурса местоположения, которому принадлежат запросы на проверку.

page_size

int32

Сколько проверок включать на страницу. Минимум — 1, а размер страницы по умолчанию и максимальный размер — 100.

page_token

string

Если указано, возвращает следующую страницу проверок.

ListVerificationsResponse

Ответное сообщение для Verifications.ListVerifications.

Поля
verifications[]

Verification

Список проверок.

next_page_token

string

Если количество проверок превысило запрошенный размер страницы, это поле будет заполнено токеном для получения следующей страницы проверки при последующем вызове. Если атрибутов больше нет, это поле не будет присутствовать в ответе.

Разрешение конфликта владения

Этот тип не имеет полей.

Указывает, что местоположение дублирует другое местоположение, имеющее хорошую репутацию.

СервисБизнесКонтекст

Дополнительные данные для проверки бизнеса услуги.

Поля
address

PostalAddress

Проверочный адрес местоположения. Он используется для включения дополнительных параметров проверки или отправки открытки.

Проверка

Проверка представляет собой попытку проверки местоположения.

Поля
name

string

Имя ресурса проверки.

method

VerificationMethod

Метод проверки.

state

State

Состояние проверки.

create_time

Timestamp

Отметка времени, когда запрашивается проверка.

announcement

string

Необязательный. Объявление ответа устанавливается только в том случае, если метод VETTED_PARTNER.

Состояние

Все возможные состояния проверки.

Перечисления
STATE_UNSPECIFIED Значение по умолчанию приведет к ошибкам.
PENDING Проверка ожидается.
COMPLETED Проверка завершена.
FAILED Проверка не удалась.

Метод проверки

Указывает процессы, используемые Google для проверки местоположения.

Перечисления
VERIFICATION_METHOD_UNSPECIFIED Значение по умолчанию приведет к ошибкам.
ADDRESS Отправьте открытку с проверочным PIN-кодом на определенный почтовый адрес. PIN-код используется для завершения проверки в Google.
EMAIL Отправьте электронное письмо с PIN-кодом подтверждения на определенный адрес электронной почты. PIN-код используется для завершения проверки в Google.
PHONE_CALL Сделайте телефонный звонок с помощью PIN-кода подтверждения на определенный номер телефона. PIN-код используется для завершения проверки в Google.
SMS Отправьте SMS с проверочным PIN-кодом на определенный номер телефона. PIN-код используется для завершения проверки в Google.
AUTO Проверьте местоположение без дополнительных действий пользователя. Эта опция может быть доступна не для всех местоположений.
VETTED_PARTNER Эта опция может быть доступна не для всех местоположений.

Вариант проверки

Опция проверки определяет, как проверить местоположение (указывается методом проверки) и куда будет отправлено подтверждение (указано отображаемыми данными).

Поля
verification_method

VerificationMethod

Метод проверки местоположения.

Поле объединения DisplayData . Один из отображаемых данных. Данные должны соответствовать методу. Пусто, если соответствующий метод не имеет данных для отображения. DisplayData может быть только одним из следующих:
phone_number

string

Устанавливайте только в том случае, если выбран метод PHONE_CALL или SMS. Номер телефона, на который будет отправлен PIN-код.

address_data

AddressVerificationData

Устанавливается только в том случае, если используется метод MAIL.

email_data

EmailVerificationData

Устанавливается только в том случае, если используется метод EMAIL.

announcement

string

Устанавливается только в том случае, если метод VETTED_PARTNER.

Данные проверки адреса

Отображение данных для проверок через открытку.

Поля
business

string

Фирменное наименование продавца.

address

PostalAddress

Адрес, на который можно отправить открытку.

expected_delivery_days_region

int32

Ожидаемое количество дней, необходимое для доставки открытки в регион адреса.

Данные проверки электронной почты

Отображение данных для проверок по электронной почте.

Поля
domain

string

Доменное имя в адресе электронной почты. например «gmail.com» в foo@gmail.com

user

string

Имя пользователя в адресе электронной почты. например, «foo» в адресе foo@gmail.com

is_user_name_editable

bool

Разрешено ли клиенту указывать другое имя пользователя.

токен верификации

Токен, созданный проверенным партнером .

Поля
token_string

string

Строка токена.

Проверять

Указывает, что местоположение требует проверки. Содержит информацию о текущих действиях по проверке, выполненных на объекте.

Поля
has_pending_verification

bool

Указывает, начался ли процесс проверки и может ли он быть завершен в этом месте.

VerifyLocationRequest

Сообщение запроса для Verifications.VerifyLocation.

Поля
name

string

Необходимый. Имя ресурса местоположения для проверки.

method

VerificationMethod

Необходимый. Метод проверки.

language_code

string

Необязательный. Код языка BCP 47, представляющий язык, который будет использоваться в процессе проверки.

context

ServiceBusinessContext

Необязательный. Дополнительная контекстная информация для проверки предприятий сферы услуг. Это необходимо только для местоположений, тип бизнеса которых CUSTOMER_LOCATION_ONLY. Для проверки АДРЕСА адрес будет использоваться для отправки открытки. Для других методов он должен быть таким же, как тот, который передается GetVerificationOptions. INVALID_ARGUMENT будет выброшен, если он установлен для других типов предприятий.

Поле объединения RequestData . Вводимые пользователем данные для конкретного метода в дополнение к данным дисплея. Данные должны соответствовать запрошенному методу. Оставьте это поле пустым, если данные не нужны. RequestData может быть только одним из следующих:
email_address

string

Необязательный. Входные данные для метода EMAIL. Адрес электронной почты, на который следует отправить PIN-код.

Адрес электронной почты принимается, только если он является одним из адресов, предоставленных FetchVerificationOptions. Если для параметра [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] для параметра is_user_name_editable установлено значение true, клиент может указать другое имя пользователя (локальную часть), но оно должно совпадать с именем домена.

mailer_contact

string

Необязательный. Входные данные для метода ADDRESS. Имя контактного лица, на которое должно быть отправлено письмо.

phone_number

string

Необязательный. Входные данные для метода PHONE_CALL/SMS Номер телефона, на который следует позвонить или на который следует отправить SMS. Это должен быть один из номеров телефонов в подходящих вариантах.

token

VerificationToken

Необязательный. Входные данные для метода VETTED_PARTNER доступны для выбора партнеров. Для проверенной учетной записи данные не требуются. Токен, связанный с местоположением. Токен, связанный с местоположением.

Верифицилокатионответ

Ответное сообщение для Verifications.VerifyLocation.

Поля
verification

Verification

Созданный запрос на проверку.

VoiceOfMerchantState

Ответное сообщение для VoiceOfMerchant.GetVoiceOfMerchantState.

Поля
has_voice_of_merchant

bool

Указывает, имеет ли местоположение хорошую репутацию и контролирует ли он компанию в Google. Любые изменения, внесенные в местоположение, распространятся на Карты после прохождения этапа проверки.

has_business_authority

bool

Указывает, имеет ли местоположение полномочия (право собственности) на компанию в Google. Если это правда, другое местоположение не может занять доминирующее положение на Картах. Однако изменения не вступят в силу, если не будет получен «Голос торговца» (т. е. has_voice_of_merchant имеет значение true).

Поле объединения gain_voice_of_merchant_action . Рекомендовано действие, чтобы получить контроль над компанией в Google. gain_voice_of_merchant_action может быть только одним из следующих:
wait_for_voice_of_merchant

WaitForVoiceOfMerchant

Подождите, чтобы получить Голос Торговца. Местоположение находится на проверке в целях обеспечения качества.

verify

Verify

Запустите или продолжите процесс проверки.

resolve_ownership_conflict

ResolveOwnershipConflict

Это место дублирует другое место, имеющее хорошую репутацию. Если у вас есть доступ к этому местоположению с хорошей репутацией, используйте идентификатор этого местоположения для выполнения операций. В противном случае запросите доступ у текущего владельца.

comply_with_guidelines

ComplyWithGuidelines

Местоположение не соответствует нашим рекомендациям и требует дополнительных действий для восстановления. Чтобы устранить эту проблему, обратитесь к статье Справочного центра .

WaitForVoiceOfMerchant

Этот тип не имеет полей.

Указывает, что после прохождения проверки местоположение получит голос продавца.