REST Resource: projects.deployments

{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}

string

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

string

A lista de escopos do Google OAuth para a qual você deseja solicitar o consentimento do usuário final antes de executar um endpoint de complementos.

object (AddOns)

A configuração do complemento do Google Workspace.

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.

{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}

object (CommonAddOnManifest)

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

object (GmailAddOnManifest)

Configuração de complementos do Gmail.

object (DriveAddOnManifest)

Configuração de complementos do Drive.

object (CalendarAddOnManifest)

Configuração de complementos do Agenda.

object (DocsAddOnManifest)

Configuração de complementos do Documentos.

object (SheetsAddOnManifest)

Configuração de complementos do Planilhas.

object (SlidesAddOnManifest)

Configuração de complementos do Apresentações.

object (HttpOptions)

Opções para enviar solicitações para endpoints HTTP complementares

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

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

string

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

object (LayoutProperties)

Propriedades de layout comuns para os cards de complementos.

object (AddOnWidgetSet)

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

boolean

Define se as informações de localidade serão transmitidas do app host.

object (HomepageExtensionPoint)

Define um endpoint que será executado em qualquer contexto, em qualquer host. Todos os cards gerados por essa função sempre estarão disponíveis para o usuário, mas poderão ser eliminados por conteúdo contextual quando o complemento declarar acionadores mais segmentados.

object (UniversalActionExtensionPoint)

Define uma lista de pontos de extensão no menu de ação universal que serve como um menu de configurações para o complemento. O ponto de extensão pode ser um URL de link a ser aberto ou um ponto de extremidade para ser executado como um envio de formulário.

array (ListValue format)

Uma ação do 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. HTTP links são automaticamente reescritos para HTTPS links.

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

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 pela estrutura será usado.

string

A cor secundária do complemento. Define a cor dos botões. Se a cor principal for definida, mas nenhuma cor secundária for definida, a cor secundária será igual à principal. Se nem a cor primária nem a secundária forem definidas, o valor padrão fornecido pela estrutura será usado.

boolean

Ativa o Material Design para cartões.

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum (WidgetType)

A lista de widgets usados em um complemento.

{
  "runFunction": string,
  "enabled": boolean
}

string

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

boolean

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

Se não for definido, o padrão será true.

Se a visualização personalizada da página inicial de um complemento for desativada, um cartão de visão geral genérico será fornecido aos usuários.

{
  "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.
}

string

Obrigatório. Texto visível para o usuário que descreve a ação realizada pela ativação deste ponto de extensão, por exemplo, "Adicionar um novo contato".

string

URL a ser aberto pelo UniversalAction.

string

Endpoint a ser executado pelo UniversalAction.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}

object (HomepageExtensionPoint)

Define um endpoint que será executado em contextos que não correspondem a um acionador contextual declarado. Todos os cartões gerados por esta função sempre estarão disponíveis para o usuário, mas poderão ser esmagados pelo conteúdo contextual quando este complemento declarar acionadores mais segmentados.

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

object (ContextualTrigger)

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

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.

object (ComposeTrigger)

Define o acionador de tempo de escrita para um complemento de tempo de escrita. Esse é o acionador que faz com que um complemento execute uma ação quando o usuário está escrevendo um e-mail. Todos os complementos de escrita precisam ter o escopo gmail.addons.current.action.compose, mesmo que não possam editar o rascunho.

string

O nome de um endpoint que verifica se o complemento tem todas as autorizações de terceiros necessárias, verificando as APIs de terceiros. Se a sondagem falhar, a função 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.

{
  "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.
}

string

Obrigatório. O nome do endpoint a ser chamado quando uma mensagem corresponder ao acionador.

object (UnconditionalTrigger)

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

{
  "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.
}

string

Obrigatório. Texto visível para o usuário que descreve a ação, por exemplo, "Adicionar um novo contato".

string

Um link que é aberto pelo Gmail quando o usuário aciona a ação.

string

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

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

object (MenuItemExtensionPoint)

Define o conjunto de ações para um complemento de escrita. Essas ações podem ser acionadas pelos usuários em um complemento de escrita.

enum (DraftAccess)

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

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

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

string

Obrigatório. Texto visível para o usuário que descreve a ação realizada pela ativação deste ponto de extensão. Por exemplo, "Inserir fatura".

string

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

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}

object (HomepageExtensionPoint)

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

object (DriveExtensionPoint)

Corresponde ao comportamento que é executado quando os itens são selecionados na visualização relevante do Drive, como a lista "Meu Drive".

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}

object (HomepageExtensionPoint)

Define um endpoint que é executado em contextos que não correspondem a um acionador contextual declarado. Todos os cards gerados por essa função sempre estarão disponíveis para o usuário, mas poderão ser eliminados por conteúdo contextual quando o complemento declarar acionadores mais segmentados.

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

object (ConferenceSolution)

Define soluções de conferência fornecidas por este complemento.

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

enum (EventAccess)

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

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

Obrigatório. O ponto de extremidade a ser chamado quando os dados da conferência devem ser criados.

string

Obrigatório. Os códigos devem ser atribuídos de forma exclusiva entre soluções de conferência dentro de um complemento. Caso contrário, a solução de conferência errada pode ser usada quando o complemento é acionado. Embora seja possível alterar o nome de exibição de um complemento, o código não deve ser alterado.

string

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

string

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (DocsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

Uma lista de pontos de extensão para visualizar links em um documento do Documentos Google. Veja mais detalhes em Visualizar links com ícones inteligentes.

{
  "runFunction": string
}

string

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

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

string

Obrigatório. O texto de um ícone inteligente de exemplo que solicita aos usuários visualizar o link, como Example: Support case. Esse texto é estático e é exibido antes dos usuários executarem o complemento.

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 nas chaves do mapa, o usuário verá a versão localizada do labeltext.

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

object (UriPattern)

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

string

Obrigatório. Endpoint a ser executado quando uma visualização de link for acionada.

string

Opcional. O ícone exibido no ícone inteligente. Se omitido, o ícone usará a barra de ferramentas do complemento, logourl.

{
  "hostPattern": string,
  "pathPrefix": string
}

string

Obrigatório para cada padrão de URL a ser visualizado. O domínio do padrão de URL. O complemento visualiza os 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.

string

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

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

Para corresponder a todos os URLs no domínio do padrão do host, deixe pathprefix em branco.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  }
}

object (HomepageExtensionPoint)

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

object (SheetsExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  }
}

object (HomepageExtensionPoint)

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

object (SlidesExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum (HttpAuthorizationHeader)

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