Last updatedAug 5, 2019

Declaring 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.

Declaring 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. 

AssetDimensionsDescription

App logo

144x144px PNG/JPG

Reference your app logo. Use transparent or bounded, chiclet-style backgrounds. Marketplace automatically creates an app icon from your logo.

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

App banner

1120x548px PNG/JPG

Include your app name, your vendor name, and brief text about your app's functionality. Users see this banner displayed in the UPM when they browse the Marketplace from their Atlassian host product.

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

Highlight images

1840x900px PNG/JPG (full size)


580x330px PNG/JPG (cropped)

Full-size: Illustrate your highlight with a screenshot. High-definition display screenshots encouraged.

Cropped: Provide a cropped version of your screenshot. This image is displayed prominently on the app details page.

1
2
3
4
5
<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>

Additional screenshots

1840x900px PNG/JPG

Provide additional screenshots to help illustrate your app's capabilities.

1
2
3
4
5
<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
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?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: 

AssetDimensionsDescription
Vendor name & URL

Use your company name or, if an individual, your own name. Be mindful of trademark and copyright guidelines. Short names are preferred.

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


Vendor logo

72x72px PNG/JPG/GIF (No animated GIFs)

Reference a large, clear, front-facing image. Your logo should be relevant to your vendor name. This appears on your vendor page in the Marketplace.

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


Vendor icon

16x16px PNG/JPG/GIF (No animated GIFs)

Reference a smaller version of your vendor logo. This appears in the sidebar and top-ranked lists. If your logo doesn't scale down well, create an additional thumbnail image. In the future, your logo may be scaled to be your vendor icon.

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


App logo

144x144px PNG/JPG

Reference logo with a transparent or bounded, chiclet-style background. Marketplace automatically creates an app icon from your logo.

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


App banner

1120 x 548px  PNG/JPG

Include your app name, your vendor name, and brief text about your app's functionality. Users see this banner displayed in the UPM when they browse the Marketplace from their Atlassian host product.

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

Example of the plugin-info section in the descriptor

1
2
3
4
5
6
7
8
9
10
11
<?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