Манифест надстроек Office

  • Статья

Каждая надстройка Office имеет манифест. Существует два типа манифестов:

  • Манифест только надстройки. Это единственный тип манифеста, который в настоящее время поддерживается для надстроек, отличных от Outlook. Его формат — XML. Этот тип манифеста нельзя использовать для приложения, сочетающего надстройку с каким-либо другим расширением платформы Microsoft 365.
  • Унифицированный манифест для Microsoft 365. Это расширенная версия манифеста в формате JSON, которая использовалась в течение многих лет в качестве манифеста для приложений Teams. Надстройки, использующие этот манифест, можно сочетать с другими типами расширений платформы Microsoft 365 в одном приложении, которое можно установить как единое целое.

Примечание.

Надстройки Office, использующие единый манифест Microsoft 365, поддерживаются непосредственно в Office в Интернете, в новом Outlook для Windows и в Office для Windows, подключенных к подписке Microsoft 365 версии 2304 (сборка 16320.00000) или более поздней.

Если пакет приложения, содержащий унифицированный манифест, развертывается в AppSource или Центре администрирования Microsoft 365 , то, если манифест имеет допустимое свойство alternateIcons, из единого манифеста создается только манифест надстройки и сохраняется. Только этот манифест надстройки позволяет устанавливать надстройку на платформах, которые не поддерживают унифицированный манифест напрямую, включая Office для Mac, Office на мобильных устройствах, версии Office для Windows по подписке до 2304 (сборка 16320.00000) и бессрочные версии Office в Windows.

Оставшаяся часть этой статьи применима к обоим типам манифестов.

Совет

В файле манифеста надстройки Office описывается, как должна активироваться надстройка, когда пользователь устанавливает ее и использует ее с документами и приложениями Office.

Файл манифеста позволяет надстройке Office выполнять следующие действия:

  • предоставлять идентификатор, версию, описание, отображаемое имя и языковой стандарт по умолчанию.

  • указывать изображения, используемые для фирменного оформления надстройки, и значки, используемые для команд надстройки на ленте приложения Office;

  • указывать, как надстройка интегрируется с Office, включая создаваемые ею элементы пользовательского интерфейса, например кнопки на ленте;

  • определять запрошенные размеры по умолчанию для контентных надстроек, а также запрошенную высоту для надстроек Outlook;

  • объявлять разрешения, в которых нуждается надстройка Office, например чтение или запись документа;

Примечание.

Если вы планируете опубликовать надстройку в AppSource и Office, она должна соответствовать Политикам сертификации коммерческого рынка.  Например, она должна работать на всех платформах, поддерживающих определенные вами методы. Дополнительные сведения см. в разделе 1120.3 и на странице с информацией о доступности для платформ и приложений Office.

Требования к размещению

Все URI образов, например используемые для команд надстроек, должны поддерживать кэширование в рабочей среде. Сервер, на котором размещено изображение, не должен возвращать заголовок, указывающий Cache-Controlno-cache, no-storeили аналогичные параметры в HTTP-ответе. Однако при разработке надстройки и внесении изменений в файлы изображений кэширование может препятствовать просмотру изменений, поэтому при разработке рекомендуется использовать Cache-Control заголовки.

Все URL-адреса для файлов кода или содержимого в надстройке должны быть защищены SSL (HTTPS). Использовать конечную точку HTTPS для надстройки не обязательно, но настоятельно рекомендуется. Надстройки без SSL-защиты (HTTPS) выдают предупреждения о небезопасном контенте и ошибки во время использования. Если вы планируете запустить надстройку в Office в Интернете или опубликовать ее в AppSource, она должна быть защищена SSL. Если надстройка получает данные из внешнего источника, она должна использовать SSL-соединение для защиты данных при передаче. Самозаверяющие сертификаты можно использовать для разработки и тестирования, если они добавлены в список доверенных сертификатов на локальном компьютере.

Рекомендации по отправке решений в AppSource

Убедитесь, что идентификатор надстройки представляет собой допустимый и уникальный GUID. В Интернете доступно множество генераторов, с помощью которых можно создать уникальный GUID.

Надстройки, отправленные в AppSource, также должны содержать URL-адрес поддержки в манифесте. Дополнительные сведения см. в статье Политики проверки для приложений и надстроек, отправляемых в AppSource.

Укажите домены, которые необходимо открыть в окне надстройки

При запуске в Office в Интернете или Outlook в Windows область задач можно перейти по любому URL-адресу. Однако на классических платформах, если надстройка пытается перейти по URL-адресу в домене, отличном от домена, в котором размещена начальная страница (как указано в файле манифеста), этот URL-адрес открывается в новом окне браузера за пределами области надстройки приложения Office.

Чтобы переопределить это поведение (классический Office), укажите каждый домен, который нужно открыть, в окне надстройки манифеста. URL-адреса в доменах из списка будут открываться в области задач как в классическом Office, так и в Office в Интернете. URL-адреса в доменах не из списка будут открываться в новом окне браузера (не в области надстроек) в классическом Office.

Примечание.

Из этого правила есть два исключения.

  • Это относится только к корневой области надстройки. Если на странице надстройки есть iframe, он может быть направлен на любой URL-адрес, независимо от того, указан ли он в манифесте, даже в классическом Office.
  • При открытии диалогового окна с помощью API displayDialogAsync URL-адрес, передаваемый методу, должен находиться в том же домене, что и надстройка, но затем диалог может быть направлен на любой URL-адрес независимо от того, указан ли он в манифесте, даже в классическом Office.

Указание доменов, из которых выполняются вызовы API Office.js

Надстройка может выполнять Office.js вызовы API из домена надстройки, на который ссылается файл манифеста. Если у вас есть другие iframes в надстройке, которым требуется доступ Office.js API, добавьте домен исходного URL-адреса в файл манифеста. Если iframe с источником, не указанным в манифесте, пытается выполнить вызов API Office.js, надстройка получит ошибку "Отклонено в разрешении".

См. также