REST Resource: projects.chatAppConfig

Ресурс: ChatAppConfig

Представляет конфигурацию приложения Google Chat, созданного как дополнение Google Workspace.

JSON-представление 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
Поля
name

string

Обязательно. Идентификатор. Название ресурса конфигурации приложения Chat.

Формат: projects/{project}/chatAppConfig, где {project} – номер проекта Google Cloud.
displayName

string

Обязательно. Отображаемое название приложения Chat. Длина должна быть от 3 до 25 символов.
description

string

Обязательно. Краткое описание приложения Chat. Должно содержать от 1 до 40 символов.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

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

string

Необязательное поле. URL аватара приложения. Это должен быть URL с протоколом HTTPS, по которому размещено квадратное изображение в формате PNG (соотношение сторон 1:1). Рекомендуемый минимальный размер: 256 x 256 пикселей. Если вы не укажете аватар, будет использоваться аватар по умолчанию.
state

enum (AppState)

Необязательное поле. Статус приложения. Если не указан, по умолчанию используется ACTIVE.
errorLoggingEnabled

boolean

Необязательное поле. Указывает, нужно ли регистрировать ошибки в Cloud Logging. Если не указано другое, по умолчанию используется false.
markupSyntax

enum (MarkupSyntax)

Необязательное поле. Синтаксис разметки по умолчанию для сообщений, отправленных или прочитанных этим приложением Chat. Если не указано, по умолчанию используется MARKUP_SYNTAX_MARKDOWN.

AppState

Текущее состояние приложения Chat.

Перечисления
APP_STATE_UNSPECIFIED Значение по умолчанию. Не указано.
ACTIVE Соответствует LIVE на странице конфигурации Chat API. Приложение активно, его могут найти и использовать пользователи, у которых есть доступ.
DISABLED Приложение отключено, его больше нельзя найти и с ним нельзя взаимодействовать.

InteractiveFeatureConfig

Настройки интерактивных функций приложения.

JSON-представление 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
Поля
connectionConfig

object (ConnectionConfig)

Обязательно. Как приложение получает события от Google Chat.
appCommands[]

object (AppCommand)

Необязательное поле. Конфигурация команд приложения.
urlPatterns[]

object (UrlPattern)

Необязательное поле. Настройки предварительного просмотра ссылок.
allowlistedTestingPrincipals[]

string

Необязательное поле. Адреса электронной почты пользователей и групп в домене Google Workspace, которые могут находить и использовать приложение.
supportsMultiuserSpaces

boolean

Необязательное поле. Можно ли добавлять приложение в прямые переписки, групповые чаты и чат-группы. Если не указано другое, по умолчанию используется false.

ConnectionConfig

Как приложение получает события.

JSON-представление 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
Поля
Тип подключения. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
httpEndpointConfig

object (HttpEndpointConfig)

Конфигурация конечной точки HTTP.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Конфигурация развертывания Apps Script.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Конфигурация темы издатель-подписчик.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Конфигурация Dialogflow.
Конец взаимоисключающих полей.

HttpEndpointConfig

Конфигурация конечной точки HTTP.

JSON-представление 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
Поля
Конфигурация URL конечной точки HTTP. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
commonUrl

string

Необязательное поле. URL по HTTPS, на который Google Chat отправляет все интерактивные события.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

Необязательное поле. Отдельные URL по HTTPS, на которые Google Chat отправляет каждый тип интерактивного события.
Конец взаимоисключающих полей.

HttpPerEventEndpointConfig

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

JSON-представление 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Поля
appCommandEndpoint

string

Обязательно. Конечная точка URL по HTTPS для событий команд приложения.
addedToSpaceEndpoint

string

Обязательно. Конечная точка URL по HTTPS для событий добавления в чат-группу.
messageEndpoint

string

Обязательно. Конечная точка URL по HTTPS для событий сообщений.
removedFromSpaceEndpoint

string

Обязательно. Конечная точка URL по HTTPS для событий удаления из чат-группы.

AppsScriptEndpointConfig

Конфигурация конечной точки Apps Script.

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

string

Обязательно. Идентификатор развертывания Apps Script.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

Необязательное поле. Названия функций Apps Script, которые Google Chat вызывает для каждого типа интерактивного события. Если функция не указана, Chat вызывает функцию по умолчанию для каждого типа событий.

AppsScriptPerEventEndpointConfig

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

JSON-представление 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Поля
appCommandEndpoint

string

Необязательное поле. Название функции для событий команд приложения. Если не указано, будет использоваться название функции по умолчанию (onAppCommand).
addedToSpaceEndpoint

string

Необязательное поле. Название функции для событий добавления в чат-группу. Если не указано, будет использоваться название функции по умолчанию (onAddedToSpace).
messageEndpoint

string

Необязательное поле. Название функции для событий сообщений. Если не указано, будет использоваться название функции по умолчанию (onMessage).
removedFromSpaceEndpoint

string

Необязательное поле. Название функции для событий удаления из чат-группы. Если не указано, будет использоваться название функции по умолчанию (onRemovedFromSpace).

CloudPubSubEndpointConfig

Конфигурация конечной точки издатель-подписчик.

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

string

Обязательно. Тема Pub/Sub, в которой Google Chat публикует все интерактивные события. Тема должна находиться в том же проекте Google Cloud, что и приложение, а у Chat должно быть разрешение на публикацию сообщений в теме. Подробнее о том, как создать приложение Google Chat с помощью Pub/Sub…

Формат: projects/{project}/topics/{topic}

DialogflowEndpointConfig

Конфигурация конечной точки Dialogflow.

JSON-представление 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
Поля
dialogflowEdition

enum (DialogflowEdition)

Обязательно. Версия Dialogflow.
agent

string

Необязательное поле. Название агента или среды Dialogflow CX. Требуется для Dialogflow CX. Не задавайте для Dialogflow ES.

Формат: projects/{project}/locations/{location}/agents/{agent} или projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

DialogflowEdition

Тип версии Dialogflow.

Перечисления
DIALOGFLOW_EDITION_UNSPECIFIED Значение по умолчанию. Не указано.
ES Версия Dialogflow ES. Чтобы использовать эту версию, агент Dialogflow ES должен находиться в том же облачном проекте Google Cloud, что и приложение. Google Chat отправляет все интерактивные события этому агенту.
CX Версия Dialogflow CX. Чтобы использовать эту версию, агент Dialogflow CX должен находиться в том же облачном проекте Google Cloud, что и приложение, и быть указан в поле agent. Google Chat отправляет все интерактивные события этому агенту.

AppCommand

Конфигурация команды приложения.

JSON-представление 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
Поля
commandType

enum (CommandType)

Обязательно. Тип команды.
commandId

integer

Обязательно. Идентификатор команды (1–1000). У каждого контента должен быть уникальный идентификатор.
command

string

Необязательное поле. Название команды. Обязательно для SLASH_COMMAND, не задавайте для других типов команд. Она должна начинаться с косой черты, например "/command".
displayName

string

Необязательное поле. Удобное отображаемое название команды. Обязательно для MESSAGE_ACTION и QUICK_COMMAND, не задавайте для SLASH_COMMAND.
description

string

Обязательно. Краткое описание команды.
dialogEnabled

boolean

Необязательное поле. Должна ли эта команда вызывать диалоговое окно. Если не указано другое, по умолчанию используется false.
loadingNotificationMessage

string

Необязательное поле. Уведомление, которое будет отправлено пользователю, когда он активирует действие сообщения. Поддерживается только для команд MESSAGE_ACTION.

CommandType

Тип команды приложения.

Перечисления
COMMAND_TYPE_UNSPECIFIED Значение по умолчанию. Не указано.
SLASH_COMMAND Команда, которая вызывается вводом символа "/" и названия команды. В тексте сообщения могут быть дополнительные аргументы.
QUICK_COMMAND Быстрая команда, вызванная из контекстного меню создания сообщения. Быстрые команды не принимают дополнительные аргументы.
MESSAGE_ACTION Команда, вызванная из контекстного меню сообщения.

UrlPattern

Конфигурация для предпросмотра по ссылке.

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

string

Обязательно. Домен, который нужно найти. Укажите определенный субдомен, например subdomain.example.com, или весь домен, добавив в начале звездочку (*). Например, *.example.com соответствует https://subdomain.example.com и https://any.number.of.subdomains.example.com.
pathPrefix

string

Необязательное поле. Префикс пути, добавленный к шаблону хоста. Если поле не заполнено, правило применяется ко всем URL в шаблоне хоста. Например, если в качестве шаблона хоста указано "subdomain.example.com", то при вводе "path/" будут сопоставляться URL страниц, начинающиеся с "https://subdomain.example.com/path/".

MarkupSyntax

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

Перечисления
MARKUP_SYNTAX_UNSPECIFIED Значение по умолчанию. Не указано. Существующие приложения Chat, созданные до появления markup_syntax, имеют это значение и используют MARKUP_SYNTAX_CHAT до явного обновления.
MARKUP_SYNTAX_CHAT Используется синтаксис разметки Google Chat. Подробнее: https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN Используется синтаксис Markdown. Этот синтаксис основан на спецификации CommonMark с дополнительными расширениями. Подробнее: https://developers.google.com/workspace/chat/format-messages#format-texts.

Методы

get

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

patch

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