REST Resource: brands.agents

Ресурс: Агент

Диалоговая сущность, представляющая бренд.

JSON-представление
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}
Поля
name

string

Уникальный идентификатор агента.

Только для чтения. Определяется платформой.

displayName

string

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

Не подлежит изменению после проверки агента.

Поле объединения detail_info . Содержит поля, необходимые для конкретного продукта.

Необходимый. detail_info может быть только одним из следующих:

businessMessagesAgent

object ( BusinessMessagesAgent )

Подробная информация об агенте для Business Messages.

rcsBusinessMessagingAgent

object ( RcsBusinessMessagingAgent )

Подробная информация об агенте для RCS Business Messaging.

БизнесСообщенияАгент

Информация об агенте, относящаяся к бизнес-сообщениям.

JSON-представление
{
  "logoUrl": string,
  "entryPointConfigs": [
    {
      object (BusinessMessagesEntryPointConfig)
    }
  ],
  "conversationalSettings": {
    string: {
      object (ConversationalSetting)
    },
    ...
  },
  "defaultLocale": string,
  "primaryAgentInteraction": {
    object (SupportedAgentInteraction)
  },
  "additionalAgentInteractions": [
    {
      object (SupportedAgentInteraction)
    }
  ],
  "customAgentId": string,
  "agentTestUrl": string,
  "testUrls": [
    {
      object (TestUrl)
    }
  ],
  "phone": {
    object (Phone)
  },
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "nonLocalConfig": {
    object (NonLocalConfig)
  },
  "surveyConfig": {
    object (SurveyConfig)
  }
}
Поля
logoUrl

string

Необязательный. Общедоступный URL-адрес логотипа агента. Максимум 50 КБ.

Не подлежит изменению после проверки агента.

entryPointConfigs[]

object ( BusinessMessagesEntryPointConfig )

Необязательный. Список конфигураций точки входа.

Не подлежит изменению после проверки агента.

conversationalSettings

map (key: string, value: object ( ConversationalSetting ))

Необходимый. Настройки диалога для агента, сопоставленные с языковым стандартом. Локаль представлена ​​правильно сформированным языковым тегом IETF BCP 47 .

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

defaultLocale

string

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

primaryAgentInteraction

object ( SupportedAgentInteraction )

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

additionalAgentInteractions[]

object ( SupportedAgentInteraction )

Необязательный. Дополнительная информация о взаимодействии агента. Позволяет агенту поддерживать несколько типов взаимодействия.

customAgentId

string

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

agentTestUrl
(deprecated)

string

Только вывод. URL-адрес для тестирования взаимодействия с агентом.

Определяется платформой.

testUrls[]

object ( TestUrl )

Только вывод. URL-адреса для тестирования взаимодействия с агентом.

Определяется платформой.

phone

object ( Phone )

Необязательный. Номер телефона, который будет отображаться агентом. Если не указано, агент отображает номер телефона бренда, найденный в Google Knowledge Graph , если таковой имеется.

authorizationConfig

object ( AuthorizationConfig )

Необязательный. Конфигурация авторизации для поддержки OAuth.

nonLocalConfig

object ( NonLocalConfig )

Необязательный. Конфигурация для нелокальных точек входа.

surveyConfig

object ( SurveyConfig )

Необязательный. Конфигурация для включения пользовательских опросов.

БизнесСообщенияEntryPointConfig

Конфигурация точки входа для агента.

JSON-представление
{
  "allowedEntryPoint": enum (EntryPoint)
}
Поля
allowedEntryPoint

enum ( EntryPoint )

Необходимый. Поверхности Google, на которых агент может появляться.

Входная точка

Поверхности Google, на которых агент может появляться.

Перечисления
ENTRY_POINT_UNSPECIFIED Неуказанная точка входа.
LOCATION Включите местоположения для этого агента.
NON_LOCAL Включите бизнес-сообщения для нелокальных точек входа.

Поддерживаемое взаимодействие агентов

Взаимодействия, поддерживаемые агентом.

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

  // Union field representative can be only one of the following:
  "botRepresentative": {
    object (BotRepresentative)
  },
  "humanRepresentative": {
    object (HumanRepresentative)
  }
  // End of list of possible types for union field representative.
}
Поля
interactionType

enum ( InteractionType )

Необходимый. Тип взаимодействия, поддерживаемый агентом.

Полевой representative Союза. Подробная информация о типе конфигурации. Необходимый. representative может быть только одно из следующих лиц:
botRepresentative

object ( BotRepresentative )

Подробности представителя бота.

humanRepresentative

object ( HumanRepresentative )

Подробности о представителях человека.

Тип взаимодействия

Тип взаимодействия, поддерживаемый агентом.

Перечисления
INTERACTION_TYPE_UNSPECIFIED Неопределенное взаимодействие.
BOT Взаимодействие с ботом.
HUMAN Человеческое взаимодействие.

Представитель бота

Подробности для представителя бота.

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

object ( MessagingAvailability )

Необходимый. Доступность обмена сообщениями ботов.

Доступность обмена сообщениями

Часы каждого дня недели, в которые доступен обмен сообщениями. Вы можете группировать часы на несколько дней. Например, * 08:00–16:00 по тихоокеанскому времени с понедельника по среду * 10:00–14:00 по тихоокеанскому времени с четверга по пятницу * 15:00–18:00 по тихоокеанскому времени с четверга по пятницу * 10:00–14:00 часы PDT суббота – суббота

Если есть перерывы в доступности, например отсутствие указанной доступности в воскресенье, обмен сообщениями будет недоступен во время этих перерывов.

Часы работы ботов не влияют на доступность. Агенты, работающие только с ботами, всегда отображают приветственное сообщение, в то время как агенты с настройками как человека, так и представителя бота учитывают только представителей человека при определении доступности.

JSON-представление
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Поля
hours[]

object ( Hours )

Необходимый. Часы доступности сообщений.

Часы

Диапазон часов, в течение которых доступен обмен сообщениями.

JSON-представление
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Поля
startTime

object ( TimeOfDay )

Необходимый. Время начала каждого дня в диапазоне дней недели.

endTime

object ( TimeOfDay )

Необходимый. Время окончания каждого дня в диапазоне дней недели.

timeZone

string

Необходимый. Часовой пояс IANA для часов. Например, «Америка/Лос-Анджелес».

startDay

enum ( DayOfWeek )

Необходимый. Начало дня.

endDay

enum ( DayOfWeek )

Необходимый. Конец дня. Включает указанный день.

ВремяДня

Обозначает время суток. Дата и часовой пояс либо не имеют значения, либо указаны в другом месте. API может разрешить високосные секунды. Связанные типы: google.type.Date и google.protobuf.Timestamp .

JSON-представление
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Поля
hours

integer

Часы суток в 24-часовом формате. Должно быть от 0 до 23. API может разрешить использование значения «24:00:00» для таких сценариев, как время закрытия предприятия.

minutes

integer

Минуты часа дня. Должно быть от 0 до 59.

seconds

integer

Секунды минут времени. Обычно должно быть от 0 до 59. API может допускать значение 60, если он допускает дополнительные секунды.

nanos

integer

Доли секунды в наносекундах. Должно быть от 0 до 999 999 999.

День недели

Представляет день недели.

Перечисления
DAY_OF_WEEK_UNSPECIFIED День недели не указан.
MONDAY Понедельник
TUESDAY Вторник
WEDNESDAY Среда
THURSDAY Четверг
FRIDAY Пятница
SATURDAY Суббота
SUNDAY Воскресенье

ЧеловекПредставитель

Подробности для представителя человека.

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

object ( MessagingAvailability )

Необходимый. Доступность обмена сообщениями между людьми.

Конфигурация авторизации

Подробности конфигурации для поддержки OAuth в бизнес-сообщениях.

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

string

URL-адрес конечной точки, по которой пользователь входит в систему.

Нелокальная конфигурация

Конфигурация для включения нелокальных точек входа.

JSON-представление
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Поля
contactOption

object ( ContactOption )

Необходимый. Контактная информация агента, которая отображается рядом с кнопкой обмена сообщениями.

enabledDomains[]

string

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

phoneNumber

object ( Phone )

Необходимый. Телефон агента. Переопределяет поле phone для разговоров, начатых из нелокальных точек входа. Этот номер телефона будет использоваться для всех настроенных регионов.

callDeflectionPhoneNumbers[]

object ( Phone )

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

regionCodes[]

string

Необходимый. Список кодов регионов CLDR для стран, в которых агенту разрешено запускать точки входа NON_LOCAL . Требуется для точек входа NON_LOCAL .

КонтактОпция

Контактные данные отображаются рядом с кнопкой обмена сообщениями.

JSON-представление
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Поля
url

string

Необходимый. URL-адрес, для которого доступны параметры связи.

options[]

enum ( Option )

Необходимый. Список вариантов контактов, доступных для указанного URL-адреса.

Вариант

Варианты контактов.

Перечисления
OPTION_UNSPECIFIED Неопределенные
WEB_CHAT Опция веб-чата.
PHONE Телефонный вариант.
EMAIL Вариант электронной почты.
FAQS Вариант часто задаваемых вопросов.
TWITTER вариант Твиттера.
WHATSAPP Вариант WhatsApp.

SurveyConfig

Подробности конфигурации для поддержки настраиваемых вопросов опроса.

JSON-представление
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
Поля
templateQuestionIds[]

string

Список идентификаторов шаблонных вопросов для шаблонных вопросов, включенных в опрос.

customSurveys

map (key: string, value: object ( CustomSurveyConfig ))

Пользовательские вопросы опроса для агента, сопоставленные с языковым стандартом. Локаль представлена ​​правильно сформированным языковым тегом IETF BCP 47 .

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

CustomSurveyConfig

Пользовательская конфигурация опроса для агента.

JSON-представление
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Поля
customQuestions[]

object ( SurveyQuestion )

Список индивидуальных вопросов.

ОпросВопрос

Подробное содержание каждого вопроса опроса.

JSON-представление
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Поля
name

string

Необходимый. Уникальный идентификатор вопроса.

questionType

enum ( Type )

Только вывод. Тип вопроса.

questionContent

string

Необходимый. Содержание вопроса. Ограничение до 200 символов для пользовательских вопросов.

responseOptions[]

object ( SurveyResponse )

Необходимый. Список ответов, отображаемых вместе с вопросом. Максимум 12.

Тип

Тип вопроса опроса.

Перечисления
TYPE_UNSPECIFIED Неизвестный тип вопроса опроса.
GOOGLE_STANDARD_QUESTION Стандартный вопрос опроса Google.
GOOGLE_TEMPLATE_QUESTION Google предоставил шаблон вопроса для опроса.
PARTNER_CUSTOM_QUESTION Индивидуальный вопрос для опроса партнеров.

Ответ на опрос

Содержимое ответа на вопрос опроса.

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

string

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

postbackData

string

Строка, которую агент получает, когда пользователь нажимает на ответ на вопрос.

RcsBusinessMessagingAgent

Информация об агенте, непосредственно связанная с RCS Business Messaging.

JSON-представление
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion)
}
Поля
description

string

Необходимый. Описание агента, видимое пользователям. Максимум 100 символов.

logoUri

string

Необходимый. Общедоступный URL-адрес логотипа агента. Максимум 50 КБ.

Не подлежит изменению после проверки агента.

heroUri

string

Необходимый. Общедоступный URL-адрес главного изображения агента. Максимум 200 КБ.

Не подлежит изменению после проверки агента.

phoneNumbers[]

object ( PhoneEntry )

Необходимый. Номера телефонов, привязанные к агенту.

emails[]

object ( EmailEntry )

Необязательный. Адреса электронной почты, связанные с агентом.

websites[]

object ( WebEntry )

Необязательный. Веб-сайты, связанные с агентом. Максимум 3.

privacy

object ( WebEntry )

Необходимый. Политика конфиденциальности, связанная с агентом.

termsConditions

object ( WebEntry )

Необходимый. Условия, связанные с агентом.

color

string

Необходимый. Цвет темы агента, видимый пользователям, в шестнадцатеричном формате. Например, #FF6347.

billingConfig

object ( RcsBusinessMessagingAgentBillingConfig )

Необходимый. Конфигурация выставления счетов для агента.

agentUseCase

enum ( AgentUseCase )

Необязательный. Вариант использования бота.

hostingRegion

enum ( HostingRegion )

Необходимый. Регион размещения агента.

ТелефонВход

Номер телефона, связанный с агентом.

JSON-представление
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Поля
phoneNumber

object ( Phone )

Необходимый. Номер телефона в формате E.164. Например, +12223334444 .

label

string

Необходимый. Ярлык для номера телефона.

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

Электронная почта, связанная с агентом.

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

string

Необходимый. Адрес электронной почты.

label

string

Необходимый. Ярлык для адреса электронной почты.

Веб-вход

Веб-ресурс, связанный с агентом.

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

string

Необходимый. Общедоступный URI, связанный с агентом. Необходимо использовать протокол HTTP или HTTPS.

label

string

Необязательный. Метка для URI.

RcsBusinessMessagingAgentBillingConfig

Платежная конфигурация для агента.

JSON-представление
{
  "billingCategory": enum (BillingCategory)
}
Поля
billingCategory

enum ( BillingCategory )

Категория выставления счетов для агента.

Категория биллинга

Поддерживаемые категории выставления счетов.

Перечисления
BILLING_CATEGORY_UNSPECIFIED Категория не указана.
CONVERSATIONAL_LEGACY Устаревшая категория для поддержки конфигурации выставления счетов существующих агентов.
CONVERSATIONAL Предназначен для более длительных и сложных сессий, во время которых пользователь и бренд обмениваются серией сообщений.
SINGLE_MESSAGE Заменяет SMS более богатым опытом обмена сообщениями. Никогда не считался РАЗГОВОРНЫМ.
BASIC_MESSAGE Модель биллинга аналогична SMS. Никогда не считался РАЗГОВОРНЫМ.

АгентUseCase

Типы вариантов использования агента, используемые в хранилище.

Перечисления
AGENT_USE_CASE_UNSPECIFIED Вариант использования не указан.
TRANSACTIONAL Агенты, которые отправляют только важные, необходимые и срочные сообщения.
PROMOTIONAL Агенты, которые рассылают рекламные, маркетинговые и рекламные сообщения. Тип по умолчанию.
OTP Агенты, которые отправляют только одноразовые пароли.
MULTI_USE Агенты, которые имеют несколько вариантов использования.

ХостингРегион

Возможные регионы размещения агента, используемые для правильной маршрутизации сообщений P2A на региональный сервер.

Перечисления
HOSTING_REGION_UNSPECIFIED Неуказанный регион хостинга.
NORTH_AMERICA Северная Америка.
EUROPE Европа.
ASIA_PACIFIC Азиатско-Тихоокеанский регион.

Методы

create

 Создает нового агента для представления бренда.

delete
(deprecated)

 Устарело: удаление агента устарело.

get

 Получить информацию об агенте.

getLaunch

 Получает информацию о запуске агента.

getVerification

 Получает проверочную информацию для агента.

list

 Перечисляет всех агентов, связанных с брендом.

patch

 Обновляет информацию об агенте.

requestLaunch

 Начинает процесс запуска агента.

requestVerification

 Начинает проверку деловой информации для агента.

updateLaunch

 Обновляет информацию о запуске агента.

updateVerification

 Обновляет состояние проверки агента.