Requirements for HTML5 Banner Files

Greta
Greta
  • Updated

Build HTML5 banners based on Adform's specifications.

Each HTML5 banner prepared for the Adform system should be compressed as a .zip file with the following files:

  • A metadata file called manifest.json: The manifest.json file defines banner parameters (such as name, description, dimensions, events, click tags, and source). Adform parses and registers these parameters in the Adform system once you upload the banner's .zip file as an asset.

    An example manifest.json file includes:

    {
        "version": "1.0", 
    
        "title": "300x250 Example Banner", 
        "description": "optional string",  
    
        "width" : "300", 
        "height": "250", 
    
        "events": {
            "enabled": 1, 
            "list": { 
                "1": "myEventName1",
                "2": "myEventName2",
                "3": "myEventName3"
            }
        },
    
        "clicktags": {
            "clickTag": "https://www.test.com",
            "clickTag2": "http://www.adform.com"
        },
    
        "source": "yourbanner.html"
    }

    You can enable (1) or disable (0) events for your banner in the manifest.json file. If you use custom events, you must define them in an events list section in the manifest.json file. If your banner has multiple clickTag instances, you must define all of them in a clickTag section on a manifest.json file.

  • An HTML source file the name of which matches the title defined in a manifest.json file.

    Note

    A manifest.json file and a defined main HTML source should be located in the root of the .zip file. Otherwise, Adform can't extract the zipped content correctly and notifies you with an error when uploading the .zip file. Also, Adform measures the total banner 'weight' when the file is unzipped.

  • JavaScript sources: such as jQuery, GreenSock animation libraries and components, and so forth if they are used in a banner. You can include libraries as local assets or as external sources.

  • Other assets: such as images, fonts, XML files, and so forth from local directories or from external paths.

Was this article helpful?

/
How we can make it better?

Thank you for your feedback!