forked from prebid/Prebid.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
51Degrees RTD submodule: initial commit (prebid#11414)
* 51Degrees RTD provider * Amended comments and documentation to improve references for obtaining additional information and resources. Added an exception if the resourceKey parameter is not updated from the example. Added a customer notices section to the readme. Used User Agent Client Hint (UA-CH) consistently in the documentation. * Modified the maintainer email address. * Change outdated URL * Adjust code to work on legacy browsers * Refactor a test of the `inject` method * Replace URL in a test method * 51Degrees RTD provider: remove redundant parameter from the example * 51Degrees RTD provider: update gpt.js URL in the example file * 51Degrees RTD provider: add schema to the `is51DegreesMetaPresent` method's URL * 51Degrees RTD provider: refactor `51Degrees` script injection method * 51Degrees RTD provider: show enriched device data in the example page * 51Degrees RTD provider: provide additional explanation for checking meta tags * 51Degrees RTD provider: update string for meta tag check * 51Degrees RTD provider: improve tests, reach 100% tests coverage * 51d example: debug warning and guidance as per review comment: - added a comment warning that debug flag should not be used in production - improved example page a bit with the testing/debugging guidance * 51d doc: add GetHighEntropyValues vs. Delegate-CH addressing review comment: prebid#11414 (review) with a discussion on why Delegate-CH is more prefereable than GetHighEntropyValues API * 51d: fix minor doc omissions --------- Co-authored-by: Bohdan V <[email protected]> Co-authored-by: Eugene Dorfman <[email protected]>
- Loading branch information
Showing
5 changed files
with
863 additions
and
0 deletions.
There are no files selected for viewing
196 changes: 196 additions & 0 deletions
196
integrationExamples/gpt/51DegreesRtdProvider_example.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,196 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta http-equiv="Delegate-CH" content="sec-ch-ua-full-version-list https://cloud.51degrees.com; sec-ch-ua-model https://cloud.51degrees.com; sec-ch-ua-platform https://cloud.51degrees.com; sec-ch-ua-platform-version https://cloud.51degrees.com"> | ||
| <script async src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"></script> | ||
| <script async src="../../build/dev/prebid.js"></script> | ||
| <meta charset="utf-8"> | ||
| <style> | ||
| body { | ||
| color: #555; | ||
| font-family: sans-serif; | ||
| } | ||
| </style> | ||
| <script> | ||
| var PREBID_TIMEOUT = 1000; | ||
| var FAILSAFE_TIMEOUT = 3000; | ||
|
|
||
| var googletag = googletag || {}; | ||
| googletag.cmd = googletag.cmd || []; | ||
|
|
||
| var pbjs = pbjs || {}; | ||
| pbjs.que = pbjs.que || []; | ||
|
|
||
| function initAdserver() { | ||
| if (pbjs.initAdserverSet) return; | ||
|
|
||
| googletag.cmd.push(function () { | ||
| pbjs.que.push(function () { | ||
| pbjs.setTargetingForGPTAsync(); | ||
| googletag.pubads().refresh(); | ||
| }); | ||
| }); | ||
|
|
||
| pbjs.initAdserverSet = true; | ||
| } | ||
|
|
||
| pbjs.que.push(function () { | ||
| var adUnits = [{ | ||
| code: 'div-banner-native-1', | ||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [ | ||
| [300, 250] | ||
| ] | ||
| }, | ||
| native: { | ||
| type: 'image' | ||
| }, | ||
| }, | ||
| bids: [{ | ||
| bidder: 'appnexus', | ||
| params: { | ||
| placementId: 13232392, | ||
| } | ||
| }] | ||
| }, | ||
| { | ||
| code: 'div-banner-native-2', | ||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [ | ||
| [300, 250] | ||
| ] | ||
| }, | ||
| native: { | ||
| title: { | ||
| required: true | ||
| }, | ||
| image: { | ||
| required: true | ||
| }, | ||
| sponsoredBy: { | ||
| required: true | ||
| } | ||
| } | ||
| }, | ||
| bids: [{ | ||
| bidder: 'appnexus', | ||
| params: { | ||
| placementId: 13232392, | ||
| } | ||
| }] | ||
| } | ||
| ]; | ||
|
|
||
| pbjs.setConfig({ | ||
| debug: true, // use only for testing, remove in production | ||
| realTimeData: { | ||
| auctionDelay: 1000, // should be set lower in production use | ||
| dataProviders: [ | ||
| { | ||
| name: '51Degrees', | ||
| waitForIt: true, | ||
| params: { | ||
| // Get your resource key from https://configure.51degrees.com/tWrhNfY6 | ||
| resourceKey: '<YOUR_RESOURCE_KEY>', | ||
| // alternatively, you can use the on-premise version of the 51Degrees service and connect to your chosen end point | ||
| // onPremiseJSUrl: 'https://localhost/51Degrees.core.js' | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| }); | ||
|
|
||
| pbjs.addAdUnits(adUnits); | ||
|
|
||
| pbjs.onEvent('bidRequested', function (data) { | ||
| try { | ||
| fod.complete(() => { | ||
| document.getElementById('enriched-51').style.display = 'block'; | ||
| document.getElementById('enriched-51-data').textContent = JSON.stringify(data.ortb2.device, null, 2); | ||
| }); | ||
| } catch (e) { | ||
| console.error('Error while trying to display enriched data', e); | ||
| } | ||
| }); | ||
|
|
||
| pbjs.requestBids({ | ||
| timeout: PREBID_TIMEOUT, | ||
| bidsBackHandler: function (bidResponses) { | ||
| initAdserver(); | ||
| } | ||
| }); | ||
| }); | ||
| setTimeout(initAdserver, FAILSAFE_TIMEOUT); | ||
| </script> | ||
|
|
||
| <script> | ||
| googletag.cmd.push(function () { | ||
| googletag | ||
| .defineSlot( | ||
| '/19968336/prebid_multiformat_test', [ | ||
| [300, 250], | ||
| [360, 360] | ||
| ], | ||
| 'div-banner-native-1' | ||
| ) | ||
| .addService(googletag.pubads()); | ||
|
|
||
| googletag | ||
| .defineSlot( | ||
| '/19968336/prebid_multiformat_test', [ | ||
| [300, 250], | ||
| [360, 360] | ||
| ], | ||
| 'div-banner-native-2' | ||
| ) | ||
| .addService(googletag.pubads()); | ||
|
|
||
| googletag.pubads().disableInitialLoad(); | ||
| googletag.pubads().enableSingleRequest(); | ||
| googletag.enableServices(); | ||
| }); | ||
| </script> | ||
| <title>51Degrees RTD submodule example - Prebid.js</title> | ||
| </head> | ||
| <body> | ||
| <h2>51Degrees RTD submodule - example of usage</h2> | ||
|
|
||
| <h3>div-banner-native-1</h3> | ||
| <div id='div-banner-native-1'> | ||
| <p>No response</p> | ||
| <script type='text/javascript'> | ||
| googletag.cmd.push(function () { | ||
| googletag.display('div-banner-native-1'); | ||
| }); | ||
| </script> | ||
| </div> | ||
|
|
||
| <h3>div-banner-native-2</h3> | ||
| <div id='div-banner-native-2'> | ||
| <p>No response</p> | ||
| <script type='text/javascript'> | ||
| googletag.cmd.push(function () { | ||
| googletag.display('div-banner-native-2'); | ||
| }); | ||
| </script> | ||
| </div> | ||
|
|
||
| <div id="debug"> | ||
| <h3>Testing/Debugging Guidance</h3> | ||
| <ol> | ||
| <li>Make sure you have <code>debug: true</code> under <code>pbjs.setConfig</code> in this example code (be sure to remove it for production!) | ||
| <li>Make sure you have replaced <code><YOUR RESOURCE KEY></code> in this example code with the one you have obtained | ||
| from the <a href="https://configure.51degrees.com/tWrhNfY6" target="blank;">51Degrees Configurator Tool</a></li> | ||
| <li>Open DevTools Console in your browser and refresh the page</li> | ||
| <li>Observe the enriched ortb device data shown below and also in the console as part of the <code>[51Degrees RTD Submodule]: reqBidsConfigObj:</code> message (under <code>reqBidsConfigObj.global.device</code>)</li> | ||
| </ol> | ||
|
|
||
| </div> | ||
| <div id="enriched-51" style="display: none"> | ||
| <h3>Enriched ORTB2 device data</h3> | ||
| <pre id="enriched-51-data"></pre> | ||
| </div> | ||
| </body> | ||
| </html> |
Oops, something went wrong.