Manifiesto de complementos de Office

  • Artículo

Cada complemento de Office tiene un manifiesto. Hay dos tipos de manifiestos:

  • Manifiesto XML: Este es el único tipo de manifiesto que se admite actualmente para los complementos de producción. Como indica el nombre, es formato XML. Este tipo de manifiesto no se puede usar para una aplicación que combina un complemento con otro tipo de aplicación de Teams; es decir, algún otro tipo de extensión de la plataforma de Microsoft 365.
  • manifiesto unificado para Microsoft 365: Se trata de un manifiesto con formato JSON que se ha usado durante años como manifiesto para las aplicaciones de Teams. Se admite para complementos solo como versión preliminar actualmente y solo en Outlook para Windows. No se debe usar con un complemento de producción. Cuando se publica en disponibilidad general, los complementos que usan este manifiesto se pueden combinar con otros tipos de aplicaciones de Teams en una sola aplicación que se puede instalar como un conjunto de unidades.

El resto de este artículo se aplica a ambos tipos de manifiesto.

Sugerencia

El archivo de manifiesto de un complemento de Office describe cómo se debe activar el complemento cuando un usuario final lo instala y lo usa con documentos y aplicaciones de Office.

Un archivo de manifiesto permite que un complemento de Office haga lo siguiente:

  • Describirse a sí mismo mediante la proporción de su identificador, versión, descripción, nombre para mostrar y configuración regional predeterminada.

  • Especificar las imágenes que se usan como marca en el complemento y la iconografía para los comandos de complemento en la cinta de opciones de la aplicación de Office.

  • Especificar cómo se integra el complemento con Office, incluida la interfaz de usuario personalizada, como los botones de la cinta que cree el complemento.

  • Especificar las dimensiones predeterminadas solicitadas para complementos de contenido y el alto solicitado para complementos de Outlook.

  • Declarar los permisos que solicite la Complemento de Office, como leer o escribir en el documento.

Nota:

Si tiene previsto publicar el complemento para AppSource y hacer que esté disponible en la experiencia de Office, asegúrese de que cumple con las Directivas comerciales de certificación de mercado. Por ejemplo, para superar la validación, el complemento debe funcionar en todas las plataformas que sean compatibles con los métodos especificados (para más información, vea la sección 1120.3 y la página de disponibilidad y aplicación del complemento de Office).

Requisitos de hospedaje

Todos los URI de imagen, como los que se usan para los comandos de complemento, deben admitir el almacenamiento en caché en producción. El servidor que hospeda la imagen no debe devolver un Cache-Control encabezado que especifique no-cache, no-storeo opciones similares en la respuesta HTTP. Sin embargo, al desarrollar el complemento y realizar cambios en los archivos de imagen, el almacenamiento en caché puede impedir que vea los cambios, por lo que es aconsejable usar Cache-Control encabezados en el desarrollo.

Todas las direcciones URL de los archivos de código o contenido del complemento deben estar protegidas con SSL (HTTPS). Aunque no es estrictamente necesario en todos los escenarios del complemento, es muy recomendable utilizar un punto de conexión HTTPS para el complemento. Los complementos que no están protegidos por SSL (HTTPS) generan durante su uso errores y advertencias de contenido que no son seguros. Si tiene previsto ejecutar el complemento en Office en la Web o publicar el complemento en AppSource, debe estar protegido con SSL. Si el complemento tiene acceso a servicios y datos externos, debe estar protegido con SSL para garantizar la seguridad de los datos en tránsito. Los certificados autofirmados pueden usarse con fines de desarrollo y pruebas, siempre y cuando el certificado sea de confianza en la máquina local.

Procedimientos recomendados para enviar a AppSource

Asegúrese de que el identificador del complemento es un GUID válido y único. Hay varias herramientas de generador de GUID disponibles en la web que puede usar para crear un GUID único.

Los complementos enviados a AppSource también deben incluir una dirección URL de soporte técnico en el manifiesto. Para obtener más información, consulte Directivas de valoración para aplicaciones y complementos enviados a AppSource.

Especificar los dominios que quiere abrir en la ventana del complemento

Cuando se ejecuta en Office en la web, el panel de tareas se puede navegar a cualquier dirección URL. Sin embargo, en las plataformas de escritorio, si el complemento intenta ir a una dirección URL de un dominio distinto del dominio que hospeda la página de inicio (como se especifica en el archivo de manifiesto), esa dirección URL se abre en una nueva ventana del explorador fuera del panel de complementos de la aplicación de Office.

Para invalidar este comportamiento (escritorio de Office), especifique cada dominio que quiera abrir en la ventana del complemento del manifiesto. Si el complemento intenta ir a una dirección URL en un dominio que está en la lista, se abrirá en el panel de tareas de Office de escritorio y Office en la web. Si intenta ir a una dirección URL que no esté en la lista, en Office de escritorio, esa dirección URL se abre en una ventana nueva del explorador (fuera del panel de complementos).

Nota:

Hay dos excepciones a este comportamiento:

  • Se aplica solo al panel raíz del complemento. Si hay un iframe incrustado en la página del complemento, el iframe se puede dirigir a cualquier dirección URL independientemente de si aparece en el manifiesto, incluso en Office de escritorio.
  • Cuando se abre un cuadro de diálogo con la API displayDialogAsync , la dirección URL que se pasa al método debe estar en el mismo dominio que el complemento, pero el cuadro de diálogo se puede dirigir a cualquier dirección URL independientemente de si aparece en el manifiesto, incluso en Office de escritorio.

Especificar dominios de los que se hacen llamadas a la API de Office. js

El complemento puede realizar Office.js llamadas API desde el dominio del anuncio al que se hace referencia en el archivo de manifiesto. Si tiene otros iframes dentro del complemento que necesitan tener acceso a Office.js API, agregue el dominio de esa dirección URL de origen al archivo de manifiesto. Si un iframe con un origen que no aparece en el manifiesto intenta realizar una llamada API Office.js, el complemento recibirá un error de permiso denegado.

Recursos adicionales