Package google.apps.script.type

Índice

AddOnWidgetSet

O subconjunto de widgets usado por um complemento.

Campos
usedWidgets[]

WidgetType

Lista de 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 datas.
STYLED_BUTTONS Os botões estilizados incluem botões preenchidos e desativados.
PERSISTENT_FORMS Formulários persistentes permitem a persistência de valores de formulário durante 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 de complementos.

CommonAddOnManifest

Configuração do complemento compartilhada entre todos os aplicativos host de complemento.

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 complemento.
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 serão transmitidas do app host.
homepageTrigger

HomepageExtensionPoint

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

UniversalActionExtensionPoint

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 um 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, o valor HTTPS será adotado. Os links HTTP são reescritos automaticamente para links HTTPS.

CreateActionExtensionPoint

A configuração de um acionador que é acionado quando um usuário invoca o fluxo de trabalho de criação de recursos em um app 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 esse 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 vai 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 for 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 usa o ícone da barra de ferramentas do complemento, logoUrl.

GranularOauthPermissionSupport

Indica se o complemento ativou o consentimento OAuth detalhado.

Enums
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Valor padrão. Não deve ser usado.
OPT_IN O complemento está ativado para o consentimento do OAuth detalhado.
OPT_OUT O complemento foi desativado do consentimento granular do OAuth.

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 esse 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 HTTP de complementos.

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 a endpoints HTTP de complementos.

Campos
authorizationHeader

HttpAuthorizationHeader

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

GranularOauthPermissionSupport

Indica se o complemento ativou o consentimento OAuth detalhado.

LayoutProperties

Propriedades de layout do card compartilhadas em todos os aplicativos de complemento host.

Campos
primaryColor

string

A cor principal do complemento. Define a cor da barra de ferramentas. Se nenhuma cor primária 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 a secundária não, a cor secundária será a mesma que a primária. Se nenhuma cor primária ou secundária for definida, o valor padrão fornecido pelo framework será usado.
useNewMaterialDesign

bool

Ativa o design do Material Design para cards.

LinkPreviewExtensionPoint

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

Campos
labelText

string

Obrigatório. O texto de um exemplo de ícone inteligente que solicita que os usuários visualizem 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 vai 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 for acionada.
logoUrl

string

Opcional. O ícone que aparece no ícone inteligente e no card de visualização. Se omitido, o complemento vai 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 esse 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, "Inserir 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 aceito 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 pela UniversalAction.

UriPattern

A configuração de cada padrão de URL que aciona uma visualização de link.

Campos
hostPattern

string

Obrigatório para cada padrão de URL na visualização. É o domínio do padrão do URL. Os links de visualização do complemento 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 os 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 em branco.