{"_id":"564ddbcbd3320b0d0028ca25","parentDoc":null,"project":"564621e00c30fb2100ba3814","__v":7,"user":"56499dade2efd717002afc83","version":{"_id":"564621e10c30fb2100ba3817","__v":14,"project":"564621e00c30fb2100ba3814","createdAt":"2015-11-13T17:46:09.275Z","releaseDate":"2015-11-13T17:46:09.275Z","categories":["564621e10c30fb2100ba3818","564624cf0c30fb2100ba3822","564628d69f3f550d00fa3db6","564dafeeda00e82b00ed601d","564daff8fc36dc3700882b95","564db0ccda00e82b00ed601f","564dcf87d3320b0d0028ca10","5661a6e436398e0d00f79566","568585153703ed1700e420b0","56858767d96a760d00545da6","56858d693703ed1700e420b2","56858d8d22c41b0d00e4666c","56859e9c009a8d0d00797130","5685a6453703ed1700e420d3"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"564dcf87d3320b0d0028ca10","version":"564621e10c30fb2100ba3817","__v":26,"pages":["564dcfb4d3320b0d0028ca11","564dd25da8671617004e7b71","564dd3a7e39c4435005a1f33","564ddbcbd3320b0d0028ca25","564ddcb2a8671617004e7b8e","564ddfffa8671617004e7b94","564de165a8671617004e7b97","564de17d9176e9170068007b","564de194e39c4435005a1f56","564de3d99176e9170068007e","564de439fe07a81700b5c3af","564ef3911e9a082b00344ea1","564f03dfedbade0d000efa57","564f0978234efc0d006e186e","564f0d9aaf8ae235002db90e","564f133e4f000617007bd68e","564f14d829338a1700beefcd","564f15619eb2701700532470","564f2fec6b10960d00865761","564f302b6b10960d00865764","564f33e219857f2b00387a44","564f35d110b21d3500ad29d3","564f42e41af2c835004bfbe9","564f456ab85ee335004cbdb3","5652e161b83d8e0d00d24b6b","56859949cfc7cf0d001cb3f5"],"project":"564621e00c30fb2100ba3814","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-19T13:32:55.176Z","from_sync":false,"order":6,"slug":"api-overview","title":"Ad Request API"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-19T14:25:15.844Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":10,"body":"There are three different types of response types.\n\n**textAd**, which returns HTML Markup that should be shown to the end user, **mraidAd** which returns MRAID Rich Media Ads, or **noAd**.\n\nThe contents of the response must be parsed by your application.\n\nThe following section gives you examples of how the different response types can look like:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<request type=\\\"textAd\\\">\\n   <htmlString>\\n      <![CDATA[<body style=\\\"text-align:center;margin:0;padding:0;\\\"><div align=\\\"center\\\">\\n      <a id=\\\"PhoneClickAdLink\\\" href=\\\"http://my.mobfox.com/ct/12114/f390f0b4b41a0a029bdd8ce6b2bf1d0b/13549/undefined/3/5040/6509\\\" \\n      target=\\\"_self\\\">\\n      <img id=\\\"PhoneClickAdImage\\\" src=\\\"http://creative1cdn.mobfox.com/5040-12114-300x50.gif\\\" alt=\\\"This is a MobFox Banner Ad\\\" border=\\\"0\\\"/>\\n      </a></div></body>]]>\\n   </htmlString>\\n   <clicktype>inapp</clicktype>\\n   <clickurl>\\nhttp://my.mobfox.com/ct/12114/f390f0b4b41a0a029bdd8ce6b2bf1d0b/13549/undefined/3/5040/6509\\n   </clickurl>\\n   <urltype>link</urltype>\\n   <refresh>90</refresh>\\n   <scale>no</scale>\\n   <skippreflight>yes</skippreflight>\\n</request>\",\n      \"language\": \"xml\",\n      \"name\": \"Success XML Response - Banner\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<request type=\\\"mraidAd\\\">\\n   <htmlString skipoverlaybutton=\\\"1\\\"><![CDATA[<script src=\\\"mraid.js\\\"></script>\\n      <script>\\n      (function() {\\n      var c = '';\\n      var u = 'http://api.celtra.com/v1/creatives/1520/compiled/ExpandableBanner/mraid-inapp.js\\n      ?channel=test&c='+encodeURIComponent(c)+'&rnd='+(Math.random()+'').slice(2);\\n      document.write('<script src=\\\"'+u+'\\\"></scr'+'ipt>');\\n      })();\\n      </script>]]>\\n   </htmlString>\\n   <clicktype>inapp</clicktype>\\n   <clickurl />\\n   <urltype>link</urltype>\\n   <refresh>30</refresh>\\n   <scale>no</scale>\\n   <skippreflight>yes</skippreflight>\\n</request>\",\n      \"language\": \"xml\",\n      \"name\": \"Success XML Response - MRAID Ad\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<request type=\\\"noAd\\\"></request>\",\n      \"language\": \"xml\",\n      \"name\": \"No Ad XML Response\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"response-format","type":"basic","title":"Response Format"}
There are three different types of response types. **textAd**, which returns HTML Markup that should be shown to the end user, **mraidAd** which returns MRAID Rich Media Ads, or **noAd**. The contents of the response must be parsed by your application. The following section gives you examples of how the different response types can look like: [block:code] { "codes": [ { "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"textAd\">\n <htmlString>\n <![CDATA[<body style=\"text-align:center;margin:0;padding:0;\"><div align=\"center\">\n <a id=\"PhoneClickAdLink\" href=\"http://my.mobfox.com/ct/12114/f390f0b4b41a0a029bdd8ce6b2bf1d0b/13549/undefined/3/5040/6509\" \n target=\"_self\">\n <img id=\"PhoneClickAdImage\" src=\"http://creative1cdn.mobfox.com/5040-12114-300x50.gif\" alt=\"This is a MobFox Banner Ad\" border=\"0\"/>\n </a></div></body>]]>\n </htmlString>\n <clicktype>inapp</clicktype>\n <clickurl>\nhttp://my.mobfox.com/ct/12114/f390f0b4b41a0a029bdd8ce6b2bf1d0b/13549/undefined/3/5040/6509\n </clickurl>\n <urltype>link</urltype>\n <refresh>90</refresh>\n <scale>no</scale>\n <skippreflight>yes</skippreflight>\n</request>", "language": "xml", "name": "Success XML Response - Banner" } ] } [/block] [block:code] { "codes": [ { "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"mraidAd\">\n <htmlString skipoverlaybutton=\"1\"><![CDATA[<script src=\"mraid.js\"></script>\n <script>\n (function() {\n var c = '';\n var u = 'http://api.celtra.com/v1/creatives/1520/compiled/ExpandableBanner/mraid-inapp.js\n ?channel=test&c='+encodeURIComponent(c)+'&rnd='+(Math.random()+'').slice(2);\n document.write('<script src=\"'+u+'\"></scr'+'ipt>');\n })();\n </script>]]>\n </htmlString>\n <clicktype>inapp</clicktype>\n <clickurl />\n <urltype>link</urltype>\n <refresh>30</refresh>\n <scale>no</scale>\n <skippreflight>yes</skippreflight>\n</request>", "language": "xml", "name": "Success XML Response - MRAID Ad" } ] } [/block] [block:code] { "codes": [ { "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"noAd\"></request>", "language": "xml", "name": "No Ad XML Response" } ] } [/block]