Recurso de manifesto do editor

A configuração de recursos usada para definir o conteúdo e o comportamento do complemento do Google Workspace nos editores. Os manifestos de complementos do Google Workspace precisam ter todos os componentes marcados como Obrigatório se estenderem o Editor.

Editores

A configuração do manifesto do complemento do Google Workspace para extensões do editor. Consulte Extensão dos 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 do documento do Editor atual, acionado quando o usuário autoriza o escopo drive.file .

linkPreviewTriggers[]

object (LinkPreviewTriggers)

Obrigatório para visualizações de links. Uma lista de acionadores para visualizar links em um arquivo dos Documentos, Planilhas ou Apresentações Google. Para mais detalhes, consulte 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 "@". Para mais detalhes, consulte Criar recursos de terceiros com ícones inteligentes.

OnFileScopeGrantedTrigger

Uma configuração para um gatilho contextual que é acionado quando a caixa de diálogo de solicitação de escopo de arquivo usa CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); e o usuário concede a autorização de 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 especificado, você precisa implementar essa função para criar e retornar uma matriz de objetos Card para exibição na interface do complemento.

LinkPreviewTriggers

A configuração de um gatilho que é acionado quando um usuário digita ou cola um link de um serviço de terceiros ou não Google em um arquivo dos Documentos, Planilhas ou Apresentações.

Para configurar esse gatilho em um complemento do Google Workspace, consulte Links de prévia 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 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.

patterns[]

object (UriPattern)

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

string

Obrigatório. O nome da função a ser executada quando o usuário autoriza o escopo https://www.googleapis.com/auth/workspace.linkpreview. Se especificado, 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 mostre uma prévia do link na interface do complemento.
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 de 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, use cases para corresponder aos URLs de casos hospedados em support.example.com/cases/.

Para corresponder a todos os URLs no domínio do padrão de host, deixe pathPrefix vazio.

CreateActionTriggers

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

Para configurar esse gatilho em 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 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 no menu @, como Create support case.
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.

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 que aparece no menu @. Se omitido, o complemento usará o ícone da barra de ferramentas, logoUrl.