Skip to content

Latest commit

 

History

History
117 lines (103 loc) · 4.81 KB

relevantdigitalBidAdapter.md

File metadata and controls

117 lines (103 loc) · 4.81 KB

Overview

Module Name:  Relevant Digital Bid Adapter
Module Type:  Bidder Adapter
Maintainer: [email protected]

Description

This adapter is used for integration with providers using the Relevant Yield platform. The provider will supply the necessary pbsHost and accountId settings along with the placementId bid parameters per ad unit.

Example setup using pbjs.setConfig()

This is the recommended method to set the global configuration parameters.

pbjs.setConfig({
  relevantdigital: {
    pbsHost: 'pbs-example.relevant-digital.com',
    accountId: '6204e5fa70e3ad10821b84ff',
  },
});

var adUnits = [
  {
    code: 'test-div',
    mediaTypes: { banner: { sizes: [[300, 250], [320, 320]] }},
    bids: [
      {
        bidder: 'relevantdigital',
        params: {
          placementId: '6204e83a077c5825441b8508_620f9e8e4fe67c1f87cd30ed',
        }
      }
   ],
  }
];

Example setup using only bid params

This method to set the global configuration parameters (like pbsHost) in params could simplify integration of a provider for some publishers. Setting different global config-parameters on different bids is not supported in general*, as the first settings found will be used and any subsequent global settings will be ignored.

 * The exception is useSourceBidderCode which can be overriden individually per ad unit.

var adUnits = [
  {
    code: 'test-div',
    mediaTypes: { banner: { sizes: [[300, 250], [320, 320]] }},
    bids: [
      {
        bidder: 'relevantdigital',
        params: {
          placementId: '6204e83a077c5825441b8508_620f9e8e4fe67c1f87cd30ed',
          pbsHost: 'pbs-example.relevant-digital.com',
          accountId: '6204e5fa70e3ad10821b84ff',
        }
      }
   ],
  }
];

Example setup with multiple providers

Notice: Placements below are not live test placements

pbjs.aliasBidder('relevantdigital', 'providerA');
pbjs.aliasBidder('relevantdigital', 'providerB');

pbjs.setConfig({
  providerA: {
    pbsHost: 'pbs-example-a.relevant-digital.com',
    accountId: '620533ae7f5bbe1691bbb815',
  },
  providerB: {
    pbsHost: 'pbs-example-b.relevant-digital.com',
    accountId: '990533ae7f5bbe1691bbb815',
  },  
});

var adUnits = [
  {
    code: 'test-div',
    mediaTypes: { banner: { sizes: [[300, 250], [320, 320]] }},
    bids: [
      {
        bidder: 'providerA',
        params: {
          placementId: '610525862d7517bfd4bbb81e_620523b7d1dbed6b0fbbb817',
        }
      },
      {
        bidder: 'providerB',
        params: {
          placementId: '990525862d7517bfd4bbb81e_770523b7d1dbed6b0fbbb817',
        }
      },      
   ],
  }
];

Bid Parameters

Name Scope Description Example Type
placementId required The placement id. '6204e83a077c5825441b8508_620f9e8e4fe67c1f87cd30ed' String
pbsHost required if not set in config Host name of the server. 'pbs-example.relevant-digital.com' String
accountId required if not set in config The account id. '6204e5fa70e3ad10821b84ff' String
useSourceBidderCode optional Set to true in order to use the bidder code of the actual server-side bidder in bid responses. You MUST also use allowAlternateBidderCodes: true in bidderSettings if you enabled this - as otherwise the bids will be rejected. true Boolean

Config Parameters

Name Scope Description Example Type
pbsHost required if not set in bid parameters Host name of the server. 'pbs-example.relevant-digital.com' String
accountId required if not set in bid parameters The account id. '6204e5fa70e3ad10821b84ff' String
pbsBufferMs optional How much less in milliseconds the server's internal timeout should be compared to the normal Prebid timeout. Default is 250. To be increased in cases of frequent timeouts. 250 Integer
useSourceBidderCode optional Set to true in order to use the bidder code of the actual server-side bidder in bid responses. You MUST also use allowAlternateBidderCodes: true in bidderSettings if you enabled this - as otherwise the bids will be rejected. true Boolean