PRODUCT
Follow

Overview

Important

Important Manifest data is only relevant for Sizmek Ad Suite.

Manifest data is metadata that contains ad settings including elements such as the banner information, panel names, expansion settings, backup image, custom interactions, and click-through URLs. These pre-defined elements are added to the config.js file that is part of the Workspace. The config.js file is scanned and extracted in the platform once a Workspace is uploaded and assigned to an ad, which relieves the user from manually configuring many of the ad settings in the platform.

Once you include the manifest data in your config.js, the platform extracts the data in its ad-related workflows, (for example, the Ads Page, the Ad Creation Wizard, or the API).

The manifest data includes the following ad elements:

  • Ad Format

  • Ad Name

  • Banner settings

  • Single Expandable settings

  • Click-through URLs

  • Panels

  • Custom Interactions

Sample Manifest Data

The following is an example of the manifest data.

Sample Manifest Data

define(
{
    "format": "expandableBanner",
    "name": "HTML_RM_Mobile_EXP_320x50",
    "defaultBanner": "Main_Banner",
    "defaultPanel": "expand_pnl_320x416",
    "banners": [
      {
        "name": "Main_Banner",
        "width": 320,
        "height": 50,
        "defaultImage": "images/320x50_DFLT.jpg"
      }
 ],
 "clickThrough": {
    "url": "http://www.sizmek.com/",
    "target": "newWindow",
    "showMenuBar": true,
    "showAddressBar": true
 },
 "panels": [
   {
    "name": "expand_pnl_320x416",
    "asset": "panel/HTML_320x50_EXP_PNL.html",
    "width": 320,
    "height": 416,
    "autoCollapse": "never",
    "delayedExpansion": false,
    "positionType": "bannerRelativePixels",
    "x": 0,
    "y": 0
   }
 ],
 "customInteractions": [
   {
    "name": "2015_Build_and_Price",
    "reportingName": "2015 Build and Price",
    "type": "clickThrough",
    "includeInRate": true,
    "closePanels": true,
    "landingPageUrl": "http://www.sizmek.com/",
    "target": "newWindow"
   },
   {
    "name": "2015_Search_Inventory",
    "reportingName": "2015 Search Inventory",
    "type": "clickThrough",
    "includeInRate": true,
    "closePanels": true,
    "landingPageUrl": "http://www.sizmek.com/",
    "target": "newWindow"
   },
   {
    "name": "Offer_Not_Found",
    "reportingName": "Offer Not Found",
    "type": "autoEvent",
    "includeInRate": false,
    "closePanels": false,
    "landingPageUrl": ""
   },
   {
    "name": "Open_Panel_Legal",
    "reportingName": "Open Panel Legal",
    "type": "userAction",
    "includeInRate": true,
    "closePanels": false,
    "landingPageUrl": ""
    }
  ],
  "Variables": [
  {
   "Key": "mdTransitionEffect",
   "Value": "easeOutCubic,2000",
   "_comment": "variable usage description (this data won't be picked up by the platform)"
   },
   {
    "Key": "mdMaxBannerWidth",
    "Value": "500",
    "_comment": "variable usage description (this data won't be picked up by the platform)"
   },
   {
    "Key": "mdVisibilityThreshold",
    "Value": "true",
    "_comment": "variable usage description (this data won't be picked up by the platform)"
   },
   {
    "Key": "mdAdhesionVisibilityTimeout",
    "Value": "12.5",
    "_comment": "variable usage description (this data won't be picked up by the platform)"
   }
 ]
}
);

Manifest Data Parameters

Important

Important Ensure that the manifest data only includes the fields that you want to configure. The platform does not support empty or null values since it will cause the conversion process to fail.

The manifest data parameters are described as follows:

format

Description

Ad format name.

Parameters

Value

Format Name in Platform

standardBanner

Standard Banner

richMediaBanner

HTML5 Rich-Media Banner

expandableBanner

HTML5 Expandable Banner

singleExpandableBanner

HTML5 Single Expandable Banner

Code Syntax Example

"format":"expandableBanner"

adFormatName

Description

Ad format name as displayed in the platform.

adFormatId

Description

ID of the ad format as displayed in the platform.

Guidelines

  • The format and adFormatId fields are identical.

  • We recommend using the adFormatId field instead of format as the ad format ID is unlikely to change.

  • AdFormatId is applied if both the adFormatName and the AdFormatId fields are used in the manifest file.

The following table lists the format name and it's correlating format ID.

Format Name

Format ID

Standard Banner

42

HTML5 Rich-Media Banner

38

HTML5 Expandable Banner

43

HTML5 Single Expandable Banner

39

Code Syntax Example

“adFormatId” : 43
“adFormatName” : “HTML5 Expandable Banner”

name

Description

User-defined name displayed in the platform.

Important

Important String can contain up to 300 characters and can include alphanumeric and special characters. Name uniqueness is validated once the ad is created in the platform.

Code Syntax Example

"name":"myExpandableBanner_300x250"

defaultBanner

Description: The name of the default banner in the ad. Responsive ads contain multiple banners, whereas non-responsive ads contain a single banner, which should be defined as the default banner.

The banner is defined in the banners object in addition to the default image which serves as the backup image.

Code Syntax Example

"defaultBanner":"main_banner"

defaultPanel

Description

Default panel of the ad. Relevant only for HTML5 Expandable Banners.

The actual panel settings are defined in the panels object. The banner is defined in the banners object.

Code Syntax Example

"defaultPanel":"expand1"

polite

Description

Ad's polite-loading settings.

Parameters

Value

Description

instant

Loads ad simultaneously when the page content loads.

defaultImage

Displays the default image.

transparent

Displays a transparent lightweight blank image.

Code Syntax Example

"polite":"defaultImage"

banners

Description

Banner attributes and the backup image asset used by the ad. Defines the panel clipping settings for HTML5 Single Expandable Ad. When building a responsive banner, the banners object can contain a list of banners.

Parameters

Field

Description

name

User-defined banner name.

asset

Banner should be placed in the root folder of the Workspace, preferably named index.html. As an asset, a banner is defined according to its relative path in the Workspace. For example, if the main banner is index.html and is located in the root of the Workspace, then the value entered in the manifest data should be index.html.

Important

Important The asset name and relative path are case-sensitive.

width

Integer value representing the banner width in pixels.

height

Integer value representing the banner height in pixels.

defaultImage

Define the default image, usually the back image of the ad, by including its relative path within the Workspace.

For example, if the backup image is images/backupImage.jpg in the Workspace, the value in the manifest data should be images/backupImage.jpg.

If there are multiple banners, you can define a specific default image for each banner unit.

Important

Important The asset name and relative path are case-sensitive.

banners: expansionParams

Description

Banner clipping and positioning options. The expansionParams object should be added to the manifest data if you are building an HTML5 Single Expandable Banner.

 

manifest_single_expandable_illustration.png

Parameters

Field

Description

x

The left offset (x-coordinate) of the collapsed-state rectangle relative to the expanded-state rectangle.

y

The top offset (y-coordinate) of the collapsed-state rectangle relative to the expanded-state rectangle.

width

The width of the expanded-state rectangle.

height

The height of the expanded-state rectangle.

"banners": [
    { 
        "name": "main_banner",
        "asset": "index.html",
        "width": 300,
        "height": 250,
        "defaultImage": "string",

         "expansionParams": {
            "x": 150,
            "y": 0,
            "width": 500,
            "height": "250
     }
   }
],

clickThrough

Description

Ad's clickThrough URL and it's attributes.

Parameters

Field

Description

Value

url

Ad's clickThrough URL.

The URL can contain up to 1,000 characters.

Use a URL scheme (protocol), for example: https://, mailto://,fb://.

target

Window location in which the clickThrough URL will open.

Supported values:

  • newWindow: Opens the landing page in a new browser window or a new tab.

  • currentFrame: Opens the landing page in the current iframe or iframe of the page.

  • top: Opens landing page on the top of the page.

showMenuBar

Boolean value that determines the appearance of the browser's menu bar in the landing page new window/tab.

Supported values:

  • True

  • False

showAddressBar

Boolean value that determines the appearance of the browser's address bar in the landing page new window/tab.

Supported values:

  • True

  • False

 "clickThrough": { 
    "url": "http://www.sizmek.com/",
    "target": "newWindow",
    "showMenuBar": true,
    "showAddressBar": false
},

panels

Description

Panel attributes used in HTML5 Expandable Banner ads. If the banner includes multiple panels, the panels object can contain a list of banners.

Parameters

Field

Description

Values

name

Panel name which must be unique if multiple panels are defined.

The name can contain up to 35 alphanumeric characters.

asset

The Asset serving as the panel is defined with a relative path to the location in the Workspace. For example, if the panel asset is panel1.html and is located under panels/panel1.html, the value used in the manifest data should be panels/panel1.html.

width

The panel width in pixels.

height

The panel height in pixels

autoExpand

Auto-expand properties and triggers for the panel.

Supported values:

  • mouseOver: Auto-expand the default panel when the mouse hovers over the banner.

  • never: Never auto-expand the panel

autoCollapse

Collapse properties and triggers for the panel.

Supported values:

  • never: Do not collapse the panel.

  • mouseOffAdd: Collapse the panel when the mouse does not hover over the panel.

  • mouseOffPanel: Auto-collapse panel when the mouse pointer does not hover over the panel.

delayedExpansion

Boolean value that defines whether auto-panel-expand should be delayed in approximately a second.

Supported values:

  • True

  • False

positionType

Panel position type.

Supported values:

  • bannerRelativePixels: The panel position is relative to the banner’s top-left corner.

  • pageRelativePixels: The panel is positioned relative to the webpage’s center.

  • pageRelativePercentage:The panel is positioned relative to the webpage’s top-left corner.

x

Integer value representing X coordinates of the panel position.

y

Integer value representing Y coordinates of the panel position.

"panels": [{
    "name": "panel1",
    "asset": "panels/panel1/index.html",
    "width": 512,
    "height": 410,
    "autoCollapse": "never",
    "delayedExpansion": false,
    "positionType": "bannerRelativePixels",
    "x": -212,
    "y": 130
}, {
    "name": "panel2",
    "asset": "panels/panel2/index.html",
    "width": 512,
    "height": 410,
    "autoCollapse": "never",
    "delayedExpansion": false,
    "positionType": "bannerRelativePixels",
    "x": -212,
    "y": 130
}, {
    "name": "panel3",
    "asset": "panels/panel3/index.html",
    "width": 512,
    "height": 410,
    "autoCollapse": "never",
    "delayedExpansion": false,
    "positionType": "bannerRelativePixels",
    "x": -212,
    "y": 130
}], 

customInteractions

Description

Custom interactions and interaction attributes in the ad.

Parameters

Field

Description

Values

name

Custom interaction name.

reportingName

Custom interaction label that is displayed in the SizmekAnalytics reports.

type

Interaction type.

Supported values:

  • autoEvent: Automatic Event Counter. Measures ad timeline events, such as watching an animation until the end.

    HTML5 API: AutomaticEventCounter.

  • userAction: User Action counter. Interaction is used to track different user action events, such as clicking buttons, playing with an ad part, or rolling over parts.

    HTML5 API: UserActionCounter.

  • clickThrough: Measures clicks when the interaction involves opening a new window.

    HTML5 API: clickthrough.

  • timer: Measures custom durations in the ad, for example, the amount of time a game was played

    HTML5 API: StartTimer, StopTimer.

includeInRate

A boolean value that defines whether to include the interaction in the Interaction Rate, and to influence the Interaction Rate metrics in reports.

Applicable only for userAction type. If not entered the default is true.

Supported values:

  • True

  • False

closePanels

Defines whether to close the ad's panels when the interaction is triggered.

Supported values:

Applicable for all types, except timer.

landingPageURL

Landing page to which the user will be directed when triggering the interaction.

The URL can include up to a 1,000 characters.

Use a URL scheme (protocol), for example: https://, mailto://,fb://.


"customInteractions": [
{
    "name": "User_Click_Credit_Card",
    "reportingName": "User Click Credit Card",
    "type": "clickThrough",
    "includeInRate": true,
    "closePanels": true,
    "landingPageUrl": "http://www.sizmek.com/"
}, {
    "name": "User_Click_Exit_Full_Screen",
    "reportingName": "User Click Exit Full Screen",
    "type": "userAction",
    "includeInRate": true,
    "closePanels": false,
    "landingPageUrl": ""
}, {
    "name": "Video_Completed",
    "reportingName": "Video Completed",
    "type": "autoEvent",
    "includeInRate": false,
    "closePanels": false,
    "landingPageUrl": ""
}, {
    "name": "Panel_Dwell",
    "reportingName": "Panel Dwell",
    "type": "timer",
    "includeInRate": false,
    "closePanels": true,
    "landingPageUrl": ""
}],

variables

You can add variables to your HTML5 ads on the ad level. The Variables object can contain a list of key-value pairs. The Manifest file parameters and the variable values override the default ad values after the Manifest file is assigned to the ad.

Guidelines and Rules

  • The Manifest file key name must match the format key name.

  • A key is ignored and not added to the ad, if the Manifest file includes a unique key that is not defined on the format level.

  • The last key is used in the Manifest file if the key appears more than once.

  • Variables that are embedded on the format level with default values will appear on the ad level even if they do not exist on in the Manifest file.

  • A variable is ignored if an error or conflict arises. The default values on the format level apply.

Variable Code Structure

Description

The variable key is defined in the platform. This key must match the key used on the platform.

Code Syntax Example

Variable values can include boolean, integers, strings, and float types.

Note

Note Boolean values are a data type and use lowercase true and false values.

"variables": [
  {
    "key": "varKey1",
    "value": "Some String"
   },
  {
    "key": "varKey2",
    "value": "500"
  },
  {
    "key": "varKey3",
    "value": "true"
  },
  {
    "key": "varKey4",
    "value": "12.5"
  }
] 

Adding the Manifest Data to Your Config.js File

Prerequisite

Ensure you are using valid manifest data.

Procedure

  1. Add the config.js file to the root of your Workspace.

  2. Edit the manifest data to reflect the ad settings you want to define.

  3. Zip the Workspace.

  4. Upload the Workspace to the platform.

Note

Note To validate the JSON code, copy the JSON section, (without the “define();“ wrapper), to an online JSON validator, such as http://codebeautify.org/jsonviewer, http://json.parser.online.fr/ or http://www.jslint.com/.

Frequently Asked Questions

Q1: Is there a way to easily import HTML5 ads from MDX2.0?

Q2: Can I make changes to the ad settings after the manifest settings are applied?

  • A2: This question varies depending on where you created your ads:

    • Ads created in the Ads page: When a Workspace is assigned to an ad in the Ads page, the ad settings reflect the manifest settings. Users can make changes that will override the manifest settings.

    • Ads created in the Ad Creation Wizard: The ad creation wizard will utilize Workspaces which include manifest data. Settings that are updated in the wizard will override the manifest's default settings.

    • Ads created in the API: You can determine if the manifest settings will override the request settings. For more information, see the API Portal.

Q3: Why don't the custom Interactions that I added to the manifest data show in the ad?

  • A3: Custom Interactions must be coded on the creative level. If the manifest data includes custom interactions that were not coded in the creative, they will not be displayed in the ad.

Q4: I downloaded a template from the Sizmek Showcase and the manifest data is missing. Is that okay?

  • A4: The manifest data is a new feature. We will be gradually adding Manifest data to frequently used templates.

Q5: There are currently only four formats that support the usage of manifest data. What about Billboard or other custom formats?

  • A5: This requires advanced capabilities that are being developed and will be available in the near future.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments