REST Resource: projects.deployments

Recurso: implantação

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 Google OAuth para os quais o consentimento do usuário final precisa ser solicitado antes de executar um endpoint de complemento.
addOns

object (AddOns)

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

string

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 (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ções comuns 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 do Agenda.
docs

object (DocsAddOnManifest)

Configuração do complemento do app 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 do Apresentações.
httpOptions

object (HttpOptions)

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

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

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

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

LayoutProperties

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

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

boolean

Ativa o design do Material Design para cards.

AddOnWidgetSet

O subconjunto de widgets usado por um complemento.

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

enum (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 Os formulários persistentes permitem 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 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
runFunction

string

Obrigatório. O endpoint a ser executado quando esse 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 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.

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

object (UnconditionalTrigger)

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

string

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 (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Campos
actions[]

object (MenuItemExtensionPoint)

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

enum (DraftAccess)

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

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 (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

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

object (DriveExtensionPoint)

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 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 for ativado.

CalendarAddOnManifest

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

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

object (HomepageExtensionPoint)

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 addons.common.homepageTrigger.
conferenceSolution[]

object (ConferenceSolution)

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

string

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

object (CalendarExtensionPoint)

Um endpoint acionado quando um evento é aberto para ser visualizado ou editado.
eventUpdateTrigger

object (CalendarExtensionPoint)

Um endpoint que é acionado quando o evento aberto é atualizado.
calendarNotificationTrigger

object (CalendarExtensionPoint)

Um endpoint que é acionado quando há um novo evento para uma assinatura de agenda configurada anteriormente.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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
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 às 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 deve 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 da conferência.

CalendarExtensionPoint

Formato comum para declarar acionadores de um complemento de agenda.

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

string

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 do calendário.
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 dos Documentos Google.

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

object (HomepageExtensionPoint)

Se presente, 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 esse par de documento/usuário.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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.
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 acionadores de um complemento do Documentos.

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

string

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 (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
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 (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 vai 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 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.

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

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

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

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, substitui a configuração de addons.common.homepageTrigger.
web

object (Web)

Detalhes sobre complementos que aprimoram 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 aprimoram 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 "main stage".
supportsScreenSharing

boolean

Indica 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 foi descontinuado. Use o campo de nível superior em MeetAddOnManifest.
supportsPopOut

boolean

Indica se o complemento oferece suporte para a abertura de uma experiência PiP no navegador.
hostOrigins[]
(deprecated)

string

Descontinuado, nome legado. 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 oferece suporte aos controles do organizador.
logoUrl

string

O URL do logotipo a ser exibido no 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 no modo escuro.
displayFlow
(deprecated)

enum (DisplayFlow)

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

Estado

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

Enums
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 o palco principal ativo.
SIDE_PANEL_AND_MAIN_STAGE O complemento é aberto com o painel lateral e a janela principal ativos.

DisplayFlow

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

Enums
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 das Planilhas Google.

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

object (HomepageExtensionPoint)

Se presente, 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 esse par de documento/usuário.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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
runFunction

string

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 (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Se presente, 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 esse par de documento/usuário.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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
runFunction

string

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 (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
Campos
authorizationHeader

enum (HttpAuthorizationHeader)

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

enum (GranularOauthPermissionSupport)

Indica se o complemento ativou o consentimento OAuth detalhado.

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.

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.

Métodos

create

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

delete

 Exclui a implantação com o nome fornecido.

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

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.