Manifesto de suplementos do Office

  • Artigo

Cada suplemento do Office tem um manifesto. Há dois tipos de manifestos:

  • Manifesto XML: Esse é o único tipo de manifesto com suporte atualmente para suplementos de produção. Como o nome indica, é formato XML. Esse tipo de manifesto não pode ser usado para um aplicativo que combina um suplemento com algum outro tipo de Aplicativo do Teams; ou seja, algum outro tipo de extensão da plataforma microsoft 365.
  • manifesto unificado para o Microsoft 365: Este é um manifesto formatado por JSON que tem sido usado há anos como o manifesto para aplicativos do Teams. Ele tem suporte para suplementos apenas como uma versão prévia atualmente e somente no Outlook para Windows. Ele não deve ser usado com um suplemento de produção. Quando ele é liberado para disponibilidade geral, os suplementos que usam esse manifesto podem ser combinados com outros tipos de Aplicativos do Teams em um único aplicativo que é instalável como uma unidade inteira.

O restante deste artigo é aplicável aos dois tipos de manifesto.

Dica

O arquivo de manifesto de um Suplemento do Office descreve como seu suplemento deve ser ativado quando um usuário final instala e o usa com documentos e aplicativos do Office.

Um arquivo de manifesto permite que um Suplemento do Office faça o seguinte:

  • Descreva a si mesmo fornecendo ID, versão, descrição, nome para exibição e local padrão.

  • Especifique as imagens usadas para identidade visual do suplemento e a iconografia usada para os comandos do suplemento na faixa de opções do Aplicativo do Office.

  • Especifique como o suplemento se integra ao Office, incluindo qualquer interface do usuário personalizada, como botões da faixa de opções criados pelo suplemento.

  • Especifique as dimensões padrão solicitadas para suplementos de conteúdo e a altura solicitada para Suplementos do Outlook.

  • Declare permissões exigidas pelo Suplemento do Office, como ler ou gravar no documento.

Observação

Se você planeja publicar o seu suplemento no AppSource e disponibilizá-lo na experiência do Office, certifique-se de que está em conformidade com as políticas de certificação do Marketplace Comercial. Por exemplo, para passar na validação, o suplemento deve funcionar em todas as plataformas com suporte para os métodos definidos (saiba mais na seção 1120.3 e na página de aplicativo e disponibilidade do Suplemento do Office).

Requisitos de hospedagem

Todas as URIs de imagem, como as usadas para comandos de suplemento, devem dar suporte ao cache na produção. O servidor que hospeda a imagem não deve retornar um Cache-Control cabeçalho especificando no-cache, no-storeou opções semelhantes na resposta HTTP. No entanto, quando você está desenvolvendo o suplemento e fazendo alterações em arquivos de imagem, o cache pode impedir que você veja suas alterações, portanto, o uso Cache-Control de cabeçalhos é aconselhável em desenvolvimento.

Todas as URLs para codificar ou arquivos de conteúdo no suplemento devem ser protegidas por SSL (HTTPS). Embora não seja estritamente obrigatório em todos os cenários de suplemento, é altamente recomendável o uso do ponto de extremidade do HTTPS para o suplemento. Os suplementos que não estiverem protegidos por SSL (HTTPS) geram erros e avisos de conteúdo não seguro durante o uso. Se você planeja executar seu suplemento no Office na Web ou publicar seu suplemento no AppSource, ele deve estar protegido por SSL. Se o suplemento acessar serviços e dados externos, ele deve estar protegido por SSL para proteger os dados em trânsito. Certificados autoassinados podem ser usados para desenvolvimento e teste, desde que sejam aceitos como confiáveis no computador local.

Práticas recomendadas de envio ao AppSource

Verifique se a identificação do suplemento é um GUID válido e exclusivo. Diversas ferramentas de gerador de GUID estão disponíveis na Web e podem ser usadas para criar um GUID exclusivo.

Os suplementos enviados ao AppSource também devem incluir uma URL de suporte no manifesto. Saiba mais em Políticas de validação para aplicativos e suplementos enviados ao AppSource.

Especificar os domínios que você deseja abrir na janela do suplemento

Ao executar no Office Online, o seu painel de tarefas pode ser navegado para qualquer URL. No entanto, em plataformas de área de trabalho, se o suplemento tentar ir para uma URL em um domínio diferente do domínio que hospeda a página inicial (conforme especificado no arquivo de manifesto), essa URL será aberta em uma nova janela do navegador fora do painel de suplemento do aplicativo do Office.

Para substituir esse comportamento (office da área de trabalho), especifique cada domínio que você deseja abrir na janela de suplemento no manifesto. Se o suplemento tentar ir para uma URL em um domínio que está na lista, ela então abre no painel de tarefas do Office para desktop e no Office Online. Se ele tentar acessar uma URL que não está na lista, no Office para desktop, essa URL abre em uma nova janela do navegador (fora do painel de suplementos).

Observação

Há duas exceções para esse comportamento.

  • Isso se aplica somente ao painel raiz do suplemento. Se houver um iframe inserido na página de suplemento, o iframe poderá ser direcionado a qualquer URL, independentemente de estar listado no manifesto, mesmo no Office da área de trabalho.
  • Quando uma caixa de diálogo é aberta com a API displayDialogAsync , a URL passada para o método deve estar no mesmo domínio que o suplemento, mas a caixa de diálogo pode ser direcionada para qualquer URL, independentemente de estar listada no manifesto, mesmo no Office da área de trabalho.

Especificar domínios a partir dos quais as chamadas da API do Office.js são feitas

Seu suplemento pode fazer Office.js chamadas de API do domínio do ad-in referenciadas no arquivo de manifesto. Se você tiver outros iframes no suplemento que precisam acessar Office.js APIs, adicione o domínio dessa URL de origem ao arquivo de manifesto. Se um iframe com uma fonte não listada no manifesto tentar fazer uma chamada de API Office.js, o suplemento receberá um erro negado por permissão.

Confira também