Card Service

Serviço de cartão

Esse serviço permite que os scripts configurem e criem componentes e comportamentos de cards e widgets para uma interface. As estruturas de interface criadas com esse serviço ficam disponíveis automaticamente em computadores e dispositivos móveis. Assim, você não precisa desenvolver interfaces separadas para ambos.

Classes

NomeBreve descrição
ActionUma ação que permite a interatividade nos elementos da interface.
ActionResponseO objeto de resposta que pode ser retornado de uma função de callback (por exemplo, um gerenciador de respostas de formulário) para executar uma ou mais ações no cliente.
ActionResponseBuilderUm builder para objetos ActionResponse.
ActionStatus
AttachmentRepresenta um anexo criado por um complemento.
AuthorizationActionUma ação de autorização que enviará o usuário ao AuthorizationUrl quando clicado.
AuthorizationExceptionUm erro que pode ser retornado para acionar a exibição de um cartão de autorização ao usuário.
BorderStyleUma classe que representa um estilo de borda completo que pode ser aplicado a widgets.
BorderTypeUm enum que representa os tipos de borda que podem ser aplicados a widgets.
ButtonUma classe base para todos os botões.
ButtonSetMantém um conjunto de objetos Button que são exibidos em uma linha.
CalendarEventActionResponseRepresenta uma resposta que faz alterações no evento da agenda que o usuário está editando em reação a uma ação realizada na interface, como um clique de botão.
CalendarEventActionResponseBuilderUm builder para objetos CalendarEventActionResponse.
CardUm card de contexto que representa uma única visualização na interface.
CardActionUm item de menu clicável que é adicionado ao menu de cabeçalho do cartão.
CardBuilderUm builder para objetos Card.
CardHeaderO cabeçalho de uma Card.
CardSectionUma seção de card contém grupos de widgets e oferece uma separação visual entre eles.
CardServiceO CardService permite criar cards genéricos usados em diferentes produtos de extensibilidade do Google, como os Complementos do Google Workspace.
CardWithId
ChatActionResponse
ChatClientDataSource
ChatResponse
ChatResponseBuilder
ChatSpaceDataSource
CommonDataSource
ComposeActionResponseO objeto de resposta que pode ser retornado de um método de callback para a ação de escrever em um complemento do Gmail.
ComposeActionResponseBuilderUm builder para objetos ComposeActionResponse.
ComposedEmailTypeUm valor de enumeração que especifica se o e-mail escrito é um rascunho independente ou de resposta.
ContentTypeUm valor de enumeração que especifica o tipo de conteúdo gerado por uma UpdateDraftActionResponse.
DatePickerUm campo de entrada que permite inserir uma data.
DateTimePickerUm campo de entrada que permite aos usuários inserir uma data e hora.
DecoratedTextUm widget que mostra texto com decorações opcionais.
Dialog
DialogAction
DisplayStyleUma enumeração que define o estilo de exibição do card.
DividerUm divisor horizontal.
DriveItemsSelectedActionResponseRepresenta uma resposta que faz alterações no Drive enquanto os itens estão selecionados e em reação a uma ação realizada na interface, como um clique de botão.
DriveItemsSelectedActionResponseBuilderUm builder para objetos DriveItemsSelectedActionResponse.
EditorFileScopeActionResponseFaz alterações em um editor, como Documentos, Planilhas ou Apresentações Google, em resposta a uma ação realizada na interface.
EditorFileScopeActionResponseBuilderUm builder para objetos EditorFileScopeActionResponse.
FixedFooterO rodapé fixo mostrado na parte de baixo de uma Card.
GridUma grade organizada para mostrar uma coleção de itens de grade.
GridItemItens com os quais os usuários interagem em um widget de grade.
GridItemLayoutUma enumeração que define o estilo de imagem e texto de um GridItem.
HorizontalAlignmentUm enum que especifica o alinhamento horizontal de um widget.
HostAppDataSource
IconÍcones predefinidos que podem ser usados em vários objetos da interface, como widgets ImageButton ou DecoratedText.
IconImageUm ícone predefinido ou de um URL com um estilo de corte personalizável.
ImageUm widget que mostra uma única imagem.
ImageButtonUm ImageButton com uma imagem.
ImageComponentUm componente de imagem que pode ser adicionado a itens de grade.
ImageCropStyleUma classe que representa um estilo de corte que pode ser aplicado a componentes de imagem.
ImageCropTypeUma enumeração que representa os estilos de corte aplicados aos componentes de imagem.
ImageStyleUma enumeração que define um estilo de corte de imagem.
Interaction
KeyValueEsta classe está obsoleta.
LinkPreviewAção de card que mostra um card de visualização de link e um ícone inteligente no app host.
LoadIndicatorUm tipo de enumeração que especifica o tipo de carregamento ou indicador de progresso que vai ser mostrado enquanto uma Action está sendo processada.
NavigationUm objeto auxiliar que controla a navegação dos cards.
NotificationNotificação mostrada ao usuário como resposta à interação com um elemento da interface.
OnCloseUm enum que especifica o que fazer quando um URL aberto por uma OpenLink é fechado.
OpenAsUm enum que especifica como abrir um URL.
OpenLinkRepresenta uma ação para abrir um link com algumas opções.
PlatformDataSource
ResponseType
SelectionInputUm campo de entrada que permite escolher entre um conjunto de opções predefinidas.
SelectionInputTypeO formato dos itens que os usuários podem selecionar.
StatusUm enum que representa o código de status.
SuggestionsSugestões de preenchimento automático para complementar um widget TextInput.
SuggestionsResponseUm objeto de resposta que pode ser retornado de uma função de callback de sugestões.
SuggestionsResponseBuilderUm builder para objetos SuggestionsResponse.
SwitchUm elemento da interface que pode ser ativado ou desativado.
SwitchControlTypeTipo de um controle de widget Switch.
TextButtonUma TextButton com um rótulo de texto.
TextButtonStyleUma enumeração que especifica o estilo de TextButton.
TextInputUm widget de campo de entrada que aceita entrada de texto.
TextParagraphUm widget que exibe texto e oferece suporte à formatação HTML básica.
TimePickerUm campo de entrada que permite aos usuários inserir um horário.
UniversalActionResponseO objeto de resposta que pode ser retornado de um método que cria uma ação universal.
UniversalActionResponseBuilderUm builder para os objetos UniversalActionResponse.
UpdateDraftActionResponseRepresenta uma ação que atualiza o rascunho de e-mail que o usuário está editando no momento.
UpdateDraftActionResponseBuilderUm builder para objetos UpdateDraftActionResponse.
UpdateDraftBccRecipientsActionAtualiza os destinatários Cco de um rascunho de e-mail.
UpdateDraftBodyActionAtualiza o corpo do rascunho do e-mail.
UpdateDraftBodyTypeUm valor de enumeração que especifica o tipo de uma UpdateDraftBodyAction.
UpdateDraftCcRecipientsActionAtualiza os destinatários Cc de um rascunho de e-mail.
UpdateDraftSubjectActionAtualiza a linha de assunto de um rascunho de e-mail.
UpdateDraftToRecipientsActionAtualiza os destinatários de um rascunho de e-mail em "Para".
UpdatedWidget
WidgetClasse de base para todos os widgets que podem ser adicionados a uma Card.

Action

Métodos

MétodoTipo de retornoBreve descrição
setFunctionName(functionName)ActionDefine o nome da função de retorno de chamada a ser chamada.
setInteraction(interaction)ActionDefine a interação com um usuário, obrigatória apenas ao abrir uma caixa de diálogo.
setLoadIndicator(loadIndicator)ActionDefine o indicador de carregamento que aparece enquanto a ação está em andamento.
setParameters(parameters)ActionPermite que parâmetros personalizados sejam transmitidos para a função de callback.
setPersistValues(persistValues)ActionIndica se os valores do formulário são determinados pelos valores do cliente ou do servidor depois que uma resposta de ação atualiza o Card do formulário.

ActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.

ActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()ActionResponseCria e valida a resposta da ação atual.
setNavigation(navigation)ActionResponseBuilderDefine a resposta como uma ação Navigation.
setNotification(notification)ActionResponseBuilderDefine a notificação para ser exibida quando a ação for ativada.
setOpenLink(openLink)ActionResponseBuilderDefine o URL que será acessado quando a ação for ativada.
setStateChanged(stateChanged)ActionResponseBuilderDefine uma sinalização para indicar que essa ação alterou o estado dos dados.

ActionStatus

Métodos

MétodoTipo de retornoBreve descrição
setStatusCode(statusCode)ActionStatusRepresenta o status de uma solicitação para abrir ou enviar uma caixa de diálogo.
setUserFacingMessage(message)ActionStatusA mensagem a ser enviada aos usuários sobre o status da solicitação.

Attachment

Métodos

MétodoTipo de retornoBreve descrição
setIconUrl(iconUrl)AttachmentDefine o URL do ícone do anexo.
setMimeType(mimeType)AttachmentDefine o tipo MIME do anexo.
setResourceUrl(resourceUrl)AttachmentDefine o URL do recurso para o anexo.
setTitle(title)AttachmentDefine o título do anexo.

AuthorizationAction

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationUrl(authorizationUrl)AuthorizationActionDefine o URL de autorização que o usuário acessa a partir da solicitação de autorização.

AuthorizationException

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.
setAuthorizationUrl(authUrl)AuthorizationExceptionDefine o URL de autorização que o usuário acessa a partir da solicitação de autorização.
setCustomUiCallback(callback)AuthorizationExceptionO nome de uma função a ser chamada para gerar um prompt de autorização personalizado.
setResourceDisplayName(name)AuthorizationExceptionDefine o nome que é exibido para o usuário quando ele pede autorização.
throwException()voidAciona o lançamento dessa exceção.

BorderStyle

Métodos

MétodoTipo de retornoBreve descrição
setCornerRadius(radius)BorderStyleDefine o raio do canto da borda, por exemplo, 8.
setStrokeColor(color)BorderStyleDefine a cor da borda.
setType(type)BorderStyleDefine o tipo de borda.

BorderType

Propriedades

PropriedadeTipoDescrição
NO_BORDEREnumNenhum estilo de borda.
STROKEEnumEstilo da borda do traço.

Button

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationAction(action)ButtonDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)ButtonDefine uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
setOnClickAction(action)ButtonDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)ButtonDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)ButtonDefine um URL que será aberto quando o objeto for clicado.

ButtonSet

Métodos

MétodoTipo de retornoBreve descrição
addButton(button)ButtonSetAdiciona um botão.

CalendarEventActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.

CalendarEventActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
addAttachments(attachments)CalendarEventActionResponseBuilderEspecifica que a resposta precisa adicionar os anexos ao evento do Agenda quando a ação de interface associada for realizada.
addAttendees(emails)CalendarEventActionResponseBuilderEspecifica que a resposta precisa adicionar os participantes indicados ao evento do Google Agenda quando a ação de interface associada for realizada.
build()CalendarEventActionResponseCria e valida a resposta da ação de evento atual do Google Agenda.
setConferenceData(conferenceData)CalendarEventActionResponseBuilderEspecifica que a resposta precisa definir os dados da videoconferência indicados para o evento do Agenda quando a ação de interface associada é realizada.

Card

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.

CardAction

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationAction(action)CardActionDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)CardActionDefine uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
setOnClickAction(action)CardActionDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)CardActionDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)CardActionDefine um URL que será aberto quando o objeto for clicado.
setText(text)CardActionDefine o texto do menu para esta ação.

CardBuilder

Métodos

MétodoTipo de retornoBreve descrição
addCardAction(cardAction)CardBuilderAdiciona um CardAction ao card.
addSection(section)CardBuilderAdiciona uma seção a este card.
build()CardCria e valida o cartão atual.
setDisplayStyle(displayStyle)CardBuilderDefine o estilo de exibição do card.
setFixedFooter(fixedFooter)CardBuilderDefine um rodapé fixo para o card.
setHeader(cardHeader)CardBuilderDefine o cabeçalho do cartão.
setName(name)CardBuilderDefine o nome do cartão.
setPeekCardHeader(peekCardHeader)CardBuilderDefine o cabeçalho do card de exibição.

CardHeader

Métodos

MétodoTipo de retornoBreve descrição
setImageAltText(imageAltText)CardHeaderDefine o texto alternativo para a imagem do cabeçalho.
setImageStyle(imageStyle)CardHeaderDefine o corte do ícone no cabeçalho do cartão.
setImageUrl(imageUrl)CardHeaderDefine a imagem a ser usada no cabeçalho, fornecendo o URL ou a string de dados dela.
setSubtitle(subtitle)CardHeaderDefine a legenda do cabeçalho do cartão.
setTitle(title)CardHeaderDefine o título do cabeçalho do cartão.

CardSection

Métodos

MétodoTipo de retornoBreve descrição
addWidget(widget)CardSectionAdiciona o widget especificado à seção.
setCollapsible(collapsible)CardSectionDefine se a seção pode ser recolhida.
setHeader(header)CardSectionDefine o cabeçalho da seção.
setNumUncollapsibleWidgets(numUncollapsibleWidgets)CardSectionDefine o número de widgets que ainda são mostrados quando a seção está recolhida.

CardService

Propriedades

PropriedadeTipoDescrição
BorderTypeBorderTypeA enumeração BorderType.
ComposedEmailTypeComposedEmailTypeA enumeração ComposedEmailType.
ContentTypeContentTypeA enumeração ContentType.
GridItemLayoutGridItemLayoutA enumeração GridItemLayout.
HorizontalAlignmentHorizontalAlignmentA enumeração HorizontalAlignment.
IconIconA enumeração Icon.
ImageCropTypeImageCropTypeA enumeração ImageCropType.
ImageStyleImageStyleA enumeração ImageStyle.
LoadIndicatorLoadIndicatorA enumeração LoadIndicator.
OnCloseOnCloseA enumeração OnClose.
OpenAsOpenAsA enumeração OpenAs.
SelectionInputTypeSelectionInputTypeA enumeração SelectionInputType.
TextButtonStyleTextButtonStyleA enumeração TextButtonStyle.
UpdateDraftBodyTypeUpdateDraftBodyTypeA enumeração UpdateDraftBodyType.

Métodos

MétodoTipo de retornoBreve descrição
newAction()ActionCrie um novo Action.
newActionResponseBuilder()ActionResponseBuilderCrie um novo ActionResponseBuilder.
newActionStatus()ActionStatusCrie um novo ActionStatus.
newAttachment()AttachmentCrie um novo Attachment.
newAuthorizationAction()AuthorizationActionCrie um novo AuthorizationAction.
newAuthorizationException()AuthorizationExceptionCrie um novo AuthorizationException.
newBorderStyle()BorderStyleCrie um novo BorderStyle.
newButtonSet()ButtonSetCrie um novo ButtonSet.
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderCrie um novo CalendarEventActionResponseBuilder.
newCardAction()CardActionCrie um novo CardAction.
newCardBuilder()CardBuilderCrie um novo CardBuilder.
newCardHeader()CardHeaderCrie um novo CardHeader.
newCardSection()CardSectionCrie um novo CardSection.
newCardWithId()CardWithIdCrie um novo CardWithId.
newChatActionResponse()ChatActionResponseCrie um novo ChatActionResponse.
newChatResponseBuilder()ChatResponseBuilderCrie um novo ChatResponseBuilder.
newComposeActionResponseBuilder()ComposeActionResponseBuilderCrie um novo ComposeActionResponseBuilder.
newDatePicker()DatePickerCrie um novo DatePicker.
newDateTimePicker()DateTimePickerCrie um novo DateTimePicker.
newDecoratedText()DecoratedTextCrie um novo DecoratedText.
newDialog()DialogCrie um novo Dialog.
newDialogAction()DialogActionCrie um novo DialogAction.
newDivider()DividerCrie um novo Divider.
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderCrie um novo DriveItemsSelectedActionResponseBuilder.
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderCrie um novo EditorFileScopeActionResponseBuilder.
newFixedFooter()FixedFooterCrie um novo FixedFooter.
newGrid()GridCrie um novo Grid.
newGridItem()GridItemCrie um novo GridItem.
newIconImage()IconImageCrie um novo IconImage.
newImage()ImageCrie um novo Image.
newImageButton()ImageButtonCrie um novo ImageButton.
newImageComponent()ImageComponentCrie um novo ImageComponent.
newImageCropStyle()ImageCropStyleCrie um novo ImageCropStyle.
newKeyValue()KeyValueCrie um novo KeyValue.
newLinkPreview()LinkPreviewCrie um novo LinkPreview.
newNavigation()NavigationCrie um novo Navigation.
newNotification()NotificationCrie um novo Notification.
newOpenLink()OpenLinkCrie um novo OpenLink.
newSelectionInput()SelectionInputCrie um novo SelectionInput.
newSuggestions()SuggestionsCrie um novo Suggestions.
newSuggestionsResponseBuilder()SuggestionsResponseBuilderCrie um novo SuggestionsResponseBuilder.
newSwitch()SwitchCrie um novo Switch.
newTextButton()TextButtonCrie um novo TextButton.
newTextInput()TextInputCrie um novo TextInput.
newTextParagraph()TextParagraphCrie um novo TextParagraph.
newTimePicker()TimePickerCrie um novo TimePicker.
newUniversalActionResponseBuilder()UniversalActionResponseBuilderCrie um novo UniversalActionResponseBuilder.
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderCrie um novo UpdateDraftActionResponseBuilder.
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionCria um novo UpdateDraftBccRecipientsAction.
newUpdateDraftBodyAction()UpdateDraftBodyActionCrie um novo UpdateDraftBodyAction.
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionCrie um novo UpdateDraftCcRecipientsAction.
newUpdateDraftSubjectAction()UpdateDraftSubjectActionCrie um novo UpdateDraftSubjectAction.
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionCrie um novo UpdateDraftToRecipientsAction.

CardWithId

Métodos

MétodoTipo de retornoBreve descrição
setCard(card)CardWithIdDefine o cartão do cardWithId.
setCardId(id)CardWithIdDefine o ID exclusivo do cartão do cardWithId.

ChatActionResponse

Métodos

MétodoTipo de retornoBreve descrição
setDialogAction(dialogAction)ChatActionResponseDefine a ação da caixa de diálogo como um evento relacionado a uma caixa de diálogo.
setResponseType(responseType)ChatActionResponseO tipo de resposta do app do Chat.
setUpdatedWidget(updatedWidget)ChatActionResponseDefine o widget atualizado, usado para fornecer opções de preenchimento automático para um widget.
setUrl(url)ChatActionResponseO URL em que os usuários podem se autenticar ou configurar.

ChatClientDataSource

Métodos

MétodoTipo de retornoBreve descrição
setSpaceDataSource(spaceDataSource)ChatClientDataSourceUma fonte de dados que preenche os espaços do Google Chat como itens de seleção para um menu de seleção múltipla.

ChatResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.

ChatResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
addCardsV2(cardWithId)ChatResponseBuilderDefine o campo do cartão da mensagem.
build()ChatResponseCria e valida a resposta da ação atual.
setActionResponse(actionResponse)ChatResponseBuilderDefine o campo de resposta da ação da mensagem.
setText(text)ChatResponseBuilderDefine o texto da mensagem do Chat.

ChatSpaceDataSource

Métodos

MétodoTipo de retornoBreve descrição
setDefaultToCurrentSpace(defaultToCurrentSpace)ChatSpaceDataSourceSe definido como true, o menu de seleção múltipla vai selecionar o espaço atual do Google Chat como um item por padrão.

CommonDataSource

Propriedades

PropriedadeTipoDescrição
UNKNOWNEnumValor padrão.
USEREnumusuários do Google Workspace.

ComposeActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.

ComposeActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()ComposeActionResponseCria e valida a resposta atual da ação de escrita.
setGmailDraft(draft)ComposeActionResponseBuilderDefine o rascunho GmailMessage criado usando GmailMessage.createDraftReply(body) ou funções semelhantes.

ComposedEmailType

Propriedades

PropriedadeTipoDescrição
REPLY_AS_DRAFTEnumUm rascunho que é uma resposta a outra mensagem.
STANDALONE_DRAFTEnumUm rascunho que é uma mensagem independente.

ContentType

Propriedades

PropriedadeTipoDescrição
TEXTEnumIndica que o conteúdo gerado é um texto simples.
MUTABLE_HTMLEnumIndica que o conteúdo gerado está formatado como HTML.
IMMUTABLE_HTMLEnumIndica que o conteúdo gerado está formatado como HTML, mas não pode ser editado depois de gerado.

DatePicker

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)DatePickerDefine o nome do campo que identifica esse seletor no objeto de evento gerado quando há uma interação com a interface.
setOnChangeAction(action)DatePickerDefine um Action que o script executa sempre que a entrada do seletor muda.
setTitle(title)DatePickerDefine o título exibido acima do campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerDefine o valor preenchido automaticamente a ser definido no campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerDefine o valor preenchido automaticamente a ser definido no campo de entrada.

DateTimePicker

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)DateTimePickerDefine o nome do campo que identifica esse seletor no objeto de evento gerado quando há uma interação com a interface.
setOnChangeAction(action)DateTimePickerDefine um Action que o script executa sempre que a entrada do seletor muda.
setTimeZoneOffsetInMins(timeZoneOffsetMins)DateTimePickerDefine o número de minutos em que o fuso horário deve ser deslocado do UTC.
setTitle(title)DateTimePickerDefine o título exibido acima do campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DateTimePickerDefine o valor preenchido automaticamente a ser definido no campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DateTimePickerDefine o valor preenchido automaticamente a ser definido no campo de entrada.

DecoratedText

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationAction(action)DecoratedTextDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setBottomLabel(text)DecoratedTextDefine o texto do rótulo a ser usado como chave e é exibido abaixo do conteúdo do texto.
setButton(button)DecoratedTextDefine o Button que é mostrado à direita do texto.
setComposeAction(action, composedEmailType)DecoratedTextDefine uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
setEndIcon(endIcon)DecoratedTextDefine o IconImage opcional exibido à direita do conteúdo.
setOnClickAction(action)DecoratedTextDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)DecoratedTextDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)DecoratedTextDefine um URL que será aberto quando o objeto for clicado.
setStartIcon(startIcon)DecoratedTextDefine os IconImage opcionais que vão ser mostrados antes do conteúdo de texto.
setSwitchControl(switchToSet)DecoratedTextDefine o Switch que é mostrado à direita do conteúdo.
setText(text)DecoratedTextDefine o texto a ser usado como o valor.
setTopLabel(text)DecoratedTextDefine o texto do rótulo a ser usado como a chave e é exibido acima do conteúdo do texto.
setWrapText(wrapText)DecoratedTextDefine se o texto do valor deve ser mostrado em uma única linha ou em várias.

Dialog

Métodos

MétodoTipo de retornoBreve descrição
setBody(card)DialogDefine o cartão do Dialog.

DialogAction

Métodos

MétodoTipo de retornoBreve descrição
setActionStatus(actionStatus)DialogActionDefine o status da ação de DialogAction.
setDialog(dialog)DialogActionDefine a caixa de diálogo do DialogAction.

DisplayStyle

Propriedades

PropriedadeTipoDescrição
PEEKEnumMostre o cabeçalho do card na parte de baixo do conteúdo do complemento sobre o conteúdo atual.
REPLACEEnumPara exibir o card, substitua o conteúdo atual.

Divider

DriveItemsSelectedActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.

DriveItemsSelectedActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()DriveItemsSelectedActionResponseCria a resposta atual da ação do Drive.
requestFileScope(itemId)DriveItemsSelectedActionResponseBuilderEspecifica o escopo do arquivo de solicitações de resposta para o item contextualmente relevante no Drive.

EditorFileScopeActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.

EditorFileScopeActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()EditorFileScopeActionResponseCria a resposta atual da ação do editor.
requestFileScopeForActiveDocument()EditorFileScopeActionResponseBuilderSolicita o escopo drive.file para o documento ativo do Editor.

FixedFooter

Métodos

MétodoTipo de retornoBreve descrição
setPrimaryButton(button)FixedFooterDefinir o botão principal no rodapé fixo.
setSecondaryButton(button)FixedFooterDefinir o botão secundário no rodapé fixo.

Grid

Métodos

MétodoTipo de retornoBreve descrição
addItem(gridItem)GridAdiciona um novo item à grade.
setAuthorizationAction(action)GridDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setBorderStyle(borderStyle)GridDefine o estilo de borda aplicado a cada item da grade.
setComposeAction(action, composedEmailType)GridDefine uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
setNumColumns(numColumns)GridO número de colunas a serem exibidas na grade.
setOnClickAction(action)GridDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)GridDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)GridDefine um URL que será aberto quando o objeto for clicado.
setTitle(title)GridDefine o texto do título da grade.

GridItem

Métodos

MétodoTipo de retornoBreve descrição
setIdentifier(id)GridItemDefine o identificador para o item da grade.
setImage(image)GridItemDefine a imagem desse item da grade.
setLayout(layout)GridItemDefine o layout do texto e da imagem para o item da grade.
setSubtitle(subtitle)GridItemDefine o subtítulo do item da grade.
setTextAlignment(alignment)GridItemDefine o alinhamento horizontal do item da grade.
setTitle(title)GridItemDefine o texto do título do item da grade.

GridItemLayout

Propriedades

PropriedadeTipoDescrição
TEXT_BELOWEnumO título e o subtítulo são mostrados abaixo da imagem do item da grade.
TEXT_ABOVEEnumO título e o subtítulo são mostrados acima da imagem do item da grade.

HorizontalAlignment

Propriedades

PropriedadeTipoDescrição
STARTEnumAlinhe o widget ao início do lado da frase.
CENTEREnumAlinhe o widget ao centro.
ENDEnumAlinhe o widget ao final do lado da frase.

HostAppDataSource

Métodos

MétodoTipo de retornoBreve descrição
setChatDataSource(chatClientDataSource)HostAppDataSourceDefine a fonte de dados do Google Chat.

Icon

Propriedades

PropriedadeTipoDescrição
NONEEnumNenhum ícone.
AIRPLANEEnumÍcone de voo
BOOKMARKEnumÍcone de favorito
BUSEnumÍcone de ônibus
CAREnumÍcone de carro
CLOCKEnumÍcone de relógio
CONFIRMATION_NUMBER_ICONEnumÍcone do número de confirmação
DOLLAREnumÍcone de dólar
DESCRIPTIONEnumÍcone de descrição
EMAILEnumÍcone de e-mail
EVENT_PERFORMEREnumÍcone de e-mail
EVENT_SEATEnumÍcone de assento de evento
FLIGHT_ARRIVALEnumÍcone de chegada de voos
FLIGHT_DEPARTUREEnumÍcone de partida do voo
HOTELEnumÍcone de hotel
HOTEL_ROOM_TYPEEnumÍcone de hotel
INVITEEnumÍcone de convite
MAP_PINEnumÍcone de alfinete do mapa
MEMBERSHIPEnumÍcone de assinante
MULTIPLE_PEOPLEEnumÍcone de várias pessoas
OFFEREnumÍcone de oferta
PERSONEnumÍcone de pessoa
PHONEEnumÍcone de telefone
RESTAURANT_ICONEnumÍcone de restaurante
SHOPPING_CARTEnumÍcone do carrinho de compras
STAREnumÍcone de estrela
STOREEnumÍcone da loja
TICKETEnumÍcone de tíquete
TRAINEnumÍcone de trem
VIDEO_CAMERAEnumÍcone de câmera de vídeo
VIDEO_PLAYEnumÍcone de reprodução de vídeo

IconImage

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)IconImageDefine o texto alternativo do URL usado para acessibilidade.
setIcon(icon)IconImageDefine o ícone predefinido se o URL não estiver definido.
setIconUrl(url)IconImageDefine o URL do ícone se ele não estiver definido.
setImageCropType(imageCropType)IconImageDefine o estilo de corte da imagem.

Image

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)ImageDefine o texto alternativo da imagem para acessibilidade.
setAuthorizationAction(action)ImageDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)ImageDefine uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
setImageUrl(url)ImageDefine a imagem a ser usada fornecendo o URL ou a string de dados dela.
setOnClickAction(action)ImageDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)ImageDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)ImageDefine um URL que será aberto quando o objeto for clicado.

ImageButton

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)ImageButtonDefine o texto alternativo do botão para acessibilidade.
setAuthorizationAction(action)ImageButtonDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)ImageButtonDefine uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
setIcon(icon)ImageButtonDefine um Icon predefinido para exibição no botão.
setIconUrl(url)ImageButtonDefine o URL de uma imagem a ser usada como o ícone desse botão.
setOnClickAction(action)ImageButtonDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)ImageButtonDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)ImageButtonDefine um URL que será aberto quando o objeto for clicado.

ImageComponent

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)ImageComponentDefine o texto alternativo da imagem.
setBorderStyle(borderStyle)ImageComponentDefine o estilo de borda aplicado à imagem.
setCropStyle(imageCropStyle)ImageComponentDefine o estilo de corte da imagem.
setImageUrl(url)ImageComponentDefine o URL da imagem.

ImageCropStyle

Métodos

MétodoTipo de retornoBreve descrição
setAspectRatio(ratio)ImageCropStyleDefine a proporção a ser usada se o tipo de corte for RECTANGLE_CUSTOM.
setImageCropType(type)ImageCropStyleDefine o tipo de corte para a imagem.

ImageCropType

Propriedades

PropriedadeTipoDescrição
SQUAREEnumEstilo de corte de forma quadrada.
CIRCLEEnumEstilo de corte da forma de círculo.
RECTANGLE_CUSTOMEnumEstilo de corte em forma retangular com proporção personalizada.
RECTANGLE_4_3EnumEstilo de corte em forma retangular com proporção de 4:3.

ImageStyle

Propriedades

PropriedadeTipoDescrição
SQUAREEnumSem corte.
CIRCLEEnumCorte em um círculo.

Interaction

Propriedades

PropriedadeTipoDescrição
INTERACTION_UNSPECIFIEDEnumValor padrão.
OPEN_DIALOGEnumAbre uma caixa de diálogo, uma interface baseada em cards que os apps de chat usam para interagir com os usuários.

KeyValue

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationAction(action)KeyValueDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)KeyValueDefine uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
setOnClickAction(action)KeyValueDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)KeyValueDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)KeyValueDefine um URL que será aberto quando o objeto for clicado.

LinkPreview

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.
setLinkPreviewTitle(title)LinkPreviewDefine o título exibido na visualização do link acima do card de visualização.
setPreviewCard(previewCard)LinkPreviewDefine o card que mostra informações sobre um link de um serviço de terceiros ou de terceiros.
setTitle(title)LinkPreviewDefine o título que aparece no ícone inteligente para a visualização do link.

LoadIndicator

Propriedades

PropriedadeTipoDescrição
SPINNEREnumUse um ícone de carregamento.
NONEEnumNão use um indicador.

Métodos

MétodoTipo de retornoBreve descrição
popCard()NavigationMostra um card da pilha de navegação.
popToNamedCard(cardName)NavigationMostra o cartão especificado pelo nome do cartão.
popToRoot()NavigationExibe a pilha de cartões no cartão raiz.
printJson()StringExibe a representação JSON desse objeto.
pushCard(card)NavigationEnvia o cartão fornecido para a pilha.
updateCard(card)NavigationSubstitui o cartão atual no local.

Notification

Métodos

MétodoTipo de retornoBreve descrição
setText(text)NotificationDefine o texto a ser exibido na notificação.

OnClose

Propriedades

PropriedadeTipoDescrição
NOTHINGEnumNão fazer nada no fechamento.
RELOADEnumRecarrega o complemento quando a janela fecha.

OpenAs

Propriedades

PropriedadeTipoDescrição
FULL_SIZEEnumAbre em uma janela ou guia inteira.
OVERLAYEnumAbre como uma sobreposição, por exemplo, um pop-up.

Métodos

MétodoTipo de retornoBreve descrição
setOnClose(onClose)OpenLinkDefine o comportamento da ação de URL quando a janela ou guia do URL é fechada.
setOpenAs(openAs)OpenLinkDefine o comportamento do URL quando ele é aberto.
setUrl(url)OpenLinkDefine o URL a ser aberto.

PlatformDataSource

Métodos

MétodoTipo de retornoBreve descrição
setCommonDataSource(commonDataSource)PlatformDataSourceDefine a fonte de dados do Google Workspace.
setHostAppDataSource(hostAppDataSource)PlatformDataSourceUsado para preencher espaços no menu de seleção múltipla.

ResponseType

Propriedades

PropriedadeTipoDescrição
TYPE_UNSPECIFIEDEnumTipo padrão processado como NEW_MESSAGE.
NEW_MESSAGEEnumPostar como uma nova mensagem no tópico.
UPDATE_MESSAGEEnumAtualize a mensagem do app do Chat.
UPDATE_USER_MESSAGE_CARDSEnumAtualize os cards na mensagem de um usuário.
REQUEST_CONFIGEnumSolicite ao usuário uma autenticação ou configuração adicional de maneira particular.
DIALOGEnumMostra uma caixa de diálogo.
UPDATE_WIDGETEnumConsulta de opções de preenchimento automático de texto do widget.

SelectionInput

Métodos

MétodoTipo de retornoBreve descrição
addItem(text, value, selected)SelectionInputAdiciona um novo item que pode ser selecionado.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputAdiciona um novo item que pode ser selecionado, para menus de seleção múltipla.
setExternalDataSource(action)SelectionInputDefine a fonte de dados externa, como um banco de dados relacional.
setFieldName(fieldName)SelectionInputDefine a chave que identifica essa entrada de seleção no objeto de evento gerado quando há uma interação com a interface.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputDefine o número máximo de itens que um usuário pode selecionar.
setMultiSelectMinQueryLength(queryLength)SelectionInputDefine o número de caracteres de texto que um usuário insere antes de o app consultar o preenchimento automático e exibe itens sugeridos no cartão.
setOnChangeAction(action)SelectionInputDefine um Action a ser executado sempre que a entrada de seleção mudar.
setPlatformDataSource(platformDataSource)SelectionInputDefine uma fonte de dados do Google Workspace.
setTitle(title)SelectionInputDefine o título que será exibido antes do campo de entrada.
setType(type)SelectionInputDefine o tipo dessa entrada.

SelectionInputType

Propriedades

PropriedadeTipoDescrição
CHECK_BOXEnumEstilo de entrada da caixa de seleção.
RADIO_BUTTONEnumEstilo de entrada do botão de opção.
DROPDOWNEnumEstilo de entrada para a seleção do menu suspenso.
SWITCHEnumUm conjunto de interruptores.
MULTI_SELECTEnum

Status

Propriedades

PropriedadeTipoDescrição
OKEnumMapeamento HTTP: 200 OK
CANCELLEDEnumMapeamento HTTP: 499 Solicitação fechada pelo cliente
UNKNOWNEnumErro desconhecido.
INVALID_ARGUMENTEnumO cliente especificou um argumento inválido.
DEADLINE_EXCEEDEDEnumMapeamento HTTP: 504 Tempo limite do gateway
NOT_FOUNDEnumMapeamento HTTP: 404 Não encontrado
ALREADY_EXISTSEnumA entidade que um cliente tentou criar já existe.
PERMISSION_DENIEDEnumMapeamento HTTP: 403 Proibido
UNAUTHENTICATEDEnumMapeamento HTTP: 401 Não autorizado
RESOURCE_EXHAUSTEDEnumMapeamento HTTP: 429 Há muitas solicitações
FAILED_PRECONDITIONEnumA operação foi rejeitada porque o estado do sistema não é o necessário para a execução dela.
ABORTEDEnumA operação foi cancelada, geralmente devido a um problema de simultaneidade, como falha na verificação do sequenciador ou cancelamento da transação.
OUT_OF_RANGEEnumHouve uma tentativa da operação depois do intervalo válido.
UNIMPLEMENTEDEnumMapeamento HTTP: 501 Não implementado
INTERNALEnumErros internos.
UNAVAILABLEEnumMapeamento HTTP: 503 Serviço indisponível
DATA_LOSSEnumPerda ou corrupção irrecuperável de dados.

Suggestions

Métodos

MétodoTipo de retornoBreve descrição
addSuggestion(suggestion)SuggestionsAdicione uma sugestão de texto.
addSuggestions(suggestions)SuggestionsAdicione uma lista de sugestões de texto.

SuggestionsResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.

SuggestionsResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()SuggestionsResponseCria e valida a resposta atual de sugestões.
setSuggestions(suggestions)SuggestionsResponseBuilderDefine as sugestões usadas no preenchimento automático nos campos de texto.

Switch

Métodos

MétodoTipo de retornoBreve descrição
setControlType(controlType)SwitchDefine o tipo de controle do interruptor.
setFieldName(fieldName)SwitchDefine a chave que identifica essa chave no objeto de evento gerado quando há uma interação com a interface.
setOnChangeAction(action)SwitchDefine a ação a ser realizada quando o interruptor for alternado.
setSelected(selected)SwitchDefine se o interruptor deve começar com a seleção ou não.
setValue(value)SwitchDefine o valor enviado como a entrada do formulário quando esse interruptor é ativado.

SwitchControlType

Propriedades

PropriedadeTipoDescrição
SWITCHEnumControle de estilo de alternância para um widget de alternância.
CHECK_BOXEnumControle no estilo de caixa de seleção para um widget de troca.

TextButton

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)TextButtonDefine o texto alternativo do botão para acessibilidade.
setAuthorizationAction(action)TextButtonDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setBackgroundColor(backgroundColor)TextButtonDefine a cor do plano de fundo para o botão TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonDefine uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
setDisabled(disabled)TextButtonDefine se o botão está desativado.
setOnClickAction(action)TextButtonDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)TextButtonDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)TextButtonDefine um URL que será aberto quando o objeto for clicado.
setText(text)TextButtonDefine o texto que aparece no botão.
setTextButtonStyle(textButtonStyle)TextButtonDefine o estilo do botão.

TextButtonStyle

Propriedades

PropriedadeTipoDescrição
OUTLINEDEnumBotão de texto normal com plano de fundo claro.
FILLEDEnumBotão de texto com plano de fundo colorido.

TextInput

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)TextInputDefine a chave que identifica essa entrada de texto no objeto de evento gerado quando há uma interação com a interface.
setHint(hint)TextInputDefine uma dica para a entrada de texto.
setMultiline(multiline)TextInputDefine se o texto de entrada será mostrado em uma ou várias linhas.
setOnChangeAction(action)TextInputDefine uma ação a ser realizada sempre que a entrada de texto mudar.
setSuggestions(suggestions)TextInputDefine as sugestões para preenchimento automático no campo de texto.
setSuggestionsAction(suggestionsAction)TextInputDefine a ação de callback para buscar sugestões com base na entrada do usuário para preenchimento automático.
setTitle(title)TextInputDefine o título que será mostrado acima do campo de entrada.
setValue(value)TextInputDefine o valor pré-preenchido a ser definido no campo de entrada.

TextParagraph

Métodos

MétodoTipo de retornoBreve descrição
setText(text)TextParagraphDefine o texto do parágrafo.

TimePicker

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)TimePickerDefine o nome do campo que identifica esse seletor no objeto de evento gerado quando há uma interação com a interface.
setHours(hours)TimePickerDefine o valor das horas preenchidas automaticamente a ser definida no campo de entrada.
setMinutes(minutes)TimePickerDefine o valor de minutos preenchidos automaticamente a ser definido no campo de entrada.
setOnChangeAction(action)TimePickerDefine um Action que o script executa sempre que a entrada do seletor muda.
setTitle(title)TimePickerDefine o título exibido acima do campo de entrada.

UniversalActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.

UniversalActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()UniversalActionResponseCria e valida a resposta de ação universal atual.
displayAddOnCards(cardObjects)UniversalActionResponseBuilderMostra o complemento com os cards especificados.
setOpenLink(openLink)UniversalActionResponseBuilderDefine o URL como aberto quando a ação universal for selecionada.

UpdateDraftActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringExibe a representação JSON desse objeto.

UpdateDraftActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()UpdateDraftActionResponseCria e valida a resposta da ação de rascunho de atualização atual.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza os destinatários Cco de um rascunho.
setUpdateDraftBodyAction(updateDraftBodyAction)UpdateDraftActionResponseBuilderDefina uma ação que atualize o corpo do e-mail de um rascunho.
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza os destinatários Cc de um rascunho.
setUpdateDraftSubjectAction(updateDraftSubjectAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza a linha de assunto de um rascunho.
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza os destinatários de um rascunho.

UpdateDraftBccRecipientsAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateBccRecipients(bccRecipientEmails)UpdateDraftBccRecipientsActionAtualiza os destinatários Cco de um rascunho de e-mail.

UpdateDraftBodyAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateContent(content, contentType)UpdateDraftBodyActionAdiciona o conteúdo especificado ao corpo do rascunho.
setUpdateType(updateType)UpdateDraftBodyActionDefine o UpdateDraftBodyType dessa ação de atualização no corpo do rascunho.

UpdateDraftBodyType

Propriedades

PropriedadeTipoDescrição
IN_PLACE_INSERTEnumPadrão.
INSERT_AT_STARTEnumAs ações de atualização inserem conteúdo no início do corpo da mensagem.
INSERT_AT_ENDEnumAs ações de atualização inserem conteúdo no final do corpo da mensagem.

UpdateDraftCcRecipientsAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateCcRecipients(ccRecipientEmails)UpdateDraftCcRecipientsActionAtualiza os destinatários Cc de um rascunho de e-mail.

UpdateDraftSubjectAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateSubject(subject)UpdateDraftSubjectActionAtualiza a linha de assunto de um rascunho de e-mail.

UpdateDraftToRecipientsAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateToRecipients(toRecipientEmails)UpdateDraftToRecipientsActionAtualiza os destinatários de um rascunho de e-mail em "Para".

UpdatedWidget

Métodos

MétodoTipo de retornoBreve descrição
addItem(text, value, selected, startIconUri, bottomText)UpdatedWidgetAdiciona um novo item que pode ser selecionado.

Widget