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

object (AddOns)

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 dos complementos do Gmail.

object (DriveAddOnManifest)

Configuração dos complementos do Drive.

object (CalendarAddOnManifest)

Configuração dos 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 de complementos

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

object (AddOnWidgetSet)

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

boolean

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

object (HomepageExtensionPoint)

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

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 a ser aberto ou um endpoint a ser executado como 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 vinculações 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 em links HTTPS.

{
  "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 pelo framework será usado.

string

A cor secundária do complemento. Define a cor dos botões. Se a cor primária for definida, mas nenhuma cor secundária for definida, a cor secundária será a mesma que a primária. Se nem a cor primária nem a secundária forem definidas, será usado o valor padrão fornecido pelo framework.

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

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

Se a visualização da página inicial personalizada de um complemento estiver desativada, um card de visão geral genérico vai aparecer para os 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 ao ativar este ponto de extensão, por exemplo, "Adicionar um novo contato".

string

URL que será aberto pela UniversalAction.

string

Endpoint a ser executado pela 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 gatilho contextual declarado. Todos os cards gerados por essa função sempre estarão disponíveis para o usuário, mas poderão ser eclipsados por conteúdo contextual quando o complemento declarar acionadores mais segmentados.

Se presente, substitui 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 gatilho de tempo do Compose para um complemento desse tipo. Este é o gatilho que faz com que um complemento entre em ação quando o usuário estiver escrevendo um e-mail. Todos os complementos do Compose precisam ter o escopo gmail.addons.current.action.compose, mesmo que não editem o rascunho.

string

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

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

object (UnconditionalTrigger)

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 descrevendo 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 que é chamado quando o usuário aciona a ação. Consulte o guia de ações universais para mais detalhes.

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

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

enum (DraftAccess)

Define o nível de acesso aos dados quando um complemento de tempo 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 ao ativar esse ponto de extensão. Por exemplo, "Inserir fatura".

string

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

Se ela não for definida, o padrão será o URL do logotipo principal do complemento.

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

object (HomepageExtensionPoint)

Se presente, substitui 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 Google Drive, como a lista de documentos do 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)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}

object (HomepageExtensionPoint)

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

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

object (ConferenceSolution)

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

object (MenuItemExtensionPoint)

Uma configuração para um acionador contextual acionado quando o usuário clica no provedor de anexos de complementos no menu suspenso do Google Agenda.

enum (EventAccess)

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

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

string

Obrigatório. O endpoint a ser chamado quando os dados de videoconferência forem criados.

string

Obrigatório. Os IDs devem ser atribuídos de maneira exclusiva a todas as soluções de conferência dentro de um complemento. Caso contrário, a solução de conferência errada poderá ser usada quando o complemento for 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 para a 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)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

Se presente, substitui 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 de documento/usuário.

object (LinkPreviewExtensionPoint)

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

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 no menu @.

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

map (key: string, value: string)

Opcional. Um mapa de labeltext para localização em outros idiomas. Formate o idioma no ISO 639 e o país/região no 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 encontrar 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 do URL que aciona o complemento para visualizar links.

string

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

string

Opcional. O ícone que aparece no ícone inteligente e no card de visualização. Se omitido, o complemento vai usar o ícone logourl na barra de ferramentas.

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

string

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

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

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

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}

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

string

Obrigatório. O texto exibido ao lado de um ícone do 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.

map (key: string, value: string)

Opcional. Um mapa de labeltext para localização em outros idiomas. Formate o idioma no ISO 639 e o país/região no 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 encontrar a versão localizada do labeltext.

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

string

Obrigatório. Endpoint a ser executado quando um fluxo de trabalho de criação de recurso for acionado para criar um link.

string

Opcional. O ícone do ponto de entrada de criação de recursos. Se ele for omitido, o menu vai usar o ícone logourl na barra de ferramentas do complemento.

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

object (HomepageExtensionPoint)

Se presente, substitui 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 de documento/usuário.

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

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

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

object (HomepageExtensionPoint)

Se presente, substitui 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 de documento/usuário.

object (LinkPreviewExtensionPoint)

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

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