This instruction guide assumes the creative file has been developed in the Adobe Edge creative platform. Please ensure all creative animation and interactivity is fully functional at this point. We recommend testing on a mobile device.
This guide provides instructions for building a rich media banner with one click-through. The same process can be applied for banner units with multiple clickthroughs as well.
Part I. Set up Your Click-Through(s):
Select your click-through hotspot/button on the stage or layer and right-click. At the bottom of the drop-down menu, you will see “Open actions for X”, where “X” is the name of your hotspot/button.
Set up a function for your click-through link. Select the touchend event.
- Type in your click-through code:
replacing 'myKeyName' with the keyname you want to have appear in Servo reporting.
Note: Only alphanumeric and the underscore characters are supported. The Keyname must begin with a letter.
- Create the servo.config.js file, referencing the keyname you put within your servo.clickthrough call above, and have that file at the root of your file structure.
Please reference Servo’s Creative API documentation, found here, regarding the servo.config.js file.
Download a sample servo.config.js file at the bottom of the article.
Part II. Add Servo API and servo.config.js Call to Your HTML File
- Include the the servo.config.js file in your index.html file (and your expandable.html file if applicable):
Below is an example of proper implementation for these two files:
To test the click-through locally, ensure the servo.config.js file is located at the root of the folder structure, where the index.html (and expandable.html if applicable) file also lives.
Read more about this here and here.
Part III. Export Your HTML Creative from Edge
Go to File > Save As, save the file as “index.html” for the banner (or initial banner if this is an expandable creative), and “expandable.html” for your expand portion. Read more about this here. This naming convention will allow the Servo API to function properly.
Once you have chosen your location, click Save.
Edge will output with the following:
“images” folder (if applicable)
When creating your ad bundle zip file to upload to Servo, you may remove the .an file, as that is not required in Servo (but you will still want to keep this file on hand in case additional edits are needed later). Please make sure to include everything else as well as your servo.config.js file when uploading your your zipped ad bundle to Servo.
Part IV: Upload to Servo
Zip the entire folder and upload the zip file to Servo.
Read more about How to Upload Rich Media Creative to Servo.
For additional Servo Rich Media API video, data, or engagement tracking, please read Servo’s Creative API Documentation.