Recurso de manifesto do editor

A configuração de recursos usada para definir o conteúdo e o comportamento dos complementos do Google Workspace nos editores. Todos os componentes precisam estar marcados como Obrigatórios nos manifestos de complementos do Google Workspace se eles estenderem o Editor.

Editores

Configuração do manifesto de complementos do Google Workspace para extensões do Editor. Consulte Como estender editores com complementos do Google Workspace para mais informações.

Representação JSON
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
Campos
homepageTrigger

object (HomepageTrigger)

Essa função de gatilho cria a página inicial do complemento no app host. Isso substitui addOns.common.homepageTrigger.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Obrigatório se o complemento incluir um comportamento específico para o documento do Editor atual, acionado quando o usuário autorizar o escopo drive.file .

linkPreviewTriggers[]

object (LinkPreviewTriggers)

Obrigatório para visualizações de links. Uma lista de acionadores para visualização de links em um arquivo dos Documentos, Planilhas ou Apresentações Google. Saiba mais em Visualizar links com ícones inteligentes.

createActionTriggers[]

object (createActionTriggers)

Obrigatório para a criação de recursos de terceiros. Uma lista de gatilhos para criar recursos em um serviço de terceiros no menu @. Saiba mais em Criar recursos de terceiros com ícones inteligentes.

OnFileScopeGrantedTrigger

Configuração para um gatilho contextual que é disparado quando a caixa de diálogo do escopo do arquivo de solicitação usando CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); e o usuário concede a autorização do escopo drive.file.

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

string

O nome da função a ser executada se o escopo drive.file for concedido. Se especificada, você precisa implementar essa função para criar e retornar uma matriz de objetos Card para exibição na IU do complemento.

LinkPreviewTriggers

Configuração de um acionador que é disparado quando um usuário digita ou cola um link de um serviço de terceiros ou de terceiros em um arquivo dos Documentos, Planilhas ou Apresentações.

Se quiser configurar esse acionador para um complemento do Google Workspace, consulte Visualizar links com ícones inteligentes.

Representação JSON
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
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 de os usuários executarem o complemento.
localizedLabelText

map (key: string, value: string)

Opcional. Um mapa de labelText para localização 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 conferir a versão localizada do labelText.

patterns[]

object (UriPattern)

Obrigatório. Uma matriz de padrões de URL que acionam o complemento para links de visualização.
runFunction

string

Obrigatório. O nome da função a ser executada quando o usuário autorizar o escopo https://www.googleapis.com/auth/workspace.linkpreview. Se especificada, você precisa implementar essa função para aceitar um objeto de evento que contenha EDITOR_NAME.matchedUrl.url como argumento e retornar um único objeto Card que exibe uma visualização de link na interface do complemento.
logoUrl

string

Opcional. O ícone que aparece no ícone inteligente e no card de visualização. Se omitido, o complemento usará o próprio í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 a ser visualizado. O domínio do padrão de URL. Os links de visualizações de complementos 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 da hostPattern.

Por exemplo, se o padrão de host do URL for support.example.com, use cases para corresponder aos URLs dos 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.

CreateActionTriggers

A configuração de um acionador que é disparado quando um usuário seleciona um item do menu de integração de terceiros no menu @ dos Documentos Google.

Para configurar esse gatilho para um complemento do Google Workspace, consulte Criar recursos de terceiros com ícones inteligentes.

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 no menu @, como Create support case.
localizedLabelText

map (key: string, value: string)

Opcional. Um mapa de labelText para localização 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 conferir a versão localizada do labelText.

runFunction

string

Obrigatório. O nome da função a ser executada quando um usuário seleciona um ponto de extensão no menu @. A função precisa retornar um card de formulário com entradas para criar o recurso de terceiros.
logoUrl

string

Opcional. O ícone exibido no menu @. Se omitido, o complemento usará o próprio ícone da barra de ferramentas, logoUrl.