> For the complete documentation index, see [llms.txt](https://docs.exoclick.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.exoclick.com/api/ad-placement-api/response/ad-plac-response.md). # Response Zones The Ad Placement API response JSON contains the **zones** array and the [**renderers**](https://docs.exoclick.com/docs/ad-plac-renderers/) and [**user**](/api/ad-placement-api/response/ad-plac-user.md) objects. In this page we will explain the **zones** array, which contains all the details regarding the ad that won your ad request. The array contains an object with ad data for each zone ID requested. | Property | Description | | -------- | ---------------------------------- | | idzone | The ID of the ad zone. | | type | The ad format used, e.g. `banner`. | | data | The ad data (Object) | Below you will find a detailed list of properties returned for each **data** object according to the available ad formats. ## Banner | Property | Description | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | url | The URL that the ad directs to. | | impression | The impression URL | | 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. | | media | This shows which type of banner this is: Image, HTML, or video: This should be `img_banner`, `html_banner` or `video_banner`, respectively. | ### Banner Response Examples **Image Banner:** ```json { "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://example.com/library/328752/47de5c021bd0d00b59ff78456c69f601baac9925.gif", "optimum_image": "http://example.com/library/328752/c990e4df40cc46482927c08350b2c960a59679e5.mp4", "width": 300, "height": 250, "media": "img_banner" } } ] } ``` **HTML Banner:** ```json { "zones": [ { "idzone": 2222222, "type": "banner", "data": { "html": "\n
\nExample HTML Ad!\n
\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" } } ] } ``` **Video Banner:** ```json { "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" } } ] } ``` ## Sticky Banner | Property | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | url | The Click URL | | impression | The impression URL | | 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" } } ] } ``` ## Instant Messages | Property | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | url | The Click URL | | impression | The impression URL | | 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" } } ] } ``` ## Native Ads When the response returns a Native ad, zones.data will return two objects: **layout** and **ad\_items** **data.layout** | Property | 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-interstitial`. | **data.ad\_items** | Property | Description | | --------------------- | ------------------------------------------------------------------------------------- | | idvariation | The ID of the variation. | | image | The original image uploaded for the ad. | | url | The click URL. | | impression | The impression URL. | | 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). | | size | The size of the ad format selected | | iframe\_url | If an iframe is used as a variation, this will be the URL of the iframe. | | video\_thumb\_id | The identifier of the video thumb asset (if present) associated with the ad creative. | | video\_thumb\_url | The URL of the video thumb asset (if present). | | video\_thumb\_enabled | The status of the video thumb asset (if present). | ### Native Ads Response Example ```json { "zones": [ { "idzone": 4058715, "type": "native_ad", "data": { "layout": { "widgetHeaderContentHtml": "Powered By ", "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" }, "ad_items": [ { "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 | Property | Description | | --------------- | ------------------------------------------------------------------------------------------------- | | url | The Click URL | | tracking | An object with tracking info. | | video | The video ad file or VAST link to load. | | brandingEnabled | Flag to enable the branding. **This value is currently not used** | | frequencyPeriod | How often in minutes the ad shows. | | maximumWidth | Video width size. | | isVast | States whether the winning campaign is a regular video ad (false) or a VAST link campaign (true). | | ctaEnabled | Flag to display a CTA on the ad | | cta | An object containing the details of the CTA | | impression | The impression URL | **data.tracking** At the moment, the **data.tracking** object only returns a `progress` array with objects meant to track the playback of the video. From these objects, the one with `"offset": "00:00:10.000"` is the one to call to persist the video view. The properties of each object are explained below: | Property | Description | | -------- | ---------------------------------------------------------------- | | offset | Progress marker in seconds or as a percentage of video ad played | | url | Tracking URL | **data.cta** | Property | Description | | ---------- | ----------------------------------------- | | displayUrl | URL related to the landing page of the ad | | text | Text to be used in the CTA element | ### Outstream Video Response Example ```json { "zones": [ { "idzone": 12345, "type": "outstream_video", "data": { "url": "https:\/\/s.example.com\/click.php?d=H4sIAAAAAAAAA11S246bMBD9mrwl0fiKeexVkXabRc2SXeWlMsYkaA02YDct8sfXZFfbqhqwRjPHx2cuGc8YyWiEePHeTSvyYYW_pu96vW6ntj8b3Zh29FtluxQ1sq9TMHnd6DEAWZGvYdxI124a7dVlc2l9W6_IZz8GvcLcOyU7d4sophBtQG.kEGhDK4k3VYazDdWVYoJyqQSkG1OoilCZdrroMd1ihDGBaUoo06oXL88paMe62Be7ar_bV_e7Yn.XKdsfy.PxaYbQddMwDL31dXG6L54PDJUwD6f.MYSpvuNHGIe7E2P8NPRlWR7JAR5sZ5wLIWVPMLrnQzD1twXo.gqVjzibD2x.msvTzH5zhp5IVVaPWDJMDsGaYJDtSHC2Q3Z02EGPxy7MFhnbjYmT7T_W.nzZ3u.GXQ4IxOBcdXp.6P2rmtf3FheZuv42oWM59w_m_2QSk1z1VPwoXtyX7_zyQ7H5JeMNM_vw6DuhbZP0QAjOk6Gnrp87P1Hj.8nZ3tLE3vWjVTv8YZO6.SmNRbbnPnUze9uAtAIo4zwhGUPxqqtOTl6P7ayX4UeM8FagLRKwxShBUcZYaoGIbyOKDKEYKYo45lnighjRYjmGX6lqiJoRLDQCiQQiEktQkom8JjXOlBQ5REIxxhSxSCAHRZDOKUGKcFrTCtcc5ZIoIIjniRbilUzqYq2ZbuqSoCQQi4gzwJzGtL7rd8Q6IdYX35m1H3.3fi0nt25ao3vZ6SV0S9W6kcH4eCNfjBDCcyCLh4DSPI9Li9ITb_nFxDs6qV5KFhlPmCW4_DF.ORT_wP8aeW0RbIEtBwB6Z5q2nTxP489bXWkscQG8skHk8SfG8eEuNlQ3NMd5zasMNUwJIYBIBVLRnNMc_QHDw8Gc2AMAAA--&cb=e2e_6949260fe161c8.72624884", "tracking": { "progress": [ { "offset": "00:00:10.000", "url": "https:\/\/s.example.com\/vregister.php?a=vview&tracking_event=progress&progress=00%3A00%3A10.000&idzone=12345...." }, { "offset": "25%", "url": "https:\/\/s.example.com\/vregister.php?a=vview&tracking_event=progress&progress=25%25&idzone=12345...." }, { "offset": "50%", "url": "https:\/\/s.example.com\/vregister.php?a=vview&tracking_event=progress&progress=50%25&idzone=12345...." }, { "offset": "75%", "url": "https:\/\/s.example.com\/vregister.php?a=vview&tracking_event=progress&progress=75%25&idzone=12345...." }, { "offset": "100%", "url": "https:\/\/s.example.com\/vregister.php?a=vview&tracking_event=progress&progress=100%25&idzone=12345...." } ] }, "video": "https:\/\/u3y8v8u4.aucdn.net\/library\/940460\/8f1ab6fd40cb27cba71db1229c250d6bce1f8b68.mp4", "brandingEnabled": 0, "frequencyPeriod": 60, "maximumWidth": 1000, "impression": "https:\/\/s.example.com\/vregister.php?a=vimp&tracking_event=impression&t=api&idzone=12345....", "isVast": false, "ctaEnabled": 1, "cta": { "displayUrl": "singleflirt.com", "text": "View More" } } } ] } ``` ## Video Slider | Property | Description | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | url | The Click URL | | tracking | An object with tracking info. | | video | The video ad file or VAST link to load. | | screenDensity | Integer indicating the share of the maximum screen space taken by the ad on a user's device | | onComplete | Indicates the behaviour of the ad after the video has finished playing. "hide" means the ad should be hidden, whereas "repeat" means ad should stay on page to let the user replay it | | closeAfter | Indicates the amount of seconds needed before the close button is shown on the ad | | brandingEnabled | Flag to enable the branding. **This property is currently not used** | | frequencyPeriod | How often in minutes the ad shows. | | impression | The impression URL | | isVast | States whether the winning campaign is a regular video ad (false) or a VAST link campaign (true). | | ctaEnabled | Flag to display a CTA on the ad | | cta | An object containing the details of the CTA | **data.tracking** At the moment, the **data.tracking** object only returns a `progress` array with objects meant to track the playback of the video. From these objects, the one with `"offset": "00:00:10.000"` is the one to call to persist the video view. The properties of each object are explained below: | Property | Description | | -------- | ---------------------------------------------------------------- | | offset | Progress marker in seconds or as a percentage of video ad played | | url | Tracking URL | **data.cta** | Property | Description | | ---------- | ----------------------------------------- | | displayUrl | URL related to the landing page of the ad | | text | Text to be used in the CTA element | ### Video Slider Response Example ```json { "zones": [ { "idzone": 12345, "type": "video_slider", "data": { "url": "https:\/\/s.example.com\/click.php?d=H4sIAAAAAAAAA11S246bMBD9mrwl0fiKeexVkXabRc2SXeWlMsYkaA02YDct8sfXZFfbqhqwRjPHx2cuGc8YyWiEePHeTSvyYYW_pu96vW6ntj8b3Zh29FtluxQ1sq9TMHnd6DEAWZGvYdxI124a7dVlc2l9W6_IZz8GvcLcOyU7d4sophBtQG.kEGhDK4k3VYazDdWVYoJyqQSkG1OoilCZdrroMd1ihDGBaUoo06oXL88paMe62Be7ar_bV_e7Yn.XKdsfy.PxaYbQddMwDL31dXG6L54PDJUwD6f.MYSpvuNHGIe7E2P8NPRlWR7JAR5sZ5wLIWVPMLrnQzD1twXo.gqVjzibD2x.msvTzH5zhp5IVVaPWDJMDsGaYJDtSHC2Q3Z02EGPxy7MFhnbjYmT7T_W.nzZ3u.GXQ4IxOBcdXp.6P2rmtf3FheZuv42oWM59w_m_2QSk1z1VPwoXtyX7_zyQ7H5JeMNM_vw6DuhbZP0QAjOk6Gnrp87P1Hj.8nZ3tLE3vWjVTv8YZO6.SmNRbbnPnUze9uAtAIo4zwhGUPxqqtOTl6P7ayX4UeM8FagLRKwxShBUcZYaoGIbyOKDKEYKYo45lnighjRYjmGX6lqiJoRLDQCiQQiEktQkom8JjXOlBQ5REIxxhSxSCAHRZDOKUGKcFrTCtcc5ZIoIIjniRbilUzqYq2ZbuqSoCQQi4gzwJzGtL7rd8Q6IdYX35m1H3.3fi0nt25ao3vZ6SV0S9W6kcH4eCNfjBDCcyCLh4DSPI9Li9ITb_nFxDs6qV5KFhlPmCW4_DF.ORT_wP8aeW0RbIEtBwB6Z5q2nTxP489bXWkscQG8skHk8SfG8eEuNlQ3NMd5zasMNUwJIYBIBVLRnNMc_QHDw8Gc2AMAAA--&cb=e2e_6949260fe161c8.72624884", "tracking": { "progress": [ { "offset": "00:00:10.000", "url": "https:\/\/s.example.com\/vregister.php?a=vview&tracking_event=progress&progress=00%3A00%3A10.000&idzone=12345...." }, { "offset": "25%", "url": "https:\/\/s.example.com\/vregister.php?a=vview&tracking_event=progress&progress=25%25&idzone=12345...." }, { "offset": "50%", "url": "https:\/\/s.example.com\/vregister.php?a=vview&tracking_event=progress&progress=50%25&idzone=12345...." }, { "offset": "75%", "url": "https:\/\/s.example.com\/vregister.php?a=vview&tracking_event=progress&progress=75%25&idzone=12345...." }, { "offset": "100%", "url": "https:\/\/s.example.com\/vregister.php?a=vview&tracking_event=progress&progress=100%25&idzone=12345...." } ] }, "video": "https://u3y8v8u4.aucdn.net/library/141372/7bbd0e98bb9b36baf778a8b970c74e26f51c037a.mp4", "screenDensity": 25, "onComplete": "repeat", "closeAfter": null, "brandingEnabled": 1, "frequencyPeriod": 0, "impression": "https://s.example.com/vregister.php?a=vimp&tracking_event=impression&t=api&idzone=12345...", "isVast": false, "ctaEnabled": 1, "cta": { "displayUrl": "fullclickenabled.com", "text": "Watch Free" } } } ] } ``` ## Fullpage Interstitials | Property | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | | url | The Click URL | | impression | The impression URL | | 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\_count | How many times the ad can show | | frequency\_period | How often in minutes the ad shows | | frequency\_trigger\_type | Flag to indicate whether this ad's frequency is based on impressions (0) or clicks (1) | | ad\_trigger\_method | Trigger method enabled for this ad zone | | ad\_trigger\_classes | Classes that should trigger the ad, if any | | first\_trigger\_clicks | Number of clicks needed on the initial visit from the user in order to trigger the ad | | next\_trigger\_clicks | Number of clicks needed after the first trigger of the ad in order to display the ad again | | chrome\_enabled | Flag to indicate whether this ad zone is enabled for Chrome (1), disabled (0) or enabled exclusively for this browser (2) | | capping\_enabled | Flag to indicate whether capping should be enforced to this ad zone or not | | media | This shows which type of banner this is: Image, HTML, or video: This should be `img_banner`, `html_banner` or `video_banner`, respectively. | **Note:** most of the properties of the Fullpage Interstitial response are related to the capping and trigger of the ad. Since you are in charge of rendering the ad, it is up to you to decide whether you want to pay attention to these properties or not. ### Fullpage Interstitial Response Example Note that, although the example shows a Desktop Fullpage Interstitial, the response for a Mobile Fullpage Interstitial should be the same aside from the zone.type. ```json { "zones": [ { "idzone": 5808222, "type": "desktop_fullpage_interstitial", "data": { "url": "https:\/\/s.example.com\/click.php?d=H4sIAAAAAAAAA01S2W7jOgz9mrwlgTZL8uPcWRAggWNkb18KWZIbz3iV5aYx9PFDp0XviIZBHx4d0iQFFxGJWEDh6n3bz.i3GfkFz.12W_ZF_VravCycX.qmArRUtQEQvMp5ghCd0V.DW6i2WOTW6.viWvjCzOgP7wY7I9y3WlXtA9GRxixHdqGkxAuWKbLIBBELZjMdScaVlghu9EOWDllZ9Ffr4FYkkSSEQECXhf7j1SuAjTNpkq6yZJVkm1WarIVu6tP5TsZxHKqq77oWjkmfN.llz9VwPp1Q7wCsj.O2NuaJn5BrL8cj8NF42jZN44ayMbtkczgYDdGxveyH0qz580Q8bEfnKRtaP_qKuLqrcdPhinXO.3HoKfFmtzEbt0vezGGXuN3l4A9t6i.JqXdus0suoHlX33n83w95To.paF0bnQ57ch9Mqj6q.cg3uW7N.bPKOrHafiL_BKEYcFn_5F_uf3arbhWP9fbw1r5URxJtSfbOry9mLbbFuTqr8ZJl.9_Wnu9dR.xQdFm.PZOhsO.3_OnbArr6Hcajitcauio.NwFWAQvOGWIxF.Fms0r13rpitNMSBILJUuIllmhJMFCxiCIGJ3yOKkQYh8BwICEWoAUUjtB7jMCZLCboHSOJguLS5jGTSmLDSUQ0hQ3JIy6lioU1MlAGcgxHgaIYaYptzCjWlDPDMmI4jhXViGIegywKN9rra9OU_aNKSAaFEhmIQISzAOs8_2LMgTG_.qqce3cv_Fz17TwvSluryk7QI2RsrobSh4f4ZJRSHiM6eRgxFsdhahWk.IxPJr_YUDW8gxQc.HyqZ_oMP_fpP_T_jUYfzhJoS4QQ_hLql62tevf2.C2YTpgIH2KQPbxBx7frkEtGIgQzs0LzDNoTUcHjTJuYiDzW.i9X4F4Z5wMAAA--&cb=e2e_69493367093292.02215167", "impression": "https:\/\/s.example.com\/cimp.php?t=api&data=H4sIAAAAAAAAA11QS0pEMRC8iheYUP1J0nHt7AXxAG\/yMig4jvjEH314k4y4MEWgSVW6qpvBcUe8Y75CvgZfa3YmDkaBDIEJvr+7dSX\/aIfTsr2118fvFur55EWhCV5AIskJwjDzaDBm9kjkOeXIUZ0ox6j9eOndHR2iXaQUe0kB+130DL+\/u5mXOiQ6JeCzoCtmBmdzG1xhfBIMviRrx6K2GK2JI1eJlY4xmS0lt9VcUFCFWlGhKklXPfCaqCxSIZRK7wb\/kK0+nM9P25yqu\/X5uxVncFJH6D1GoDhzz+x93gLx3fgtBNVSvB\/4pJft67m6\/8kviC5DnYbBUP6jLyD8VoGGMabxeNjCSzttr+8zok6zgEFdtjk3dqnKEe3QF7cIlyxYI+ohq1VqyLYu7QfZRfrR8QEAAA==&cb=e2e_69493367093c99.73988768", "image": "https:\/\/s3t3d2y1.afcdn.net\/library\/940460\/c8c01e1ff28dea8c9345f243dcd7b4ca8c7df26d.jpg", "optimum_image": "https:\/\/s3t3d2y1.afcdn.net\/library\/940460\/a359ed6758e1c53523936ed27a001b7bf0f726ab.webp", "width": 1600, "height": 900, "frequency_count": 1, "frequency_period": 720, "frequency_trigger_type": 0, "ad_trigger_method": 3, "ad_trigger_classes": "", "first_trigger_clicks": 0, "next_trigger_clicks": 0, "chrome_enabled": 1, "capping_enabled": 1, "media": "img_banner", "cid": 7675254 } } ] } ``` ## In-Page Push | Property | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | url | The Click URL | | impression | The Impression URL | | 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. | | title | Title of the notification | | description | Description of the notification | | horizontal\_position | Indicates the horizontal position on the page (left, center, right) | | vertical\_position | Indicates the vertical position on the page (top, middle, bottom) | | delay | Number of seconds before the notification appears after the page loads | | max\_notifications\_on\_page | Number of notifications that can appear on the page at the same time | | once\_closed\_hide\_for | Length of time in seconds that the ad is hidden for once it is closed (needs cookie consent from user) | | user\_session\_capping | Number of times the ad is shown to the user (needs cookie consent from user) | | delay\_between\_notifications | Number of seconds before the next notification appears after the previous one loads | ### In-Page Push Notification Response Example ```json { "idzone":9999999, "type":"in_page_push_notification", "data":{ "url":"https://syndication.example.com/click.php?data=H4sIAAAAAAAAA02QvW7DMAyEX0VLVoGUSP2MXbp06DPQltwadeQgNuIU4MPXMYo2OE68w0ccOUF25BUs6.e6XpaTfzm51322bbNrXdaxfdh.PquCYkg55BQh6OU63upS7_OlybnaNimCJWfBoibnIfmISjlRdqwMSZVQvSLvGNDo4E5pB.7SQB1jHXwntQvZMlCMLgRkYA9Ij3wNnAPGobiB.l7EA_AQZOBSsCOqOwZ0.W5l7GUd52brXcpir3P_tehx0Ty55nDN4Zpp7mUyv0XNVjvTSWv1aj7X82T0IP_rAXOgTxv6S7C6I.FIPeuN9f1Ni3OIsXj0.0sEMJXEUQafa5QaovwASom5rH8BAAA-", "image":"https://static.example.com/library/195600/0ce94b4e2b6222ee26594af823a65cb7059ca62d.jpg", "title":"Title", "description":"This is a description", "impression":"https://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAA1VPW2rDQAy8Si+QZaSV9pH/XiBQ8O/au4bQ1glxKS7o8N24hFAJSTMwjCQG+wPigdIL8VH0iGAEJ+zgyIZhMCG73s7fbW3b5bqUz+aWD6OsAXiMSClnmOQkmdUUyTQhs3hL7JF8JCM1b3ikA3AX2uvbaa8ucAQyYYuMTVI339cbd+OOscGCjEpt9mNpY8hOITFyCKRQDxJYC5oDxbnyLNNUiu9b5lBmrZVGkXb3sfVnqeepfJ0vi2tbqau7Xab39XkaJ9qFzzz80R6wHZVuMpn9E8HUuHevOyHrz8wcYhHNtVSfRVklttxAOSTh6RdhQ+r1fQEAAA==", "optimum_image":"https://static.example.com/library/195600/0c9243bcbb139db5671a779366a98a08f678b2f1.webp", "horizontal_position":"right", "vertical_position":"top", "delay":0, "max_notifications_on_page":2, "once_closed_hide_for":10, "user_session_capping":0, "delay_between_notifications":10 } } ``` ## Multi-Format A response for a Multi-Format request might return different results: * If the winning ad is a Native campaign, then the response will contain a [**regular Native data object.**](#native-ads) * If the winning ad is a Banner campaign and you have a **Single Zone** on the layout, then the response will contain a [**regular Banner data object.**](#banner) * If the winning ad is a Banner campaign and you chose a layout with **multiple ads**, then the response will contain a **group** object with the following properties: | Property | Description | | ----------- | --------------------------------------------------------------------------------- | | orientation | The orientation of the Multi-Zone Layout, which can be "horizontal" or "vertical" | | ad\_items | Array containing the ad data for each spot on the layout. | Regardless of the result, the property **multizoneid** will be added to the response, indicating the zone ID of the multi-format ad zone to which this response corresponds to. ### Multi-Format Response Example The following example shows the **zones** object for a Multi-Format ad zone with an **Horizontal x 3** layout: ```json { "zones": [ { "group": { "orientation": "horizontal", "ad_items": [ { "idzone": 12345, "type": "banner", "data": { "url": "https://syndication.example.com/click.php?d=H4sIAAAAAAAAA01RTU_DMAz9NbtVlT.SNDlygAsHkPgFaZuySS2dmrAO5B9PEtCGHFmW37P97HROWSISlGNK53jghwM95RfTuoU2puCX87qHLYztsC4ZEAHBzhiF2oKTPfSLz7Tt9B0KQwiptdiihZYwU0kbUg6saNaMYEQjiigUEtflXiAMcCWdqcUcwRXBggirrCtPybiDgTE4xTiwUaPqaTToPA_AaFwuA9k5Dsd1nWMVAdX2fW9u.Sbnm2Na5iZtX6fU.HhuptMcPvwSSqpCY5j855yktqzamI0DLhGCUs5J3R9I_gjFVPX5HDYvWyIpBfkS5hcvzUQe317_1dyNim8B8O7xNj.2i3.P26VupaRMb6m2K4WX_HEvz2J0D9xZNyF7oyftstYRhr7TTo3QjT9DY7Q.5AEAAA--&cb=e2e_69495dc1258023.87481108", "impression": "https://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAA01QW27CMBC8Si+ANftw4u13+a+KOEBiQotUiEQQ0GoPXzu0FI9ke3dnH7MMjgviBfMT4RnyzOZMHBIFSghM8OXq1ZX8MvT7bjoNx933EPK4d43EFt1AIo0ThJGSR4lCaDwSeWuamNmJY8NqSG6ts6NAtASUYjUCULjw9erFl+s3L63bmnV72AW4coTTPErpxK7FIGNcCWkuB0MWGkyFsjS60Z43DVknGUKNFTr8IlP+GMfPaR4fNwTStlaLfw6XIscgvqg5RYuqmZcDn8Pd9HXI7nc6PCakorD+XH59NfeR848HzfebZj58CvvufTqeb\/udm4a6r7oFUoWfu+OuO+3Gw72898rgzcDWgIX6bAOGNmZpt9SzbOMPcuXp2OIBAAA=&cb=e2e_69495dc1258be3.55680913", "image": "http://example.com/library/328752/47de5c021bd0d00b59ff78456c69f601baac9925.gif", "optimum_image": "http://example.com/library/328752/c990e4df40cc46482927c08350b2c960a59679e5.mp4", "width": 300, "height": 250, "media": "img_banner", }, "multizoneid": 67890 }, { "idzone": 12345, "type": "banner", "data": { "url": "https://syndication.example.com/click.php?d=H4sIAAAAAAAAA01Ry07DMBD8mt4iax.2Ex85wIUDSHyBk7i0UkKrODQF7cezdlFBa9mr2dnZh9tgO2IQMCiHdT3nHT_s6EnPtm0mjUuKczbDaVZEBARb7y26DoJsqZ9jXtNy_E6FIYRkOjTYgSFUKjlPznkQx44RvDhEEYtCElrVAmGAKzmlFgsEV4QORNgSkVbReICBMQXLOLC3o.1p9BgiD8Dog6aBbJyHw.k01TarrGLb1tzxRvHmsM5Tsy5fx7WJ.dzsj1P6iHMqUA2NaR8_p1WqZO2N2Qfg4iFYG4KU.YOV33gxW2_dRqezFk8KXxfhb_GiJfL49vov58_o9hoALDfeS2czx_e8XOpAWlDK97RVq2RdiOTlWXqA6CEmSBg7l6hl71se1O8p7e3wA2CxptPbAQAA&cb=e2e_69495dc1259304.50721064", "impression": "https://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAA01QW24CMQy8Si9ANLbjkPBd/qsiDpDdhRapsBKLgFY+fL3Lo40l27HHjzGDdUY8Y34hLCALLsbEIVOgjMAEW67eLJJdNs2+DqfNcfezCW2\/t6jERa2ARJIRhJGzqagQkimRzUvMLDBiTayaYGVubHCRyMyRdPwEAA6GrVevtly\/m8+eMz8MmwBXVu8z7WIlWnSfCuNKyFM7FLRCmxKFWkmxiw13iUqVFkKpOBx2kaH97PuvYVofNwmknD2tj4CJ0ykQm401ziXGUswfbErX4fvQmj3hMM3IznD0TO6xsfY\/5k\/oDgkjadc0YWFD2NeP4Xi+3XYa6Pw9MV6AYoSd63FXT7v+8Oxt266JaKo2XJ37tlHJrhO6bcp+HvwC8uORF98BAAA=&cb=e2e_69495dc1258be3.55680913", "image": "https://example.com/library/451295/ca73592afb53e581f294bf7298e8ffb5f8da4c9f.jpg", "optimum_image": "https://example.com/library/451295/51d30fc0dfe338ef5c05314ad9f6778c1bd6016f.webp", "width": 300, "height": 250, "media": "img_banner" }, "multizoneid": 67890 }, { "idzone": 12345, "type": "banner", "data": { "url": "https://syndication.example.com/click.php?d=H4sIAAAAAAAAA11Ry07DMBD8Gm5ptLt.xD5ygAsHkPgC13GaqHlUcdq0aD8eO0UFofFhNTP7tAGQZIChVNwuyyk.iecnek2vd2PdTHN0fSi7sVzaxO3deDhOx11_vp7n285PYz3tKAnMwFhpLVEZsLyG_eDiEubuK5R.GpiQSoMlGigJk5V0RUICsBJKIGhWiMwSmdhWqRawALiSStYMS3BFSGOykESUuiTdghcYrBTohZa13FOt0TrhQaC2KQ14FdG309THbQjYsK5r8eCLxBftMvTFMt.6pXDxVDRdH0Y3hExtUh0ad.4X3kpuswmhLYgcIUhpLef9K8k_esbdm65hSOkccfYzyYfK_PL58SfjF_SvCnAsB3eI82XbI_W5d.LNeyHi9zfW0hitq6bx6SahrpXz5AjznzifTvwNlJrwcuoBAAA-&cb=e2e_69495dc1259e91.21591992", "impression": "https://syndication.example.com/cimp.php?t=api&data=H4sIAAAAAAAAA01Q0U7DMBD7FX5gle8uuSY8wzvSxAe0WQtIjEkrYgP548mysRErp4vPTqwoNK5EV6p3gnvYvWaqaJekk4ROBXxcPzEID9O4HZbPaf\/2M3Vlt6W5WO\/MEDOnwBQpMVo0gTOKMAFBEyjqvVoAmHsqUWFBVYPEdujB5\/VD21KhNOCosRrb4+xD4yUrjoLU\/MgoJlMOJsU8bMKoG5c8WIGJ5yoHD7aU193ufWl5cUYn0bWO4x9Bq\/kzjKuTp4YPIWfWBbbxsHx\/FPIqB2NC0uinjnbhTt7\/mhvEbm2rS7cdXpb9V0sVeLGd\/+V6Cz3MmIupz9BxRF+8L5vZVQLmnH3+BX0inm26AQAA&cb=e2e_69495dc125a500.54289539", "image": "https://example.com/library/451295/ca73592afb53e581f294bf7298e8ffb5f8da4c9f.jpg", "optimum_image": "https://example.com/library/451295/51d30fc0dfe338ef5c05314ad9f6778c1bd6016f.webp", "width": 300, "height": 250, "media": "img_banner" }, "multizoneid": 67890 } ] } } ] } ``` ## Responsive Display Ads Some formats, like Banners and Fullpage interstitials, can enable [**Responsive Display Ads**](/exoclick-docs/general-responsive-display-ads.md) to receive demand from Native Ads campaigns in addition to the demand from their original ad formats. In these situations, the response will contain the **original\_zone** object indicating the type and data of the original format. Here is an example for a Banner ad format: ```json { "zones": [ { "idzone": 5353142, "type": "native_ad", "data": { "layout": { "widgetHeaderContentHtml": "Powered By <\/span><\/a>", "branding_logo": "\/\/s3t3d2y1.afcdn.net\/widget-branding-logo.png", "branding_logo_hover": "\/\/s3t3d2y1.afcdn.net\/widget-branding-logo-hover.png", "itemsPerRow": 1, "itemsPerCol": 1, "font_family": "Arial, Helvetica, Verdana, sans-serif", "header_font_size": "12px", "header_font_color": "#999999", "widget_background_color": "transparent", "widget_width": "450px", "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": 1, "image_border_size": "", "image_border_color": "", "text_align": "left", "customcss_enabled": 1, "customcss": "{\n width: 300px !important;\n height: 250px !important;\n}\n.exo-native-widget-header {\n display: none !important;\n}\n.exo-native-widget-item-container {\n width: 300px !important;\n height: 250px !important;\n max-width: 300px !important;\n padding-right: 0 !important;\n padding-bottom: 0 !important;\n}\n.exo-native-widget-item-image-wrapper { \n width: 300px !important;\n height: 250px !important;\n max-height: 250px !important;\n overflow: hidden !important;\n}\n.exo-native-widget-item-content-box {\n position: relative !important;\n}\n.exo-native-widget-item-content {\n position: absolute !important;\n z-index: 5 !important;\n top: 180px !important;\n background-color: white !important;\n opacity: 0.7 !important;\n height: auto !important;\n max-height: 110px !important;\n min-height: 70px !important;\n width: 100% !important;\n max-width: 300px !important;\n}\n.exo-native-widget-item-title {\n padding: 10px 8px 4px 8px !important;\n height: 20px !important;\n color: black !important;\n font-weight: 900 !important;\n font-size: 18px !important;\n display: flex !important;\n align-items: center;\n justify-content: center;\n text-align: center;\n white-space: normal !important;\n}\n.exo-native-widget-item-text {\n padding: 20px 8px 4px 8px !important;\n height: 20px !important;\n color: grey !important;\n font-weight: normal !important;\n font-size: 13px !important;\n display: flex !important;\n align-items: center;\n justify-content: center;\n text-align: center;\n white-space: normal !important;\n}\n.exo-native-widget-item-brand {\n padding: 5px 8px 0px 8px !important;\n height: 20px !important;\n font-weight: normal !important;\n font-size: 18px !important;\n display: none !important;\n align-items: center;\n justify-content: center;\n text-align: center;\n white-space: normal !important;\n}", "header_enabled": 1, "mobile_breakpoint": 450, "spacing_v": 10, "spacing_h": 10, "zoom": 1, "mobile_rows": 1, "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", "mobile_image_height": 450, "delaySeconds": 0, "frequency": 0, "frequencyCount": 0, "publisherAdType": "native-recommendation", "adTriggerType": "", "popTriggerMethod": "", "popTriggerClasses": "", "item_spacing_on_each_side": "5px", "text_position": "bottom", "text_box_size": "90px", "widget_height": "570px", "brand_enabled": 0, "brand_font_size": "11px", "brand_font_color": "#555555", "brand_font_weight": "normal", "brand_decoration": "none" }, "ad_items": [ { "image": "https:\/\/s.example.net\/library\/451295\/4c5353dfe10c9e8ea12b05cc44eb0c6cafbc6100.jpg", "url": "https:\/\/s.example.com\/click.php?d=H4sIAAAAAAAAA01RwW7DIAz9mt4iZBuHwnGH7rLDJvUDJkJIWylZqpA16.SPH6Cpmx4YYz.eMZi93rMzYhS0cl7Xa9rppx095zHOXXdX88lPURUzzMspqjBPORfT..GYVxEQ3BvDaJFQtthNPq1xuXxXphCSsqjQgiLMVCDDYBmk1a1GJmkRRRiFxO2zFohggSP4QrB5q5mIGFvR4CBojI41Bm245456g87rABqNy8dANp3CeZ7HVKtDxbZtzSPe5HhzXqexWZf7ZW18ujbDZYwfucESqqk.Dv5zXKVKFmitjQNdPARm56Q2DiS_hALOs.Xq5tuWVggNCFGhlq0cjm__.H8oDFCQf6DYzFX4KJ3U5E9pudWGWErh_JRVLsui3LL.64tQ77kbnOfWDtH2vQeLjgM548MQYvgB99zVE.gBAAA-&cb=e2e_694966c98c6cc2.67060117", "optimum_image": "https:\/\/s3t3d2y1.afcdn.net\/library\/451295\/15c408293013fe9637290dbc36ec5a3fbd671c48.webp", "title": "All systems online \ud83d\udc68\u200d\ud83d\ude80", "description": "Reach for the stars in this new space simulation game.", "brand": "ogame.com", "original_url": "https:\/\/lobby.ogame.gameforge.com\/es_ES\/", "image_position": "50% 50%", "format": "native_ad", "size": "300x300", "iframe_url": "", "impression": "https:\/\/s.example.com\/cimp.php?t=api&data=H4sIAAAAAAAAA01QW04DMQy8ChfoymM72Q3f9B9R9QC7aXhIlEpdRAHN4Um2tJCRbDlje2yraFhBV6o3kFvXWwEV2g3oMEinEK4393TwVKb9OL+X48t36fJhTw\/QFJgEZpEQUxkGBgsGVwaAsbfeU+M0ugwuTD2VUmGuqo7Qgk4kSmAv3G7uuN4+sIr3qhenJJYpWiN6DZBUPiHD0kmSZENJbsgWfeeT7iLSaFkMMdV04cnm\/Hw4vM7L5HJGB8Q6HMPlg1Y3SWJctRqDuKfE+oQLPc5fb5m8pgc\/O1q12hZrdX\/8f2D4XTUsFk1+SRfO3X58mo8f56suevXwrebMX3uyFMEoKT5OZZzyVC9gIfa7WDBZHqfwA7sG\/xjOAQAA&cb=e2e_694966c98c7af4.92854754", "count_only_viewed_impressions": 0, "video_thumb_id": null, "video_thumb_url": null, "video_thumb_enabled": 0 } ] }, "original_zone": { "type": "banner", "data": { "width": 300, "height": 250 } } } ] } ``` ## Impression tracking Make sure to make a GET call for the Impression URL to register the impressions for your ad requests. One way to achieve this is by creating an invisible image file using the impression URL as the source on the page where the ad will be displayed, e.g: ```html ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.exoclick.com/api/ad-placement-api/response/ad-plac-response.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.