Method: accounts.locations.verify

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

HTTP-запрос

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:verify

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

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

Параметры
name

string

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

Тело запроса

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

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

  // Union field RequestData can be only one of the following:
  "emailInput": {
    object (EmailInput)
  },
  "addressInput": {
    object (AddressInput)
  },
  "phoneInput": {
    object (PhoneInput)
  }
  // End of list of possible types for union field RequestData.
}
Поля
method

enum ( VerificationMethod )

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

languageCode

string

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

context

object ( ServiceBusinessContext )

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

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

object ( EmailInput )

Входные данные для метода EMAIL.

addressInput

object ( AddressInput )

Входные данные для метода ADDRESS.

phoneInput

object ( PhoneInput )

Входные данные для метода PHONE_CALL/SMS

Тело ответа

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

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

JSON-представление
{
  "verification": {
    object (Verification)
  }
}
Поля
verification

object ( Verification )

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

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

Требуется одна из следующих областей OAuth:

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

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

Электронная почтаВвод

Вход для подтверждения EMAIL.

JSON-представление
{
  "emailAddress": string
}
Поля
emailAddress

string

Адрес электронной почты, на который следует отправить PIN-код.

Адрес электронной почты принимается, только если он является одним из адресов, предоставленных location.fetchVerificationOptions. Если для EmailVerificationData isUserNameEditable установлено значение true, клиент может указать другое имя пользователя (локальную часть), но оно должно совпадать с именем домена.

АдресВвод

Вход для проверки АДРЕСА.

JSON-представление
{
  "mailerContactName": string
}
Поля
mailerContactName

string

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

Телефонный ввод

Вход для подтверждения PHONE_CALL/SMS.

JSON-представление
{
  "phoneNumber": string
}
Поля
phoneNumber

string

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