- HTTP-запрос
- Параметры пути
- Тело запроса
- Тело ответа
- Области авторизации
- Вариант проверки
- Данные проверки адреса
- Данные проверки электронной почты
Сообщает обо всех подходящих вариантах проверки для местоположения на определенном языке.
HTTP-запрос
POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
location | Необходимый. Местоположение для проверки. |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{
"languageCode": string,
"context": {
object ( |
Поля | |
---|---|
languageCode | Необходимый. Код языка BCP 47, представляющий язык, который будет использоваться в процессе проверки. Доступные параметры зависят от языка. |
context | Необязательный. Дополнительная контекстная информация для проверки предприятий сферы услуг. Может применяться только к филиалам с типом деятельности CUSTOMER_LOCATION_ONLY. Указание точного адреса может предоставить больше возможностей. INVALID_ARGUMENT будет выброшен, если он установлен для других типов местоположений. |
Тело ответа
Ответное сообщение для Verifications.FetchVerificationOptions.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"options": [
{
object ( |
Поля | |
---|---|
options[] | Доступные варианты проверки. |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/business.manage
Дополнительную информацию см. в обзоре OAuth 2.0 .
Вариант проверки
Опция проверки определяет, как проверить местоположение (указывается методом проверки) и куда будет отправлено подтверждение (указано отображаемыми данными).
JSON-представление |
---|
{ "verificationMethod": enum ( |
Поля | |
---|---|
verificationMethod | Метод проверки местоположения. |
Поле объединения DisplayData . Один из отображаемых данных. Данные должны соответствовать методу. Пусто, если соответствующий метод не имеет данных для отображения. DisplayData может быть только одним из следующих: | |
phoneNumber | Устанавливайте только в том случае, если выбран метод PHONE_CALL или SMS. Номер телефона, на который будет отправлен PIN-код. |
addressData | Устанавливается только в том случае, если используется метод MAIL. |
emailData | Устанавливается только в том случае, если используется метод EMAIL. |
announcement | Устанавливается только в том случае, если метод VETTED_PARTNER. |
Данные проверки адреса
Отображение данных для проверок через открытку.
JSON-представление |
---|
{
"business": string,
"address": {
object ( |
Поля | |
---|---|
business | Фирменное наименование продавца. |
address | Адрес, на который можно отправить открытку. |
expectedDeliveryDaysRegion | Ожидаемое количество дней, которое потребуется для доставки открытки в регион адреса. |
Данные проверки электронной почты
Отображение данных для проверок по электронной почте.
JSON-представление |
---|
{ "domain": string, "user": string, "isUserNameEditable": boolean } |
Поля | |
---|---|
domain | Доменное имя в адресе электронной почты. например «gmail.com» в foo@gmail.com |
user | Имя пользователя в адресе электронной почты. например, «foo» в адресе foo@gmail.com |
isUserNameEditable | Разрешено ли клиенту указывать другое имя пользователя. |