AddOns Response Service

Служба обработки запросов на дополнительные услуги

Этот сервис позволяет использовать скрипты для настройки и создания дополнений для Google Workspace.

Классы

Имя Краткое описание
Accessory Widget
Action Действие, которое могут использовать дополнения Google Workspace, расширяющие функциональность Google Workspace Studio, для отображения новой карточки.
Action Response
Action Response Builder
Add Ons Response Service Add Ons Response Service позволяет создавать ответы для дополнений Google Workspace.
Addon Compose Ui Action Response
Addon Compose Ui Action Response Builder
Addon Compose Ui Action Type
Attachment
Basic Data Type Перечисление, представляющее основные обобщенные типы данных.
Calendar Event Action Response
Calendar Event Action Response Builder
Chat Data Actions Response Builder
Chat Message
Color Объект Color, представляющий цвет в цветовом пространстве RGBA.
Compose Action Response
Compose Action Response Builder
Composed Email Type
Content Type
Create Message Action
Data Actions Response
Data Type Тип данных (DataType) используется для задания типа переменной.
Drive Items Selected Action Response
Drive Items Selected Action Response Builder
Dynamic Resource Definition Объект DynamicResourceDefinition является базовым элементом для Resource Fields Definition Retrieved Action ; он может содержать одно или несколько Resource Field для динамического определения количества выходных переменных, предоставляемых шагом в Google Workspace Studio.
Editor File Scope Action Response
Editor File Scope Action Response Builder
End Navigation
Error Actionability Перечисление (Enum), представляющее собой возможность принятия мер в случае ошибки.
Error Retryability Перечисление (Enum), определяющее возможность повторного вызова действия при возникновении ошибки.
Font Weight Перечисление, представляющее толщину шрифта стилизованного текста.
Host App Action HostAppAction — это тип действия, обрабатываемый отдельными хост-приложениями.
Hyperlink Элемент «Гиперссылка», используемый в Text Format Element .
Insert Section Конструктор для объектов InsertSection.
Insert Widget Конструктор для объектов InsertWidget.
Link Объект ссылки из стороннего ресурса, который преобразуется в смарт-чип в хост-приложении.
Link Preview
List Container Контейнер для элементов списка, где каждый элемент списка может содержать несколько Text Format Element .
List Item Элемент списка, где каждый элемент списка может содержать несколько Text Format Element .
List Type Перечисление, представляющее тип списка.
Modify Card Конструктор объектов Modify Card , который изменяет и обновляет интерфейс существующей карточки, передавая объект Modify Card в Action .
Navigation Вспомогательный объект, управляющий навигацией по карточкам.
Notification
On Close
Open As
Open Link
Remove Section Конструктор для объектов Remove Section .
Remove Widget Конструктор для объектов RemoveWidget.
Render Action Отображает или обновляет карточку, выполняя Action в ответ на взаимодействие с пользователем.
Render Action Builder Конструктор объектов Render Action .
Resource Data Данные ресурса представляют собой специфические для приложения данные, содержащие набор пар ключ-значение, включающих имена переменных и Variable Data .
Resource Field ResourceField — это базовый строительный блок Dynamic Resource Definition ; каждое поле ресурса соответствует выходной переменной текущего шага.
Resource Fields Definition Retrieved Action Resource Fields Definition Retrieved Action — это тип Resource Fields Definition Retrieved Action , используемый для получения определения списка полей ресурса с помощью функции dynamic Resource Definition Provider указанной в манифесте.
Resource Retrieved Action Объект ResourceRetrievedAction используется для получения содержимого пользовательских ресурсов по мере необходимости, при этом поле пользовательского ресурса определяется в объекте ResourceData.
Resource Type Для специфичных для приложения типов ресурсов уникальный идентификатор этого типа ресурсов должен иметь соответствующее определение WorkflowResourceDefinition.
Return Element Error Action Объект ReturnElementErrorAction указывает на то, что во время вызова элемента произошла ошибка.
Return Output Variables Action Содержит выходные переменные, сгенерированные в результате выполнения действия в Google Workspace Studio.
Save Workflow Action Это действие указывает на то, что основное приложение (Google Workspace Studio) должно сохранить агента.
Send Status
Styled Text Текстовый элемент с возможностью выбора стиля, например, жирный, курсив и цвет.
Text Format Chip Интерактивная фишка в текстовом формате.
Text Format Element Элемент форматирования текста, который может представлять собой Text Format Chip , Styled Text , Hyperlink или List Container .
Text Format Icon Значок, отображаемый в Text Format Chip .
Text Style Перечисление, представляющее стиль оформленного текста.
Time Stamp Представляет собой объект временной метки, который можно добавить в Variable Data .
Universal Action Response
Universal Action Response Builder
Update Draft Action Response
Update Draft Action Response Builder
Update Draft Bcc Recipients Action
Update Draft Body Action
Update Draft Body Type
Update Draft Cc Recipients Action
Update Draft Subject Action
Update Draft To Recipients Action
Update Inline Preview Action
Update Message Action
Update Widget Конструктор для объектов Update Widget .
Validation Error Severity Перечисление, отражающее степень серьезности ошибки валидации.
Value Metadata Объект valueMetadata содержит информацию о потенциальных значениях переменной.
Variable Data Представляет собой переменную данных, которая может содержать набор значений различных типов.
Workflow Action WorkflowAction — это тип Host App Action , используемый для выполнения определенного действия в Google Workspace Studio.
Workflow Text Format Блок текста с широкими возможностями форматирования, включая стили, гиперссылки и интерактивные элементы, определенные в Text Format Element .
Workflow Validation Error Action Это действие указывает на то, что основное приложение (Google Workspace Studio) должно отобразить ошибку проверки.

Accessory Widget

Методы

Метод Тип возвращаемого значения Краткое описание
add Widget(widget) Accessory Widget Задает виджет для этого действия.

Action

Методы

Метод Тип возвращаемого значения Краткое описание
add Modify Card(modifyCard) Action Добавляет операцию ModifyCard к действию.
add Navigation(navigation) Action Добавляет карточную навигацию к действию.

Action Response

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.

Action Response Builder

Методы

Метод Тип возвращаемого значения Краткое описание
add Modify Card(modifyCard) Action Response Builder Устанавливает действие "Изменить карту" в качестве операции.
build() Action Response Формирует текущий ответ на действие и проверяет его.
set Link Preview(linkPreview) Action Response Builder Устанавливает значение LinkPreview для выбранного действия.
set Navigation(navigation) Action Response Builder Задает реакцию на действие Navigation .
set Notification(notification) Action Response Builder Задает параметр для отображения уведомления при активации действия.
set Open Link(openLink) Action Response Builder Задает URL-адрес, на который будет осуществлен переход при активации действия.
set State Changed(stateChanged) Action Response Builder Устанавливает флаг, указывающий на то, что данное действие изменило существующее состояние данных.

Add Ons Response Service

Характеристики

Свойство Тип Описание
Addon Compose Ui Action Type Addon Compose Ui Action Type Перечисление Addon Compose Ui Action Type .
Composed Email Type Composed Email Type Перечисление Composed Email Type .
Content Type Content Type Перечисление Content Type .
End Navigation End Navigation Перечисление End Navigation .
On Close On Close Перечисление « On Close .
Open As Open As Перечисление Open As .
Send Status Send Status Перечисление Send Status .
Update Draft Body Type Update Draft Body Type Перечисление Update Draft Body Type .

Методы

Метод Тип возвращаемого значения Краткое описание
new Accessory Widget() Accessory Widget Создает новый Accessory Widget .
new Action() Action Создает новое Action .
new Action Response Builder() Action Response Builder Создает Action Response Builder .
new Addon Compose Ui Action Response Builder() Addon Compose Ui Action Response Builder Создает Addon Compose Ui Action Response Builder .
new Attachment() Attachment Создает Attachment .
new Calendar Event Action Response Builder() Calendar Event Action Response Builder Создает Calendar Event Action Response Builder .
new Chat Data Action Builder() Chat Data Actions Response Builder Создает Chat Data Actions Response Builder .
new Chat Message() Chat Message Создает Chat Message .
new Compose Action Response Builder() Compose Action Response Builder Создает Compose Action Response Builder .
new Create Message Action() Create Message Action Создает Create Message Action .
new Drive Items Selected Action Response Builder() Drive Items Selected Action Response Builder Создает Drive Items Selected Action Response Builder .
new Editor File Scope Action Response Builder() Editor File Scope Action Response Builder Создает Editor File Scope Action Response Builder .
new Link Preview() Link Preview Создает Link Preview .
new Navigation() Navigation Создает Navigation .
new Notification() Notification Создает Notification .
new Open Link() Open Link Создает Open Link .
new Render Action Builder() Render Action Builder Создает новый Render Action Builder .
new Universal Action Response Builder() Universal Action Response Builder Создает Universal Action Response Builder .
new Update Draft Action Response Builder() Update Draft Action Response Builder Создает Update Draft Action Response Builder .
new Update Draft Bcc Recipients Action() Update Draft Bcc Recipients Action Создает Update Draft Bcc Recipients Action »;
new Update Draft Body Action() Update Draft Body Action Создает Update Draft Body Action .
new Update Draft Cc Recipients Action() Update Draft Cc Recipients Action Создает Update Draft Cc Recipients Action .
new Update Draft Subject Action() Update Draft Subject Action Создает Update Draft Subject Action .
new Update Draft To Recipients Action() Update Draft To Recipients Action Создает Update Draft To Recipients Action .
new Update Inline Preview Action() Update Inline Preview Action Создает Update Inline Preview Action .
new Update Message Action() Update Message Action Создает Update Message Action .

Addon Compose Ui Action Response

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.

Addon Compose Ui Action Response Builder

Методы

Метод Тип возвращаемого значения Краткое описание
build() Addon Compose Ui Action Response Формирует ответ от текущего действия Compose UI для дополнения и выполняет его проверку.
set Type(type) Addon Compose Ui Action Response Builder Задает поле перечисления, определяющее действие пользовательского интерфейса при создании дополнения.

Addon Compose Ui Action Type

Характеристики

Свойство Тип Описание
DISMISS Enum По умолчанию.

Attachment

Методы

Метод Тип возвращаемого значения Краткое описание
set Icon Url(iconUrl) Attachment Задает URL-адрес значка для вложения.
set Mime Type(mimeType) Attachment Задает MIME-тип для вложения.
set Resource Url(resourceUrl) Attachment Задает URL-адрес ресурса для вложения.
set Title(title) Attachment Задает заголовок для вложения.

Basic Data Type

Характеристики

Свойство Тип Описание
BASIC_TYPE_UNSPECIFIED Enum Значение по умолчанию.
STRING Enum Последовательность символов.
INTEGER Enum Целочисленное значение.
FLOAT Enum Число с плавающей запятой.
TIMESTAMP Enum Метка времени в формате ISO 8601.
BOOLEAN Enum Логическое значение.
EMAIL_ADDRESS Enum Строка в формате адреса электронной почты.
GOOGLE_USER Enum Пользователь сервисов Google в формате «users/encoded_GAIA_ID»
FILE Enum Тип файла.
FORMATTED_TEXT Enum Текст с расширенным форматированием.

Calendar Event Action Response

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.

Calendar Event Action Response Builder

Методы

Метод Тип возвращаемого значения Краткое описание
add Attachments(attachments) Calendar Event Action Response Builder Указывает, что в ответе должны быть добавлены вложения к событию календаря при выполнении соответствующего действия в пользовательском интерфейсе.
add Attendees(emails) Calendar Event Action Response Builder Указывает, что в ответе указанные участники должны быть добавлены в событие календаря при выполнении соответствующего действия в пользовательском интерфейсе.
build() Calendar Event Action Response Формирует ответ на действие, относящееся к текущему событию календаря, и проверяет его.
set Conference Data(conferenceData) Calendar Event Action Response Builder Указывает, что в ответе должны быть установлены указанные данные конференции в событие календаря при выполнении соответствующего действия в пользовательском интерфейсе.

Chat Data Actions Response Builder

Методы

Метод Тип возвращаемого значения Краткое описание
build() Data Actions Response Формирует текущий ответ на действие.
set Create Chat Message Action(createMessageAction) Chat Data Actions Response Builder Задает Create Message Action для этого Data Actions Response .
set Update Chat Message Action(updateMessageAction) Chat Data Actions Response Builder Задает Update Message Action для Data Actions Response .
set Update Inline Preview Action(updateInlinePreviewAction) Chat Data Actions Response Builder Устанавливает Update Inline Preview Action для Data Actions Response .

Chat Message

Методы

Метод Тип возвращаемого значения Краткое описание
add Card With Id(cardWithId) Chat Message Устанавливает карточку сообщения.
set Text(text) Chat Message Задает текст сообщения.

Color

Методы

Метод Тип возвращаемого значения Краткое описание
set Alpha(alpha) Color Задает альфа-канал цвета.
set Blue(blue) Color Задает синюю составляющую цвета.
set Green(green) Color Задает зеленую составляющую цвета.
set Red(red) Color Задает красную составляющую цвета.

Compose Action Response

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.

Compose Action Response Builder

Методы

Метод Тип возвращаемого значения Краткое описание
build() Compose Action Response Формирует текущий ответ действия создания и проверяет его.
set Gmail Draft(draft) Compose Action Response Builder Устанавливает черновик Gmail Message , созданного с помощью Gmail Message.createDraftReply(body) или аналогичной функции.

Composed Email Type

Характеристики

Свойство Тип Описание
REPLY_AS_DRAFT Enum Черновик, являющийся ответом на другое сообщение.
STANDALONE_DRAFT Enum Черновик, представляющий собой самостоятельное сообщение.

Content Type

Характеристики

Свойство Тип Описание
TEXT Enum Указывает, что сгенерированный контент представляет собой обычный текст.
MUTABLE_HTML Enum Указывает, что сгенерированный контент отформатирован как HTML.
IMMUTABLE_HTML Enum Указывает на то, что сгенерированный контент отформатирован как HTML, но после генерации его нельзя редактировать.

Create Message Action

Методы

Метод Тип возвращаемого значения Краткое описание
set Message(message) Create Message Action Задает сообщение для этого действия.

Data Actions Response

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.

Data Type

Методы

Метод Тип возвращаемого значения Краткое описание
set Basic Data Type(basicDataType) Data Type Устанавливает тип данных на один из поддерживаемых Basic Data Type .
set Resource Type(resourceType) Data Type Устанавливает тип данных на заданный пользователем Resource Type .
set Value Metadata(valueMetadata) Data Type Задает Value Metadata , содержащие информацию о типе переменной.

Drive Items Selected Action Response

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.

Drive Items Selected Action Response Builder

Методы

Метод Тип возвращаемого значения Краткое описание
build() Drive Items Selected Action Response Формирует ответ на текущее действие в Google Диске.
request File Scope(itemId) Drive Items Selected Action Response Builder Указывает, что в ответе запрашивается область действия файла для контекстно релевантного элемента в Диске.

Dynamic Resource Definition

Методы

Метод Тип возвращаемого значения Краткое описание
add Resource Field(resourceField) Dynamic Resource Definition Добавляет поле ресурса в определение динамического ресурса.
set Resource Id(resourceId) Dynamic Resource Definition Задает идентификатор для определения динамического ресурса; этот идентификатор соответствует workflow Resource Definition Id в манифесте.

Editor File Scope Action Response

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.

Editor File Scope Action Response Builder

Методы

Метод Тип возвращаемого значения Краткое описание
build() Editor File Scope Action Response Формирует ответ на текущее действие редактора.
request File Scope For Active Document() Editor File Scope Action Response Builder Запрашивает область drive.file для текущего активного документа редактора.

End Navigation

Характеристики

Свойство Тип Описание
ACTION_UNSPECIFIED Enum Действие не указано.
CLOSE_DIALOG Enum Закрывает диалоговое окно .
CLOSE_DIALOG_AND_EXECUTE Enum Закрывает диалоговое окно и обновляет карточку, которая открыла диалоговое окно.

Error Actionability

Характеристики

Свойство Тип Описание
ERROR_ACTIONABILITY_UNSPECIFIED Enum Не указано.
NOT_ACTIONABLE Enum Пользователь не может исправить эту ошибку с помощью карты конфигурации.
ACTIONABLE Enum Пользователь может исправить ошибку с помощью карты конфигурации.

Error Retryability

Характеристики

Свойство Тип Описание
RETRYABILITY_UNSPECIFIED Enum Не указано.
NOT_RETRYABLE Enum Ошибка не подлежит повторной попытке, выполнение процесса завершается после первой же попытки.
RETRYABLE Enum Ошибка допускает повторную попытку, рабочий процесс попытается выполнить этот шаг до 5 раз.

Font Weight

Характеристики

Свойство Тип Описание
FONT_WEIGHT_UNSPECIFIED Enum Стандартный вес при нормальной толщине.
LIGHT Enum Меньший вес при меньшей толщине.
MEDIUM Enum Промежуточный оттенок между светлым и жирным.
BOLD Enum Увеличенный вес при большей толщине.

Host App Action

Методы

Метод Тип возвращаемого значения Краткое описание
set Workflow Action(workflowAction) Host App Action Устанавливает действие основного приложения в качестве действия рабочего процесса.

Методы

Метод Тип возвращаемого значения Краткое описание
set Link(link) Hyperlink Задает целевой URL-адрес гиперссылки.
set Text(text) Hyperlink Задает текст гиперссылки.

Insert Section

Методы

Метод Тип возвращаемого значения Краткое описание
insert At Top(onCardTop) Insert Section Устанавливает флаг onCardTop, указывающий, следует ли вставлять новый раздел в верхнюю часть карточки.
insert Below Section(sectionId) Insert Section Задает идентификатор раздела, и новый раздел вставляется под ним.
set Section(section) Insert Section Задает раздел карточки для вставки.

Insert Widget

Методы

Метод Тип возвращаемого значения Краткое описание
insert Above Widget(widgetId) Insert Widget Задает идентификатор виджета, и новый виджет вставляется поверх виджета с заданным идентификатором.
insert Below Widget(widgetId) Insert Widget Задает идентификатор виджета, и новый виджет вставляется под виджет с заданным идентификатором.
set Widget(widget) Insert Widget Задает Widget для вставки.

Методы

Метод Тип возвращаемого значения Краткое описание
set Title(title) Link Задает заголовок ссылки.
set Url(url) Link Задает URL-адрес ссылки.

Link Preview

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.
set Link Preview Title(title) Link Preview Задает заголовок, отображаемый в предварительном просмотре ссылки над карточкой предварительного просмотра.
set Preview Card(previewCard) Link Preview Задает карточку, отображающую информацию о ссылке из стороннего сервиса, не принадлежащего Google.
set Title(title) Link Preview Задает заголовок, отображаемый на смарт-чипе при предварительном просмотре ссылки.

List Container

Методы

Метод Тип возвращаемого значения Краткое описание
add List Item(listItem) List Container Добавляет элемент списка в контейнер списка.
set List Nest Level(listLevel) List Container Задает уровень списка, начиная с 0 для верхнего уровня и увеличиваясь на 1 для каждого вложенного списка.
set List Type(listType) List Container Задает тип списка: упорядоченный или неупорядоченный.

List Item

Методы

Метод Тип возвращаемого значения Краткое описание
add Text Format Element(textFormatElement) List Item Добавляет Text Format Element к элементу списка.

List Type

Характеристики

Свойство Тип Описание
LIST_TYPE_UNSPECIFIED Enum Значение по умолчанию.
ORDERED Enum Упорядоченный список.
UNORDERED Enum Неупорядоченный список.

Modify Card

Методы

Метод Тип возвращаемого значения Краткое описание
set Insert Section(insertSection) Modify Card Задает Insert Section для этого объекта карты изменения.
set Insert Widget(insertWidget) Modify Card Задает Insert Widget для этого объекта карточки изменения.
set Remove Section(removeSection) Modify Card Задает Remove Section для данного объекта карты изменения.
set Remove Widget(removeWidget) Modify Card Устанавливает Remove Widget для этого объекта карточки изменения.
set Replace Section(replacementSection) Modify Card Задает заменяющий Card Section для этого изменяемого объекта карточки; заменяющий раздел должен иметь тот же идентификатор, что и существующий раздел карточки.
set Replace Widget(replacementWidget) Modify Card Задает виджет для замены в этом объекте карточки изменения; виджет для замены должен иметь тот же идентификатор, что и существующий виджет.
set Update Widget(updateWidget) Modify Card Устанавливает Update Widget для этого объекта карточки изменения.

Методы

Метод Тип возвращаемого значения Краткое описание
pop Card() Navigation
pop To Named Card(cardName) Navigation
pop To Root() Navigation
print Json() String Выводит JSON-представление этого объекта.
push Card(card) Navigation Добавляет выданную карту в стопку.
set End Navigation(endNavigation) Navigation Задает действие при завершении навигации.
update Card(card) Navigation Выполняется замена текущей карты на месте.

Notification

Методы

Метод Тип возвращаемого значения Краткое описание
set Text(text) Notification Задает текст, отображаемый в уведомлении.

On Close

Характеристики

Свойство Тип Описание
NOTHING Enum При закрытии ничего не делать.
RELOAD Enum При закрытии окна дополнение перезагружается.

Open As

Характеристики

Свойство Тип Описание
FULL_SIZE Enum Открыть в полноэкранном режиме или во вкладке.
OVERLAY Enum Открывается как наложение, например, всплывающее окно.

Методы

Метод Тип возвращаемого значения Краткое описание
set On Close(onClose) Open Link Определяет поведение действия URL-адреса при закрытии окна или вкладки URL-адреса.
set Open As(openAs) Open Link Задает поведение URL-адреса при его открытии.
set Url(url) Open Link Задает URL-адрес для открытия.

Remove Section

Методы

Метод Тип возвращаемого значения Краткое описание
set Section Id(sectionId) Remove Section Задает идентификатор раздела, который необходимо удалить.

Remove Widget

Методы

Метод Тип возвращаемого значения Краткое описание
set Widget Id(widgetId) Remove Widget Задает идентификатор виджета, который нужно удалить.

Render Action

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.

Render Action Builder

Методы

Метод Тип возвращаемого значения Краткое описание
build() Render Action Формирует текущий процесс рендеринга и выполняет его проверку.
set Action(action) Render Action Builder Задает действие, которое дополнения могут использовать для обновления пользовательского интерфейса в соответствии с действием рендеринга.
set Host App Action(hostAppAction) Render Action Builder Устанавливает Host App Action обрабатываемое отдельными хост-приложениями, в значение действия рендеринга.

Resource Data

Методы

Метод Тип возвращаемого значения Краткое описание
add Variable Data(key, value) Resource Data Добавляет Variable Data с ключом, заданным её именем; если ключ уже существует, значение перезаписывается.
set Variable Data Map(fields) Resource Data Задает карту данных переменных, в которой в качестве ключей используются имена переменных.

Resource Field

Методы

Метод Тип возвращаемого значения Краткое описание
set Data Type(dataType) Resource Field Задает тип данных поля, позволяет другим шагам фильтровать переменные по типу при выборе.
set Display Text(displayText) Resource Field Задает описание поля, которое отображается конечному пользователю во время выбора переменных на последующих этапах.
set Selector(selector) Resource Field Задает ключ для функции-поставщика, которому будет передаваться значение во время выполнения шага.

Resource Fields Definition Retrieved Action

Методы

Метод Тип возвращаемого значения Краткое описание
add Dynamic Resource Definition(dynamicResourceDefinition) Resource Fields Definition Retrieved Action Добавляет Dynamic Resource Definition к действию получения определения полей ресурса.

Resource Retrieved Action

Методы

Метод Тип возвращаемого значения Краткое описание
set Resource Data(resourceData) Resource Retrieved Action Устанавливает Resource Data в соответствии с действием получения ресурса, чтобы предоставить значения динамическим полям ресурса или пользовательским полям ресурса.

Resource Type

Методы

Метод Тип возвращаемого значения Краткое описание
set Workflow Resource Definition Id(resourceType) Resource Type Задает идентификатор определения ресурса рабочего процесса.

Return Element Error Action

Методы

Метод Тип возвращаемого значения Краткое описание
set Error Actionability(errorActionability) Return Element Error Action Определяет возможность принятия мер в случае ошибки: ошибка должна быть допускающей принятие мер, если ее можно устранить путем перенастройки шага.
set Error Log(log) Return Element Error Action Задает параметры журнала ошибок, отображаемого для конечного пользователя в ленте активности рабочего процесса.
set Error Retryability(errorRetryability) Return Element Error Action Задает возможность повторной попытки при возникновении ошибки; если ошибка не подлежит повторной попытке, процесс завершается после первой попытки.

Return Output Variables Action

Методы

Метод Тип возвращаемого значения Краткое описание
add Variable Data(key, value) Return Output Variables Action Добавляет переменную с данными, ключом к которой является имя переменной; если ключ уже существует, значение перезаписывается.
set Log(log) Return Output Variables Action Устанавливает запись в журнале выполненного действия рабочего процесса для конечного пользователя в ленте активности рабочего процесса.
set Variable Data Map(variables) Return Output Variables Action Задает карту данных переменных, ключом к которой является имя переменной; если ключ уже существует, значение перезаписывается.

Save Workflow Action

Send Status

Характеристики

Свойство Тип Описание
NOT_SEND Enum По умолчанию.
CONTINUE_SEND Enum Продолжайте отправлять электронные письма после обновления черновика.

Styled Text

Методы

Метод Тип возвращаемого значения Краткое описание
add Style(style) Styled Text Задает стиль стилизованного текста; к одному стилизованному тексту можно применить несколько стилей.
set Color(color) Styled Text Задает цвет стилизованного текста.
set Font Weight(fontWeight) Styled Text Задает толщину шрифта стилизованного текста.
set Text(text) Styled Text Задает основное содержимое стилизованного текста.

Text Format Chip

Методы

Метод Тип возвращаемого значения Краткое описание
set Label(label) Text Format Chip Задает текст, отображаемый на чипе.
set Text Format Icon(icon) Text Format Chip Задает значок, отображаемый на чипе.
set Url(url) Text Format Chip Задает URL-адрес, на который будет осуществлен переход при нажатии на чип.

Text Format Element

Методы

Метод Тип возвращаемого значения Краткое описание
set Hyperlink(hyperlink) Text Format Element Устанавливает элемент форматирования текста в качестве Hyperlink .
set List Container(listContainer) Text Format Element Устанавливает для элемента форматирования текста тип List Container .
set Styled Text(styledText) Text Format Element Устанавливает для элемента форматирования текста тип " Styled Text .
set Text(text) Text Format Element Задает для элемента форматирования текста текстовую строку.
set Text Format Chip(chip) Text Format Element Устанавливает элемент форматирования текста в качестве Text Format Chip .

Text Format Icon

Методы

Метод Тип возвращаемого значения Краткое описание
set Icon Url(iconUrl) Text Format Icon Задает URL-адрес значка.
set Material Icon Name(materialIconName) Text Format Icon Задает имя значка в стиле Material Icons, определенное в Google Material Icons.

Text Style

Характеристики

Свойство Тип Описание
STYLE_UNSPECIFIED Enum Стиль не применялся.
ITALIC Enum Курсив.
UNDERLINE Enum Подчеркните стиль.
STRIKETHROUGH Enum Зачеркнутый стиль.
LINE_BREAK Enum Разрыв строки.
UPPERCASE Enum Стиль написания заглавными буквами.
CODE Enum Стиль кодирования.
CODE_BLOCK Enum Стиль кодового блока.

Time Stamp

Методы

Метод Тип возвращаемого значения Краткое описание
set Nanos(nanos) Time Stamp Задает значение в наносекундах для метки времени, оно представляет собой количество наносекунд в текущей секунде.
set Seconds(seconds) Time Stamp Задает количество секунд от метки времени, представляющее собой число секунд, прошедших с начала эпохи Unix (1 января 1970 г., 00:00:00 UTC).

Universal Action Response

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.

Universal Action Response Builder

Методы

Метод Тип возвращаемого значения Краткое описание
build() Universal Action Response Формирует текущий универсальный ответ на действие и проверяет его.
display Add On Cards(cardObjects) Universal Action Response Builder Отображает дополнение с указанными карточками.
set Open Link(openLink) Universal Action Response Builder Задает URL-адрес, который будет открываться при выборе универсального действия.

Update Draft Action Response

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.

Update Draft Action Response Builder

Методы

Метод Тип возвращаемого значения Краткое описание
build() Update Draft Action Response Формирует текущий черновик ответа на запрос об обновлении и проверяет его.
set Send Status(sendStatus) Update Draft Action Response Builder Задает поле перечисления, определяющее, будет ли отправлено электронное письмо после действия обновления.
set Update Draft Bcc Recipients Action(updateDraftBccRecipientsAction) Update Draft Action Response Builder Задает действие, которое обновляет список получателей в поле «Скрытая копия» (Bcc) черновика электронного письма.
set Update Draft Body Action(updateDraftBodyAction) Update Draft Action Response Builder Настройте действие, которое обновляет текст черновика электронного письма.
set Update Draft Cc Recipients Action(updateDraftCcRecipientsAction) Update Draft Action Response Builder Задает действие, которое обновляет список получателей в копии черновика.
set Update Draft Subject Action(updateDraftSubjectAction) Update Draft Action Response Builder Задает действие, которое обновляет тему черновика.
set Update Draft To Recipients Action(updateDraftToRecipientsAction) Update Draft Action Response Builder Задает действие, которое обновляет список получателей черновика.

Update Draft Bcc Recipients Action

Методы

Метод Тип возвращаемого значения Краткое описание
add Update Bcc Recipients(bccRecipientEmails) Update Draft Bcc Recipients Action Обновляет список получателей в скрытой копии (Bcc) черновика электронного письма.

Update Draft Body Action

Методы

Метод Тип возвращаемого значения Краткое описание
add Update Content(content, contentType) Update Draft Body Action Добавляет указанное содержимое в текст черновика.
set Update Type(updateType) Update Draft Body Action Задает Update Draft Body Type для данного действия обновления в теле черновика.

Update Draft Body Type

Характеристики

Свойство Тип Описание
IN_PLACE_INSERT Enum По умолчанию.
INSERT_AT_START Enum В действия обновления вставьте содержимое в начало тела сообщения.
INSERT_AT_END Enum В действия обновления вставьте содержимое в конец тела сообщения.

Update Draft Cc Recipients Action

Методы

Метод Тип возвращаемого значения Краткое описание
add Update Cc Recipients(ccRecipientEmails) Update Draft Cc Recipients Action Обновляет список получателей в копии черновика электронного письма.

Update Draft Subject Action

Методы

Метод Тип возвращаемого значения Краткое описание
add Update Subject(subject) Update Draft Subject Action Обновляет тему черновика электронного письма.

Update Draft To Recipients Action

Методы

Метод Тип возвращаемого значения Краткое описание
add Update To Recipients(toRecipientEmails) Update Draft To Recipients Action Обновляет поле «Кому» в черновике электронного письма.

Update Inline Preview Action

Методы

Метод Тип возвращаемого значения Краткое описание
add Card With Id(cardWithId) Update Inline Preview Action Добавляет карточку для этого действия.
add Expiration(ttl) Update Inline Preview Action Добавляет срок действия для данного действия.

Update Message Action

Методы

Метод Тип возвращаемого значения Краткое описание
set Message(message) Update Message Action Задает сообщение для этого действия.

Update Widget

Методы

Метод Тип возвращаемого значения Краткое описание
add Suggestion(text, value, selected, startIconUri, bottomText) Update Widget Добавляет новый элемент, который можно выбрать для создания меню с множественным выбором.

Validation Error Severity

Характеристики

Свойство Тип Описание
SEVERITY_UNSPECIFIED Enum Не указано.
CRITICAL Enum Это критическая ошибка, которую необходимо исправить до публикации.
WARNING Enum Внимание! Ошибка не является критической и не препятствует публикации.

Value Metadata

Методы

Метод Тип возвращаемого значения Краткое описание
add Castable Type(dataType) Value Metadata Добавляет в метаданные значения необязательный список допустимых типов, которые могут быть динамически преобразованы для переменных данных.
add Enum Value(enumValue) Value Metadata Добавляет необязательное строковое значение к допустимым значениям перечисления переменной; это поле можно задать только в том случае, если Data Type установлен как String.
set Default Value(defaultValue) Value Metadata Задает необязательное значение по умолчанию для переменной. Например, если тип переменной — логическое значение (boolean), значение по умолчанию может быть установлено на « true » или « false ».

Variable Data

Методы

Метод Тип возвращаемого значения Краткое описание
add Boolean Value(value) Variable Data Добавляет логическое значение к данным переменной.
add Email Address(emailAddress) Variable Data Добавляет адрес электронной почты к данным переменной.
add Float Value(value) Variable Data Добавляет к данным переменной значение с плавающей запятой.
add Google User(googleUser) Variable Data Добавляет пользователя Google в переменную данных.
add Integer Value(value) Variable Data Добавляет целочисленное значение к данным переменной.
add Resource Data(resourceData) Variable Data Добавляет значение Resource Data к данным переменной.
add Resource Reference(resourceReference) Variable Data Добавляет идентификатор ссылки на ресурс к данным переменной.
add String Value(value) Variable Data Добавляет строковое значение к данным переменной.
add Timestamp Value(value) Variable Data Добавляет значение Time Stamp к данным переменной.
add Workflow Text Format(workflowTextFormat) Variable Data Добавляет значение « Workflow Text Format к данным переменной.

Workflow Action

Workflow Text Format

Методы

Метод Тип возвращаемого значения Краткое описание
add Text Format Element(textFormatElement) Workflow Text Format Добавляет Text Format Element в форматирование текста рабочего процесса.

Workflow Validation Error Action

Методы

Метод Тип возвращаемого значения Краткое описание
set Severity(severity) Workflow Validation Error Action Задает уровень серьезности ошибки проверки.