PRODUCT
Follow

Overview

The manifest ad data is a set of 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 predefined elements are added to the config.js file that is part of the Workspace.

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

The manifest data can include the following ad elements:

  • Ad format

  • Ad name

  • Banner settings

  • Single expandable settings

  • Click-through URLs

  • Panels

  • Custom interactions

Note

Note: Ad settings in SAS override settings in the config.js file.

Manifest Data Parameters

format

Ad format name.

Value

Format Name in SAS

standardBanner

Standard Banner

richMediaBanner

HTML5 Rich-Media Banner

expandableBanner

HTML5 Expandable Banner

singleExpandableBanner

HTML5 Single Expandable Banner

adFormatName

Ad format name as displayed in SAS. It is not recommended to use this parameter, as format names may vary over the time.

adFormatID

Ad format identifier. The adFormatID value is applied if both adFormatName and adFormatId parameters are used in the manifest file.

Format Name

Format ID

Standard Banner

42

HTML5 Rich-Media Banner

38

HTML5 Expandable Banner

43

HTML5 Single Expandable Banner

39

Adhesion

10328

Billboard

10342

Deluxe Banner

10366

Deluxe Expandable

10430

Immersive Takeover

10350

Interstitial

10355

Page Peel

10322

Parallax Reveal

10272

Pushdown

10360

Scroll Reveal

10324

Simple Skin

10438

Sticky Scroller

10379

Vertical Video

10389

Video Expandable

10339

name

The ad name, which will be generated in SAS, can be a string up to 300 characters and can include alphanumeric and special characters. Name uniqueness is validated once the ad is created in SAS.

defaultBanner

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

The banner properties are defined in the banners parameter.

polite

Enables you to select the type of download mode options for the ad.

Value

Description

instant

Loads ad simultaneously when the page content loads.

defaultImage

Displays the default image when the page content loads.

transparent

Displays a transparent lightweight blank image when the page content loads.

banners

This parameter contains an array with one or more banner attributes stored in individual objects. It also contains the clipping settings for HTML5 Single Expandable Ads. Each object may contain the following parameters.

Field

Description

name

User-defined banner name.

asset

HTML file of the banner according to its relative path in the Workspace.

width

Integer value representing the banner width in pixels.

height

Integer value representing the banner height in pixels.

defaultImage

Desired backup image file according to its relative path in the Workspace.

expansionParams

Contains an object with the Single Expandable expansion parameters:

  • x: Left offset of the collapsed state.

  • y: Top offset of the collapsed state.

  • width: Width of the expanded state.

  • height: Height of the expanded state.

panels

This parameter contains an array with one or more panel attributes stored in individual objects. Each object may contain the following attributes.

Field

Description

Values

name

Panel name. This value must be unique if multiple panels are defined.

N/A

asset

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

Panel width in pixels.

N/A

height

Panel height in pixels.

N/A

x

Integer value representing X coordinates of the panel position.

N/A

y

Integer value representing Y coordinates of the panel position.

N/A

autoExpand

Auto-expand properties and triggers for the panel.

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

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

  • true

  • false

positionType

Panel position type.

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

  • pageRelativePixels: Panel is positioned relative to the webpage’s top-left corner in pixels.

  • pageRelativePercentage: Panel is positioned relative to the webpage’s top-left corner in percentage.

clickThrough

Ad’s click-through URL and its attributes.

Field

Description

Value

url

Ad's click-through 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 click-through URL will open.

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

  • true

  • false

showAddressBar

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

  • true

  • false

customInteractions

This parameter contains an array with an object for each custom interaction. Each object may contain the following attributes.

Field

Description

Values

name

Custom interaction name.

Must be a string with no blank spaces or special characters.

reportingName

Custom interaction label that is displayed in the SAS Analytics reports.

This must be a string.

type

Interaction type.

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

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

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

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

includeInRate

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

  • true

  • false

closePanels

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

  • true

  • false

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://.

Variables

  • The Variables array can contain a list of key-value pairs; so the variables of the custom format are automatically populated in SAS.

  • The Manifest file key name must match the format key name which is not the same as the variable display 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. 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.

  • The Manifest file variable values override the default ad values after the Manifest file is assigned to the ad.

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

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

  • Variable values can include boolean (in lowercase), integers, strings, and float types. All variable values should be entered as string with quotes.

Example

This example shows the content of one config.js file.

define({
    "adFormatId": "43",
    "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.acme.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": "Build_and_Price",
        "reportingName": "Build and Price",
        "type": "clickThrough",
        "includeInRate": true,
        "closePanels": true,
        "landingPageUrl": "http://www.acme.com/",
        "target": "newWindow"
    }, {
        "name": "Search_Inventory",
        "reportingName": "Search Inventory",
        "type": "clickThrough",
        "includeInRate": true,
        "closePanels": true,
        "landingPageUrl": "http://www.acme.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)"
   }]
});
Was this article helpful?
2 out of 2 found this helpful
Have more questions? Submit a request

Comments