Response
Note: The response is made in JSON format.
Response Parameters
Type
In the response, the "type" field sets what ad format is being used. It can be any one of the following:
bannersticky_bannerpopunderinstant_messagemobile_instant_messagenative_adoutstream_video
Impression Tracking
In order to record impressions for an ad, the response contains a field called "impressions". This field contains a URL, unique to that ad, that records when an impression takes place.
The best way to use this impression URL is to GET it in the user's browser.
One way to achieve this is to:
Add
<img src="IMPRESSION_TRACKER_URL" width="0" height="0">to the page where the ad will be displayed.- The IMPRESSION_TRACKER_URL is the URL returned in the "impression" field of the response.
Banner
Zones
| Parameter | Description |
|---|---|
| idzone | The ID of the ad zone. |
| type | The ad format used, e.g. banner. |
Data
| Parameter | Description |
|---|---|
| url | The URL that the ad directs to. |
| impression | The URL of the impression tracker. |
| image | The original image uploaded for the ad. |
| width | The width of the ad in pixels. |
| height | The height of the ad in pixels. |
| optimum_image | In an image banner, if the creative uploaded is an animated GIF, this is the optimized MP4 version of it that is created for use in the ad. |
| media | This shows which type of banner this is: Image, HTML, or video: This should be img_banner, html_banner, or video_banner respectively. |
| variation_fields | Contains the information of the customizable fields. tag: Field Identifier; value: Value associated with the field that will be displayed |
Banner Response Examples: JSON
Image Banner
{
"zones": [
{
"idzone": 1111111,
"type": "banner",
"data": {
"url": "http://main.example.com/click.php?data=H4sIAAAAAAAAAyVOu04DMRD8lTRprX14bW9JQ0PBN6xzPlGAgCToQJqPx7nTTrGa0TxOyELNnKCJuWX3yqpVBW_3.9ftrE9neZ7Yti3FekuXzw8ABHBhKmoujuUa33H9O0RJ3JJkSmxALs3YJUNrqbkYjNpkGQKWmWIFUKJfMQI_UqMvY20_jukTVOZVuXr3EcrlYqNXW6lHjl6G1t3T32PiGEbzTtjp46Y7F27Hp1ltHz.JXZ31j96M1xdQzRbNJbxE1EJhbfWL8bLQCBvyD4rI3QwpAQAA",
"impression": "http://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAAzVPS05DMQy8Chdo5PEnn+5YsGCL4ADJa7ICIYqQiuTD4z5ax9HEI2fGZmIcCAfoA7Wj8ZGac0JNrJRg/vz66Ao/nftXP/9+p+3zw3NRLbhDVZFcXErU2dyoujJVa+Saq6GxOtjZLTt5EBxAiUiAqq0ViBRhB5E/vb3sF47EDMQvIbqwUVDXUVBrQraUEzRkw+oqdiHv4zRX/WlegCUobbTZBXmzOYotGl37yFNKCJGP9x65L0P/J4nlcHW+Ex4imsPh9hYV8wjynYnY98Gte81yosm2lswFmW2jPBsv07YQw/0B+rSsfmgBAAA=",
"image": "http://static.example.com/library/674471/66c5e562a8a324a649c05a52bb03b65be3f0882a.png",
"width": 300,
"height": 250,
"media": "img_banner",
"variation_fields": [
{
"tag": "title",
"value": "Test"
},
{
"tag": "description",
"value": "description test"
},
{
"tag": "brand",
"value": "exads"
},
{
"tag": "cta",
"value": "Click now!"
}
]
}
}
]
}
HTML Banner
{
"zones": [
{
"idzone": 2222222,
"type": "banner",
"data": {
"html": "\n<div id=\"example_id\">\nExample HTML Ad!\n</div>\n",
"impression": "https://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAAz1OW2oDMQy8Si8Qo7Fky8p3+18IPYDteqGwJYGkkA8dvt7dUj1AjGY0ihRxIpwgL2Rn4XMiR0khRg0REsDF3y7vTn4b69f9tv7cw+PqauxJPGWPouIgN1h2jazFET1uK3I2cGZLc6RApMmN/OPyujdmxikpzwkCuw1KCcgp5ACRqZqnnZ5T7QosDLVmozJyT6NpWqhVqS0P1o3oba2zQr9+b46Hq8hh9Ac4M2cjHDMAY/YZ5DsyY//8n11qtiy0LJU/e2Xl0a3FUqlq70q/g8aBP0ABAAA=",
"width": 300,
"height": 250,
"media": "html_banner",
"variation_fields": [
{
"tag": "title",
"value": "Test"
},
{
"tag": "description",
"value": "description test"
},
{
"tag": "brand",
"value": "exads"
},
{
"tag": "cta",
"value": "Click now!"
}
]
}
}
]
}
Video Banner
{
"zones": [
{
"idzone": 4444444,
"type": "banner",
"data": {
"url": "http://main.example.com/click.php?data=H4sIAAAAAAAAAyVPy4rbQBD8lb34GNHz1Oi4EBaDHe3itWRHt3kpWWLNjGTJOKE_PmOZbuimqruKekFOQVaMIxTA8Pc8p.uGvW7oW.45LlNhdPhlpngtbBweMHv7chv23d.jvXzZP2RDpU1DRmJ0H9vabD.O.23dlFdqxv1kktasIfTcfpK_yxwvy.AO.93ox5Y08zR24bgMwf2QLUyTTok1x1ND_p2WOFxjiqPbyQ6mdP5cLs.jdO6kMeoUFtfV9f1Qdy65WzjU56m9pa6971M4hnS.HX7KlgbqA7U.9uw9K.X3cWRZym7p6zdEBEQiCUgOgjJMcQox.EdQpAVRBeVQEIHIZVkJkICsUhVwiQJURglSJDSLEEQGcKfisWZNbZzv1VKhEpkvCekZKStTec2ItMKbUvRgNNdGelauP.aic6_W2Q6yq2JQEXzBlX5WVuGSqOfGOBNrhAysrJDr4Pi.Q2l6kB6ctbLKNlaUXnvOcwiheleq__CkLqj3AQAA",
"impression": "http://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAAz1PSU4DQQz8Ch9Iq7x1u3NDIgeuQB7Qk+k5QYKQkHLw47FGEbYP5a3KZjAdQAfSJ6Ij/KgSXMgLKwpZvH48h1J8336ut+ssl9tXsFUWjwYR9vBmaB7SvUNrGDyUUbtoaG3dUBHEwUGBcEuIkILTwTKL0/ktzu8vgeLkLWc4BLiz5dKuTe6FqpVaSDWz0NzHHTGWdW7+26MRbUKtL30OoXqxuTTbsAwdS53SduHlc2Ts5yPvQn7mgp6tgqq8C+PhSaY1lR5YVCzSEHslzer/bJLZ2upl+jbHyoJGa9u20W0Mn75Y+wNJJUoPYQEAAA==",
"video": "http://static.example.com/library/256238/906f02361f3cd12043514304c777ed489599f637.mp4",
"width": 300,
"height": 250,
"media": "video_banner",
"variation_fields": [
{
"tag": "title",
"value": "Test"
},
{
"tag": "description",
"value": "description test"
},
{
"tag": "brand",
"value": "exads"
},
{
"tag": "cta",
"value": "Click now!"
}
]
}
}
]
}
Sticky Banner
Zones
| Parameter | Description |
|---|---|
| idzone | The ID of the ad zone. |
| type | The ad format used, e.g. sticky_banner. |
Data
| Parameter | Description |
|---|---|
| url | The URL that the ad directs to. |
| impression | The URL of the impression tracker. |
| image | The original image uploaded for the ad. |
| optimum_image | In a sticky banner, if the creative uploaded is an animated GIF, this is the optimized MP4 version of it that is created for use in the ad. |
| width | The width of the ad in pixels. |
| height | The height of the ad in pixels. |
| frequency_period | How often in minutes the ad shows. |
| v_pos | The vertical position of the ad. |
| h_pos | The horizontal position of the ad. |
| media | This shows which type of banner this is: Image, HTML, or video: This should be img_banner, html_banner, or video_banner respectively. |
Sticky Banner Response Example: JSON
{
"zones": [
{
"idzone": 4204610,
"type": "sticky_banner",
"data": {
"url": "http://main.example.com/click.php?data=H4sIAAAAAAAAAz1Qy4rbQBD8FV98jOie9xwNy.LgzVokkmx808tsQLIeI4Ex_fHpsZPQA1NVU11NjxIejXAEiaavZRnDVu624p3P_VsIX0k99JHK94Bb.QYaPJitMB2TZv69MAyCsXLWopIicsl86LhezSYoFqT3xvjIdLQLUAYhUsv0e7aL0DFs74yWOUYMTbr_rPZp9rH_zG0Q1XTRZanHcy7EKcshW7vm58dhaqcC82WeLrds7W9NcTIFzHM5jjLPTjk.TuvQh2EcpuZgLjCP51_c.COaxvMx9L3i5xVW.Rj6GScJYVIdPMYHzHIIzcFmNs3sMc1Tezt2nFFgUcWQN7sjAkKDyngHUtL_rUkk6BKhIEFN__6G_m5NGhyRQhKEggO0IQlwF5qzmBI5zbpFvEq0vvJtKdHUuq2svkJVqrIyrbRPb9WVfJ4TmQFtXsKGhQ09HbE4hue6F5JKaopuBa8eHh8v5DoeyLSqFhbKuuaNjPMtz1etr5pKOrTX.g.ZmJDwMAIAAA--",
"impression": "http://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAAzVOO25DMQy7Si8QQ3/L2Qp06dz2AParPaXImkGHj56LiDJEEJRFAsIL8AXoDeGKfFUOKuiFBApqfH6/h2Dcb4ly3P+CyatSUHOpHtyaWQshEEMIBU/e0Cin14rCFJjuUAsI1+QQpy9+vj72wxM1GOBBKeO+iO4FTYsVFAk55Vx7nKsVcTHWNtrsjHboHFUXjC592OS6rePWs3de+EcB9/MUvYTITzKzvzgLa2RBbCVrR34BY/2uLofrmg3XRGudh1uVCXosPOgJ0ouJzUoBAAA=",
"image": "http://example.com/library/328752/47de5c021bd0d00b59ff78456c69f601baac9925.gif",
"optimum_image": "http://example.com/library/328752/c990e4df40cc46482927c08350b2c960a59679e5.mp4",
"width": 300,
"height": 250,
"frequency_period": 1440,
"v_pos": "top",
"h_pos": "left",
"media": "img_banner"
}
}
]
}
Popunder
Zones
| Parameter | Description |
|---|---|
| idzone | The ID of the ad zone. |
| type | The ad format used, e.g. popunder. |
Data
| Parameter | Description |
|---|---|
| url | The URL that the ad directs to. |
Popunder Response Example: JSON
{
"zones": [
{
"idzone": 4031009,
"type": "popunder",
"data": {
"url": "http://syndication.example.com/splash.php?cat=508&idzone=4031009&type=8&p=blabla.com&block=0&el=&tags=+&scr_info=&sub="
}
},
{
"idzone": 4031013,
"type": "popunder",
"data": {
"url": "http://syndication.example.com/splash.php?cat=508&idzone=4031013&type=8&p=blabla.com&block=0&el=&tags=+&scr_info=&sub="
}
}
]
}
Instant Message
Zones
| Parameter | Description |
|---|---|
| idzone | The ID of the ad zone. |
| type | The ad format used, e.g. instant_message. |
Data
| Parameter | Description |
|---|---|
| url | The URL that the ad directs to. |
| impression | The URL of the impression tracker. |
| image | The URL of the image |
| optimum_image | If the creative uploaded is an animated GIF, this is the optimized MP4 version of it that is created for use in the ad. |
| width | The width of the ad in pixels. |
| height | The height of the ad in pixels. |
| frequency_period | How often the ad shows in minutes. |
| media | This shows which type of banner is used: Image, HTML, or video: This should be img_banner, html_banner, or video_banner respectively. |
Instant Message Response Example: JSON
{
"zones": [
{
"idzone": 4031007,
"type": "instant_message",
"data": {
"url": "https://main.example.com/click.php?data=H4sIAAAAAAAAA01Oy2oDMQz8lVxyXSTLtuxjLrn00G_wQ0uhDQmbBEqZj6.6uZQZJJiRRjogUi2UBUz4eDxu96OcjuHs7JvNZVwvAAjgTBJKUE74se16a9vnboaFyxIiLW4gxixclT1UmEiRmF1lBHDwlJSBkOibE4EdaH3aWp4VJfmAMq_CWnu1JpxHsq5ppd5i69lEfYPQv5rz9Rg5Dtjl_3gZe_GLfy3i_Q0tyZrFyuxT2KKFMWqfJKIjTx3yC41GCKIMAQAA",
"impression": "https://syndication.example.com/cimp.php?t=imp&data=H4sIAAAAAAAAA01OQWrEMAz8Sj8QM5Jly9lzf1AKucppcmnLloXCUubxdbIUqpFgJEbSKBSTYFJ5QrtIu+RCTdKSGpIULstCE/5st+tX3N7Tev1kVqlOy2rZWa3g6JAFcBaRweeGmmlWs8wuFKWyVIKtDA4iQejg68vzWUPCSi24S8Hgx1dBMk3DxNDbmOEORn/b9vY900X2LD73eYssdS1b97Kjh0Wv27B1bPWPGHlaxgNJ1c5b/zA92hHgHzu9gjNE1zC4eoS59xY1AmsvHq6mv8/Xp409AQAA",
"image": "https://static.example.com/library/32167/30faa1b47960b066dbc594e9251fbedf2349192e.jpg",
"optimum_image": "http://static.example.com/library/428515/d17db557c0761f48323156f47fd53dc3de393806.mp4",
"width": 250,
"height": 150,
"frequency_period": 1440,
"media": "img_banner"
}
}
]
}
Mobile Instant Message
Zones
| Parameter | Description |
|---|---|
| idzone | The ID of the ad zone. |
| type | The ad format used, e.g. mobile_instant_message. |
Data
| Parameter | Description |
|---|---|
| url | The URL that the ad directs to. |
| impression | The URL of the impression tracker. |
| image | The original image uploaded for the ad. |
| optimum_image | If the creative uploaded is an animated GIF, this is the optimized MP4 version of it that is created for use in the ad. |
| width | The width of the ad in pixels. |
| height | The height of the ad in pixels. |
| frequency_period | The period for frequency capping in minutes. |
| capping | How many times the ad shows during the frequency_period. |
| media | This shows which type of banner is used: Image, HTML, or video: This should be img_banner, html_banner, or video_banner respectively. |
Mobile Instant Message Response Example: JSON
{
"zones": [
{
"idzone": 1655304,
"type": "mobile_instant_message",
"data": {
"url": "http://main.example.com/click.php?data=H4sIAAAAAAAAAz1Qy27bMBD8lVx8FZZv.hggCNw6jY1Wso1cAkqkUwOWKJFSkwr8.C6tpFwC5M4OZ5bLiRCUQoJCpN_j2McVu1_RR9yjjUppXTS.xeydfmyb9xV7bHwcV.wBCshLrKhsphBc1_xFdIoWgdG84d17u98815t9.bR5rlSkdT_IYfhuThWdyxKO83S1P5.2gzkeSDWG4aUrp7azh6M8QAim71lVHisyHyffRt_7wW7lC4T.9Asf_sik_rSLbcuxPMHEZt8GMjCIA7_C3M8QmI92q0q1L9VuX.1Vt7uixoEc6izyoO5z98GZ8fLHvV4sNs01IZRpigVjXxvT9uby1n3WllFhKfopNC7_8YqxTEjGy.huPLZeS7lGZPbdghApBAOe3dArIwJ0zvzUjSEP7luZezn70Jo8XQbwQQBSgkQk4UpT0Cr9d0u0ILqgHAoi0lfL6dMloXZKnCREKAoImb7kCKYpaYG4IuTMiFrXa2cYkY1wtRJnqA03tXRM3bj11eC.OWIG6W4B7hC4SzdGDpThkujlxjgTKbM5LG_QPh8c6bttEjVlzFKiGSXOGaPAcApMSQrKNVb_Ax31zHSPAgAA",
"impression": "http://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAAzVOOW4DMQz8Sj4QYXhJlLsAaVLHfsBqj8qBWxd8vKkNzCEhaUiOhsH0Ccn8QL+IXrQFF/LCikIWP9evUIrHPVHWx18ouyXP3bV5SO+19qBqJtAweE6bMSPUiVicgzg4rAYiNzkPFACWw3H7/T6LJjQEeBKQj/ktuZcULrWQamgqzt1nVjSiQ6j10fdFqK62j2YHxqLLqLu0VECM+5J5msY/Chyzx28iUkQr+fsuKhYZiJPJOH1PaNRpbLAfir3p2rnrNqTzIRXVNue2b/oC0O6/XVABAAA=",
"image": "http://static.example.com/library/428515/e5aaf8a2ad46aee522c89d8583dc082f47fcb00d.gif",
"optimum_image": "http://static.example.com/library/428515/d17db557c0761f48323156f47fd53dc3de393806.mp4",
"width": 300,
"height": 100,
"frequency_period": 1440,
"capping": 0,
"media": "img_banner"
}
}
]
}
Native Ads
Zones
| Parameter | Description |
|---|---|
| idzone | The ID of the ad zone. |
| type | The ad format used, e.g. native_ad. |
Data > Layout
| Parameter | Description |
|---|---|
| widgetHeaderContentHtml | The URL of the 'Powered by' branding that shows. |
| branding_logo | The URL for the branding logo that shows if enabled. |
| branding_logo_hover | The URL for the branding logo that shows when the user hovers over it. |
| itemsPerRow | The number of ads that show in each row of the widget. |
| itemsPerCol | The number of ads that show in each column of the widget. |
| font_family | The family of font used in the ad. |
| header_font_size | The size of font used in the branding header. |
| header_font_color | The colour of font used in the branding header. |
| widget_background_color | The hex code of the background colour used for the widget. |
| widget_width | The width of the entire widget. |
| minimum_width_for_full_sized_layout | The minimum width for a full-sized layout in pixels. |
| item_height | The height of each individual ad. |
| item_padding | The padding between each of the ads. |
| image_height | The height of the image in each ad. |
| image_width | The width of the image in each ad. |
| text_margin_top | The size in pixels of the top text margin. |
| text_margin_bottom | The size in pixels of the bottom text margin. |
| text_margin_left | The size in pixels of the left text margin. |
| text_margin_right | The size in pixels of the right text margin. |
| title_font_size | The font size of the title for each ad. |
| title_font_color | The font colour of the title for each ad. |
| title_font_weight | The font weight of the title for each ad. |
| title_decoration | Whether the title is underlined or not. |
| title_hover_color | The font colour when the title is hovered over. |
| title_hover_font_weight | The font weight when the title is hovered over. |
| title_hover_decoration | Whether the title is underlined on hover or not. |
| description_font_size | The font size of the description for each ad. |
| description_font_color | The font colour of the description for each ad. |
| description_font_weight | The font weight of the description for each ad. |
| description_decoration | Whether the description is underlined or not. |
| description_hover_color | The font colour when the description is hovered over. |
| description_hover_font_weight | The font weight when the description is hovered over. |
| description_hover_decoration | Whether the description is underlined on hover or not. |
| open_in_new_window | Whether the ad should be opened in a new window when clicked. 1=yes, 0=no. |
| mobile_responsive_type | The type of responsiveness when using a mobile device (i.e none or compact). 1=compact, 0=no. |
| header_is_on_top | Whether the branding should be displayed above or below the ads. 1=yes, 0=no. |
| header_text_align | The horizontal alignment of the branding header. |
| title_enabled | Whether the title is enabled or not. 1=yes, 0=no. |
| description_enabled | Whether the description is enabled or not. 1=yes, 0=no. |
| image_border_size | The size in pixels of the image border. |
| image_border_color | The hex code colour of the image border. |
| text_align | The alignment of the text: left, center, or right. |
| customcss_enabled | Whether custom css is enabled or not. 1=yes, 0=no. |
| customcss | If enabled the custom css will display here. |
| header_enabled | Whether header is enabled or not. 1=yes, 0=no. |
| mobile_breakpoint | The breakpoint in pixels, between desktop and mobile views of the ad zone. |
| spacing_v | The vertical spacing in pixels between the ads, set in Advanced Options. |
| spacing_h | The horizontal spacing in pixels between the ads, set in Advanced Options. |
| zoom | Whether the ad should zoom in/out on hover. |
| mobile_rows | The number of rows of ads in the mobile widget. |
| mobile_cols | The number of columns of ads in the mobile widget. |
| use_v2_script | Whether the ad zone was created with the newer V2 setup or the older v1. |
| text_enabled | Whether the text title and description should be displayed. 1=yes, 0=no. |
| mobile_image_width | The width of the image in each ad on mobile. |
| mobile_text_box_size | The text box size when on mobile. Valid range 50-500. |
| mobile_text_enabled | Whether the title is enabled or not on mobile. 1=yes, 0=no. |
| mobile_text_position | The position of the text on mobile: bottom or right. |
| item_spacing_on_each_side | The padding on each side of the ads, if they were set up using the old v1 setup. |
| text_position | Whether the text is positioned on the left or right side. |
| text_box_size | The size of the text box in pixels. Range 50-500. |
| widget_height | The height of the entire widget. |
| brand_enabled | Whether the branding is enabled or not. |
| brand_font_size | The font size of the branding. |
| brand_font_color | The font colour of the branding. |
| brand_font_weight | The font weight of the branding. |
| brand_decoration | Whether the font is underlined or not. |
| mobile_image_height | The height of the image in each ad on mobile. |
| publisherAdType | What type of native ad this is, i.e recommendation, exit, or interstitial: native-recommendation, native-exit, native-interstitial. |
Data
| Parameter | Description |
|---|---|
| image | The original image uploaded for the ad. |
| url | The URL that the ad directs to. |
| impression | The URL of the impression tracker. |
| title | The title text of the ad. |
| description | The description text of the ad. |
| brand | The brand text of the ad. |
| original_url | The original url of the landing page. |
| image_position | The position of the ad image (how the image will be cropped). |
Native Ads Response Example: JSON
{
"zones": [
{
"idzone": 4058715,
"type": "native_ad",
"data": {
"layout": {
"widgetHeaderContentHtml": "<a target=\"_blank\" href=\"https://www.exads.rocks\" rel=\"nofollow\">Powered By <span></span></a>",
"branding_logo": "//static.example.com/widget-branding-logo.png",
"branding_logo_hover": "//static.example.com/widget-branding-logo-hover.png",
"itemsPerRow": 4,
"itemsPerCol": 1,
"font_family": "Arial, Helvetica, Verdana, sans-serif",
"header_font_size": "12px",
"header_font_color": "#999999",
"widget_background_color": "transparent",
"widget_width": "1830px",
"minimum_width_for_full_sized_layout": "450px",
"item_height": "300px",
"item_padding": "10px",
"image_height": "450px",
"image_width": "450px",
"text_margin_top": "3px",
"text_margin_bottom": "3px",
"text_margin_left": "0px",
"text_margin_right": "0px",
"title_font_size": "16px",
"title_font_color": "#000000",
"title_font_weight": "normal",
"title_decoration": "none",
"title_hover_color": "#0000FF",
"title_hover_font_weight": "normal",
"title_hover_decoration": "none",
"description_font_size": "14px",
"description_font_color": "#555555",
"description_font_weight": "normal",
"description_decoration": "none",
"description_hover_color": "#0055FF",
"description_hover_font_weight": "normal",
"description_hover_decoration": "none",
"open_in_new_window": 1,
"mobile_responsive_type": 1,
"header_is_on_top": 1,
"header_text_align": "right",
"title_enabled": 1,
"description_enabled": 0,
"image_border_size": "",
"image_border_color": "",
"text_align": "left",
"customcss_enabled": 0,
"customcss": null,
"header_enabled": 1,
"mobile_breakpoint": "450",
"spacing_v": "10",
"spacing_h": "10",
"zoom": "1",
"mobile_rows": "2",
"mobile_cols": "1",
"use_v2_script": "1",
"text_enabled": "1",
"mobile_image_width": "450",
"mobile_text_box_size": "90",
"mobile_text_enabled": "1",
"mobile_text_position": "bottom",
"item_spacing_on_each_side": "5px",
"text_position": "bottom",
"text_box_size": "90px",
"widget_height": "570px",
"brand_enabled": "1",
"brand_font_size": "11px",
"brand_font_color": "#555555",
"brand_font_weight": "normal",
"brand_decoration": "none",
"mobile_image_height": "450",
"publisherAdType": "native-recommendation"
},
"data": [
{
"image": "https://static.example.com/library/432437/97567ec37c751bc909fc06c96920bb353efefe36.jpg",
"url": "https://main.example.com/click.php?data=H4sIAAAAAAAAAz2OO27EMAxEr7LNljE0okhJZZo0KfYMkj9IgPwAG3GKOfxybSDgAJTI0RtdmBBzhhCBb9v2s17l.RpfXPu.D_Nfm9Zh_P70.1fb3n_n9UlJBhIGQGoQ47.LyHVw3gDRIUYjkwIlR2UKWjKUGopPQQ80xziI8CKiJMrDpb7NwCIO63VuAht17lmX0Ftq3WbJ_iKwfzTXkXuQLjzGZ8kjWeQ8hWj1.HUNp7WkoyXeXqmW0acQp0mWKdaUUaqUcTQbkaqlOziYDlsjAQAA",
"impression": "https://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAA01OS04FMQy7CheYKs6nad8OxAlAHKDzW4FYsHmLHJ5M0ZOI00apLddMjIWwMD2R3cRvqAHvBewFYoW5xsvbcyjiuI/9p2zfX6HCKv4YzbU3CyVrDgujlmp2h4Qa0Jwt0lWCEnLJLN1yKYRwio/313mQYIq8rw9BRblQQXQKzUe6U4BFw4FTMuPajyGomx2r20nr0LHWIwNd5uvnyJ5paQLFpcrkHpArnkgs+FuIa48siklnNf0nH+JUR60bidjoKd+HbHLuO7bTvP0ChQRmKEsBAAA=",
"title": "title 5",
"description": "description 5",
"brand": "brand 5",
"original_url": "https://www.example.com/natives-5",
"image_position": "50% 50%"
},
{
"image": "https://static.example.com/library/432437/d51084a3da98f857bca6ba19037cfe90b9a93c0b.jpg",
"url": "https://main.example.com/click.php?data=H4sIAAAAAAAAAz2OOW7EMAxFrzLNlBG4iFrKNGlS5AySR0ICZANsxCn.4UN7gIAEuH0.8oLIkjNVMOF1277Xqz5e5cl93_cwftttDcvXh9efbXv7GeuDAiCAEzNrJU34V4FzDc4LrBZEEhCNuWQyRLKS2WBUvMtQBzjGQWA3sGiEHirzaWae6rBeR1NOi42ebVJvsfU0NPsGob839_PuSboAciaH6XFZ9Z6RpHp.XekuLfEMES_PsCEcS7ZOc6HU6pR0mxIlVuNcUvsDR8DGSCMBAAA-",
"impression": "https://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAA01OSU4EMQz8Ch/oqLzFydxAvADEA9I96ROIA5c5+PHj7gEJV+Ko7FKlGEwLaGE8wS7iF6pB3guxFxIrzDVe3p5DKeZtXH/K9v0VKqzif09z7c1CYc3JwtBSze7ooUbUHBbpKoGEHDJLtyQFFI74eH89LyUYkf34kFCUCwpFR2gOcUMQi4YT7ZIZ1z6HUN1srm471qFjrTMDHebr58hzpsUJKi6Vg3/pI0vGE4mFHgRce2QhznVW03/yMU3nbjW7wfu8trHtuk3kZBuT7xcrT8hLAQAA",
"title": "Native 3 title",
"description": "Native 3 description",
"brand": "Native 3 brand",
"original_url": "https://www.example.com/natives-3",
"image_position": "50% 50%"
},
{
"image": "https://static.example.com/library/432437/59bb52f508ef418172a4809481e24a5ec01d9cfb.png",
"url": "https://main.example.com/click.php?data=H4sIAAAAAAAAAz2QOW7EMAxFrzLNlBG4iJJZppkmRc4gjWUkQDbARpziHz4cTxCQALV8vk_whMxSK1Uw4WXbvtazPp7lErnvexo_bV7T9fM97h9te_0e64MAIIALM6uTFvyrwNVT8BKrJZECZGOeKjEy2VTZYDTFK0MDEJgAgSPAohl6U1n8VuZFA9Z9NOVytdGrLdRbbr0MjWmjs7.1yMP3IJ0QVPoLvTmr3k8kxY.pne7SKR8l4_kJ5CLmOhp5pnmm1od1iZUs7p06_QJgI9fDIwEAAA--",
"impression": "https://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAA02OTU7EMAyFr8IFGj3/xensQJwAxAGSTroCsWAzCx9+3DJI2Ikjx0/PH4NpAS2MJ9hF/EI1yNdC7IXECnONl7fnUIp569efsn1/hQqr+N/TXNdmobDmZGFoqWZ3pMKImoMiXSWQKYfM0i2bkgNHfLy/njdVwYisx0JCUS4oFCtC8xM3BLFoONEuyTjW2YXqZnO47Rhd+6gzgQ7z8dnznLQ4k4pLpQcFHiyJJxIL/TbgukYG4hxnNP0n364sUKu1XQeq7juSgm3qgK29zzv4Hxr/SwEAAA==",
"title": "Native 2 title",
"description": "Native 2 description",
"brand": "Native 12 bran",
"original_url": "https://www.example.com/natives-2",
"image_position": "50% 50%"
},
{
"image": "https://static.example.com/library/432437/d32054c6f9c66c2853bff50b00578b15e0739875.jpg",
"url": "https://main.example.com/click.php?data=H4sIAAAAAAAAAz2Ou27GIAyFX.Vf_rHIxgbC2KVLhz4DEFAr9SYlajqch69JpApL.HL8Hd.g7FNiBuN137.3uzze_ZPFcRyu_5Z1c.3rw.rPsr_99O1BARDAkZklk0T8q8ApO8M5luC8j4AG5mXSlYL9AYEW6zLEAIYxEKY12ItCpirY1DaGGKzmXoRjC72mMKgWLTV2SbZBqO_F4vQ9STcDn8l8Mp1Frox8zOfVmS7pcgkVL89IK8fcZHQdSyfxWe2MtjYRP1RT_gOkVnReIgEAAA--",
"impression": "https://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAA01PSU4EMQz8Ch/oqLy103MD8QIQD0i6MycQBy5z8ONxGs0IV+LETqlcYTAtoIXxBLuIX2gN8q0QeyGxwrzGy9tzKMW4teOn7N9focIqfj+q61YtFFadLAw12exOFGpEdV5SVQIJmTRLtSwKQOGIj/fXcyctGJF5TiQU5YJCsSE0m7ghiEUjBa+SJvs2mtC62+huV/Smra8jHU31/tlynXZxgorLuqUSHpDpTyQW+ivASchAnM8Z9T99wIh1b2PHcbhxFwEN4UbjmD/+BS14KDZMAQAA",
"title": "title 4",
"description": "description 4",
"brand": "brand 4",
"original_url": "https://www.example.com/natives-4",
"image_position": "50% 50%"
}
]
}
}
]
}
Outstream Video
Zones
| Parameter | Description |
|---|---|
| idzone | The ID of the ad zone. |
| type | The ad format used, e.g. outstream_video. |
Data
| Parameter | Description |
|---|---|
| url | The URL that the ad directs to. |
| impression | The URL of the impression tracker. |
| tracking | An object with tracking info. |
- offset | Progress marker to persist the video view. |
- url | URL to call to persist the video view. |
| video | The video ad file to load. |
| brandingEnabled | Flag to enable the branding. |
| frequencyPeriod | How often in minutes the ad shows. |
| maximumWidth | Video width size. |
| impression | The URL of the impression tracker. |
Outstream Video Response Example: JSON
{
"zones": [
{
"idzone": 4394449,
"type": "outstream_video",
"data": {
"url": "https://static.example.com/click.php?...",
"tracking": {
"progress": [
{
"offset": "00:00:10.000",
"url": "https://static.example.com/vregister.php?..."
}
]
},
"video": "https://static.example.com/library/195600/629e84e4a8522e6cf9a5a8298f9922737696e535.mp4",
"brandingEnabled": 1,
"frequencyPeriod": 0,
"maximumWidth": 0,
"cookieconsent": 1,
"impression": "https://static.example.com/vregister.php?..."
}
}
]
}