Method: locations.fetchVerificationOptions

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

HTTP-запрос

POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
location

string

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

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  }
}
Поля
languageCode

string

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

context

object ( ServiceBusinessContext )

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

Тело ответа

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

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "options": [
    {
      object (VerificationOption)
    }
  ]
}
Поля
options[]

object ( VerificationOption )

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

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

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

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

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

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

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

JSON-представление 
{
  "verificationMethod": enum (VerificationMethod),

  // Union field DisplayData can be only one of the following:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  },
  "announcement": string
  // End of list of possible types for union field DisplayData.
}
Поля
verificationMethod

enum ( VerificationMethod )

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

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

string

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

addressData

object ( AddressVerificationData )

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

emailData

object ( EmailVerificationData )

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

announcement

string

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

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

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

JSON-представление 
{
  "business": string,
  "address": {
    object (PostalAddress)
  },
  "expectedDeliveryDaysRegion": integer
}
Поля
business

string

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

address

object ( PostalAddress )

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

expectedDeliveryDaysRegion

integer

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

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

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

JSON-представление 
{
  "domain": string,
  "user": string,
  "isUserNameEditable": boolean
}
Поля
domain

string

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

user

string

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

isUserNameEditable

boolean

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