Method: locations.verify

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

HTTP-запрос

POST https://mybusinessverifications.googleapis.com/v1/{name=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:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  }
  // End of list of possible types for union field RequestData.
}
Поля
method

enum ( VerificationMethod )

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

languageCode

string

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

context

object ( ServiceBusinessContext )

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

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

string

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

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

mailerContact

string

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

phoneNumber

string

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

token

object ( VerificationToken )

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

Тело ответа

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

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

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

object ( Verification )

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

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

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

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

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

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

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

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

string

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