Method: locations.verify

Инициация проверки адреса.

HTTP-запрос

POST https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify

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

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

Параметры
name

string

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

Тело запроса

Ниже приведена структура данных в теле запроса.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  },
  "trustedPartnerToken": string
  // End of mutually exclusive fields.
}
Поля
method

enum (VerificationMethod)

Обязательно. Способ подтверждения.
languageCode

string

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

object (ServiceBusinessContext)

Необязательное поле. Дополнительная информация для подтверждения компаний, оказывающих услуги. Оно обязательно только для адресов, у которых тип компании – CUSTOMER_LOCATION_ONLY. Для подтверждения адреса на него будет отправлена открытка. Для других методов он должен быть таким же, как и переданный в GetVerificationOptions. Если указать его для других типов адресов, будет возвращена ошибка INVALID_ARGUMENT.
Пользовательские данные для определенного способа в дополнение к отображаемым данным. Данные должны соответствовать запрошенному методу. Если данные не нужны, оставьте поле пустым. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
emailAddress

string

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

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

string

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

string

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

object (VerificationToken)

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

string

Входные данные для метода TRUSTED_PARTNER. Токен подтверждения, связанный с адресом.
Конец взаимоисключающих полей.

Тело ответа

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

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

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

object (Verification)

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

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

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

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

Дополнительную информацию вы найдете в OAuth 2.0 Overview.

VerificationToken

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

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

string

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