Esta página foi traduzida pela API Cloud Translation.

AddOns Response Service

Esse serviço permite que os scripts configurem e criem complementos do Google Workspace que estendem o Google Workspace Studio.

Classes

Nome	Breve descrição
`Action`	Uma ação que os complementos do Google Workspace que estendem o Google Workspace Studio podem usar para renderizar um novo card.
`AddOnsResponseService`	O `AddOnsResponseService` permite criar respostas para complementos do Google Workspace que estendem o Google Workspace Studio.
`BasicDataType`	Uma enumeração que representa os tipos de dados genéricos básicos.
`Color`	Um objeto Color que representa uma cor no espaço de cores RGBA.
`DataType`	Um DataType é usado para definir o tipo de uma variável.
`DynamicResourceDefinition`	Uma DynamicResourceDefinition é um bloco de construção para um `ResourceFieldsDefinitionRetrievedAction`. Ela pode conter um ou mais números de `ResourceField` para definir dinamicamente o número de variáveis de saída fornecidas por uma etapa no Google Workspace Studio.
`ErrorActionability`	Um enum que representa a capacidade de ação do erro.
`ErrorRetryability`	Uma enumeração que representa a capacidade de repetição da invocação de ação quando há um erro.
`FontWeight`	Uma enumeração que representa a espessura da fonte do texto estilizado.
`HostAppAction`	Uma HostAppAction é um tipo de ação processada por apps host individuais.
`Hyperlink`	Um elemento de hiperlink usado em `TextFormatElement`.
`InsertSection`	Um builder para objetos InsertSection.
`InsertWidget`	Um builder para objetos InsertWidget.
`Link`	O objeto de link de um recurso de terceiros que é convertido em um ícone inteligente no aplicativo host.
`ListContainer`	Contêiner para itens de lista, em que cada item pode conter vários `TextFormatElement`.
`ListItem`	Um item de lista, em que cada item pode conter vários `TextFormatElement`.
`ListType`	Uma enumeração que representa o tipo da lista.
`ModifyCard`	Um criador de objetos `ModifyCard` que muda e atualiza a interface de um card existente transmitindo o objeto `ModifyCard` para um `Action`.
`Navigation`	Um objeto auxiliar que controla a navegação por cards.
`RemoveSection`	Um builder para objetos `RemoveSection`.
`RemoveWidget`	Um builder para objetos RemoveWidget.
`RenderAction`	Renderiza ou atualiza um card realizando um `Action` em resposta a uma interação do usuário.
`RenderActionBuilder`	Um builder para objetos `RenderAction`.
`ResourceData`	Representa dados de recursos específicos de um aplicativo. Os dados de recursos contêm uma coleção de pares de chave-valor de nomes de variáveis e `VariableData`.
`ResourceField`	Um ResourceField é um bloco de construção básico de um `DynamicResourceDefinition`. Cada campo de recurso corresponde a uma variável de saída da etapa atual.
`ResourceFieldsDefinitionRetrievedAction`	Um `ResourceFieldsDefinitionRetrievedAction` é um tipo de `ResourceFieldsDefinitionRetrievedAction` usado para recuperar a definição de uma lista de campos de recursos usando a função `dynamicResourceDefinitionProvider` especificada no manifesto.
`ResourceRetrievedAction`	Uma ResourceRetrievedAction é usada para recuperar o conteúdo de recursos personalizados quando necessário, em que o campo de recurso personalizado é definido no ResourceData.
`ResourceType`	Um tipo de recurso específico do aplicativo. O identificador exclusivo do tipo de recurso precisa ter uma WorkflowResourceDefinition correspondente.
`ReturnElementErrorAction`	Um ReturnElementErrorAction indica que ocorreu um erro durante a invocação do elemento.
`ReturnOutputVariablesAction`	Contém variáveis de saída geradas pela ação executada no Google Workspace Studio.
`SaveWorkflowAction`	Essa ação indica que o app host (Google Workspace Studio) precisa salvar o agente.
`StyledText`	Elemento de texto com estilos como negrito, itálico e cor.
`TextFormatChip`	Um ícone clicável no formato de texto.
`TextFormatElement`	Um elemento de formato de texto, que pode ser `TextFormatChip`, `StyledText`, `Hyperlink` ou `ListContainer`.
`TextFormatIcon`	Um ícone exibido em um `TextFormatChip`.
`TextStyle`	Uma enumeração que representa o estilo do texto estilizado.
`TimeStamp`	Representa um objeto de carimbo de data/hora que pode ser adicionado a um `VariableData`.
`UpdateWidget`	Um builder para objetos `UpdateWidget`.
`ValidationErrorSeverity`	Uma enumeração que representa a gravidade do erro de validação.
`ValueMetadata`	Um valueMetadata contém informações sobre os valores possíveis de uma variável.
`VariableData`	Representa um dado variável que pode conter uma coleção de valores em vários tipos.
`WorkflowAction`	Um WorkflowAction é um tipo de `HostAppAction` usado para realizar uma ação específica no Google Workspace Studio.
`WorkflowTextFormat`	Um bloco de texto com opções de formatação avançada, incluindo estilos, hiperlinks e elementos interativos definidos em `TextFormatElement`.
`WorkflowValidationErrorAction`	Essa ação indica que o app host (Google Workspace Studio) precisa mostrar um erro de validação.

`Action`

Métodos

Método	Tipo de retorno	Breve descrição
`addModifyCard(modifyCard)`	`Action`	Adiciona uma operação ModifyCard à ação.
`addNavigation(navigation)`	`Action`	Adiciona uma navegação por cards à ação.

`AddOnsResponseService`

Métodos

Método	Tipo de retorno	Breve descrição
`newAction()`	`Action`	Crie um novo `Action`.
`newNavigation()`	`Navigation`	Crie um novo `Navigation`.
`newRenderActionBuilder()`	`RenderActionBuilder`	Crie um novo `RenderActionBuilder`.

`BasicDataType`

Propriedades

Propriedade	Tipo	Descrição
`BASIC_TYPE_UNSPECIFIED`	`Enum`	Valor padrão.
`STRING`	`Enum`	Uma string de caracteres.
`INTEGER`	`Enum`	Um valor inteiro.
`FLOAT`	`Enum`	Um número de ponto flutuante.
`TIMESTAMP`	`Enum`	Um carimbo de data/hora no formato ISO 8601.
`BOOLEAN`	`Enum`	Um valor booleano.
`EMAIL_ADDRESS`	`Enum`	Uma string no formato de um endereço de e-mail.
`GOOGLE_USER`	`Enum`	Um usuário dos Serviços do Google, no formato "users/encoded_GAIA_ID"
`FILE`	`Enum`	Um tipo de arquivo.
`FORMATTED_TEXT`	`Enum`	Um texto com formatação avançada.

`Color`

Métodos

Método	Tipo de retorno	Breve descrição
`setAlpha(alpha)`	`Color`	Define o componente alfa da cor.
`setBlue(blue)`	`Color`	Define o componente azul da cor.
`setGreen(green)`	`Color`	Define o componente verde da cor.
`setRed(red)`	`Color`	Define o componente vermelho da cor.

`DataType`

Métodos

Método	Tipo de retorno	Breve descrição
`setBasicDataType(basicDataType)`	`DataType`	Define o tipo de dados como um dos `BasicDataType`s compatíveis.
`setResourceType(resourceType)`	`DataType`	Define o tipo de dados como um `ResourceType` definido pelo usuário.
`setValueMetadata(valueMetadata)`	`DataType`	Define o `ValueMetadata`, que contém informações relacionadas ao tipo da variável.

`DynamicResourceDefinition`

Métodos

Método	Tipo de retorno	Breve descrição
`addResourceField(resourceField)`	`DynamicResourceDefinition`	Adiciona um campo de recurso à definição de recurso dinâmico.
`setResourceId(resourceId)`	`DynamicResourceDefinition`	Define o ID da definição de recurso dinâmico, que corresponde ao `workflowResourceDefinitionId` no manifesto.

`ErrorActionability`

Propriedades

Propriedade	Tipo	Descrição
`ERROR_ACTIONABILITY_UNSPECIFIED`	`Enum`	Não especificado.
`NOT_ACTIONABLE`	`Enum`	O erro não pode ser corrigido pelo usuário no card de configuração.
`ACTIONABLE`	`Enum`	O erro pode ser corrigido pelo usuário no card de configuração.

`ErrorRetryability`

Propriedades

Propriedade	Tipo	Descrição
`RETRYABILITY_UNSPECIFIED`	`Enum`	Não especificado.
`NOT_RETRYABLE`	`Enum`	O erro não pode ser repetido, e o fluxo termina após a primeira tentativa.
`RETRYABLE`	`Enum`	O erro é passível de novas tentativas, e o fluxo de trabalho vai tentar executar a etapa até cinco vezes.

`FontWeight`

Propriedades

Propriedade	Tipo	Descrição
`FONT_WEIGHT_UNSPECIFIED`	`Enum`	Peso padrão com espessura normal.
`LIGHT`	`Enum`	Mais leve e com espessura reduzida.
`MEDIUM`	`Enum`	Peso intermediário entre leve e negrito.
`BOLD`	`Enum`	Mais pesado e com maior espessura.

`HostAppAction`

Métodos

Método	Tipo de retorno	Breve descrição
`setWorkflowAction(workflowAction)`	`HostAppAction`	Define a ação do app host como ação do fluxo de trabalho.

`Hyperlink`

Métodos

Método	Tipo de retorno	Breve descrição
`setLink(link)`	`Hyperlink`	Define o URL de destino do hiperlink.
`setText(text)`	`Hyperlink`	Define o texto do hiperlink.

`InsertSection`

Métodos

Método	Tipo de retorno	Breve descrição
`insertAtTop(onCardTop)`	`InsertSection`	Define a flag onCardTop, que indica se a nova seção deve ser inserida na parte de cima do card.
`insertBelowSection(sectionId)`	`InsertSection`	Define o ID da seção, e a nova seção é inserida abaixo dela.
`setSection(section)`	`InsertSection`	Define a seção do card a ser inserida.

`InsertWidget`

Métodos

Método	Tipo de retorno	Breve descrição
`insertAboveWidget(widgetId)`	`InsertWidget`	Define o ID do widget, e o novo widget é inserido acima do widget com o ID especificado.
`insertBelowWidget(widgetId)`	`InsertWidget`	Define o ID do widget, e o novo widget é inserido abaixo do widget com o ID especificado.
`setWidget(widget)`	`InsertWidget`	Define o `Widget` a ser inserido.

`Link`

Métodos

Método	Tipo de retorno	Breve descrição
`setTitle(title)`	`Link`	Define o título do link.
`setUrl(url)`	`Link`	Define o URL do link.

`ListContainer`

Métodos

Método	Tipo de retorno	Breve descrição
`addListItem(listItem)`	`ListContainer`	Adiciona um item ao contêiner de lista.
`setListNestLevel(listLevel)`	`ListContainer`	Define o nível da lista, começando em 0 para o nível superior e aumentando em 1 para cada lista aninhada.
`setListType(listType)`	`ListContainer`	Define o tipo da lista como ordenada ou não ordenada.

`ListItem`

Métodos

Método	Tipo de retorno	Breve descrição
`addTextFormatElement(textFormatElement)`	`ListItem`	Adiciona um `TextFormatElement` ao item da lista.

`ListType`

Propriedades

Propriedade	Tipo	Descrição
`LIST_TYPE_UNSPECIFIED`	`Enum`	Valor padrão.
`ORDERED`	`Enum`	Lista ordenada.
`UNORDERED`	`Enum`	Lista não ordenada.

`ModifyCard`

Métodos

Método	Tipo de retorno	Breve descrição
`setInsertSection(insertSection)`	`ModifyCard`	Define o `InsertSection` para este objeto de cartão de modificação.
`setInsertWidget(insertWidget)`	`ModifyCard`	Define o `InsertWidget` para este objeto de cartão de modificação.
`setRemoveSection(removeSection)`	`ModifyCard`	Define o `RemoveSection` para este objeto de cartão de modificação.
`setRemoveWidget(removeWidget)`	`ModifyCard`	Define o `RemoveWidget` para este objeto de cartão de modificação.
`setReplaceSection(replacementSection)`	`ModifyCard`	Define a `CardSection` de substituição para este objeto de cartão de modificação. A seção de substituição precisa ter o mesmo ID de uma seção de cartão existente.
`setReplaceWidget(replacementWidget)`	`ModifyCard`	Define o widget de substituição para este objeto de cartão de modificação. O widget de substituição precisa ter o mesmo ID de um widget atual.
`setUpdateWidget(updateWidget)`	`ModifyCard`	Define o `UpdateWidget` para este objeto de cartão de modificação.

`Navigation`

Métodos

Método	Tipo de retorno	Breve descrição
`printJson()`	`String`	Imprime a representação JSON deste objeto.
`pushCard(card)`	`Navigation`	Envia o card especificado para a pilha.

`RemoveSection`

Métodos

Método	Tipo de retorno	Breve descrição
`setSectionId(sectionId)`	`RemoveSection`	Define o ID da seção a ser removida.

`RemoveWidget`

Métodos

Método	Tipo de retorno	Breve descrição
`setWidgetId(widgetId)`	`RemoveWidget`	Define o ID do widget a ser removido.

`RenderAction`

Métodos

Método	Tipo de retorno	Breve descrição
`printJson()`	`String`	Imprime a representação JSON deste objeto.

`RenderActionBuilder`

Métodos

Método	Tipo de retorno	Breve descrição
`build()`	`RenderAction`	Cria e valida a ação de renderização atual.
`setAction(action)`	`RenderActionBuilder`	Define a ação que os complementos podem usar para atualizar a interface do usuário para a ação de renderização.
`setHostAppAction(hostAppAction)`	`RenderActionBuilder`	Define o `HostAppAction` processado por apps host individuais para a ação de renderização.

`ResourceData`

Métodos

Método	Tipo de retorno	Breve descrição
`addVariableData(key, value)`	`ResourceData`	Adiciona um `VariableData` com chave pelo nome da variável. Um valor é substituído se a chave já existir.
`setVariableDataMap(fields)`	`ResourceData`	Define o mapa dos dados da variável com chave pelos nomes das variáveis.

`ResourceField`

Métodos

Método	Tipo de retorno	Breve descrição
`setDataType(dataType)`	`ResourceField`	Define o tipo de dados do campo e permite que outras etapas filtrem as variáveis por tipo na seleção.
`setDisplayText(displayText)`	`ResourceField`	Define a descrição do campo que é mostrada ao usuário final durante a seleção de variáveis em etapas subsequentes.
`setSelector(selector)`	`ResourceField`	Define uma chave para que a função do provedor forneça o valor durante a execução da etapa.

`ResourceFieldsDefinitionRetrievedAction`

Métodos

Método	Tipo de retorno	Breve descrição
`addDynamicResourceDefinition(dynamicResourceDefinition)`	`ResourceFieldsDefinitionRetrievedAction`	Adiciona um `DynamicResourceDefinition` à ação de recuperação da definição dos campos de recursos.

`ResourceRetrievedAction`

Métodos

Método	Tipo de retorno	Breve descrição
`setResourceData(resourceData)`	`ResourceRetrievedAction`	Define o `ResourceData` como a ação de recuperação de recursos para fornecer valores aos campos de recursos dinâmicos ou personalizados.

`ResourceType`

Métodos

Método	Tipo de retorno	Breve descrição
`setWorkflowResourceDefinitionId(resourceType)`	`ResourceType`	Define o ID da definição do recurso de fluxo de trabalho.

`ReturnElementErrorAction`

Métodos

Método	Tipo de retorno	Breve descrição
`setErrorActionability(errorActionability)`	`ReturnElementErrorAction`	Define a capacidade de ação do erro. Um erro é acionável se puder ser resolvido reconfigurando a etapa.
`setErrorLog(log)`	`ReturnElementErrorAction`	Define o registro de erros a ser mostrado ao usuário final no feed de atividades do fluxo de trabalho.
`setErrorRetryability(errorRetryability)`	`ReturnElementErrorAction`	Define a capacidade de repetição de erros. O fluxo termina após a primeira tentativa se um erro não for repetível.

`ReturnOutputVariablesAction`

Métodos

Método	Tipo de retorno	Breve descrição
`addVariableData(key, value)`	`ReturnOutputVariablesAction`	Adiciona dados de variável com chave pelo nome da variável. Um valor é substituído se a chave já existir.
`setLog(log)`	`ReturnOutputVariablesAction`	Define o registro da ação de fluxo de trabalho executada para o usuário final no feed de atividades do fluxo de trabalho.
`setVariableDataMap(variables)`	`ReturnOutputVariablesAction`	Define o mapa dos dados da variável indexados pelo nome da variável. Um valor é substituído se a chave já existir.

`SaveWorkflowAction`

`StyledText`

Métodos

Método	Tipo de retorno	Breve descrição
`addStyle(style)`	`StyledText`	Define o estilo do texto estilizado e pode aplicar vários estilos a um único texto estilizado.
`setColor(color)`	`StyledText`	Define a cor do texto estilizado.
`setFontWeight(fontWeight)`	`StyledText`	Define a espessura da fonte do texto estilizado.
`setText(text)`	`StyledText`	Define o conteúdo principal do texto estilizado.

`TextFormatChip`

Métodos

Método	Tipo de retorno	Breve descrição
`setLabel(label)`	`TextFormatChip`	Define o texto exibido no ícone.
`setTextFormatIcon(icon)`	`TextFormatChip`	Define o ícone mostrado no ícone.
`setUrl(url)`	`TextFormatChip`	Define o URL para navegar quando o ícone é clicado.

`TextFormatElement`

Métodos

Método	Tipo de retorno	Breve descrição
`setHyperlink(hyperlink)`	`TextFormatElement`	Define o elemento de formato de texto como um `Hyperlink`.
`setListContainer(listContainer)`	`TextFormatElement`	Define o elemento de formato de texto como um `ListContainer`.
`setStyledText(styledText)`	`TextFormatElement`	Define o elemento de formato de texto como um `StyledText`.
`setText(text)`	`TextFormatElement`	Define o elemento de formato de texto como uma string de texto.
`setTextFormatChip(chip)`	`TextFormatElement`	Define o elemento de formato de texto como um `TextFormatChip`.

`TextFormatIcon`

Métodos

Método	Tipo de retorno	Breve descrição
`setIconUrl(iconUrl)`	`TextFormatIcon`	Define o URL do ícone.
`setMaterialIconName(materialIconName)`	`TextFormatIcon`	Define o nome do ícone do Material Design definido em Ícones do Material Design do Google.

`TextStyle`

Propriedades

Propriedade	Tipo	Descrição
`STYLE_UNSPECIFIED`	`Enum`	Nenhum estilo aplicado.
`ITALIC`	`Enum`	Estilo itálico.
`UNDERLINE`	`Enum`	Estilo de sublinhado.
`STRIKETHROUGH`	`Enum`	Estilo tachado.
`LINE_BREAK`	`Enum`	Quebra de linha.
`UPPERCASE`	`Enum`	Estilo em maiúsculas.
`CODE`	`Enum`	Estilo de código.
`CODE_BLOCK`	`Enum`	Estilo do bloco de código.

`TimeStamp`

Métodos

Método	Tipo de retorno	Breve descrição
`setNanos(nanos)`	`TimeStamp`	Define os nanos do carimbo de data/hora, representando o número de nanossegundos no segundo atual.
`setSeconds(seconds)`	`TimeStamp`	Define os segundos do carimbo de data/hora, representando o número de segundos desde a época Unix(1º de janeiro de 1970, 00:00:00 UTC).

`UpdateWidget`

Métodos

Método	Tipo de retorno	Breve descrição
`addSuggestion(text, value, selected, startIconUri, bottomText)`	`UpdateWidget`	Adiciona um novo item que pode ser selecionado para menus de seleção múltipla.

`ValidationErrorSeverity`

Propriedades

Propriedade	Tipo	Descrição
`SEVERITY_UNSPECIFIED`	`Enum`	Não especificado.
`CRITICAL`	`Enum`	Crítico: o erro é crítico e precisa ser corrigido antes da publicação.
`WARNING`	`Enum`	Aviso: o erro não é crítico e não está bloqueando a publicação.

`ValueMetadata`

Métodos

Método	Tipo de retorno	Breve descrição
`addCastableType(dataType)`	`ValueMetadata`	Adiciona tipos permitidos opcionais que podem ser transmitidos dinamicamente para um dado de variável a esses metadados de valor.
`addEnumValue(enumValue)`	`ValueMetadata`	Adiciona um valor de string opcional aos valores de enumeração permitidos de uma variável. Esse campo só pode ser definido se o `DataType` estiver definido como o tipo String.
`setDefaultValue(defaultValue)`	`ValueMetadata`	Define o valor padrão opcional da variável. Por exemplo, se o tipo de variável for booleano, o defaultValue poderá ser definido como "`true`" ou "`false`".

`VariableData`

Métodos

Método	Tipo de retorno	Breve descrição
`addBooleanValue(value)`	`VariableData`	Adiciona um valor booleano aos dados da variável.
`addEmailAddress(emailAddress)`	`VariableData`	Adiciona um endereço de e-mail aos dados da variável.
`addFloatValue(value)`	`VariableData`	Adiciona um valor de ponto flutuante aos dados da variável.
`addGoogleUser(googleUser)`	`VariableData`	Adiciona um usuário do Google aos dados da variável.
`addIntegerValue(value)`	`VariableData`	Adiciona um valor inteiro aos dados da variável.
`addResourceData(resourceData)`	`VariableData`	Adiciona um valor `ResourceData` aos dados da variável.
`addResourceReference(resourceReference)`	`VariableData`	Adiciona um ID de referência de recurso aos dados da variável.
`addStringValue(value)`	`VariableData`	Adiciona um valor de string aos dados da variável.
`addTimestampValue(value)`	`VariableData`	Adiciona um valor `TimeStamp` aos dados da variável.
`addWorkflowTextFormat(workflowTextFormat)`	`VariableData`	Adiciona um valor `WorkflowTextFormat` aos dados da variável.

`WorkflowAction`

`WorkflowTextFormat`

Métodos

Método	Tipo de retorno	Breve descrição
`addTextFormatElement(textFormatElement)`	`WorkflowTextFormat`	Adiciona um `TextFormatElement` ao formato de texto do fluxo de trabalho.

`WorkflowValidationErrorAction`

Métodos

Método	Tipo de retorno	Breve descrição
`setSeverity(severity)`	`WorkflowValidationErrorAction`	Define a gravidade do erro de validação.

AddOns Response Service Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Classes

Métodos

Métodos

Propriedades

Métodos

Métodos

Métodos

Propriedades

Propriedades

Propriedades

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Propriedades

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Métodos

Propriedades

Métodos

Métodos

Propriedades

Métodos

Métodos

Métodos

Métodos

AddOns Response Service