Prebid Server Bidder Params

33Across

Features

"Send All Bids" Ad Server Keys

Bid Params

Ad Unit Setup for Banner

var adUnits = [
{
  code: '33across-hb-ad-123456-1', // ad slot HTML element ID  
  mediaTypes: {
    banner: {  
      sizes: [
          [300, 250], 
          [728, 90]
      ]
    }   
  } 
  bids: [{
    bidder: '33across',
    params: {
        siteId: 'examplePub123',    // required 
        productId: 'siab|inview'    // required
    }
  }]
}

Ad Unit Setup for Outstream Video

var adUnits = [
{
  code: '33across-hb-ad-123456-1', // ad slot HTML element ID  
  mediaTypes: {
    video: {                                // We recommend setting the following video params
                                            // in Ad Unit rather than bidder params as per Prebid 4.0 recommendation. 
      playerSize: [300, 250],               // required
      context: 'outstream',                 // required
      mimes: ['video/mp4','video/x-flv'],   // required
      protocols: [ 2, 3 ],                  // required, set at least 1 value in array
      placement: 2,                         // optional, defaults to 2 when context = outstream
      api: [ 1, 2 ],                        // optional
      skip: 0,                              // optional
      minduration: 5,                       // optional
      maxduration: 30,                      // optional
      playbackmethod: [1,3],                // optional
      battr: [ 13, 14 ],                    // optional
      linearity: 1,                         // optional
      minbitrate: 10,                       // optional
      maxbitrate: 10                        // optional
    }   
  }, 
  bids: [{
    bidder: '33across',
    params: {
        siteId: 'examplePub123',    // required     
        productId: 'siab'           // required     
    }
  }],
  ...
}

Ad Unit Setup for Instream Video

var adUnits = [
{
  code: '33across-hb-ad-123456-1', // ad slot HTML element ID  
  mediaTypes: {
    video: {                                // We recommend setting the following video params
                                            // in Ad Unit rather than bidder params as per Prebid 4.0 recommendation. 
      playerSize: [300, 250],               // required
      context: 'instream',                  // required
      mimes: ['video/mp4','video/x-flv'],   // required
      protocols: [ 2, 3 ],                  // required, set at least 1 value in array
      placement: 1,                         // optional, defaults to 1 when context = instream
      startdelay: 0,                        // optional, defaults to 0 when context = instream
      api: [ 1, 2 ],                        // optional
      skip: 0,                              // optional
      minduration: 5,                       // optional
      maxduration: 30,                      // optional
      playbackmethod: [1,3],                // optional
      battr: [ 13, 14 ],                    // optional
      linearity: 1,                         // optional
      minbitrate: 10,                       // optional
      maxbitrate: 10                        // optional
    }   
  }, 
  bids: [{
    bidder: '33across',
    params: {
        siteId: 'examplePub123',    // required    
        productId: 'instream'       // required     
    }
  }],
  ...
}

Ad Unit Setup for Multi-format: Banner, Video (Outstream)

var adUnits = [
{
  code: '33across-hb-ad-123456-1', // ad slot HTML element ID  
  mediaTypes: {
    banner: {  
      sizes: [
          [300, 250], 
          [728, 90]
      ]
    },
    video: {                                // We recommend setting the following video params
                                            // in Ad Unit rather than bidder params as per Prebid 4.0 recommendation. 
      playerSize: [300, 250],               // required
      context: 'outstream',                 // required
      mimes: ['video/mp4','video/x-flv'],   // required
      protocols: [ 2, 3 ],                  // required, set at least 1 value in array
      placement: 2,                         // optional, defaults to 2 when context = outstream
      api: [ 1, 2 ],                        // optional
      skip: 0,                              // optional
      minduration: 5,                       // optional
      maxduration: 30,                      // optional
      playbackmethod: [1,3],                // optional
      battr: [ 13, 14 ],                    // optional
      linearity: 1,                         // optional
      minbitrate: 10,                       // optional
      maxbitrate: 10                        // optional
    }   
  }, 
  bids: [{
    bidder: '33across',
    params: {
        siteId: 'examplePub123',    // required     
        productId: 'siab'           // required     
    }
  }],
  ...
}

SRA Mode

We recommend using SRA mode to optimize the bidding process as this allows our adapter to group together bid requests for Ad Units pertaining to the same product and site ID thereby minimizing the number of http requests made to our endpoint. To enable SRA set the following bidder specific config under 33Across

pbjs.setBidderConfig({
   bidders: ['33across'],
   config: {
      ttxSettings: {
        enableSRAMode: true
      }
   }
});

AAX

Features

"Send All Bids" Ad Server Keys

Bid Params

Video Object

Besides the above-mentioned parameters, we support all other OpenRTB 2.x video objects as optional parameters.

In addition to bids[].params.video, Aax adapter consumes parameters specified in the mediaTypes.video.

Example of Instream Video Ad-unit

var videoAdUnit = {
  code: 'video1',
  mediaTypes: {
    video: {
      context: "instream",
      playerSize: [640, 480],
      mimes: ['video/mp4'],
      placement: 1
    }
  },
  bids: [{
    bidder: 'aax',
    params: {
      cid: 'aax_test_customer',
      crid: 'aax_crid',  
    }
  }]
};

Example of Native Ad-unit

var adUnits = [{
  code: 'div-gpt-ad-6874091242345-0',
  mediaTypes: {
    native: {
      image: {
        required: true,
        sizes: [300, 250],
        wmin: 50,
      },
      title: {
        required: true,
        len: 80
      }
    }
  },
  bids: [{
    bidder: 'aax',
    params: {
      cid: 'aax_test_customer',
      crid: 'aax_crid'
    }
  }]
}];

Example of Banner Ad-unit

var adUnits = [{
  code: 'div-gpt-ad-6874091242345-0',
  mediaTypes: {
    banner: {
      sizes: [
        [728, 90],
        [300, 600],
        [300, 250]
      ],
    }
  },
  bids: [{
    bidder: 'aax',
    params: {
      cid: 'aax_test_customer',
      crid: 'aax_crid'
    }
  }]
}];

Aceex

Features

"Send All Bids" Ad Server Keys

Note:

The Example Bidding adapter requires setup before beginning. Please contact us at tech@aceex.com

Bid Params

AcuityAds

Features

"Send All Bids" Ad Server Keys

Note:

The Example Bidding adapter requires setup before beginning. Please contact us at rafi.babler@acuityads.com

Prebid.JS Bid Params

Prebid Server Bid Params

AdformOpenRTB

Features

"Send All Bids" Ad Server Keys

This bidder previously had a bidder code of adformOpenRTB, but prefers new configurations to use adf.

Bid params

Note: Bid placement should be defined using the mid parameter or inv and mname parameters (dynamic master tag) but not both.

OpenRTB request config

OpenRTB bid request app, site, device properties configured using prebid config.

pbjs.setConfig({
  ortb2: {
    app: {
      name: 'My APP'
    }
  }
});

Ad Generation

Features

"Send All Bids" Ad Server Keys

Bid Params

Adhese

Features

"Send All Bids" Ad Server Keys

Registration

The Adhese bid adapter may require an additional setup from the Adhese team, even for existing Adhese customers. Please reach out to your support team or info@adhese.com for more information.

Prebid Server host companies need to work with Adhese for each additional publisher.

Bid Params

Configuration

Adhese supports ‘iframe’ UserSync configuration only.

For Prebid.js v1.15.0 and later:

pbjs.setConfig({
  userSync: {
    filterSettings: {
      iframe: {
        bidders: '*',      // '*' represents all bidders
        filter: 'include'
      }
    }
  }
});

For Prebid.js v1.14.0 and before:

pbjs.setConfig({
   userSync: {
    iframeEnabled: true,
    enabledBidders: ['adhese']
 }});

Note: Combine the above the configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only last call for a given attribute will take effect.

AdKernel

Features

"Send All Bids" Ad Server Keys

Note:

The Adkernel Bidding adaptor requires setup and approval before beginning. Please reach out to prebid@adkernel.com for more details

Bid Params

AdKernelAdn

Features

"Send All Bids" Ad Server Keys

Note:

The AdkernelAdn Header Bidding adaptor requires setup and approval before beginning. Please reach out to prebid@adkernel.com for more details

Bid Params

ADman Media

Features

"Send All Bids" Ad Server Keys

Note:

The Adman Bidding adapter requires setup before beginning. Please contact us at prebid@admanmedia.com Due to different integration API prebid.js and prebid-server api params are different

Prebid.JS Bid Params

Prebid server Bid Params

AdMixer

Features

"Send All Bids" Ad Server Keys

Bid Params

Adnuntius

Features

"Send All Bids" Ad Server Keys

Bid Params

Targeting

The Adnuntius Documentation provides detailed information on sending targeting data to the Adnuntius adserver.

Example

Here’s an example of sending targeting information about categories to adnuntius via the bid request:

{
    code: "0000000000072345",
    mediaTypes: {
        banner: {
            sizes: [[980, 360], [980, 300], [980, 240], [980, 120]]
        }
    },
    bids: [
        {
            bidder: "adnuntius",
            params: {
                auId: "8b6bc",
                network: "adnuntius",
                targeting: {
                    c: ['prebids']
                }
            }
        }
    ]
}

Sending segments to the ad server

There’s an option to send segment id in the bidder config that will be picked up and sent to the ad server. Below is an example on how to do this:

pbjs.setBidderConfig({
    bidders: ['adnuntius', 'bidderB'],
    config: {
        ortb2: {
            user: {
                data: [{
                    name: "adnuntius",
                    segment: [
                        { id: "1" },
                        { id: "2" }
                    ]
                }]
            }
        }
    }
});

Disable cookies for adnuntius

You have the option to tell adnuntius not to set cookies in your browser. This does not mean that third party ads being served through the ad server will not set cookies. Just that Adnuintius will not set it for internal ads.

pbjs.setBidderConfig({
    bidders: ['adnuntius'],
    config: {
        useCookie: false
    }
});

Use cookie will always be set to true by default. Changing it to false will disable cookies.

Prebid Server Test Request

The following test parameters can be used to verify that Prebid Server is working properly with the server-side Adnuntius adapter. the auId below will not return a creative. Please substitute it with your own.

"imp": [{
    "id": "impression-id",
    "banner": {
        "format": [{
            "w": 980,
            "h": 240
        }, {
            "w": 980,
            "h": 360
        }]
    },
    "ext": {
        "adnuntius": {
            "auId": "abc123"
        }
    }
}]

Passing no Cookie in Prebid Server request

As a publisher you have the option to set no cookie in the device request to let Adnuntius adserver know not to set cookies in the client’s browser. In order to do that you just need to pass this in the request:

"device": {  
    "ext": {
        "noCookies": true
    }
},

First Party Data

publishers can use the ortb2 configuration parameter to provide First Party Data. We accept all standard OpenRTB fields for both:

• ortb2.site
• ortb2.user

These fields are optional and only needed for user identification and contextual targeting. How to use it can be read here: Prebid ortb2. Currently we only support this for our prebid server bidder, but will add it to the client bidder in the future.

Video requests

Currently we only support client requests and instream context. An example request would look like this:

{
    code: 'video1',
    mediaTypes: {
        video: {
            playerSize: [640, 480],
            context: 'instream'
        }
    },
    bids: [{
        bidder: 'adnuntius',
        params: {
            auId: '00000000001cd429', //put your placement id here

            video: {
                skippable: true,
                playback_method: ['auto_play_sound_off']
            }
        }
    }]
};

Example native

Here’s an example of how to request a native ad from adnuntius:

{
    code: 'native',
    sizes: [
        [320, 320]
    ],
    mediaTypes: {
        native: {
            title: {
                required: true
            },
            image: {
                required: true
            },
            body: {
                required: true
            }
        }
    },
    bids: [{
        bidder: 'adnuntius',
        params: {
            auId: "0000000000abc123",
        }
    }]
}

AdOcean

Features

"Send All Bids" Ad Server Keys

Note

The AdOcean bid adapter may require an additional setup from the AdOcean team. Please contact with your local Technical Support team or by visiting AdOcean website.

Bid Params

Adoppler

Features

"Send All Bids" Ad Server Keys

Bid Params

Adot

Features

"Send All Bids" Ad Server Keys

Prebid JS

Bid Params

Video Object

Bid Config

PublisherId

You can set a publisherId using pbjs.setBidderConfig for the bidder adot

Example

pbjs.setBidderConfig({
    bidders: ['adot'],
    config: {
        adot: {
            publisherId: '__MY_PUBLISHER_ID__'
        }
    }
});

Specific publisher path

You can set a specific publisher path using pbjs.setBidderConfig for the bidder adot The bidrequest will add this path to the bidder endpoint

Example

pbjs.setBidderConfig({
    bidders: ['adot'],
    config: {
        adot: {
            publisherPath: '__MY_PUBLISHER_PATH__'
        }
    }
});

Prebid server

Bid Params

Testing Bid Request

The following test parameters can be used to verify that Prebid Server is working properly with the server-side adot adapter. This is a mobile Bid-request example.

  {
  "id": "b967c495-adeb-4cf3-8f0a-0d86fa17aeb2",
  "app": {
    "id": "0",
    "name": "test-adot-integration",
    "publisher": {
      "id": "1",
      "name": "Test",
      "domain": "test.com"
    },
    "bundle": "com.example.app",
    "paid": 0,
    "domain": "test.com",
    "page": "https:\/\/www.test.com\/",
    "cat": [
      "IAB1",
      "IAB6",
      "IAB8",
      "IAB9",
      "IAB10",
      "IAB16",
      "IAB18",
      "IAB19",
      "IAB22"
    ]
  },
  "device": {
    "ua": "Mozilla\/5.0 (Linux; Android 7.0; SM-G925F Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/80.0.3987.132 Mobile Safari\/537.36",
    "make": "phone-make",
    "model": "phone-model",
    "os": "os",
    "osv": "osv",
    "ip": "0.0.0.0",
    "ifa": "IDFA",
    "carrier": "WIFI",
    "language": "English",
    "geo": {
      "zip": "75001",
      "country": "FRA",
      "type": 2,
      "lon": 48.2,
      "lat": 2.32,
      "accuracy": 100
    },
    "ext": {
      "is_app": 1
    },
    "connectiontype": 2,
    "devicetype": 4
  },
  "user": {
    "id": "IDFA",
    "buyeruid": ""
  },
  "imp": [
    {
      "id": "dec4147e-a63f-4d25-9fff-da9bfd05bd02",
      "banner": {
        "w": 320,
        "h": 50,
        "format": [
          {
            "w": 320,
            "h": 50
          }
        ],
        "api": [
          1,
          2,
          5,
          6,
          7
        ]
      },
      "bidfloorcur": "USD",
      "bidfloor": 0.1,
      "instl": 0,
      "ext": {
        "adot": {
        }
      }
    }
  ],
  "cur": [
    "USD"
  ],
  "regs": {
    "ext": {
      "gdpr": 1
    }
  },
  "at": 1
}

Please contact admin@we-are-adot.com if you would like to build and deploy Prebid server and use it with Adot.

Adpone

Features

"Send All Bids" Ad Server Keys

Bid Params

Adprime

Features

"Send All Bids" Ad Server Keys

Note:

The Adprime Bidding adapter requires setup before beginning. Please contact us at rafal@adprime.com

Prebid.js Bid Params

Prebid Server Bid Params

Adrino

Features

"Send All Bids" Ad Server Keys

Note

The Adrino bidder adapter requires setup and approval from the Adrino team. Please reach out to wydawcy@adrino.pl for more information.

Bid Params

Native example

var adUnits = [
    code: '/12345678/prebid_native_example_1',
    mediaTypes: {
        native: {
            image: {
                required: true,
                sizes: [[300, 210],[300,150],[140,100]]
            },
            title: {
                required: true
            },
            sponsoredBy: {
                required: false
            },
            body: {
                required: false
            },
            icon: {
                required: false
            }
        }
    },
    bids: [{
        bidder: 'adrino',
        params: {
            hash: 'abcdef123456'
        }
    }]
];

Adtarget

Features

"Send All Bids" Ad Server Keys

Registration

To use the Adtarget bidder you will need an aid from an exchange account on https://adtarget.com.tr. For further information, please contact kamil@adtarget.com.tr.

Bid params

Description

Provides a solution for accessing Video demand and display demand from Adtarget

Test Parameters

    var adUnits = [

      // Video adUnit
      {
        code: 'videoPlayer',
        mediaTypes: {
          video: {
            playerSize:[640,480]
            context: 'instream'
          }
        },
        bids: [{
          bidder: 'adtarget',
          params: {
            aid: 331133
          }
        }]
      },

      // Banner adUnit
      {
        code: 'bannerAd',
        mediaTypes: {
          banner: {
            sizes: [[300, 250]]
          }
        },
        bids: [{
          bidder: 'adtarget',
          params: {
            aid: 529814
          }
        }]
      }
    ];

Additional Configuration

It is possible to configure requests to be splitted in chunks to have less bid requests in single http request (default value is 10)

    pbjs.setBidderConfig({
        config: {              
            adtarget: {
                chunkSize: 1   // makes 1 http request per 1 adunit configured
            }
        }
    });

Adtelligent

Features

"Send All Bids" Ad Server Keys

Bid params

Description

Get access to multiple demand partners across Adtelligent AdExchange and maximize your yield with Adtelligent header bidding adapter.

Adtelligent header bidding adapter connects with Adtelligent demand sources in order to fetch bids. This adapter provides a solution for accessing Video demand and display demand.

Adtelligent now supports adpod.

Test Parameters

    var adUnits = [

      // Video instream adUnit
      {
        code: 'test-div',
        mediaTypes: {
          video: {
            context: 'instream',
            playerSize: [640, 480]
          }
        },
        bids: [{
          bidder: 'adtelligent',
          params: {
            aid: 331133
          }
        }]
      },

      // Video outstream adUnit
      {
        code: 'test-div',
        mediaTypes: {
          video: {
            context: 'outstream',
            playerSize: [640, 480]
          }
        },
        bids: [{
          bidder: 'adtelligent',
          params: {
            aid: 331133
          }
        }]
      },

       // Video ADPOD adUnit
      {
        code: 'test-div',
        sizes: [[640, 480]],
        mediaTypes: {
          video: {
            context: 'adpod',
            playerSize: [640, 480]            
          }
        },
        bids: [{
          bidder: 'adtelligent',
          params: {
            aid: 331133
          }
        }]
      },

      // Banner adUnit
      {
        code: 'test-div',
        mediaTypes:{
            banner:{
                sizes: [[300, 250]]
            }
        }
        bids: [{
          bidder: 'adtelligent',
          params: {
            aid: 350975
          }
        }]
      }
    ];

Additional Configuration

It is possible to configure requests to be split into chunks so as to have fewer bid requests in a single http request (default value is 10).

    pbjs.setBidderConfig({
        config: {              
            adtelligent: {
                chunkSize: 1   // makes 1 http request per 1 adunit configured
            }
        }
    });

Adtarget.me

Features

"Send All Bids" Ad Server Keys

Note:

The Adtrgtme bidding adapter requires setup before beginning. Please contact us at info@adtarget.me

Advangelists

Features

"Send All Bids" Ad Server Keys

Note:

For more information about [Advangelists https://advangelists.com], please contact lokesh@advangelists.com

Bid Params

AdView

Features

"Send All Bids" Ad Server Keys

Note:

Currently adapter doesn’t support multi impression and can not perform impression splitting, so only the first impression will be delivered.

The Example Bidding adapter requires setup before beginning. Please contact us at partner@adview.com

Bid Params

adxcg

Features

"Send All Bids" Ad Server Keys

Note

Prebid-server activation requires setup and approval before beginning. Please reach out to your account manager or info@adxcg.com for more details.

Bid Params

Adyoulike

Features

"Send All Bids" Ad Server Keys

Note:

The Adyoulike Header Bidding adaptor requires setup and approval from the Adyoulike team. Please reach out to your account manager or prebid@adyoulike.com for more information.

Bid Params

Same ‘placement’ parameter can be used from either prebid JS or prebid server.

AJA

Features

"Send All Bids" Ad Server Keys

Note

The AJA Bidding adaptor requires setup and approval before beginning. Please reach out to ssp_support@aja-kk.co.jp for more details

Bid Params

Configuration

AJA recommends setting UserSync by iframe for monetization.

For Prebid.js v1.15.0 and later:

pbjs.setConfig({
  userSync: {
    filterSettings: {
      iframe: {
        bidders: "*", // '*' represents all bidders
        filter: "include",
      },
    },
  },
});

For Prebid.js v1.14.0 and before:

pbjs.setConfig({
  userSync: {
    iframeEnabled: true,
    enabledBidders: ["aja"],
  },
});

AlgoriX

Features

"Send All Bids" Ad Server Keys

Note:

AlgoriX adapter requires setup and approval from the AlgoriX team, even for existing in-app developers and publishers. Please reach out to your account team or email to prebid@algorix.co for more information.

Bid Params

Note:

• Prebid Server adapter only checks for and uses first imp bid params. All other imp bid params are ignored.
• placementId and appId will be generated on AlgoriX Platform.
• region is optional param, which determine the AlgoriX server. APAC for SG endpoint, USE for US endpoint, Other for Global endpoint.

Alkimi

Features

"Send All Bids" Ad Server Keys

Bid Params

AMX RTB

Features

"Send All Bids" Ad Server Keys

Bid Params

Test Parameters

To enable 100% fill test ads, you can use the following params:

{
  testMode: true,
  tagId: "cHJlYmlkLm9yZw"
}

This will produce a bid at $10 with a test creative.

Note that the tagId is case-sensitive. Do not use cHJlYmlkLm9yZw in production environments: this ID is for testing only.

First Party Data

From Prebid.js >= 4.30, publishers can use the ortb2 configuration parameter to provide First Party Data. We accept all standard OpenRTB fields for both:

• ortb2.site
• ortb2.user

Note that all fields are optional. For contextual data (e.g. categories), standard IAB taxonomies are supported. We do not support passing first party data via bid parameters.

Example - Setting ortb2.site and ortb2.user fields

pbjs.setBidderConfig({
  bidders: ["amx"],
  config: {
    ortb2: {
      site: {
        keywords: "kw1,kw2",
        cat: ["IAB2"],
        sectioncat: ["IAB2-1"],
        pagecat: ["IAB2-22"],
        content: {
          context: 5
        }
      },
      user: {
        yob: 1981,
        keywords: "kw3",
      }
    }
  }
})

AndBeyond.Media

Features

"Send All Bids" Ad Server Keys

Prebid Bid Params

Apacdex

Features

"Send All Bids" Ad Server Keys

Table of Contents

• Table of Contents
• Bid Params
• Geo Object
• Video Ad Unit
• Sample Banner Ad Unit
• Sample Video Ad Unit: Instream
• Sample Video Ad Unit: Outstream

Bid Params

(*) Please do not use placementId and siteId at the same time.

Geo Object

If the publisher has GEO data of the user’s device. Make it available through the geo audience so we can improve ad targeting, which means improving bids. The list of fields can be referenced in Section 3.2.19 from the OpenRTB 2.5 document.

Video Ad Unit

Publishers declare video inventory by passing the following parameters via mediaTypes.video

Lists of values are in the OpenRTB 2.5 documentation as referenced above.

Sample Banner Ad Unit

var adUnits = [
  {
    code: 'test-div',
    mediaTypes: {
      banner: {
        sizes: [[300, 250], [300,600]]
      }
    },
    bids: [
      {
          bidder: 'apacdex',
          params: {
              siteId: 'apacdex1234', // siteId provided by Apacdex
              floorPrice: 0.01, // default is 0.01 if not declared
          }
      }
    ]
  }
];

Sample Video Ad Unit: Instream

var instreamAdUnit = {
  code: 'test-div',
  sizes: [[640, 480]],
  mediaTypes: {
    video: {
      playerSize: [[640, 480]],
      context: "instream"
      api: [2],
      placement: 1,
      skip: 1,
      linearity: 1,
      minduration: 1,
      maxduration: 120,
      mimes: ["video/mp4", "video/x-flv", "video/x-ms-wmv", "application/vnd.apple.mpegurl", "application/x-mpegurl", "video/3gpp", "video/mpeg", "video/ogg", "video/quicktime", "video/webm", "video/x-m4v", "video/ms-asf", video/x-msvideo"],
      playbackmethod: [6],
      startdelay: 0,
      protocols: [1, 2, 3, 4, 5, 6]
    },
  },
  bids: [
    {
      bidder: 'apacdex',
      params: {
        siteId: 'apacdex1234', // siteId provided by Apacdex
        floorPrice: 0.01, // default is 0.01 if not declared
      }
    }
  ]
};

mediaTypes.video object reference to section 3.2.7 Object: Video in the OpenRTB 2.5 document You must review all video parameters to ensure validity for your player and DSPs

Sample Video Ad Unit: Outstream

var outstreamAdUnit = {
  code: 'test-div',
  sizes: [[410, 231]],
  mediaTypes: {
    video: {
      playerSize: [[410, 231]],
      context: "outstream"
      api: [2],
      placement: 5,
      linearity: 1,
      minduration: 1,
      maxduration: 120,
      mimes: ["video/mp4", "video/x-flv", "video/x-ms-wmv", "application/vnd.apple.mpegurl", "application/x-mpegurl", "video/3gpp", "video/mpeg", "video/ogg", "video/quicktime", "video/webm", "video/x-m4v", "video/ms-asf", video/x-msvideo"],
      playbackmethod: [6],
      startdelay: 0,
      protocols: [1, 2, 3, 4, 5, 6]
    },
  },
  bids: [
    {
      bidder: 'apacdex',
      params: {
        siteId: 'apacdex1234', // siteId provided by Apacdex
        floorPrice: 0.01, // default is 0.01 if not declared
      }
    }
  ]
};

mediaTypes.video object reference to section 3.2.7 Object: Video in the OpenRTB 2.5 document You must review all video parameters to ensure validity for your player and DSPs

Applogy

Features

"Send All Bids" Ad Server Keys

Bid Params

AppNexus

Features

"Send All Bids" Ad Server Keys

Disclosure:

This adapter is known to use an HTTP 1 endpoint. Header bidding often generates multiple requests to the same host and bidders are encouraged to change to HTTP 2 or above to help improve publisher page performance via multiplexing.

Table of Contents

• Disclosure:
• Table of Contents
  • Bid Params
  • Video Object
  • User Object
  • App Object
  • Custom Targeting keys
  • Auction Level Keywords
  • Passing Keys Without Values
  • First Party Data
  • User Sync in AMP
  • Mobile App Display Manager Version
  • Debug Auction
  • Prebid Server Test Request

All AppNexus (Xandr) placements included in a single call to requestBids must belong to the same parent Publisher. If placements from two different publishers are included in the call, the AppNexus bidder will not return any demand for those placements.
Note: This requirement does not apply to adapters that are aliasing the AppNexus adapter.

Bid Params

Video Object

User Object

App Object

AppNexus supports using prebid within a mobile app’s webview. If you are interested in using an SDK, please see Prebid Mobile instead.

Custom Targeting keys

AppNexus returns custom keys that can be sent to the adserver through bidderSettings: buyerMemberId, dealPriority, and dealCode. The following snippet demonstrates how to add these custom keys as key-value pairs.

pbjs.bidderSettings = {
  appnexus: {
    adserverTargeting: [
      {
        key: "apn_buyer_memberid", // Use key configured in your adserver
        val: function(bidResponse) {
          return bidResponse.appnexus.buyerMemberId;
        }
      },
      {
        key: "apn_prio", // Use key configured in your adserver
        val: function(bidResponse) {
          return bidResponse.appnexus.dealPriority;
        }
      }, {
        key: "apn_dealcode", // Use key configured in your adserver
        val: function(bidResponse) {
          return bidResponse.appnexus.dealCode;
        }
      }
    ]
  }
}

Auction Level Keywords

It’s possible to pass a set of keywords for the whole request, rather than a particular adUnit. Though they would apply to all adUnits (which include the appnexus bidder) in an auction, these keywords can work together with the bidder level keywords (if for example you want to have specific targeting for a particular adUnit).

Below is an example of how to define these auction level keywords for the appnexus bidder:

pbjs.setConfig({
  appnexusAuctionKeywords: {
    genre: ['classical', 'jazz'],
    instrument: 'piano'
  }
});

Like in the bidder.params.keywords, the values here can be empty. Please see the section immediately below for more details.

Passing Keys Without Values

It’s possible to use the keywords parameter to define keys that do not have any associated values. Keys with empty values can be created in Prebid.js and can also be sent through Prebid Server to AppNexus. The following are examples of sending keys with empty values:

keywords: {
  myKeyword: '',
  myOtherKeyword: ['']
}

The preceding example passes the key myKeyword with an empty value. The key myOtherKeyword contains an empty value array.

You can define keys with values and without values in the same keywords definition. In this next example, we’ve defined the key color with an array of values: red, blue, and green. We’ve followed that with the key otherKeyword with an empty value array.

keywords: {
  color: ['red', 'blue', 'green'],
  otherKeyword: ['']
}

First Party Data

Publishers should use the ortb2 method of setting First Party Data.

At this time however, the appnexus bidder only reads the First Party Data when using the Prebid Server and Prebid Server Premium endpoints. The client-side version of the appnexus bidder does not use the values from the First Party Data fields.

PBS/PSP supports all first party data fields: site, user, segments, and imp-level first party data.

User Sync in AMP

If you are syncing user id’s with Prebid Server and are using AppNexus’ managed service, see AMP Implementation Guide cookie-sync instructions for details.

Mobile App Display Manager Version

The AppNexus endpoint expects imp.displaymanagerver to be populated for mobile app sources requests, however not all SDKs will populate this field. If the imp.displaymanagerver field is not supplied for an imp, but request.app.ext.prebid.source and request.app.ext.prebid.version are supplied, the adapter will fill in a value for diplaymanagerver. It will concatenate the two app fields as <source>-<version> fo fill in the empty displaymanagerver before sending the request to AppNexus.

Debug Auction

Enabling the AppNexus Debug Auction feature should only be done for diagnosing the AppNexus auction. Do not enable this feature in a production setting where it may impact users.

To understand what is happening behind the scenes during an auction, you can enable a debug auction by adding an apn_prebid_debug cookie with a JSON string. For example:

{ "enabled": true, "dongle": "QWERTY", "debug_timeout": 1000, "member_id": 958 }

To view the results of the debug auction, add the pbjs_debug=true query string parameter and open your browser’s developer console.

Prebid Server Test Request

The following test parameters can be used to verify that Prebid Server is working properly with the server-side Appnexus adapter. This example includes an imp object with an Appnexus test placement ID and sizes that would match with the test creative.

	"imp": [{
		"id": "some-impression-id",
		"banner": {
			"format": [{
				"w": 600,
				"h": 500
			}, {
				"w": 300,
				"h": 600
			}]
		},
		"ext": {
			"appnexus": {
				"placement_id": 13144370
			}
		}
	}]

Appush

Features

"Send All Bids" Ad Server Keys

Prebid Params

Audience Network

Features

"Send All Bids" Ad Server Keys

Registration

Audience Network will not bid on requests made from device simulators. When testing for Mobile bids, you must make bid requests using a real device.

Note: Audience Network is disabled by default. Please enable it in the app config if you wish to use it. Make sure you provide the partnerID for the auctions to run correctly.

Bid Params

Automatad OpenRTB Bid Adapter

Features

"Send All Bids" Ad Server Keys

Prebid.js Bid Params

Prebid-Server Bid Params

Avocet

Features

"Send All Bids" Ad Server Keys

Registration

Please contact Avocet at info@avocet.io if you would like to get started selling inventory via the Avocet platform.

Bid Params

Prebid Server Note: Avocet is disabled by default. Please enable it in the app config if you wish to use it. This can be done by setting adapters.avocet.disabled to false and by setting adapters.avocet.endpoint to a valid Avocet endpoint url.

Axonix

Features

"Send All Bids" Ad Server Keys

Prebid Server Note:

The Axonix Bidding adapter requires setup before beginning. Please contact us at support.axonix@emodoinc.com.

Bid Params

Beachfront

Features