Índice
AddOnWidgetSet
(mensagem)AddOnWidgetSet.WidgetType
(enum)CommonAddOnManifest
(mensagem)CreateActionExtensionPoint
(mensagem)HomepageExtensionPoint
(mensagem)HttpAuthorizationHeader
(enum)HttpOptions
(mensagem)LayoutProperties
(mensagem)LinkPreviewExtensionPoint
(mensagem)MenuItemExtensionPoint
(mensagem)UniversalActionExtensionPoint
(mensagem)UriPattern
(mensagem)
AddOnWidgetSet
O subconjunto de widgets usado por um complemento.
Campos | |
---|---|
usedWidgets[] |
A lista dos widgets usados em um complemento. |
WidgetType
O tipo de widget. WIDGET_TYPE_UNSPECIFIED
é o conjunto básico de widgets.
Enums | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
O conjunto de widgets padrão. |
DATE_PICKER |
O seletor de data. |
STYLED_BUTTONS |
Os botões estilizados incluem botões preenchidos e desativados. |
PERSISTENT_FORMS |
Formulários persistentes permitem valores de formulário persistentes durante ações. |
FIXED_FOOTER |
Rodapé corrigido em um cartão. |
UPDATE_SUBJECT_AND_RECIPIENTS |
Atualize o assunto e os destinatários de um rascunho. |
GRID_WIDGET |
O widget de grade. |
ADDON_COMPOSE_UI_ACTION |
Uma ação do complemento do Gmail que se aplica à interface de escrita do complemento. |
CommonAddOnManifest
Configuração de complementos compartilhada entre todos os aplicativos host de complementos.
Campos | |
---|---|
name |
Obrigatório. O nome de exibição do complemento. |
logoUrl |
Obrigatório. O URL da imagem do logotipo mostrada na barra de ferramentas de complementos. |
layoutProperties |
Propriedades de layout comuns para os cards de complementos. |
addOnWidgetSet |
Os widgets usados no complemento. Se esse campo não for especificado, o conjunto padrão será usado. |
useLocaleFromApp |
Define se informações de localidade serão transmitidas do app host. |
homepageTrigger |
Define um endpoint que será executado em qualquer contexto e em qualquer host. Todos os cards gerados por essa função vão estar sempre disponíveis para o usuário, mas eles poderão ser eclipsados por conteúdo contextual quando o complemento declarar acionadores mais direcionados. |
universalActions[] |
Define uma lista de pontos de extensão no menu de ações universal que serve como um menu de configurações para o complemento. O ponto de extensão pode ser um URL de link para abrir ou um endpoint para executar como envio de formulário. |
openLinkUrlPrefixes |
Uma ação OpenLink só pode usar um URL com um esquema |
CreateActionExtensionPoint
A configuração de um acionador que é disparado quando um usuário invoca o fluxo de trabalho de criação de recursos em um aplicativo do Google Workspace. Saiba mais em Criar recursos de terceiros no menu @.
Campos | |
---|---|
id |
Obrigatório. O ID exclusivo para diferenciar esse ponto de extensão. O ID pode ter até 64 caracteres e precisa estar no formato |
labelText |
Obrigatório. O texto mostrado ao lado de um ícone do ponto de entrada de criação de recursos, como |
localizedLabelText |
Opcional. Um mapa de Se a localidade de um usuário estiver presente nas chaves do mapa, ele vai encontrar a versão localizada do |
runFunction |
Obrigatório. Endpoint a ser executado quando um fluxo de trabalho de criação de recurso é acionado para criar um link. |
logoUrl |
Opcional. O ícone do ponto de entrada de criação de recursos. Se omitido, o menu vai usar o ícone da barra de ferramentas do complemento, |
HomepageExtensionPoint
Formato comum para declarar a visualização da página inicial de um complemento.
Campos | |
---|---|
runFunction |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão é ativado. |
enabled |
Opcional. Se definido como Se não for definido, o padrão será Se a visualização da página inicial personalizada de um complemento estiver desativada, um card de visão geral genérico será fornecido aos usuários. |
HttpAuthorizationHeader
O cabeçalho de autorização foi enviado em solicitações HTTP
de complemento.
Enums | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
Valor padrão, equivalente a SYSTEM_ID_TOKEN . |
SYSTEM_ID_TOKEN |
Enviar um token de ID para a conta de serviço do sistema do complemento do Google Workspace específico do projeto (padrão). |
USER_ID_TOKEN |
Envie um token de ID para o usuário final. |
NONE |
Não envie um cabeçalho de autenticação. |
HttpOptions
Opções para enviar solicitações para endpoints HTTP
de complementos.
Campos | |
---|---|
authorizationHeader |
Configuração do token enviado no cabeçalho de autorização |
LayoutProperties
Propriedades de layout do cartão compartilhadas em todos os aplicativos host de complementos.
Campos | |
---|---|
primaryColor |
A cor principal do complemento. Define a cor da barra de ferramentas. Se nenhuma cor primária for definida, o valor padrão fornecido pela estrutura será usado. |
secondaryColor |
A cor secundária do complemento. Define a cor dos botões. Se a cor primária for definida, mas nenhuma cor secundária for definida, a cor secundária será a mesma que a primária. Se nem a cor primária nem a secundária forem definidas, o valor padrão fornecido pelo framework vai ser usado. |
useNewMaterialDesign |
Ativa o Material Design para cartões. |
LinkPreviewExtensionPoint
A configuração de um acionador que é disparado quando um usuário digita ou cola um link de um serviço de terceiros ou de terceiros em um arquivo dos Documentos, Planilhas ou Apresentações Google.
Campos | |
---|---|
labelText |
Obrigatório. O texto de um exemplo de ícone inteligente que solicita que os usuários visualizem o link, como |
localizedLabelText |
Opcional. Um mapa de Se a localidade de um usuário estiver presente nas chaves do mapa, ele vai encontrar a versão localizada do |
patterns[] |
Obrigatório. Uma matriz de padrões de URL que acionam o complemento para links de visualização. |
runFunction |
Obrigatório. Endpoint a ser executado quando uma visualização de link é acionada. |
logoUrl |
Opcional. O ícone que aparece no ícone inteligente e no card de visualização. Se omitido, o complemento usará o próprio ícone da barra de ferramentas, |
MenuItemExtensionPoint
Formato comum para declarar um item ou botão de menu que aparece em um app host.
Campos | |
---|---|
runFunction |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão é ativado. |
label |
Obrigatório. Texto visível para o usuário que descreve a ação realizada ao ativar o ponto de extensão. Por exemplo, "Inserir fatura". |
logoUrl |
O URL da imagem do logotipo mostrada na barra de ferramentas de complementos. Se não for definido, o padrão será o URL principal do logotipo do complemento. |
UniversalActionExtensionPoint
Formato para declarar um ponto de extensão de item do menu de ações universal.
Campos | |
---|---|
label |
Obrigatório. Texto visível para o usuário que descreve a ação realizada ao ativar o ponto de extensão, por exemplo, "Adicionar um novo contato". |
Campo de união action_type . Obrigatório. O tipo de ação compatível com um item do menu de ações universal. Pode ser um link para abrir ou um endpoint para executar. action_type pode ser apenas de um dos tipos a seguir: |
|
openLink |
URL que será aberto pela UniversalAction. |
runFunction |
Endpoint a ser executado pela UniversalAction. |
UriPattern
A configuração de cada padrão de URL que aciona uma visualização de link.
Campos | |
---|---|
hostPattern |
Obrigatório para cada padrão de URL que será visualizado. O domínio do padrão de URL. Os links de visualizações de complementos que contêm esse domínio no URL. Para visualizar links de um subdomínio específico, como Por exemplo, |
pathPrefix |
Opcional. O caminho que anexa o domínio da Por exemplo, se o padrão de host do URL for Para corresponder a todos os URLs no domínio do padrão do host, deixe |