Skip to content

download.md

Latest commit

 

History

History
503 lines (421 loc) · 13.3 KB

download.md

File metadata and controls

503 lines (421 loc) · 13.3 KB
Raw
layout page_v2
title Download Prebid.js
description Documentation on how to download Prebid.js for header bidding.
sidebarType 0
<script src="https://cdn.firebase.com/js/client/2.4.2/firebase.js"></script> <script> getVersionList(); $(function(){ $('#myModal').on('show.bs.modal', function (e) { var form_data = get_form_data(); if(form_data.modules.length < 1){ alert('Please select at least 1 bidder'); return e.preventDefault() // stops modal from being shown } return; }); // show all adapters $('.adapters .col-md-4').show(); }); function getVersionList() { $.ajax({ type: "GET", url: "http://js-download.prebid.org/versions", }) .success(function(data) { try{ data = JSON.parse(data); var versions = data.versions; if(!versions || versions.length === 0) { showError(); return; } versions.forEach(function(version, index){ if(index === 0) { $('.selectpicker').append(''+version+' - latest '); } else{ if(version.match(/\d\.\d+\.\d+/i)){ $('.selectpicker').append(''+version+''); } else{ // $('.selectpicker').append(''+version+' - deprecated'); } } }); } catch(e) { console.log(e); showError(); } }) .fail(function(e) { console.log(e); showError(); }); function showError(){ $('.selectpicker').append('Error generating version list. Please try again later'); } } function submit_download() { var form_data = get_form_data(); var alertStatus = $('#download-status'); alertStatus.addClass('hide'); $('#download-button').html(' Sending Request...').addClass('disabled'); alertStatus.html('Request sent! This should only take a few moments!'); alertStatus.removeClass('hide'); $.ajax({ type: "POST", url: "http://js-download.prebid.org/download", //dataType: 'json', data: form_data }) .success(function(data, textStatus, jqXHR) { var buttn = $('#download-button'); //buttn.addClass('btn-success'); buttn.html(' Prebid.js file successfully generated!'); alertStatus.addClass('hide'); // Try to find out the filename from the content disposition `filename` value var filename = "prebid" + form_data['version'] + ".js"; // this doens't work in our current jquery version. var disposition = jqXHR.getResponseHeader('Content-Disposition'); if (disposition && disposition.indexOf('attachment') !== -1) { var filenameRegex = /filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/; var matches = filenameRegex.exec(disposition); if (matches != null && matches[1]) filename = matches[1].replace(/['"]/g, ''); } // The actual download var blob = new Blob([data], { type: 'text/javascript' }); var link = document.createElement('a'); link.href = window.URL.createObjectURL(blob); link.download = filename; document.body.appendChild(link); link.click(); document.body.removeChild(link); }) .fail(function(e) { errorO = e; console.log(e); var buttn = $('#download-button'); buttn.html(' Receive Prebid.js'); buttn.removeClass('disabled'); alert('Ran into an issue.'); }); } function get_form_data() { var bidders = []; var analytics = []; var version = $('.selectpicker').val(); var bidder_check_boxes = $('.bidder-check-box'); for (var i = 0; i < bidder_check_boxes.length; i++) { var box = bidder_check_boxes[i]; if (box.checked) { bidders.push(box.getAttribute('moduleCode')); } } var analytics_check_boxes = $('.analytics-check-box'); for (var i = 0; i < analytics_check_boxes.length; i++) { var box = analytics_check_boxes[i]; if (box.checked) { analytics.push(box.getAttribute('analyticscode') + 'AnalyticsAdapter'); } } var form_data = {}; form_data['modules'] = bidders.concat(analytics); form_data['version'] = version; return form_data; } </script> <style> .disabled { color: #aaa; } </style>

Customize and Download Prebid.js

{: .lead :} To improve the speed and load time of your site, build Prebid.js for only the header bidding partners you choose.

Option 1: Customize your download here

{% assign bidder_pages = site.pages | where: "layout", "bidder" %} {% assign module_pages = site.pages | where: "page_type", "module" %}

{: .alert.alert-success :} Note: If you receive an error during download you most likely selected a configuration that is not supported. Verify that each bidder / module is available in the selected version.

Select Prebid Version

Select Bidder Adapters

{% for page in bidder_pages %} {% if page.s2s_only == true %} {% continue %} {% endif %}
{% if page.aliasCode %} {{ page.title }} {% else %} {{ page.title }} {% endif %} 
</label>
{% endfor %}

Analytics Adapters

Adagio Analytics
Adkernel Analytics
Adomik Analytics
Adxcg Analytics
AdxPremium Analytics
Appier Analytics
Datablocks Analytics
Eplanning Analytics
Finteza Analytics
Google Analytics
Livewrapped Analytics
Marsmedia Analytics
OpenX Analytics
Prebid Manager
PubWise.io Analytics
PulsePoint
Realvu Analytics
Rivr Analytics
Prebid Analytics by Roxot
Scaleable.ai Analytics
Sigmoid Analytics
Sharethrough
Sortable Analytics
Sovrn Analytics
STAQ Analytics
Vuble Analytics
yuktamedia Analytics

Modules

{% for page in module_pages %} {% if page.enable_download == false %} {% continue %} {% endif %}
{{ page.display_name }}
{% endfor %}
User ID: DigiTrust ID
User ID: ID5 ID
User ID: Criteo RTUS ID
User ID: IdentityLink ID

Get Prebid.js! 

    <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>

    <h4 class="modal-title" id="myModalLabel">Download Custom Built Prebid.js</h4>
  </div>

  <div class="modal-body">

    <div class="lead">
      Downloading Prebid.js...
    </div>

    <div class="form-group">
        <button type="button" id="download-button" class="btn btn-lg btn-primary" onclick="submit_download()"><i class="glyphicon glyphicon-envelope"></i> Download Prebid.js</button>
    </div>

    <div class="alert alert-warning hide" role="alert" id="download-status"></div>

    <p>
    Ran into problems? Email <code>support@prebid.org</code>
    </p>

  </div>


</div>

Option 2: Build from Source Code (More Advanced)

{: .lead :} Alternatively, you can build Prebid.js from the source code. For instructions, see the Prebid.js README on GitHub.