{"_id":"564ddcb2a8671617004e7b8e","project":"564621e00c30fb2100ba3814","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"},"parentDoc":null,"__v":2,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-19T14:29:06.884Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"The key values in the response are:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"request:type\",\n    \"0-1\": \"Either \\\"textAd\\\" for an ad that includes HTML Markup for you to render on the device, \\\"mraidAd\\\" for a MRAID Rich Media Ad, or \\\"noAd\\\" if no ad currently is available.\",\n    \"1-0\": \"htmlString\",\n    \"1-1\": \"If the ad is a textAd, this is the HTML Markup/Content of the ad that you should render on the device and show to the end user. If the ad is an mraidAd, this parameter will include the Javascript mRaid code that needs to be executed and displayed to the end user.\",\n    \"2-0\": \"htmlString:skipoverlaybutton\",\n    \"2-1\": \"Ignore this parameter. This value is only used by our native SDK and not needed with API integrations.\",\n    \"3-0\": \"clicktype\",\n    \"3-1\": \"If \\\"clicktype\\\" is 'inapp', the Ad URL should be opened in an in-app browsing environment when the ad is clicked. If \\\"clicktype\\\" is 'safari', then the ad click should by opened in Safari on iOS and in the native browser on Android.\",\n    \"4-0\": \"clickurl\",\n    \"4-1\": \"The URL that should be opened when the Ad is clicked. (only included with textAds, not with mRaid Ads) - However if you render the Markup from htmlString this Link should already be included in the markup and usually is not needed.\",\n    \"5-0\": \"urltype\",\n    \"5-1\": \"Ignore this parameter. This value is only used by our native SDK and not needed with API integrations.\",\n    \"6-0\": \"refresh\",\n    \"6-1\": \"Time in seconds after which the ad should refresh and request a new advertisement.\",\n    \"7-0\": \"scale\",\n    \"7-1\": \"Ignore this parameter. This value is only used by our native SDK and not needed with API integrations.\",\n    \"8-0\": \"skippreflight\",\n    \"8-1\": \"Ignore this parameter. This value is only used by our native SDK and not needed with API integrations.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]","excerpt":"","slug":"response-parameters","type":"basic","title":"Response Parameters"}

Response Parameters


The key values in the response are: [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "request:type", "0-1": "Either \"textAd\" for an ad that includes HTML Markup for you to render on the device, \"mraidAd\" for a MRAID Rich Media Ad, or \"noAd\" if no ad currently is available.", "1-0": "htmlString", "1-1": "If the ad is a textAd, this is the HTML Markup/Content of the ad that you should render on the device and show to the end user. If the ad is an mraidAd, this parameter will include the Javascript mRaid code that needs to be executed and displayed to the end user.", "2-0": "htmlString:skipoverlaybutton", "2-1": "Ignore this parameter. This value is only used by our native SDK and not needed with API integrations.", "3-0": "clicktype", "3-1": "If \"clicktype\" is 'inapp', the Ad URL should be opened in an in-app browsing environment when the ad is clicked. If \"clicktype\" is 'safari', then the ad click should by opened in Safari on iOS and in the native browser on Android.", "4-0": "clickurl", "4-1": "The URL that should be opened when the Ad is clicked. (only included with textAds, not with mRaid Ads) - However if you render the Markup from htmlString this Link should already be included in the markup and usually is not needed.", "5-0": "urltype", "5-1": "Ignore this parameter. This value is only used by our native SDK and not needed with API integrations.", "6-0": "refresh", "6-1": "Time in seconds after which the ad should refresh and request a new advertisement.", "7-0": "scale", "7-1": "Ignore this parameter. This value is only used by our native SDK and not needed with API integrations.", "8-0": "skippreflight", "8-1": "Ignore this parameter. This value is only used by our native SDK and not needed with API integrations." }, "cols": 2, "rows": 9 } [/block]