REST Resource: projects.deployments

Recurso: Deployment

Uma implantação de complemento do Google Workspace

Representação JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
Campos
name

string

O nome do recurso de implantação. Exemplo: projects/123/deployments/my_deployment.
oauthScopes[]

string

A lista de escopos do OAuth do Google para os quais pedir consentimento do usuário final antes de executar um endpoint de complemento.
addOns

object (AddOns)

A configuração do complemento do Google Workspace.
etag

string

Esse valor é calculado 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 (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
Campos
common

object (CommonAddOnManifest)

Configuração comum a todos os complementos do Google Workspace.
gmail

object (GmailAddOnManifest)

Configuração do complemento do Gmail.
drive

object (DriveAddOnManifest)

Configuração de complementos do Drive.
calendar

object (CalendarAddOnManifest)

Configuração do complemento da Agenda.
docs

object (DocsAddOnManifest)

Configuração do complemento dos Documentos.
meet

object (MeetAddOnManifest)

Configuração do complemento do Meet.
sheets

object (SheetsAddOnManifest)

Configuração do complemento das Planilhas.
slides

object (SlidesAddOnManifest)

Configuração do complemento Apresentações.
httpOptions

object (HttpOptions)

Opções para enviar solicitações a endpoints HTTP de complementos

CommonAddOnManifest

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

Representação JSON 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
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

object (LayoutProperties)

Propriedades de layout comuns para os cards de complementos.
addOnWidgetSet

object (AddOnWidgetSet)

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

boolean

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

object (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[]

object (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

array (ListValue format)

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.

LayoutProperties

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

Representação JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
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)

boolean

Ativa o Material Design para cards.

AddOnWidgetSet

O subconjunto de widgets usado por um complemento.

Representação JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
Campos
usedWidgets[]

enum (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.

HomepageExtensionPoint

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

Representação JSON 
{
  "runFunction": string,
  "enabled": boolean
}
Campos
runFunction

string

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

boolean

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.

UniversalActionExtensionPoint

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

Representação JSON 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
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.

GmailAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento do Gmail.

Representação JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Define um endpoint que será executado em contextos que não correspondem a um gatilho contextual declarado. 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.

Se presente, isso substitui a configuração de addons.common.homepageTrigger.
contextualTriggers[]

object (ContextualTrigger)

Define o conjunto de condições que acionam o complemento.
universalActions[]

object (UniversalAction)

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.
composeTrigger

object (ComposeTrigger)

Define o acionador de tempo de composição para um complemento de tempo de composição. Esse é o gatilho que faz um complemento agir quando o usuário está escrevendo um e-mail. Todos os complementos de tempo de composição precisam ter o escopo gmail.addons.current.action.compose, mesmo que não editem o rascunho.
authorizationCheckFunction

string

O nome de um endpoint que verifica se o complemento tem todas as autorizações de terceiros necessárias, sondando 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 do usuário tranquila.

ContextualTrigger

Define um acionador que é disparado quando o e-mail aberto atende a um critério específico. Quando o gatilho é acionado, ele executa um endpoint específico, geralmente para criar novos cards e atualizar a interface.

Representação JSON 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
Campos
onTriggerFunction

string

Obrigatório. O nome do endpoint a ser chamado quando uma mensagem corresponder ao gatilho.
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

object (UnconditionalTrigger)

Os acionadores incondicionais são executados quando qualquer mensagem de e-mail é aberta.

UnconditionalTrigger

Esse tipo não tem campos.

Um gatilho 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, independente do contexto da mensagem.

Representação JSON 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
Campos
text

string

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 de ação determina o comportamento do Gmail quando o usuário a invoca. action_type pode ser apenas de um dos tipos a seguir:
runFunction

string

Um endpoint chamado quando o usuário aciona a ação. Consulte o guia de ações universais para mais detalhes.

ComposeTrigger

Um gatilho que é ativado quando o usuário está escrevendo um e-mail.

Representação JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Campos
actions[]

object (MenuItemExtensionPoint)

Define o conjunto de ações para um complemento de tempo de composição. São ações que os usuários podem acionar em um complemento de tempo de composição.
draftAccess

enum (DraftAccess)

Define o nível de acesso aos dados quando um complemento de tempo de composição é acionado.

DraftAccess

Uma enumeração que define o nível de acesso aos dados necessário para o acionador de composição.

Tipos enumerados
UNSPECIFIED Valor padrão quando nada é definido para "draftaccess".
NONE O acionador de composição não pode acessar nenhum dado do rascunho quando um complemento de composição é acionado.
METADATA Concede ao gatilho de composição a permissão para acessar os metadados do rascunho quando um complemento de composição é acionado. Isso inclui a lista de destinatários, como as listas "Para" e "Cc" de uma mensagem em rascunho.

DriveAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento do Drive.

Representação JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Se presente, isso substitui a configuração de addons.common.homepageTrigger.
onItemsSelectedTrigger

object (DriveExtensionPoint)

Corresponde ao comportamento 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 os acionadores de um complemento do Drive.

Representação JSON 
{
  "runFunction": string
}
Campos
runFunction

string

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

CalendarAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento da Agenda.

Representação JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Define um endpoint executado em contextos que não correspondem a um gatilho contextual declarado. 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.

Se presente, isso substitui a configuração de addons.common.homepageTrigger.
conferenceSolution[]

object (ConferenceSolution)

Define as soluções de videoconferência fornecidas por este complemento. Os complementos de videoconferência de terceiros só podem ser criados no Apps Script.
createSettingsUrlFunction

string

Um endpoint para executar que cria um URL para a página de configurações do complemento.
eventOpenTrigger

object (CalendarExtensionPoint)

Um endpoint que é acionado quando um evento é aberto para visualização ou edição.
eventUpdateTrigger

object (CalendarExtensionPoint)

Um endpoint que é acionado quando o evento de abertura é atualizado.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

Uma configuração para um acionador contextual que é disparado quando o usuário clica no provedor de anexos do complemento no menu suspenso da Agenda.
currentEventAccess

enum (EventAccess)

Define o nível de acesso aos dados quando um complemento de evento é acionado.

ConferenceSolution

Define valores relacionados a conferências. 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
onCreateFunction

string

Obrigatório. O endpoint a ser chamado quando os dados da conferência precisam ser criados.
id

string

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 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

string

Obrigatório. O nome de exibição da solução de conferência.
logoUrl

string

Obrigatório. O URL da imagem do logotipo da solução de conferência.

CalendarExtensionPoint

Formato comum para declarar os gatilhos de um complemento da Agenda.

Representação JSON 
{
  "runFunction": string
}
Campos
runFunction

string

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

EventAccess

Uma enumeração que define o nível de acesso aos dados que os acionadores de eventos exigem.

Tipos enumerados
UNSPECIFIED Valor padrão quando nada é definido para "eventAccess".
METADATA Dá aos gatilhos de eventos a permissão para acessar os metadados dos eventos, como ID do evento e ID da agenda.
READ Dá aos acionadores de eventos acesso a todos os campos de eventos fornecidos, incluindo metadados, participantes e dados de conferência.
WRITE Dá aos gatilhos de eventos acesso aos metadados dos eventos e a capacidade de realizar todas as ações, incluindo adicionar participantes e definir dados de conferência.
READ_WRITE Dá aos acionadores de eventos acesso a todos os campos de eventos fornecidos, incluindo metadados, participantes e 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 Google Docs.

Representação JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Se presente, isso substitui a configuração de addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Endpoint a ser executado quando a autorização de escopo de arquivo for concedida para este par documento/usuário.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Uma lista de pontos de extensão para visualizar links em um documento do Google Docs. Para mais detalhes, consulte Visualizar links com ícones inteligentes.
createActionTriggers[]

object (CreateActionExtensionPoint)

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 os gatilhos de um complemento do Google Docs.

Representação JSON 
{
  "runFunction": string
}
Campos
runFunction

string

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

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.

Representação JSON 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
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 (key: string, value: 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.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
patterns[]

object (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.

UriPattern

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

Representação JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
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.

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 "@".

Representação JSON 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
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 (key: string, value: 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.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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.

MeetAddOnManifest

Manifesto do complemento do Meet.

Representação JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Se presente, isso substitui a configuração de addons.common.homepageTrigger.
web

object (Web)

Detalhes sobre complementos que melhoram o cliente da Web do Meet.
supportsCollaboration

boolean

Se o complemento oferece suporte à colaboração ou ao convite de outras pessoas para a experiência do complemento.
termsUri

string

Um link para os Termos de Serviço do complemento, se houver.

Web

Detalhes sobre complementos que melhoram o cliente da Web do Meet.

Representação JSON 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
Campos
sidePanelUri
(deprecated)

string

O URI do iframe do painel lateral.
sidePanelUrl

string

O URL do iframe do painel lateral.
mainStageUri
(deprecated)

string

O URI do iframe do "palco principal".
supportsScreenSharing

boolean

Se o complemento oferece suporte ao compartilhamento de tela no palco principal.
supportsCollaboration
(deprecated)

boolean

Se o complemento oferece suporte à colaboração ou ao convite de outras pessoas para a experiência do complemento. Este campo está descontinuado. Use o campo de nível superior em MeetAddOnManifest.
supportsPopOut

boolean

Se o complemento é compatível com a abertura em uma experiência picture-in-picture do navegador.
hostOrigins[]
(deprecated)

string

Nome legado e descontinuado. Origens que precisam ser adicionadas à propriedade "frame-src" do iframe que contém o site de terceiros. Use addonorigins.
addOnOrigins[]

string

Origens que precisam ser adicionadas à propriedade "frame-src" do iframe que contém o site de terceiros.
openState

enum (State)

O estado inicial quando o complemento é aberto.
supportsCollaborationHostControls

boolean

Se o complemento de colaboração é compatível com os controles do organizador.
logoUrl

string

O URL do logotipo a ser exibido para o complemento. Se não for especificado, o padrão será o logotipo na seção comum do manifesto.
darkModeLogoUrl

string

Uma versão do logourl para o modo escuro.
displayFlow
(deprecated)

enum (DisplayFlow)

O fluxo de exibição que o complemento vai seguir quando for iniciado.

Estado

Enumeração para especificar o estado inicial de abertura do complemento.

Tipos enumerados
STATE_UNSPECIFIED O estado inicial não foi especificado com o complemento.
SIDE_PANEL_ONLY O complemento é aberto com apenas o painel lateral ativo.
MAIN_STAGE_ONLY O complemento é aberto com apenas a janela principal ativa.
SIDE_PANEL_AND_MAIN_STAGE O complemento é aberto com o painel lateral e a janela principal ativos.

DisplayFlow

Enumeração para especificar o fluxo de exibição que o complemento vai seguir quando for iniciado.

Tipos enumerados
DISPLAY_FLOW_UNSPECIFIED O fluxo de exibição não foi especificado.
FOCUS O complemento precisa ser iniciado no fluxo de exibição "foco".
AUGMENT O complemento precisa ser iniciado no fluxo de exibição "aumentar".

SheetsAddOnManifest

Propriedades que personalizam a aparência e a execução de um complemento do Google Sheets.

Representação JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Se presente, isso substitui a configuração de addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Endpoint a ser executado quando a autorização de escopo de arquivo for concedida para este par documento/usuário.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Uma lista de pontos de extensão para visualizar links em um documento das Planilhas Google. Para mais detalhes, consulte Visualizar links com ícones inteligentes.

SheetsExtensionPoint

Formato comum para declarar os gatilhos de um complemento do Google Sheets.

Representação JSON 
{
  "runFunction": string
}
Campos
runFunction

string

Obrigatório. O endpoint a ser executado quando este 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 (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Se presente, isso substitui a configuração de addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Endpoint a ser executado quando a autorização de escopo de arquivo for concedida para este par documento/usuário.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Uma lista de pontos de extensão para visualizar links em um documento das Apresentações Google. Para mais detalhes, consulte Visualizar links com ícones inteligentes.

SlidesExtensionPoint

Formato comum para declarar os gatilhos de um complemento do Apresentações Google.

Representação JSON 
{
  "runFunction": string
}
Campos
runFunction

string

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

HttpOptions

Opções para enviar solicitações aos endpoints do complemento HTTP.

Representação JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
Campos
authorizationHeader

enum (HttpAuthorizationHeader)

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

enum (GranularOauthPermissionSupport)

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

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.

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 granular do OAuth.
OPT_OUT O complemento está desativado do consentimento granular do OAuth.

Métodos

create

 Cria uma implantação com o nome e a configuração especificados.

delete

 Exclui a implantação com o nome especificado.

get

 Recebe a implantação com o nome especificado.

getInstallStatus

 Recebe o status de instalação de uma implantação de teste.

install

 Instala uma implantação na sua conta para teste.

list

 Lista todas as implantações em um projeto específico.

replaceDeployment

 Cria ou substitui uma implantação com o nome especificado.

uninstall

 Desinstala uma implantação de teste da conta do usuário.