Package google.apps.script.type

Índice

AddOnWidgetSet

O subconjunto de widgets usado por um complemento.

Campos
usedWidgets[]

WidgetType

A lista de widgets usados em um complemento.

WidgetType

O tipo de widget. WIDGET_TYPE_UNSPECIFIED é o conjunto de widgets básicos.

Tipos enumerados
WIDGET_TYPE_UNSPECIFIED O conjunto de widgets padrão.
DATE_PICKER O seletor de datas.
STYLED_BUTTONS Os botões estilizados incluem botões preenchidos e desativados.
PERSISTENT_FORMS Com os formulários persistentes, é possível manter os valores do formulário durante as ações.
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 de complemento do Gmail que se aplica à interface de criação do complemento.

CommonAddOnManifest

Configuração de complemento compartilhada em todos os aplicativos host de complementos.

Campos
name

string

Obrigatório. O nome de exibição do complemento.
logoUrl

string

Obrigatório. O URL da imagem do logotipo mostrada na barra de ferramentas do complemento.
layoutProperties

LayoutProperties

Propriedades de layout comuns para os cards de complementos.
addOnWidgetSet

AddOnWidgetSet

Os widgets usados no complemento. Se esse campo não for especificado, o conjunto padrão será usado.
useLocaleFromApp

bool

Determina se as informações de localidade devem ser transmitidas do app host.
homepageTrigger

HomepageExtensionPoint

Define um endpoint que será executado em qualquer contexto e host. Os cards gerados por essa função sempre estarão disponíveis para o usuário, mas podem ser substituídos por conteúdo contextual quando o complemento declarar acionadores mais segmentados.
universalActions[]

UniversalActionExtensionPoint

Define uma lista de pontos de extensão no menu de ações universais, 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

ListValue

Uma ação OpenLink só pode usar um URL com um esquema HTTPS, MAILTO ou TEL. Para links HTTPS, o URL também precisa corresponder a um dos prefixos especificados na lista de permissões. Se o prefixo omitir o esquema, HTTPS será usado. Os links HTTP são reescritos automaticamente como links HTTPS.

CreateActionExtensionPoint

A configuração de um gatilho que é acionado quando um usuário invoca o fluxo de trabalho de criação de recursos em um aplicativo do Google Workspace. Para mais informações, consulte Criar recursos de terceiros com o menu "@".

Campos
id

string

Obrigatório. O ID exclusivo para diferenciar este ponto de extensão. O ID pode ter até 64 caracteres e precisa estar no formato [a-zA-Z0-9-]+.
labelText

string

Obrigatório. O texto que aparece ao lado de um ícone para o ponto de entrada de criação de recursos, como Create support case. Esse texto é estático e aparece antes que os usuários executem o complemento.
localizedLabelText

map<string, string>

Opcional. Um mapa de labelText para localizar em outros idiomas. Formate o idioma em ISO 639 e o país/região em ISO 3166, separados por um hífen -. Por exemplo, en-US.

Se a localidade de um usuário estiver presente nas chaves do mapa, ele verá a versão localizada do labelText.
runFunction

string

Obrigatório. Endpoint a ser executado quando um fluxo de trabalho de criação de recursos é acionado para criar um link.
logoUrl

string

Opcional. O ícone que aparece no ponto de entrada de criação de recursos. Se omitido, o menu vai usar o ícone da barra de ferramentas do complemento, logoUrl.

GranularOauthPermissionSupport

Indica se o complemento ativou as permissões granulares do OAuth.

Tipos enumerados
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Valor padrão, não deve ser usado.
OPT_IN O complemento está ativado para permissão OAuth granular.
OPT_OUT O complemento está desativado do consentimento OAuth granular.

HomepageExtensionPoint

Formato comum para declarar a visualização da página inicial de um complemento.

Campos
runFunction

string

Obrigatório. O endpoint a ser executado quando este ponto de extensão for ativado.
enabled

BoolValue

Opcional. Se definido como false, desativa a visualização da página inicial nesse contexto.

O padrão é true se não estiver definido.

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

Cabeçalho de autorização enviado em solicitações de complemento HTTP.

Tipos enumerados
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Valor padrão, equivalente a SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Envie um token de ID para a conta de serviço do sistema (padrão) do complemento do Google Workspace específico do projeto.
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 aos endpoints do complemento HTTP.

Campos
authorizationHeader

HttpAuthorizationHeader

Configuração para o token enviado no cabeçalho de autorização HTTP.
granularOauthPermissionSupport

GranularOauthPermissionSupport

Indica se o complemento ativou as permissões granulares do OAuth.

LayoutProperties

Propriedades de layout de card compartilhadas em todos os aplicativos host de complementos.

Campos
primaryColor

string

A cor principal do complemento. Ela define a cor da barra de ferramentas. Se nenhuma cor principal for definida, o valor padrão fornecido pelo framework será usado.
secondaryColor

string

A cor secundária do complemento. Ele define a cor dos botões. Se a cor primária estiver definida, mas não a secundária, a cor secundária será igual à primária. Se nenhuma cor primária ou secundária for definida, o valor padrão fornecido pelo framework será usado.
useNewMaterialDesign
(deprecated)

bool

Ativa o Material Design para cards.

LinkPreviewExtensionPoint

A configuração de um gatilho que é acionado quando um usuário digita ou cola um link de um serviço de terceiros ou que não é do Google em um arquivo dos Documentos, Planilhas ou Apresentações Google.

Campos
labelText

string

Obrigatório. O texto de um exemplo de ícone inteligente que pede aos usuários para visualizar o link, como Example: Support case. Esse texto é estático e aparece antes que os usuários executem o complemento.
localizedLabelText

map<string, string>

Opcional. Um mapa de labelText para localizar em outros idiomas. Formate o idioma em ISO 639 e o país/região em ISO 3166, separados por um hífen -. Por exemplo, en-US.

Se a localidade de um usuário estiver presente nas chaves do mapa, ele verá a versão localizada do labelText.
patterns[]

UriPattern

Obrigatório. Uma matriz de padrões de URL que acionam o complemento para visualizar links.
runFunction

string

Obrigatório. Endpoint a ser executado quando uma prévia de link é acionada.
logoUrl

string

Opcional. O ícone que aparece no smart chip e no card de prévia. Se omitido, o complemento usará o ícone da barra de ferramentas, logoUrl.

Formato comum para declarar um item de menu ou botão que aparece em um app host.

Campos
runFunction

string

Obrigatório. O endpoint a ser executado quando este ponto de extensão for ativado.
label

string

Obrigatório. Texto visível para o usuário que descreve a ação realizada ao ativar esse ponto de extensão. Por exemplo, "Insira a fatura".
logoUrl

string

O URL da imagem do logotipo mostrada na barra de ferramentas do complemento.

Se não for definido, o padrão será o URL do logotipo principal do complemento.

UniversalActionExtensionPoint

Formato para declarar um ponto de extensão de item de menu de ação universal.

Campos
label

string

Obrigatório. Texto visível ao usuário que descreve a ação realizada ao ativar esse 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 em um item de menu de ação universal. Pode ser um link para abrir ou um endpoint para executar. action_type pode ser apenas de um dos tipos a seguir:
runFunction

string

Endpoint a ser executado pelo UniversalAction.

UriPattern

A configuração de cada padrão de URL que aciona uma prévia de link.

Campos
hostPattern

string

Obrigatório para cada padrão de URL a ser visualizado. É o domínio do padrão do URL. O complemento mostra uma prévia dos links que contêm esse domínio no URL. Para visualizar links de um subdomínio específico, como subdomain.example.com, inclua o subdomínio. Para visualizar links de todo o domínio, especifique um caractere curinga com um asterisco (*) como subdomínio.

Por exemplo, *.example.com corresponde a subdomain.example.com e another.subdomain.example.com.
pathPrefix

string

Opcional. O caminho que anexa o domínio do hostPattern.

Por exemplo, se o padrão de host do URL for support.example.com, para corresponder a URLs de casos hospedados em support.example.com/cases/, insira cases.

Para corresponder a todos os URLs no domínio do padrão de host, deixe pathPrefix vazio.