Package google.apps.studio.v1

Index

WorkspaceStudioService

The Workspace Studio service.

FireTrigger

rpc FireTrigger(FireTriggerRequest) returns (FireTriggerResponse)

Notifies Google that a trigger event has occurred.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/workspace.studio.trigger

For more information, see the Authorization guide.

FireTriggerRequest

The request message for the FireTrigger method.

Fields
name

string

Required. The resource name of the trigger. Format: triggers/{trigger_id}
outputs

map<string, VariableData>

Optional. The output variables from the trigger event in the 3P application.
log

TextFormat

Optional. Optional user facing log for the trigger event.
request_id

string

Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a request_id is provided.

FireTriggerResponse

This type has no fields.

The response message for the FireTrigger method.

ResourceData

Application specific resource value.

Fields
fields

map<string, VariableData>

A map of the resource fields keyed by the field name.

TextFormat

A block of text with rich formatting options including styles, hyperlinks, and interactive elements.

Fields
text_format_elements[]

TextFormatElement

Optional. A collection of text format elements.

Chip

A clickable chip in the text format.

Fields
icon

Icon

Optional. The icon displayed in the chip.
label

string

Optional. The text displayed in the chip.
url

string

Optional. The URL to navigate to when the chip is clicked.

Icon

An icon in the chip.

Fields
Union field icons. The icon displayed in the chip. icons can be only one of the following:
icon_url

string

Display a custom icon hosted at an HTTPS URL.

For example:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Supported file types include .png and .jpg.
material_icon

string

The icon name defined in the Google Material Icon, for example, check_box. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.

TextFormatElement

A single element within a WorkflowTextFormatMarkup message, which can be a chip, styled text, a hyperlink, or a list container.

Fields
Union field element. Element that represents one of several possible text format elements. element can be only one of the following:
text

string

Text in the text format.
chip

Chip

Clickable chip in the text format.
styled_text

StyledText

Styled text in the text format.
list_container

ListContainer

List container in the text format.

ListContainer

Container for list items, where each list item can contain multiple TextFormatElement's.

Fields
list_nest_level

int64

Optional. The nest level of the list. Starts from 0 for the top level, and increases by 1 for each nested list.
list_type

ListType

Optional. The type of the list.
list_items[]

ListItem

Optional. A collection of list items.

ListItem

A list item.

Fields
text_format_elements[]

TextFormatElement

Optional. A collection of text format elements.

ListType

Enum for different list types.

Enums
LIST_TYPE_UNSPECIFIED No list type specified.
ORDERED Ordered list.
UNORDERED Unordered list.

StyledText

Text element with styles such as bold, italic and color.

Fields
text

string

Optional. The main content of the text.
styles[]

Style

Optional. A collection of styles applied to the text.
font_weight

FontWeight

Optional. The font weight of the text.
color

Color

Optional. The color of the text.
wrap_style

WrapStyle

Optional. The wrap style of the text.

FontWeight

Enum for different font weights.

Enums
FONT_WEIGHT_UNSPECIFIED Standard weight with normal thickness.
LIGHT Lighter weight with reduced thickness.
MEDIUM Intermediate weight between light and bold.
BOLD Heavier weight with increased thickness.

Style

Enum for different text styles such as italic, underline, etc.

Enums
STYLE_UNSPECIFIED No style applied.
ITALIC Italic style.
UNDERLINE Underline style.
STRIKETHROUGH Strikethrough style.
LINE_BREAK Line break.
UPPERCASE Uppercase style.
CODE Code.
CODE_BLOCK Code block.

WrapStyle

Enum for different wrap styles.

Enums
WRAP_STYLE_UNSPECIFIED No wrap style specified.
NO_WRAP No wrap style.

VariableData

Represents variable data, which can hold multiple values of different types.

Fields
boolean_values[]

bool

Boolean values.
integer_values[]

int64

Integer values.
string_values[]

string

String values.
timestamp_values[]

Timestamp

Timestamp values.
resource_references[]

string

A list of resource IDs (e.g. "spaces/123").
resource_data_values[]

ResourceData

A list of resource data.
email_address_values[]

string

Email address values.
users[]

string

Google user values in the format users/{user}.