-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GPP consent module: phase one release (#9321)
* GPP consent module phase 1 * various updates and added test pages * revise calling CMP, remove provisionalConsent, remove cmpDisplayStatus check, update pbs usersync * change callback check to be more strict * update logic on adding gpp data to ortb2 * update gpp metadata
- Loading branch information
1 parent
51c984e
commit e2cfc18
Showing
16 changed files
with
1,374 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| <!-- | ||
| This page calls a single bidder for a single ad slot. It can be considered a "hello world" example for using | ||
| Prebid with the Google Publisher Tag. | ||
| It also makes a good test page for new adapter PR submissions. Simply set your server's Bid Params object in the | ||
| bids array inside the adUnits, and it will use your adapter to load an ad. | ||
| NOTE that many ad servers won't send back an ad if the URL is localhost... so you might need to | ||
| set an alias in your /etc/hosts file so that you can load this page from a different domain. | ||
| --> | ||
|
|
||
| <html> | ||
|
|
||
| <head> | ||
| <script type="text/javascript" data-cmp-ab="1" src="https://cdn.consentmanager.net/delivery/semiautomatic.js" | ||
| data-cmp-cdid="599af61faf55" data-cmp-host="delivery.consentmanager.net" data-cmp-cdn="cdn.consentmanager.net" data-cmp-codesrc="1"></script> | ||
|
|
||
|
|
||
| <script async src="../../build/dev/prebid.js"></script> | ||
| <script async src="https://www.googletagservices.com/tag/js/gpt.js"></script> | ||
| <script> | ||
| var FAILSAFE_TIMEOUT = 3300; | ||
| var PREBID_TIMEOUT = 1000; | ||
|
|
||
| var adUnits = [{ | ||
| code: 'div-gpt-ad-1460505748561-0', | ||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [[300, 250], [300, 600]], | ||
| } | ||
| }, | ||
| // Replace this object to test a new Adapter! | ||
| bids: [{ | ||
| bidder: 'appnexus', | ||
| params: { | ||
| placementId: 13144370 | ||
| } | ||
| }] | ||
|
|
||
| }]; | ||
|
|
||
| var pbjs = pbjs || {}; | ||
| pbjs.que = pbjs.que || []; | ||
|
|
||
| </script> | ||
|
|
||
| <script> | ||
| var googletag = googletag || {}; | ||
| googletag.cmd = googletag.cmd || []; | ||
| googletag.cmd.push(function () { | ||
| googletag.pubads().disableInitialLoad(); | ||
| }); | ||
|
|
||
| pbjs.que.push(function () { | ||
| pbjs.addAdUnits(adUnits); | ||
| pbjs.setConfig({ | ||
| userSync: { | ||
| filterSettings: { | ||
| iframe: { | ||
| bidders: ['appnexus'], | ||
| filter: 'include' | ||
| } | ||
| } | ||
| } | ||
| }) | ||
| pbjs.setConfig({ | ||
| consentManagement: { | ||
| gpp: { | ||
| cmpApi: 'iab', | ||
| timeout: 5000 | ||
| }, | ||
| usp: { | ||
| cmpApi: 'static', | ||
| consentData: { | ||
| getUSPData: { | ||
| uspString: '1YYY' | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }) | ||
| pbjs.requestBids({ | ||
| bidsBackHandler: sendAdserverRequest, | ||
| timeout: PREBID_TIMEOUT | ||
| }); | ||
| }); | ||
|
|
||
| function sendAdserverRequest() { | ||
| if (pbjs.adserverRequestSent) return; | ||
| pbjs.adserverRequestSent = true; | ||
| googletag.cmd.push(function () { | ||
| pbjs.que.push(function () { | ||
| pbjs.setTargetingForGPTAsync(); | ||
| googletag.pubads().refresh(); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| setTimeout(function () { | ||
| sendAdserverRequest(); | ||
| }, FAILSAFE_TIMEOUT); | ||
|
|
||
| </script> | ||
|
|
||
| <script> | ||
| googletag.cmd.push(function () { | ||
| googletag.defineSlot('/19968336/header-bid-tag-0', [[300, 250], [300, 600]], 'div-gpt-ad-1460505748561-0').addService(googletag.pubads()); | ||
|
|
||
| googletag.pubads().enableSingleRequest(); | ||
| googletag.enableServices(); | ||
| }); | ||
| </script> | ||
| </head> | ||
|
|
||
| <body> | ||
| <h2>Prebid.js Test</h2> | ||
| <h5>Div-1</h5> | ||
| <!-- <button onclick="googletag.cmd.push(function () {googletag.pubads().refresh();});">Refresh GAM</button> --> | ||
| <div id='div-gpt-ad-1460505748561-0'> | ||
| <script type='text/javascript'> | ||
| googletag.cmd.push(function () { googletag.display('div-gpt-ad-1460505748561-0'); }); | ||
| </script> | ||
| </div> | ||
| </body> | ||
|
|
||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| <!-- start a locally ran server under a different port than 9999 and run gulp serve. | ||
| load this page from the local server to properly replicate loading prebid.js within a 3rd party iframe --> | ||
| <html> | ||
| <head> | ||
| <script type="text/javascript" data-cmp-ab="1" src="https://cdn.consentmanager.net/delivery/autoblocking/599af61faf55.js" | ||
| data-cmp-host="delivery.consentmanager.net" data-cmp-cdn="cdn.consentmanager.net" data-cmp-codesrc="1"></script> | ||
| </head> | ||
| <body> | ||
| <iframe style="width: 100%; height: 100%;" src="http://test.localhost:9999/integrationExamples/gpt/gpp_us_hello_world_iframe_subpage.html"></iframe> | ||
| </body> | ||
| </html> | ||
|
|
140 changes: 140 additions & 0 deletions
140
integrationExamples/gpt/gpp_us_hello_world_iframe_subpage.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| <!-- | ||
| This page calls a single bidder for a single ad slot. It can be considered a "hello world" example for using | ||
| Prebid with the Google Publisher Tag. | ||
| It also makes a good test page for new adapter PR submissions. Simply set your server's Bid Params object in the | ||
| bids array inside the adUnits, and it will use your adapter to load an ad. | ||
| NOTE that many ad servers won't send back an ad if the URL is localhost... so you might need to | ||
| set an alias in your /etc/hosts file so that you can load this page from a different domain. | ||
| --> | ||
|
|
||
| <html> | ||
|
|
||
| <head> | ||
| <script async src="../../build/dev/prebid.js"></script> | ||
| <script async src="https://www.googletagservices.com/tag/js/gpt.js"></script> | ||
| <script> | ||
| var FAILSAFE_TIMEOUT = 3300; | ||
| var PREBID_TIMEOUT = 1000; | ||
|
|
||
| var adUnits = [{ | ||
| code: 'div-gpt-ad-1460505748561-0', | ||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [[300, 250], [300, 600]], | ||
| } | ||
| }, | ||
| // Replace this object to test a new Adapter! | ||
| bids: [{ | ||
| bidder: 'appnexus', | ||
| params: { | ||
| placementId: 13144370 | ||
| } | ||
| }] | ||
|
|
||
| }]; | ||
|
|
||
| var pbjs = pbjs || {}; | ||
| pbjs.que = pbjs.que || []; | ||
|
|
||
| </script> | ||
|
|
||
| <script> | ||
| var googletag = googletag || {}; | ||
| googletag.cmd = googletag.cmd || []; | ||
| googletag.cmd.push(function () { | ||
| googletag.pubads().disableInitialLoad(); | ||
| }); | ||
|
|
||
| pbjs.que.push(function () { | ||
| pbjs.addAdUnits(adUnits); | ||
| pbjs.setConfig({ | ||
| userSync: { | ||
| filterSettings: { | ||
| iframe: { | ||
| bidders: ['appnexus'], | ||
| filter: 'include' | ||
| } | ||
| } | ||
| } | ||
| }) | ||
| pbjs.setConfig({ | ||
| debug: true, | ||
| consentManagement: { | ||
| gpp: { | ||
| cmpApi: 'iab', | ||
| timeout: 5000 | ||
| }, | ||
| usp: { | ||
| cmpApi: 'static', | ||
| consentData: { | ||
| getUSPData: { | ||
| uspString: '1YYY' | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }) | ||
| pbjs.requestBids({ | ||
| bidsBackHandler: sendAdserverRequest, | ||
| timeout: PREBID_TIMEOUT | ||
| }); | ||
| }); | ||
|
|
||
| function sendAdserverRequest() { | ||
| if (pbjs.adserverRequestSent) return; | ||
| pbjs.adserverRequestSent = true; | ||
| googletag.cmd.push(function () { | ||
| pbjs.que.push(function () { | ||
| pbjs.setTargetingForGPTAsync(); | ||
| googletag.pubads().refresh(); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| // setTimeout(function () { | ||
| // sendAdserverRequest(); | ||
| // }, FAILSAFE_TIMEOUT); | ||
|
|
||
| </script> | ||
|
|
||
| <script> | ||
| googletag.cmd.push(function () { | ||
| googletag.defineSlot('/19968336/header-bid-tag-0', [[300, 250], [300, 600]], 'div-gpt-ad-1460505748561-0').addService(googletag.pubads()); | ||
|
|
||
| googletag.pubads().enableSingleRequest(); | ||
| googletag.enableServices(); | ||
| }); | ||
| </script> | ||
| </head> | ||
|
|
||
| <body> | ||
| <h2>Prebid.js Test</h2> | ||
| <h5>Div-1</h5> | ||
| <!-- <button onclick="pbjs.que.push(function() {pbjs.setConfig({ | ||
| consentManagement: { | ||
| gpp: { | ||
| cmpApi: 'iab', | ||
| timeout: 5000 | ||
| }, | ||
| usp: { | ||
| cmpApi: 'static', | ||
| consentData: { | ||
| getUSPData: { | ||
| uspString: '1YYY' | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }); | ||
| pbjs.requestBids({ | ||
| bidsBackHandler: sendAdserverRequest, | ||
| timeout: PREBID_TIMEOUT | ||
| });})">Start Auction</button> --> | ||
| <div id='div-gpt-ad-1460505748561-0'> | ||
| <script type='text/javascript'> | ||
| googletag.cmd.push(function () { googletag.display('div-gpt-ad-1460505748561-0'); }); | ||
| </script> | ||
| </div> | ||
| </body> | ||
|
|
||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.