Skip to content

Latest commit

 

History

History
202 lines (163 loc) · 4.14 KB

adbookpsp.md

File metadata and controls

202 lines (163 loc) · 4.14 KB
layout title description biddercode media_types tcfeu_supported prebid_member schain_supported coppa_supported usp_supported pbjs pbs pbjs_version_notes sidebarType
bidder
AdBookPSP
Prebid AdBookPSP Bidder Adapter
adbookpsp
banner, video
false
false
true
true
true
true
false
removed in 9.0
1

NOTE: The AdBookPSP Bidder Adapter requires setup and approval before use. The adapter uses custom targeting keys that require a dedicated Google Ad Manager setup to work. Please reach out to your AdbookPSP representative for more details.

Bid Params

{: .table .table-bordered .table-striped }

Name Scope Description Example Type
orgId optional Org ID listed in the Deal File abc123 string
placementId optional Placement ID listed in the Deal File abc123 string

Each adUnit with adbookpsp adapter has to have either placementId or orgId set.

var adUnits = [
  {
    bids: [
      {
        bidder: 'adbookpsp',
        params: {
          placementId: 'example-placement-id',
          orgId: 'example-org-id',
        },
      },
    ],
  },
];

Alternatively, orgId can be set globally while configuring prebid.js:

pbjs.setConfig({
  adbookpsp: {
    orgId: 'example-org-id',
  },
});

NOTE: adUnit orgId will take precedence over the globally set orgId.

Banner parameters

Required:

  • sizes

Example configuration:

var adUnits = [
  {
    code: 'div-1',
    mediaTypes: {
      banner: {
        sizes: [[300, 250]],
      },
    }
  },
];

Video parameters

Required:

  • context
  • mimes
  • playerSize

Additionaly, all Video object parameters described in chapter 3.2.7 of the OpenRTB 2.5 specification can be passed as bidder params.

Example configuration:

var adUnits = [
  {
    code: 'div-1',
    mediaTypes: {
      video: {
        context: 'outstream',
        mimes: ['video/mp4', 'video/x-flv'],
        playerSize: [400, 300],
        protocols: [2, 3],
      },
    },
    bids: [
      {
        bidder: 'adbookpsp',
        params: {
          placementId: 'example-placement-id',
          video: {
            placement: 2,
          },
        },
      },
    ],
  },
];

NOTE: Supporting outstream video requires the publisher to set up a renderer as described in the Prebid docs.

Testing params

To test the adapter, either placementId: 'example-placement-id' or orgId: 'example-org-id' can be used.

NOTE: If any adUnit uses the testing params, all adUnits will receive testing responses.

Example adUnit configuration:

var adUnits = [
  {
    code: 'div-1',
    mediaTypes: {
      banner: {
        sizes: [[300, 250]],
      },
    },
    bids: [
      {
        bidder: 'adbookpsp',
        params: {
          placementId: 'example-placement-id',
        },
      },
    ],
  },
];

Example google publisher tag configuration:

googletag
  .defineSlot('/22094606581/example-adbookPSP', sizes, 'div-1')
  .addService(googletag.pubads());

Configuration

Setting of the orgId can be done in the pbjs.setConfig() call. If this is the case, both orgId and placementId become optional. Remember to only call pbjs.setConfig() once as each call overwrites anything set in previous calls.

Enabling iframe based user syncs is also encouraged.

pbjs.setConfig({
  adbookpsp: {
    orgId: 'example-org-id',
    winTrackingEnabled: true,
  },
  userSync: {
    filterSettings: {
      iframe: {
        bidders: '*',
        filter: 'include',
      },
    },
  },
});

Privacy

GDPR and US Privacy are both supported by default.

Event tracking

This adapter tracks win events for it’s bids. This functionality can be disabled by adding winTrackingEnabled: false to the adapter configuration:

pbjs.setConfig({
  adbookpsp: {
    winTrackingEnabled: false,
  },
});

COPPA support

COPPA support can be enabled for all the visitors by changing the config value:

config.setConfig({ coppa: true });