Prebid.js Analytics Adapters

33Across

Features

About

This analytics adapter collects data about the performance of your ad slots for each auction run on your site. It also provides insight into how identifiers from the 33Across User ID Sub-module and other user ID sub-modules improve your monetization. The data is sent at the earliest opportunity for each auction to provide a more complete picture of your ad performance.

The analytics adapter is free to use! However, the publisher must work with our account management team to obtain a Publisher/Partner ID (PID) and enable Analytics for their account. To get a PID and to have the publisher account enabled for Analytics, you can reach out to our team at the following email - analytics_support@33across.com

If you are an existing publisher and you already use a 33Across PID, you can reach out to analytics_support@33across.com to have your account enabled for analytics.

The 33Across privacy policy is at https://www.33across.com/privacy-policy/.

Analytics Options

Configuration

The data is sent at the earliest opportunity for each auction to provide a more complete picture of your ad performance, even if the auction is interrupted by a page navigation. At the latest, the adapter will always send the report when the page is unloaded, at the end of the auction, or after the timeout, whichever comes first.

In order to guarantee consistent reports of your ad slot behavior, we recommend including the GPT Pre-Auction Module (gptPreAuction if compiling from source). This module is included by default when Prebid is downloaded.

Enable the 33Across Analytics Adapter in Prebid.js using the analytics provider 33across and options as seen in the example below.

Example Configuration

pbjs.enableAnalytics({
    provider: '33across',
    options: {
        /**
         * The 33Across Publisher ID.
         */
        pid: 'abc123',
        /** 
         * Timeout in milliseconds after which an auction report 
         * will be sent regardless of auction state.
         * [optional]
         */
        timeout: 10000
    }
});

Asteriobid PBM

Features

Registration

Please visit http://prebidmanager.com/ for more information.

adWMG

Features

Analytics Options

Example Configuration

  pbjs.enableAnalytics({
  provider: 'adWMG',
    options : {
          site: 'test.com',
          publisher_id: '5abd0543ba45723db49d97ea'
  }});

Registration

Please visit adwmg.com for more information.

Adagio

Features

Registration

The Adagio Analytics adapter requires setup and approval from the Adagio team. Please reach out to contact@adagio.io for more information.

Example Configuration

  pbjs.que.push(function () {
    pbjs.enableAnalytics({
      provider: 'adagio',
      options: {
        organizationId: '1000', // Required. Provided by Adagio
        site: 'my-website', // Required. Provided by Adagio
      }
    });
  });

Adkernel

Features

Registration

Please visit adkernel.com/dsp-suite/ for more information.

Adloox

Features

Disclosure

The adapter adds an HTML <script> tag to load Adloox’s post-buy verification JavaScript (https://j.adlooxtracking.com/ads/js/tfav_adl_X.js at ~25kiB gzipped) when the bidWon event for each ad slot.

Registration

The Adloox analytics adapter requires on-boarding and configuration parameters supplied to you by Adloox account team. Please reach out to your account team or info@adloox.com for more information.

Analytics Options

For detailed instructions please look to the integration guidelines shipped with the Prebid.js project which also link to our Prebid video and real-time data provider options.

Example Configuration

  pbjs.enableAnalytics({
    provider: 'adloox',
    options: {
      client: 'adlooxtest',  // supplied by Adloox
      clientid: 127,         // supplied by Adloox
      platformid: 0,         // supplied by Adloox
      tagid: 0               // supplied by Adloox
    }
  });

AdvRed

Features

About

The AdvRed analytics adapter can be used by all clients after approval. For more information, please visit https://ams.adv.red/

Analytics Options

Example Configuration

pbjs.enableAnalytics({
    provider: 'advRed',
    options: {
        publisherId: '123456'    // change to the Publisher ID you received from AdvRed
    }
});

Adxcg

Features

Registration

The Adxcg analytics adapter requires setup and approval from the Adxcg team, even for existing accounts. Please reach out to your account team or visit www.adxcg.com for more information.

Analytics Options

Example Configuration

  pbjs.enableAnalytics({
    provider: 'adxcg',
    options: {
        publisherId: 'OBTAIN-FROM-ADXCG'        
    }
  });

AdxPremium

Features

Registration

Please visit luponmedia.com for more information.

agma

Features

Analytics Options

Example Configuration

pbjs.enableAnalytics({
    provider: 'agma',
    options: {
        code: 'provided-by-agma'    // change to the code you received from agma
    }
});

Registration

Please contact team-internet@agma-mmc.de for signup.

Appier

Features

Registration

Please visit www.appier.com for more information.

Assertive Yield

Features

Registration

Please visit assertiveyield.com for more information.

AsterioBid

Features

Registration

Please visit asteriobid.com/ for more information.

ATS Analytics

Features

Registration

LiveRamp’s ATS Analytics is free of charge and only requires a simple registration with Liveramp. Please sign up through our Console platform and create the analytics adapter to get started.

The LiveRamp privacy policy is at liveramp.com/privacy/service-privacy-policy/.

Analytics Options

Example Configuration

pbjs.que.push(function () {
  pbjs.enableAnalytics([{
    provider: "atsAnalytics",
    options: {
      pid: "999"              // Set your valid Placement ID here
    }
  }])
});

Audigent

Features

Use

The Audigent analytics adapter can be used by all clients after approval. For more information, please visit https://audigent.com or contact our Prebid integration team at prebid@audigent.com.

The Audigent privacy policy is at audigent.com/privacypolicy/.

Analytics Options

Example Configuration

pbjs.enableAnalytics({
    provider: 'hadronAnalytics',
    options: {
        partnerId: 1234,    // change to the Partner Number you received from Audigent
        eventsToTrack: ['auctionEnd', 'auctionInit']
    }
});

Automatad

Features

Instructions for usage

The Automatad analytics adapter requires on-boarding, configuration parameters & addition of an external script that will be supplied to you by your Automatad account team. Please reach out to your account team or cs@automatad.com for more information.

Adapter Configuration Options

Example Configuration

import CONSTANTS '../src/constants.json';
// ...
const EVENTS = CONSTANTS.EVENTS
// ...
pbjs.enableAnalytics({
  provider: 'automatadAnalytics',
  options: {
    siteID: 'N8vZLx',        // supplied by Automatad
    publisherID: 'PXfvBq',   // supplied by Automatad
    logDebug: false          // Defaults to false
  },
  includeEvents: [
      EVENTS.AUCTION_INIT,
      EVENTS.BID_RESPONSE,
      EVENTS.AUCTION_DEBUG,
      EVENTS.BID_WON,
      EVENTS.BIDDER_DONE,
      EVENTS.NO_BID,
      EVENTS.BID_TIMEOUT
  ]
});

BidWatch

Features

Registration

The BidWatch Analytics Adapter requires setup and approval from the BidWatch team. Please reach out to contact@bidwatch.io for more information.

Analytics Options

Example Configuration

  pbjs.enableAnalytics({
    provider: 'bidwatch',
    options: {
        domain: "CONTACT-BIDWATCH-TEAMS-FIRST"
    }
  });

byData

Features

Registration

The byData Analytics adapter requires setup and approval from the byData team. Please visit bydata.com for more information.

Analytics Options

Example Configuration

    pbjs.enableAnalytics({
        provider: "bydata",  
        options: {
            clientId:'asc10001',   // please contact byData team to get a clientId for yourself 
            logFrequency : 100,    // Default - 1%       
        }
    });

Concert

Features

Registration

The Concert analytics adapter requires setup and approval from the Concert team. Please reach out to support@concert.io or visit concert.io for more information.

Example Configuration

  pbjs.enableAnalytics({
    provider: 'concert',
  });

DataBlocks

Features

Registration

Please visit datablocks.net/ for more information.

8pod

Features

Disclosure

The adapter subscribe on events from 8pod’s ad unit when the bidWon event for each ad slot and then send internal event to our tracker once in 10 sec.

ePlanning

Features

Registration

Please visit ww.e-planning.net/ for more information.

Epsilon

Features

Registration

Epsilon (formerly Conversant) analytics adapter requires approval from the Epsilon team, even for existing accounts. Please reach out to publishersupport@epsilon.com for more information.

Analytics Options

Example Configuration

Legacy provider code of ‘conversant’ is still supported

            <!-- should be called before requestBids() -->
            pbjs.que.push(function(){
                pbjs.enableAnalytics(
                    {
                        provider: 'epsilon',
                        options: {
                            site_id: 108060,
                            cnvr_sampling: 0.5,
                            send_error_data: true
                        }
                    }
                );
            });

Finteza

Features

Registration

Please visit www.finteza.com/ for more information.

Generic

Features

See module documentation.

Greenbids

Features

Registration

The Greenbids Analytics adapter requires setup and approval from the Greenbids team. Please reach out to our team for more information greenbids.ai.

Analytics Options

Example Configuration

    pbjs.enableAnalytics({
        provider: 'greenbids',
        options: {
            pbuid: "greenbids-publisher-1" // please contact Greenbids to get a pbuid for yourself
            greenbidsSampling: 0.01
        }
    });

Growthcode

Features

Registration

GrowthCode offers scaled infrastructure-as-a-service to empower independent publishers to harness data and take control of identity and audience while rapidly aligning to industry changes and margin pressure.

Please visit growthcode.io for more information.

Analytics Options

Example Configuration

pbjs.enableAnalytics({
  provider: 'growthCodeAnalytics',
  options: {
    pid: '<Contact GrowthCode>',
    trackEvents: [
      'auctionEnd',
      'bidAdjustment',
      'bidTimeout',
      'bidRequested',
      'bidResponse',
      'noBid',
      'bidWon',
      'bidderDone']
  }
});

ID5

Features

Registration

The ID5 Analytics Adapter is free to use during our Beta period, but requires a simple registration with ID5. Please visit id5.io/solutions to sign up and request your ID5 Partner Number to get started. If you’re already using the ID5 Universal ID, you may use your existing Partner Number with the analytics adapter.

The ID5 privacy policy is at id5.io/platform-privacy-policy.

Analytics Options

Example Configuration

pbjs.enableAnalytics({
    provider: 'id5Analytics',
    options: {
        partnerId: 173    // change to the Partner Number you received from ID5
    }
});

Intent IQ

Features

Description

By using this Intent IQ adapter, you will be able to obtain comprehensive analytics and metrics regarding the performance of the Intent IQ Unified ID module. This includes how the module impacts your revenue, CPMs, and fill rates related to bidders and domains.

Intent IQ Universal ID Registration

No registration for this module is required.

Intent IQ Universal ID Configuration

IMPORTANT: only effective when Intent IQ Universal ID module be installed and configured. (How-To)

No additional configuration for this module is required. We will use the configuration provided for Intent IQ Universal IQ module.

Example Configuration

pbjs.enableAnalytics({
    provider: 'iiqAnalytics'
});

Manual Report Trigger with reportExternalWin

The reportExternalWin function allows for manual reporting, meaning that reports will not be sent automatically but only when triggered manually.

To enable this manual reporting functionality, you must set the manualWinReportEnabled parameter in Intent IQ Unified ID module configuration is true. Once enabled, reports can be manually triggered using the reportExternalWin function.

pbjs.setConfig({
    userSync: {
        userIds: [{
            name: "intentIqId",
            params: {
                partner: 123456,     // valid partner id
                browserBlackList: "chrome",
                manualWinReportEnabled: true
            }
        }]
    }
});

You can find more information and configuration examples in the Intent IQ Universal ID module

Calling the reportExternalWin Function

To call the reportExternalWin function, you need to pass the partner_id parameter as shown in the example below:

window.intentIqAnalyticsAdapter_[partner_id].reportExternalWin(reportData)

Example use with Partner ID = 123455

window.intentIqAnalyticsAdapter_123455.reportExternalWin(reportData)

Function Parameters

The reportExternalWin function takes an object containing auction win data. Below is an example of the object:

var reportData = {
biddingPlatformId: 1, // Platform ID. The value 1 corresponds to PreBid.
partnerAuctionId: '[YOUR_AUCTION_ID_IF_EXISTS]', // Auction ID, if available.
bidderCode: 'xxxxxxxx', // Bidder code.
prebidAuctionId: '3d4xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8e', // PreBid auction ID.
cpm: 1.5, // Cost per thousand impressions (CPM).
currency: 'USD', // Currency for the CPM value.
originalCpm: 1.5, // Original CPM value.
originalCurrency: 'USD', // Original currency.
status: 'rendered', // Auction status, e.g., 'rendered'.
placementId: 'div-1' // ID of the ad placement.
}

To report the auction win, call the function as follows:

window.intentIqAnalyticsAdapter_[partner_id].reportExternalWin(reportData)

Invisibly

Features

Registration

Please visit invisibly.com for more information.

Kargo

Features

Registration

Please visit kargo.com or contact your Kargo account manager for more information.

Example Configuration

pbjs.enableAnalytics({
  provider: 'kargo',
  options: {
      sampling: 100 // value out of 100
  }
});

Konduit

Features

Registration

Please visit konduitvideo.com/ for more information.

LiveIntent

Features

Registration

Please visit LiveIntent for more information.

Example Configuration

pbjs.enableAnalytics(
  {
    provider: 'liveintent',
    options: {
      bidWonTimeout: 2000,
      sampling: 0.5 // the tracked event percentage, a number between 0 and 1.
    }
  }
)

Livewrapped

Features

Registration

Please visit livewrapped.com/ for more information.

Magnite

Features

Registration

The Magnite analytics adapter requires setup and approval from the Magnite team, even for existing accounts. Please reach out to your Magnite account team for more information.

Analytics Options

Example Configuration

  pbjs.enableAnalytics({
    provider: 'magnite',
    options: {
        accountId: MAGNITE-ACCOUNT-ID,
        endpoint: 'OBTAIN-FROM-MAGNITE'
    }
  });

MallTv

Features

Registration

This is currently a private adapter

Analytics Options

Example Configuration

pbjs.enableAnalytics({
    provider: 'malltv',
    options: {
        propertyId: '123456',
        server: 'https://central.mall.tv/analytics'
    }
});

MediaNet

Features

Registration

Please visit www.media.net for more information.

NoBid

Features

Registration

The NoBid Analytics Adapter is free to use during our Beta period, but requires a simple registration with NoBid. Please visit www.nobid.io to sign up and request your Publisher ID Number to get started. If you’re already using the NoBid Bid Adapter, you may use your existing Site ID Number with the analytics adapter.

The NoBid privacy policy is at nobid.io/privacy-policy.

Analytics Options

Example Configuration

pbjs.enableAnalytics({
    provider: 'nobid',
    options: {
        siteId: 123 // change to the Site ID you received from NoBid
    }
});

Oolo

Features

Registration

Please visit www.oolo.io for more information.

Optimon

Features

Registration

Please visit optimon.io for more information.

Oxxion

Features

Registration

The Oxxion Analytics Adapter requires setup and approval from the Oxxion team. Please reach out to contact@oxxion.io for more information.

Analytics Options

Example Configuration

pbjs.enableAnalytics(
  //...
  {
    provider: 'oxxion',
    options : {
          domain: 'test.endpoint'
    }
  }
  //...
)

Piano DMP

Features

Registration

Please visit piano.io/product/dmp/ for more information.

Example Configuration

  pbjs.enableAnalytics({
    provider: 'pianoDmp'
  });

PubMatic

Features

Registration

The PubMatic Analytics adapter requires setup and approval from the PubMatic team. Please reach out to your account team for more information.

Analytics Options

Example Configuration

    pbjs.enableAnalytics({
        provider: 'pubmatic',
        options: {
            "publisherId": 12345 // please contact PubMatic to get a publisherId for yourself
        }
    });

PubPerf

Features

Registration

Please visit http://www.pubperf.com/ for more information.

PubStack

Features

Registration

Please visit pubstack.io/?source=prebid.org-analytics for more information.

PubWise

Features

Registration

Please visit www.pubwise.io for more information.

Pubxai

Features

Registration

Please visit http://pubx.ai/ for more information.

PulsePoint

Features

Registration

Please visit www.pulsepoint.com for more information.

RealVu

Features

Registration

Please visit www.realvu.com/rvaa for more information.

Relevant

Features

Registration

Please visit www.relevant-digital.com/relevantyield for more information.

Roxot

Features

Registration

To start using Prebid Analytics, please, email us at contact@roxot.com to provide us with your billing info and get your personal publisher ID which is used in the prebid config on your site/s.

Add the following code to your prebid.js config to activate Prebid Analytics:

Example Configuration

pbjs.que.push(function () {
    pbjs.enableAnalytics({
        provider: 'roxot',
        options: {
            publisherIds: ["YOUR-PUBLISHER-ID"]
        }
    });
});

Scaleable

Features

Registration

Please visit scaleable.ai for more information.

Sharethrough

Features

Registration

This module is free to use.

About

This analytics adapter collects data about win/loss events (beacon firings) from each auction run on your site. This data is communicated to Sharethrough via API calls the analytics adapter makes to an endpoint dedicated to the collection of beacon information. Sharethrough uses this information to improve its services as a SSP.

Example Configuration

pbjs.enableAnalytics({
  provider: 'sharethrough',
})

Compiling from Source (Optional)

In order to guarantee consistent reporting events, we recommend including the GPT Pre-Auction Module, gptPreAuction. This module is included by default when Prebid is downloaded.

If you are compiling from source, this might look something like:

gulp bundle --modules=gptPreAuction,sharethroughBidAdapter,sharethroughAnalyticsAdapter

Please note that the above snippet is a “bare bones” example - you will likely want to include other modules as well. A more realistic example might look something like the example below (with other bid adapters also included in the list as needed):

gulp bundle --modules=gptPreAuction,consentManagementTcf,consentManagementGpp,consentManagementUsp,enrichmentFpdModule,tcfControl,sharethroughBidAdapter,sharethroughAnalyticsAdapter

Enable the Sharethrough Analytics Adapter in Prebid.js using the analytics provider sharethrough as seen in the Example Configuration section.

Sigmoid

Features

Registration

Please visit www.sigmoid.com/identity-graph-adtech for more information.

Smartyads

Features

Example Configuration

pbjs.que.push(function () {
    pbjs.enableAnalytics({
        provider: 'smartyads'
    });
});

Sonobi

Features

Registration

Please visit sonobi.com for more information.

Sovrn

Features

The Sovrn analytics adapter is no longer supported.

STAQ

Features

Registration

Please visit www.staq.com for more information.

Tercept

Features

Registration

To start using Prebid Analytics, please, email us at gourav.chindlur@tercept.com to provide us with your billing info and get your personal publisher ID & Key along with other details which are used in the prebid config on your site/s. Add the following code to your prebid.js config to activate Prebid Analytics:

Example Configuration

pbjs.que.push(function() {
    pbjs.enableAnalytics({
    provider: 'tercept',
    options: {
        pubId: <PUB_ID>,
        pubKey: <NETWORK_CODE>,
        host: <HOST_NAME>
        pathName: <PATH_NAME>
    }
});
});

Please visit https://www.tercept.com/ for more information.

ucFunnel

Features

Registration

Please visit www.ucfunnel.com for more information.

Yandex Metrica

Features

Description

This adapter integrates Prebid.js with Yandex Metrica. It offers detailed insights into auction performance and user behavior, enabling publishers to make data-driven decisions to optimize their ad revenue.

Disclosure: The adapter utilizes the Metrica Tag build based on github.com/yandex/metrica-tag, approximately 60 kB gzipped.

Setup Instructions

1. Register Your Website:

   Visit Yandex Metrica and register your website to obtain a counter ID.

2. Insert Counter Initialization Code:

   Retrieve the counter initialization code from the Yandex Metrica settings page at https://metrica.yandex.com/settings?id={counterId}, where {counterId} is your counter ID, and embed it into your website’s HTML.

3. Initialize the Adapter in Prebid.js:

   Configure the Yandex Analytics Adapter in your Prebid.js setup. For optimal performance and ease of management, it is preferred to use a single counter. Add the following JavaScript snippet, replacing 123 with your actual counter ID:

   pbjs.enableAnalytics({
     provider: "yandex",
     options: {
       // Replace 123 with your actual counter ID
       // It's preferred to use a single counter for optimal performance and ease of management
       counters: [123]
     }
   });
   

4. Special Instructions for Single Page Applications (SPAs):

   If your website is an SPA, make sure to configure your Metrica tag accordingly.

Accessing Analytics Data

You can view the collected analytics data in the Yandex Metrica dashboard. Navigate to metrika.yandex.com/dashboard and look for the Prebid Analytics section to analyze your data.

YieldOne

Features

Registration

Please visit www.platform-one.co.jp for more information.

YuktaMedia

Features

Registration

Please visit yuktamedia.com/prebid/ for more information. The YuktaMedia Analytics adapter requires setup and approval from the YuktaMedia team. Please reach out at info@yuktamedia.com for more information.

Analytics Options

Configuration Example

    pbjs.enableAnalytics({
        provider: 'yuktamedia',
        options: {
          pubId: 1234, // pubId and pubKey be given by YuktaMedia. 
          pubKey: 'some string', // Please contact us to get pubId and pubKey.
          enableUTMCollection: true,
          enableSession: true,
          enableUserIdCollection: true
        }
    });

Zeta Global Ssp

Features

Registration

Please visit zetaglobal.com for more information.

Analytics Options

Example Configuration

pbjs.enableAnalytics({
     provider: 'zeta_global_ssp',
     options: {
         sid: 111,
         tags: {
             ...
         }
     }
 });