Method: locations.fetchVerificationOptions

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

HTTP-запрос

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

URL имеет синтаксис gRPC Transcoding.

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

Параметры
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 Overview.

VerificationOption

Вариант подтверждения – это способ подтверждения адреса (указывается в поле verification method) и место, куда будет отправлен запрос на подтверждение (указывается в поле display data).

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  },
  "announcement": string
  // End of mutually exclusive fields.
}
Поля
verificationMethod

enum (VerificationMethod)

Способ подтверждения адреса.
Один из элементов данных. Данные должны соответствовать методу. Если для соответствующего способа нет данных, поле остается пустым. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
phoneNumber

string

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

object (AddressVerificationData)

Задается, только если выбран метод MAIL.
emailData

object (EmailVerificationData)

Задается, только если выбран метод EMAIL.
announcement

string

Указывается, только если выбран метод VETTED_PARTNER.
Конец взаимоисключающих полей.

AddressVerificationData

Показывает данные о подтверждениях с помощью открытки.

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

string

Название компании продавца.
address

object (PostalAddress)

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

integer

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

EmailVerificationData

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

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

string

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

string

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

boolean

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