Support SafeFrame / x-domain on prebid creatives #885

protonate · 2016-12-16T15:16:46Z

Type of change

Feature

Description of change

A creative served in a cross domain iframe can request the ad from the auction winner via postMessage.

mkendall07 · 2016-12-16T19:42:30Z

integrationExamples/gpt/safeframe/creative.html

+  };
+
+  var listenAdFromPrebid = function () {
+    window.addEventListener("message", renderAd, false);


mkendall07 · 2016-12-16T19:43:28Z

integrationExamples/gpt/safeframe/creative.html

+      message: 'Prebid creative requested: %%PATTERN:hb_adid%%',
+      adId: '%%PATTERN:hb_adid%%'
+    });
+    window.parent.postMessage(message, '*');


No way to avoid * here I guess?

mkendall07 · 2016-12-16T19:47:18Z

src/prebid.js

@@ -289,6 +289,35 @@ function setRenderSize(doc, width, height) {
  }
 }

+function listenAdRequestFromCreative() {
+  addEventListener('message', sendAdToCreative, false);


missing window?

mkendall07 · 2016-12-16T19:48:26Z

src/prebid.js

+
+    var ad = adObject.ad;
+    var adUrl = adObject.adUrl;
+    var message = JSON.stringify({


prefer a factory pattern for creating messages.

mkendall07 · 2017-01-06T17:00:27Z

integrationExamples/gpt/x-domain/creative.js

+      var ad = adObject.ad;
+      var doc = window.document;
+
+      // if (doc === document || adObject.mediaType === 'video') {


conversation piece?

Yep. This code is running in the x-domain iframe, so doc === document. Also utils module is not available so need to solve for a local console.log.

mkendall07 · 2017-01-06T17:01:43Z

integrationExamples/gpt/x-domain/creative.js

+function requestAdFromPrebid() {
+  var message = JSON.stringify({
+    message: 'Prebid Request',
+    adId: window.prebidAdId


Where does prebidAdId come from?

The DFP code snippet needs to set the adId for the creative.js, and while developing using an external creative.js file this simply sticks it on the x-domain iframe window object.

mkendall07 · 2017-01-06T17:02:34Z

integrationExamples/gpt/x-domain/creative.js

+    message: 'Prebid Request',
+    adId: window.prebidAdId
+  });
+  window.parent.postMessage(message, '*');


Should we add a marco for hostname? This could be set as a keyword by Prebid and then communication would be limited between those domains.

Yes, indeed, I'll make the change.

…ins for postMessage (no wildcards), resize cross domain iframes

protonate · 2017-01-09T06:12:58Z

@mkendall07 this is ready for further review.

mkendall07 · 2017-01-10T15:37:00Z

integrationExamples/gpt/x-domain/creative.js

+// creative will be rendered, e.g. DFP delivering a SafeFrame
+
+const publisherDomain = 'http://localhost:9999';
+const adServerDomain = 'http://tpc.googlesyndication.com';


Let's add a note about making sure to match the protocol. I assume that this becomes HTTPS on secure pages?

mkendall07 · 2017-01-10T15:39:15Z

integrationExamples/gpt/x-domain/creative.js

@@ -0,0 +1,53 @@
+// this script can be returned by an ad server delivering a cross domain iframe, into which the
+// creative will be rendered, e.g. DFP delivering a SafeFrame


Can make a note about using a macro here instead of a hardcoded string. Many creatives will be delivered to multiple domains.

mkendall07 · 2017-01-10T15:40:26Z

src/prebid.js

@@ -288,6 +291,58 @@ function setRenderSize(doc, width, height) {
  }
 }

+function listenMessagesFromCreative() {


Let's move this function into a separate file

protonate · 2017-01-12T08:17:22Z

@mkendall07 review notes addressed.

mkendall07

LGTM.

Support SafeFrame / x-domain on prebid creatives

…ebid-official-0.18.0 to release/1.13.0 * commit 'e145489bc5dd6d292cf16e7fe80adfdf991562ac': (27 commits) Add changelog entry. Prebid 0.18.0 Release Add Criteo adapter (prebid#928) add an event that fires when requestBids is called (prebid#939) Xaxis adapter submitted by Daniel hoffmann (prebid#938) Add flash detection to TripleLift adapter (prebid#855) OpenX Adapter: Fixed bug regarding cross-domain iframe support (prebid#931) Emit event when setTargetingForGPTAsync is called (prebid#873) Maintenance/refactor hb deal (prebid#935) Reset hb_* keys only for registered aduniits (prebid#934) update code style - smartyads adapter Catch errors in bidsBackHandler. Also fix test cleanup in pbjs api spec. (prebid#905) Smartyads Adapter (prebid#895) Appnexus targeting function (prebid#920) There are 2 changes- (prebid#913) Adding support for all AST parameters (prebid#923) GumGum adapter - include the bid timeout as `tmax` (prebid#908) Add pixel size (prebid#892) enable postMessage listener for cross-domain iframe support (prebid#885) Add Sharethrough adapter (prebid#865) ...

…13.0 to master * commit '7d32ed18c8636d9241ef8b299b6abd885536db69': (27 commits) Add changelog entry. Prebid 0.18.0 Release Add Criteo adapter (prebid#928) add an event that fires when requestBids is called (prebid#939) Xaxis adapter submitted by Daniel hoffmann (prebid#938) Add flash detection to TripleLift adapter (prebid#855) OpenX Adapter: Fixed bug regarding cross-domain iframe support (prebid#931) Emit event when setTargetingForGPTAsync is called (prebid#873) Maintenance/refactor hb deal (prebid#935) Reset hb_* keys only for registered aduniits (prebid#934) update code style - smartyads adapter Catch errors in bidsBackHandler. Also fix test cleanup in pbjs api spec. (prebid#905) Smartyads Adapter (prebid#895) Appnexus targeting function (prebid#920) There are 2 changes- (prebid#913) Adding support for all AST parameters (prebid#923) GumGum adapter - include the bid timeout as `tmax` (prebid#908) Add pixel size (prebid#892) enable postMessage listener for cross-domain iframe support (prebid#885) Add Sharethrough adapter (prebid#865) ...

StaymanHou · 2018-02-27T14:51:14Z

Would the doc also be updated regarding the safeframe option?

Here it still says the safeframe box has to be unchecked. And the code snippet doesn't work for safeframe.

mkendall07 added the in progress label Dec 16, 2016

mkendall07 reviewed Dec 16, 2016

View reviewed changes

protonate self-assigned this Jan 3, 2017

protonate mentioned this pull request Jan 5, 2017

PROPOSAL: Sandbox using DFP Safe Frame with Post Message #675

Closed

8 tasks

protonate added 4 commits January 5, 2017 09:37

enable postMessage listener for cross-domain iframe support

9de4999

add SafeFrame creative example

ffe5877

push listener setup to prebid command que

e80bceb

include setRenderSize and send bid won event in creative

d7f1f48

protonate force-pushed the feature/x-domain-iframe branch from 4a3065a to d7f1f48 Compare January 5, 2017 17:39

protonate added 2 commits January 5, 2017 12:31

add setRenderSize and send bid won event in creative

07c1921

ad payloads written to safeframe

47f3aff

mkendall07 approved these changes Jan 6, 2017

View reviewed changes

emit bid won event in receiveMessage, set publisher and adServer doma…

100b791

…ins for postMessage (no wildcards), resize cross domain iframes

protonate assigned mkendall07 and unassigned protonate Jan 9, 2017

mkendall07 requested changes Jan 10, 2017

View reviewed changes

secure creatives module, domain macro comment, review notes

dfbdb51

use macro for adId in cross domain creative

d0514cb

mkendall07 approved these changes Jan 12, 2017

View reviewed changes

mkendall07 changed the title ~~enable postMessage listener for cross-domain iframe support~~ Support SafeFrame / x-domain on prebid creatives Jan 12, 2017

mkendall07 merged commit 3ec356f into master Jan 12, 2017

mkendall07 deleted the feature/x-domain-iframe branch January 12, 2017 19:08

mkendall07 removed the in progress label Jan 12, 2017

Walexander pushed a commit to MbidIO/Prebid.js that referenced this pull request Mar 6, 2017

enable postMessage listener for cross-domain iframe support (prebid#885)

184424f

Support SafeFrame / x-domain on prebid creatives

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support SafeFrame / x-domain on prebid creatives #885

Support SafeFrame / x-domain on prebid creatives #885

protonate commented Dec 16, 2016

mkendall07 Dec 16, 2016

mkendall07 Dec 16, 2016

mkendall07 Dec 16, 2016

mkendall07 Dec 16, 2016

mkendall07 Jan 6, 2017

protonate Jan 6, 2017

mkendall07 Jan 6, 2017

protonate Jan 6, 2017

mkendall07 Jan 6, 2017

protonate Jan 6, 2017

protonate commented Jan 9, 2017

mkendall07 Jan 10, 2017

mkendall07 Jan 10, 2017

mkendall07 Jan 10, 2017

protonate commented Jan 12, 2017

mkendall07 left a comment

StaymanHou commented Feb 27, 2018

		@@ -0,0 +1,53 @@
		// this script can be returned by an ad server delivering a cross domain iframe, into which the
		// creative will be rendered, e.g. DFP delivering a SafeFrame

Support SafeFrame / x-domain on prebid creatives #885

Support SafeFrame / x-domain on prebid creatives #885

Conversation

protonate commented Dec 16, 2016

Type of change

Description of change

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

protonate commented Jan 9, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

protonate commented Jan 12, 2017

mkendall07 left a comment

Choose a reason for hiding this comment

StaymanHou commented Feb 27, 2018