Manifesto de Suplementos do Office
Todos os suplementos do Office têm um manifesto. Existem dois tipos de manifestos:
- Manifesto apenas de suplemento: este é o único tipo de manifesto que é atualmente suportado para suplementos que não são do Outlook. O formato é XML. Este tipo de manifesto não pode ser utilizado para uma aplicação que combina um suplemento com outro tipo de extensão da plataforma do Microsoft 365.
- Manifesto unificado para o Microsoft 365: esta é uma versão expandida do manifesto formatado em JSON que tem sido utilizado durante anos como manifesto para o Teams Apps. Os suplementos que utilizam este manifesto podem ser combinados com outros tipos de extensões da plataforma do Microsoft 365 numa única aplicação que é instalável como uma unidade.
Observação
Os Suplementos do Office que utilizam o manifesto unificado do Microsoft 365 são diretamente suportados no Office na Web, no novo Outlook no Windows e no Office no Windows ligado a uma subscrição do Microsoft 365, Versão 2304 (Compilação 16320.00000) ou posterior.
Quando o pacote de aplicação que contém o manifesto unificado é implementado no AppSource ou no Centro de Administração do Microsoft 365 , se o manifesto tiver uma propriedade "alternateIcons" válida, é gerado um manifesto apenas de suplemento a partir do manifesto unificado e armazenado. Este manifesto apenas de suplemento permite que o suplemento seja instalado em plataformas que não suportam diretamente o manifesto unificado, incluindo o Office no Mac, o Office em dispositivos móveis, versões de subscrição do Office no Windows anteriores à 2304 (Compilação 16320.00000) e versões perpétuas do Office no Windows.
O resto deste artigo é aplicável a ambos os tipos de manifesto.
Dica
- Para obter uma descrição geral específica do manifesto apenas do suplemento, consulte Suplementos do Office com um manifesto apenas de suplemento.
- Para obter uma descrição geral específica do manifesto unificado, consulte Suplementos do Office com o manifesto unificado do Microsoft 365.
- Se estiver familiarizado com o manifesto apenas do suplemento, o artigo Comparar o manifesto apenas do suplemento com o manifesto unificado do Microsoft 365 explica o manifesto unificado ao compará-lo com o manifesto apenas do suplemento.
O ficheiro de manifesto de um Suplemento do Office descreve como o seu suplemento deve ser ativado quando um utilizador final o instala e utiliza com documentos e aplicações do Office.
Um ficheiro 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
Todos os URIs de imagem, como os utilizados para comandos de suplementos, têm de suportar a colocação em cache na produção. O servidor que aloja a imagem não deve devolver um Cache-Control cabeçalho que especifique no-cache, no-storeou opções semelhantes na resposta HTTP. No entanto, quando estiver a desenvolver o suplemento e a fazer alterações aos ficheiros de imagem, a colocação em cache pode impedi-lo de ver as suas alterações, pelo que a utilização Cache-Control de cabeçalhos é aconselhável no desenvolvimento.
Todos os URLs para ficheiros de código ou conteúdo no suplemento devem estar protegidos 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 planeia executar o seu suplemento no Office na Web ou publicar o seu suplemento no AppSource, este tem de 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 submetidos ao AppSource também têm de incluir um 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 na Web ou no novo Outlook no Windows, o seu painel de tarefas pode ser navegado para qualquer URL. No entanto, nas plataformas de ambiente de trabalho, se o seu suplemento tentar aceder a um URL num domínio diferente do domínio que aloja a página inicial (conforme especificado no ficheiro de manifesto), esse URL é aberto numa nova janela do browser fora do painel de suplementos da aplicação do Office.
Para substituir este comportamento (de ambiente de trabalho do Office), especifique cada domínio que pretende abrir na janela do 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 existir um iframe incorporado na página do suplemento, o iframe pode ser direcionado para qualquer URL, independentemente de estar listado no manifesto, mesmo no Office para ambiente de trabalho.
- Quando é aberta uma caixa de diálogo com a API displayDialogAsync , o URL transmitido ao método tem de estar no mesmo domínio que o suplemento, mas a caixa de diálogo pode ser direcionada para qualquer URL, independentemente de estar listado no manifesto, mesmo no Office de ambiente de trabalho.
Especificar domínios a partir dos quais as chamadas da API do Office.js são feitas
O suplemento pode fazer Office.js chamadas à API a partir do domínio do suplemento referenciado no ficheiro de manifesto. Se tiver outros iframes no seu suplemento que precisem de aceder Office.js APIs, adicione o domínio desse URL de origem ao ficheiro de manifesto. Se um iframe com uma origem não listada no manifesto tentar fazer uma chamada à API Office.js, o suplemento receberá um erro de permissão negada.