Declare marketing assets for server apps

Apps listed in the Atlassian Marketplace require visual marketing assets like a logo and screenshots. Customers in the Marketplace use these assets to quickly assess what your app does, and learn how it interacts with Atlassian host products. You can package visual marketing assets in your JAR. You should place these images in an images directory. Then, you can reference these assets in a file titled atlassian-plugin-marketing.xml. You can avoid manually filling out many visual marketing fields when you include a atlassian-plugin-marketing.xml in your JAR submission to the Atlassian Marketplace.

This page describes how to reference visual marketing assets in a file you can create, called atlassian-plugin-marketing.xml.

Declare marketing assets in atlassian-plugin-marketing.xml

This section describes how to reference your visual assets in a separate atlassian-plugin-marketing.xml file. The Atlassian Marketplace automatically detects your visual assets, and matches them to corresponding highlight and screenshot fields in the Create app form. Assets referenced in this file are only used on the Atlassian Marketplace.

**Important: **

• Name your marketing descriptor atlassian-plugin-marketing.xml .
• Store this file under src/main/resources at the same level with the regular descriptor file, atlassian-plugin.xml.
• Keep your images in an images  directory within the JAR. 

The following is a table describing the visual assets you can describe in this file. 

1
2
<logo image="images/01_logo.jpg"/>

1
2
<banner image="images/02_banner.jpg"/>

1
2
<highlights>
    <highlight image="images/03_highlight1_ss.jpg" cropped="images/04_highlight1_cropped.jpg"/>
    <highlight image="images/05_highlight2_ss.jpg" cropped="images/06_highlight2_cropped.jpg"/>
    <highlight image="images/07_highlight3_ss.jpg" cropped="images/08_highlight3_cropped.jpg"/>
</highlights>

1
2
<screenshots>
    <screenshot image="images/09_addl_ss1.jpg"/>
    <screenshot image="images/10_addl_ss2.jpg"/>
    <screenshot image="images/11_addl_ss3.jpg"/>
</screenshots>

Example of a complete marketing descriptor

1
2
<?xml version="1.0" encoding="utf-8"?>
<atlassian-plugin-marketing>
    <!--Describe names and versions of compatible products -->
    <compatibility>
        <product name="jira" min="4.0" max="4.4.1"/>
        <product name="bamboo" min="3.0" max="3.1"/>
    </compatibility>
    <!-- Describe your app logo and banner. The banner is only displayed in the UPM. -->
    <logo image="images/01_logo.jpg"/>
    <banner image="images/02_banner.jpg"/>
    <!-- Describe highlight and cropped highlight image assets, in order. -->
    <highlights>
        <highlight image="images/03_highlight1_ss.jpg" cropped="images/04_highlight1_cropped.jpg"/>
        <highlight image="images/05_highlight2_ss.jpg" cropped="images/06_highlight2_cropped.jpg"/>
        <highlight image="images/07_highlight3_ss.jpg" cropped="images/08_highlight3_cropped.jpg"/>
    </highlights>
    <!-- Describe additional screenshots you'd like listed on your app listing. -->
    <screenshots>
        <screenshot image="images/09_addl_ss1.jpg"/>
        <screenshot image="images/10_addl_ss2.jpg"/>
        <screenshot image="images/11_addl_ss3.jpg"/>
    </screenshots>
</atlassian-plugin-marketing>

UPM visual marketing materials

The regular descriptor file, atlassian-plugin.xml, references visual assets used in UPM. These assets overlap with the Atlassian Marketplace marketing materials. This file should include the following asset references inside the plugin-info tag: 

1
2
<vendor name="Atlassian Plugin Generator" url="http://example.com"/>

1
2
<param name="vendor-logo">images/vendorLogo.jpg</param>

1
2
<param name="vendor-icon">images/vendorIcon.jpg</param>

1
2
<param name="plugin-logo">images/pluginLogo.jpg</param>

1
2
<param name="plugin-banner">images/pluginBanner.jpg</param>

Example of the plugin-info section in the descriptor

1
2
<?xml version="1.0" encoding="utf-8"?>
<plugin-info>
    <description>Description of Example Marketing for Confluence</description>
    <version>1.0</version>
    <vendor name="Your Name Here" url="http://example.com"/>
    <param name="atlassian-licensing-enabled">true</param>
    <param name="plugin-icon">images/pluginIcon.jpg</param>
    <param name="plugin-banner">images/pluginBanner.jpg</param>
    <param name="plugin-logo">images/pluginLogo.jpg</param>
    <param name="vendor-logo">images/vendorLogo.jpg</param>
</plugin-info>

Example JAR content

The below assets are an example of the contents within an example JAR file:

• META-INF/MANIFEST.MF
• atlassian-plugin.xml
• atlassian-plugin-marketing.xml
• images/11_addl_ss3.jpg
• images/10_addl_ss2.jpg
• images/09_addl_ss1.jpg
• images/08_highlight3_cropped.jpg
• images/07_highlight3_ss.jpg
• images/06_highlight2_cropped.jpg
• images/05_highlight2_ss.jpg
• images/04_highlight1_cropped.jpg
• images/03_highlight1_ss.jpg
• images/02_banner.jpg
• images/01_logo.jpg