Package google.cloud.gsuiteaddons.v1

Содержание

GSuiteAddOns

Сервис для управления развертыванием дополнений Google Workspace.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Создает развертывание с указанным названием и конфигурацией.

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

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

  • https://www.googleapis.com/auth/cloud-platform

Подробную информацию можно найти в руководстве по авторизации.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Удаляет развертывание с указанным названием.

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

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

  • https://www.googleapis.com/auth/cloud-platform

Подробную информацию можно найти в руководстве по авторизации.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

Получает информацию об авторизации для развертываний в заданном проекте.

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

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

  • https://www.googleapis.com/auth/cloud-platform

Подробную информацию можно найти в руководстве по авторизации.
GetChatAppConfig

rpc GetChatAppConfig(GetChatAppConfigRequest) returns (ChatAppConfig)

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

Требуется аутентификация и авторизация с учетными данными пользователя и разрешениями IAM gsuiteaddons.chatAppConfigs.get и chat.bots.get в проекте.

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

Требует одной из следующих областей применения OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

Подробную информацию можно найти в руководстве по авторизации.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Получает развертывание с указанным названием.

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

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

  • https://www.googleapis.com/auth/cloud-platform

Подробную информацию можно найти в руководстве по авторизации.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

Получает статус установки тестового развертывания.

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

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

  • https://www.googleapis.com/auth/cloud-platform

Подробную информацию можно найти в руководстве по авторизации.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Устанавливает развертывание в аккаунт для тестирования. Подробнее о том, как протестировать дополнение…

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

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

  • https://www.googleapis.com/auth/cloud-platform

Подробную информацию можно найти в руководстве по авторизации.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Выводит список всех развертываний в определенном проекте.

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

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

  • https://www.googleapis.com/auth/cloud-platform

Подробную информацию можно найти в руководстве по авторизации.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

Создает или заменяет развертывание с указанным названием.

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

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

  • https://www.googleapis.com/auth/cloud-platform

Подробную информацию можно найти в руководстве по авторизации.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Удаляет тестовое развертывание из аккаунта пользователя. Подробнее о том, как протестировать дополнение…

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

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

  • https://www.googleapis.com/auth/cloud-platform

Подробную информацию можно найти в руководстве по авторизации.
UpdateChatAppConfig

rpc UpdateChatAppConfig(UpdateChatAppConfigRequest) returns (ChatAppConfig)

Обновляет конфигурацию приложения Chat в проекте. Поддерживаются только приложения Chat, созданные как дополнения Google Workspace. Для каждого проекта Google Cloud можно задать только одну конфигурацию приложения Chat.

Требуется аутентификация и авторизация с учетными данными пользователя и разрешениями IAM gsuiteaddons.chatAppConfigs.update, chat.bots.update и chat.bots.get в проекте.

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

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

  • https://www.googleapis.com/auth/cloud-platform

Подробную информацию можно найти в руководстве по авторизации.

AddOns

Конфигурация дополнения Google Workspace.

Поля
common

CommonAddOnManifest

Конфигурация, общая для всех дополнений Google Workspace.
gmail

GmailAddOnManifest

Конфигурация дополнения Gmail.
drive

DriveAddOnManifest

Конфигурация дополнения для Диска.
calendar

CalendarAddOnManifest

Конфигурация дополнения Календаря.
docs

DocsAddOnManifest

Конфигурация дополнения для Документов.
meet

MeetAddOnManifest

Конфигурация дополнения Meet.
sheets

SheetsAddOnManifest

Конфигурация дополнения для Google Таблиц.
slides

SlidesAddOnManifest

Конфигурация дополнения для Презентаций.
httpOptions

HttpOptions

Варианты отправки запросов к конечным точкам HTTP дополнения

AppCommand

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

Поля
commandType

CommandType

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

int32

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

string

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

string

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

string

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

bool

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

string

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

CommandType

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

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

AppsScriptEndpointConfig

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

Поля
deploymentId

string

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

AppsScriptPerEventEndpointConfig

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

AppsScriptPerEventEndpointConfig

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

Поля
appCommandEndpoint

string

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

string

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

string

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

string

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

Авторизация

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

Поля
name

string

Каноническое полное название этого ресурса. Пример: projects/123/authorization
serviceAccountEmail

string

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

string

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

ChatAppConfig

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

Поля
name

string

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

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

string

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

string

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

InteractiveFeatureConfig

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

string

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

AppState

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

bool

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

MarkupSyntax

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

AppState

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

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

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.

CloudPubSubEndpointConfig

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

Поля
topic

string

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

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

ConnectionConfig

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

Поля
Объединенное поле config. Тип подключения. config может иметь одно из следующих значений:
httpEndpointConfig

HttpEndpointConfig

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

AppsScriptEndpointConfig

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

CloudPubSubEndpointConfig

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

DialogflowEndpointConfig

Конфигурация Dialogflow.

CreateDeploymentRequest

Сообщение с запросом на создание развертывания.

Поля
parent

string

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

Пример: projects/my_project.

Для авторизации требуется следующее разрешение IAM для указанного ресурса parent:

  • gsuiteaddons.deployments.create
deploymentId

string

Обязательно. Идентификатор, который будет использоваться для этого развертывания. Полное название созданного ресурса будет projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

Обязательно. Развертывание, которое нужно создать (deployment.name задать нельзя).

DeleteDeploymentRequest

Запрос на удаление развертывания.

Поля
name

string

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

Пример: projects/my_project/deployments/my_deployment.

Для авторизации требуется следующее разрешение IAM для указанного ресурса name:

  • gsuiteaddons.deployments.delete
etag

string

Тег etag развертывания, которое нужно удалить. Если он указан, то должен совпадать с тегом etag сервера.

Развертывание

Развертывание дополнения Google Workspace

Поля
name

string

Название ресурса развертывания. Пример: projects/123/deployments/my_deployment.
oauthScopes[]

string

Список областей действия Google OAuth, для которых нужно запрашивать согласие конечного пользователя перед выполнением конечной точки дополнения.
addOns

AddOns

Конфигурация дополнения Google Workspace.
etag

string

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

DialogflowEndpointConfig

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

Поля
dialogflowEdition

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 отправляет все интерактивные события этому агенту.

GetAuthorizationRequest

Запрос на получение информации об авторизации дополнения Google Workspace.

Поля
name

string

Обязательно. Название проекта, для которого нужно получить информацию об авторизации дополнения Google Workspace.

Пример: projects/my_project/authorization.

Для авторизации требуется следующее разрешение IAM для указанного ресурса name:

  • gsuiteaddons.authorizations.get

GetChatAppConfigRequest

Запрос на получение конфигурации приложения Chat.

Поля
name

string

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

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

Для авторизации требуется следующее разрешение IAM для указанного ресурса name:

  • gsuiteaddons.chatAppConfigs.get
view

ChatAppConfigView

Необязательное поле. Представление ChatAppConfig, которое нужно вернуть. Если этот параметр не задан, по умолчанию используется BASIC.

ChatAppConfigView

Представление, указывающее, какие поля должны быть заполнены в ресурсе ChatAppConfig.

Перечисления
CHAT_APP_CONFIG_VIEW_UNSPECIFIED Значение по умолчанию или не задано. Значение по умолчанию – BASIC.
BASIC Заполняются только основные метаданные о конфигурации приложения, без конфигурации интерактивных функций. Это значение используется по умолчанию.
FULL Заполняет все поля, включая настройки интерактивных функций.

GetDeploymentRequest

Запрос на развертывание.

Поля
name

string

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

Пример: projects/my_project/deployments/my_deployment.

Для авторизации требуется следующее разрешение IAM для указанного ресурса name:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Сообщение с запросом на получение статуса установки тестового развертывания.

Поля
name

string

Обязательно. Полное название ресурса развертывания.

Пример: projects/my_project/deployments/my_deployment/installStatus.

Для авторизации требуется следующее разрешение IAM для указанного ресурса name:

  • gsuiteaddons.deployments.installStatus

HttpEndpointConfig

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

Поля
Объединенное поле config. Конфигурация URL конечной точки HTTP. config может иметь одно из следующих значений:
commonUrl

string

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

HttpPerEventEndpointConfig

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

HttpPerEventEndpointConfig

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

Поля
appCommandEndpoint

string

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

string

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

string

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

string

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

InstallDeploymentRequest

Сообщение с запросом на установку развертывания для тестирования.

Поля
name

string

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

Пример: projects/my_project/deployments/my_deployment.

Для авторизации требуется следующее разрешение IAM для указанного ресурса name:

  • gsuiteaddons.deployments.install

InstallStatus

Статус установки тестового развертывания.

Поля
name

string

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

Пример: projects/123/deployments/my_deployment/installStatus.
installed

BoolValue

True, если развертывание установлено для пользователя.

InteractiveFeatureConfig

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

Поля
connectionConfig

ConnectionConfig

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

AppCommand

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

UrlPattern

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

string

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

bool

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

ListDeploymentsRequest

Сообщение с запросом на получение списка развертываний для проекта.

Поля
parent

string

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

Пример: projects/my_project.

Для авторизации требуется следующее разрешение IAM для указанного ресурса parent:

  • gsuiteaddons.deployments.list
pageSize

int32

Максимальное количество развертываний, которое нужно вернуть. Сервис может вернуть меньше результатов, чем указано в этом значении. Если значение не указано, возвращается не более 1000 развертываний. Максимальное значение – 1000. Если указать большее значение, оно будет автоматически изменено на 1000.
pageToken

string

Токен страницы, полученный из предыдущего вызова ListDeployments. Укажите его, чтобы получить следующую страницу.

При разбиении на страницы все остальные параметры, передаваемые в ListDeployments, должны соответствовать вызову, который предоставил токен страницы.

ListDeploymentsResponse

Ответное сообщение со списком развертываний.

Поля
deployments[]

Deployment

Список развертываний для указанного проекта.
nextPageToken

string

Токен, который можно отправить как page_token, чтобы получить следующую страницу. Если это поле отсутствует, значит последующих страниц нет.

ReplaceDeploymentRequest

Сообщение с запросом на создание или замену развертывания.

Поля
deployment

Deployment

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

Для авторизации требуется следующее разрешение IAM для указанного ресурса deployment:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

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

Поля
name

string

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

Пример: projects/my_project/deployments/my_deployment.

Для авторизации требуется следующее разрешение IAM для указанного ресурса name:

  • gsuiteaddons.deployments.execute

UpdateChatAppConfigRequest

Сообщение с запросом для UpdateChatAppConfig.

Поля
chatAppConfig

ChatAppConfig

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

Для авторизации требуется следующее разрешение IAM для указанного ресурса chatAppConfig:

  • gsuiteaddons.chatAppConfigs.update
updateMask

FieldMask

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

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

UrlPattern

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

Поля
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/".