- Recurso: implantação
- AddOns
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- Métodos
Recurso: implantação
Uma implantação de complemento do Google Workspace
Representação JSON |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Campos | |
---|---|
name |
O nome do recurso de implantação. Exemplo: |
oauth |
A lista de escopos do OAuth do Google para os quais o consentimento do usuário final precisa ser solicitado antes de executar um endpoint do complemento. |
add |
A configuração do complemento do Google Workspace. |
etag |
Esse valor é computado pelo servidor com base na versão da implantação no armazenamento e pode ser enviado em solicitações de atualização e exclusão para garantir que o cliente tenha um valor atualizado antes de prosseguir. |
AddOns
Uma configuração de complemento do Google Workspace.
Representação JSON |
---|
{ "common": { object ( |
Campos | |
---|---|
common |
Configuração comum a todos os complementos do Google Workspace. |
gmail |
Configuração do complemento do Gmail. |
drive |
Configuração de complementos do Drive. |
calendar |
Configuração do complemento do Agenda. |
docs |
Configuração do complemento do Documentos. |
sheets |
Configuração do complemento das Planilhas. |
slides |
Configuração do complemento do Apresentações. |
http |
Opções para enviar solicitações a endpoints HTTP complementares |
CommonAddOnManifest
Configuração do complemento compartilhada entre todos os aplicativos host de complemento.
Representação JSON |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Campos | |
---|---|
name |
Obrigatório. O nome de exibição do complemento. |
logo |
Obrigatório. O URL da imagem do logotipo mostrada na barra de ferramentas do complemento. |
layout |
Propriedades de layout comuns para os cards de complemento. |
add |
Os widgets usados no complemento. Se esse campo não for especificado, o conjunto padrão será usado. |
use |
Determina se as informações de localidade serão transmitidas do app host. |
homepage |
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. |
universal |
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. |
open |
Uma ação OpenLink só pode usar um URL com um esquema |
LayoutProperties
Propriedades de layout do card compartilhadas em todos os aplicativos de complemento host.
Representação JSON |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Campos | |
---|---|
primary |
A cor principal do complemento. Ele define a cor da barra de ferramentas. Se nenhuma cor primária for definida, o valor padrão fornecido pelo framework será usado. |
secondary |
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. |
use |
Ativa o design do Material Design para cards. |
AddOnWidgetSet
O subconjunto de widgets usado por um complemento.
Representação JSON |
---|
{
"usedWidgets": [
enum ( |
Campos | |
---|---|
used |
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. |
FIXED_FOOTER |
Correção do rodapé em um card. |
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. |
HomepageExtensionPoint
Formato comum para declarar a visualização da página inicial de um complemento.
Representação JSON |
---|
{ "runFunction": string, "enabled": boolean } |
Campos | |
---|---|
run |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
enabled |
Opcional. Se definido como O padrão é Se a visualização da página inicial personalizada de um complemento estiver desativada, um card de visão geral genérica será fornecido aos usuários. |
UniversalActionExtensionPoint
Formato para declarar um ponto de extensão de item de menu de ação universal.
Representação JSON |
---|
{ "label": string, // Union field |
Campos | |
---|---|
label |
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: |
|
open |
URL a ser aberto pela UniversalAction. |
run |
Endpoint a ser executado pela UniversalAction. |
GmailAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento do Gmail.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Define um endpoint que será executado em contextos que não correspondem a um gatilho contextual declarado. Todos os cards gerados por essa função vão estar sempre disponíveis para o usuário, mas podem ser ofuscados pelo conteúdo contextual quando esse complemento declarar gatilhos mais segmentados. Se presente, substitui a configuração de |
contextual |
Define o conjunto de condições que acionam o complemento. |
universal |
Define um conjunto de ações universais para o complemento. O usuário aciona ações universais no menu da barra de ferramentas do complemento. |
compose |
Define o acionador de tempo de composição para um complemento de tempo de composição. Esse é o gatilho que faz com que um complemento entre em ação quando o usuário está escrevendo um e-mail. Todos os complementos de tempo de composição precisam ter o escopo |
authorization |
O nome de um endpoint que verifica se o complemento tem todas as autorizações de terceiros necessárias, investigando as APIs de terceiros. Se a sondagem falhar, a função vai gerar uma exceção para iniciar o fluxo de autorização. Essa função é chamada antes de cada invocação do complemento para garantir uma experiência tranquila ao usuário. |
ContextualTrigger
Define um acionador que é acionado quando o e-mail aberto atende a critérios específicos. Quando o acionador é acionado, ele executa um endpoint específico, geralmente para criar novos cards e atualizar a interface.
Representação JSON |
---|
{ "onTriggerFunction": string, // Union field |
Campos | |
---|---|
on |
Obrigatório. O nome do endpoint a ser chamado quando uma mensagem corresponder ao acionador. |
Campo de união trigger . O tipo de acionador determina as condições que o Gmail usa para mostrar o complemento. trigger pode ser apenas de um dos tipos a seguir: |
|
unconditional |
Os gatilhos incondicionais são executados quando qualquer mensagem de e-mail é aberta. |
UnconditionalTrigger
Esse tipo não tem campos.
Um acionador que é acionado quando qualquer mensagem de e-mail é aberta.
UniversalAction
Uma ação que está sempre disponível no menu da barra de ferramentas do complemento, independentemente do contexto da mensagem.
Representação JSON |
---|
{ "text": string, // Union field |
Campos | |
---|---|
text |
Obrigatório. Texto visível ao usuário que descreve a ação, por exemplo, "Adicionar um novo contato". |
Campo de união action_type . O tipo da ação determina o comportamento do Gmail quando o usuário a invoca. action_type pode ser apenas de um dos tipos a seguir: |
|
open |
Um link que é aberto pelo Gmail quando o usuário aciona a ação. |
run |
Um endpoint que é chamado quando o usuário aciona a ação. Consulte o guia de ações universais para mais detalhes. |
ComposeTrigger
Um acionador que é ativado quando o usuário está escrevendo um e-mail.
Representação JSON |
---|
{ "actions": [ { object ( |
Campos | |
---|---|
actions[] |
Define o conjunto de ações de um complemento de tempo de composição. São ações que os usuários podem acionar em um complemento de composição. |
draft |
Define o nível de acesso aos dados quando um complemento de tempo de composição é acionado. |
MenuItemExtensionPoint
Formato comum para declarar um item de menu ou botão que aparece em um app host.
Representação JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Campos | |
---|---|
run |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
label |
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". |
logo |
O URL da imagem do logotipo mostrado na barra de ferramentas do complemento. Se não for definido, o padrão será o URL do logotipo principal do complemento. |
DraftAccess
Um tipo enumerado que define o nível de acesso a dados necessário para o acionador do Compose.
Enums | |
---|---|
UNSPECIFIED |
Valor padrão quando nada é definido para o acesso de rascunho. |
NONE |
O acionador do Compose não pode acessar nenhum dado do rascunho quando um complemento do Compose é acionado. |
METADATA |
Dá ao acionador do Compose a permissão para acessar os metadados do rascunho quando um complemento do Compose é acionado. Isso inclui a lista de público-alvo, como a lista "Para" e "Cc" de uma mensagem de rascunho. |
DriveAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento do Drive.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Se presente, substitui a configuração de |
on |
Corresponde ao comportamento que é executado quando os itens são selecionados na visualização relevante do Drive, como a lista de documentos do Meu Drive. |
DriveExtensionPoint
Formato comum para declarar acionadores de um complemento do Drive.
Representação JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
run |
Obrigatório. O endpoint a ser executado quando o ponto de extensão for ativado. |
CalendarAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento do Agenda.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Define um endpoint que é executado em contextos que não correspondem a um acionador contextual declarado. 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. Se presente, substitui a configuração de |
conference |
Define as soluções de videoconferência fornecidas por esse complemento. Os complementos de videoconferência de terceiros só podem ser criados no Apps Script. |
create |
Um endpoint a ser executado que cria um URL para a página de configurações do complemento. |
event |
Um endpoint que é acionado quando um evento é aberto para ser visualizado ou editado. |
event |
Um endpoint que é acionado quando o evento aberto é atualizado. |
event |
Uma configuração de um acionador contextual que é acionado quando o usuário clica no provedor de anexos do complemento no menu suspenso do Agenda. |
current |
Define o nível de acesso aos dados quando um complemento de evento é acionado. |
ConferenceSolution
Define valores relacionados à conferência. Os complementos de videoconferência de terceiros só podem ser criados no Apps Script.
Representação JSON |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Campos | |
---|---|
on |
Obrigatório. O endpoint a ser chamado quando os dados da conferência precisam ser criados. |
id |
Obrigatório. Os IDs precisam ser atribuídos de forma exclusiva em todas as soluções de conferência em um complemento. Caso contrário, a solução de conferência errada poderá ser usada quando o complemento for acionado. Embora seja possível mudar o nome de exibição de um complemento, o ID não pode ser alterado. |
name |
Obrigatório. O nome de exibição da solução de conferência. |
logo |
Obrigatório. O URL da imagem do logotipo da solução da conferência. |
CalendarExtensionPoint
Formato comum para declarar acionadores de um complemento de agenda.
Representação JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
run |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
EventAccess
Um tipo enumerado que define o nível de acionamento de eventos de acesso a dados.
Enums | |
---|---|
UNSPECIFIED |
Valor padrão quando nada é definido para eventAccess. |
METADATA |
Permite que os acionadores de eventos acessem os metadados de eventos, como o ID do evento e o ID da agenda. |
READ |
Dá aos acionadores de eventos acesso a todos os campos de evento fornecidos, incluindo metadados, participantes e dados da conferência. |
WRITE |
Dá aos acionadores de eventos acesso aos metadados dos eventos e a capacidade de realizar todas as ações, incluindo adicionar participantes e definir dados da conferência. |
READ_WRITE |
Dá aos acionadores de eventos acesso a todos os campos de evento fornecidos, incluindo os metadados, os participantes e os dados da conferência, além da capacidade de realizar todas as ações. |
DocsAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento do Documentos Google.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Se presente, substitui a configuração de |
on |
Endpoint a ser executado quando a autorização de escopo de arquivo for concedida para esse par de documento/usuário. |
link |
Uma lista de pontos de extensão para visualizar links em um documento do Documentos Google. Para saber mais, consulte Visualizar links com ícones inteligentes. |
create |
Uma lista de pontos de extensão para criar recursos de terceiros nos aplicativos do Google Workspace. Para mais informações, consulte Criar recursos de terceiros com o menu "@". |
DocsExtensionPoint
Formato comum para declarar acionadores de um complemento do Documentos.
Representação JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
run |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
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.
Representação JSON |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
Campos | |
---|---|
label |
Obrigatório. O texto de um exemplo de ícone inteligente que solicita que os usuários visualizem o link, como |
localized |
Opcional. Um mapa de Se a localidade de um usuário estiver presente nas chaves do mapa, ele vai ver a versão localizada do Um objeto com uma lista de pares |
patterns[] |
Obrigatório. Uma matriz de padrões de URL que acionam o complemento para visualizar links. |
run |
Obrigatório. Endpoint a ser executado quando uma prévia de link for acionada. |
logo |
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, |
UriPattern
A configuração de cada padrão de URL que aciona uma visualização de link.
Representação JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Campos | |
---|---|
host |
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 Por exemplo, |
path |
Opcional. O caminho que anexa o domínio do Por exemplo, se o padrão de host do URL for Para corresponder a todos os URLs no domínio do padrão de host, deixe |
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 "@".
Representação JSON |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
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 |
label |
Obrigatório. O texto que aparece ao lado de um ícone para o ponto de entrada de criação de recursos, como |
localized |
Opcional. Um mapa de Se a localidade de um usuário estiver presente nas chaves do mapa, ele vai ver a versão localizada do Um objeto com uma lista de pares |
run |
Obrigatório. Endpoint a ser executado quando um fluxo de trabalho de criação de recursos for acionado para criar um link. |
logo |
Opcional. O ícone que aparece no ponto de entrada da criação de recursos. Se omitido, o menu usa o ícone da barra de ferramentas do complemento, |
SheetsAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento das Planilhas Google.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Se presente, substitui a configuração de |
on |
Endpoint a ser executado quando a autorização de escopo de arquivo for concedida para esse par de documento/usuário. |
link |
Uma lista de pontos de extensão para visualizar links em um documento das Planilhas Google. Para saber mais, consulte Visualizar links com ícones inteligentes. |
SheetsExtensionPoint
Formato comum para declarar acionadores de um complemento das Planilhas.
Representação JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
run |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
SlidesAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento das Apresentações Google.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Se presente, substitui a configuração de |
on |
Endpoint a ser executado quando a autorização de escopo de arquivo for concedida para esse par de documento/usuário. |
link |
Uma lista de pontos de extensão para visualizar links em um documento do Apresentações Google. Para saber mais, consulte Visualizar links com ícones inteligentes. |
SlidesExtensionPoint
Formato comum para declarar os acionadores de um complemento do Apresentações.
Representação JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
run |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
HttpOptions
Opções para enviar solicitações a endpoints HTTP
de complementos.
Representação JSON |
---|
{
"authorizationHeader": enum ( |
Campos | |
---|---|
authorization |
Configuração do token enviado no cabeçalho de autorização |
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. |
Métodos |
|
---|---|
|
Cria uma implantação com o nome e a configuração especificados. |
|
Exclui a implantação com o nome fornecido. |
|
Recebe a implantação com o nome especificado. |
|
Recebe o status de instalação de uma implantação de teste. |
|
Instala uma implantação na sua conta para testes. |
|
Lista todas as implantações em um projeto específico. |
|
Cria ou substitui uma implantação com o nome especificado. |
|
Desinstala uma implantação de teste da conta do usuário. |