Receive Protected Audience API demand from Index using Prebid Server

Info: Starting in June 2025, Index is pausing support for the Protected Audience API. After this date, you will no longer receive Protected Audience API demand from Index, even if your inventory is configured to be eligible for it.

The Protected Audience API is an in-browser API available on Chrome for banner ads. It allows DSPs to create and target interest groups without relying on third-party cookies, while protecting users from cross-site tracking. The final bidding happens on the device, within the browser.

Publishers who want to use the Protected Audience API with Prebid Server A server-to-server parallel bidding integration to retrieve demand from Index and all other SSPs and exchanges., must first set up their inventory to be eligible for Protected Audience API in Prebid.js An open-source library for publishers to implement header bidding on their websites and manage multiple header bidding partners.. Prebid Server will automatically pass through the on-device auction signals received from Prebid.js to Index Exchange (Index). To receive Protected Audience API auction demand from Index, contact your Index Representative.

Before you begin:

Depending on whether you are using the Prebid Server Go or Java code base and the Prebid.js version, you must make sure that you are using the appropriate Prebid Server version:

  • For Prebid Server Go:

    • If you are using a Prebid.js version that is between 8.18.0 and 8.51.0, you must be using Prebid Server version 2.1.0 or later.

    • If you are using a Prebid.js version that is 8.52.0 or later, you must be using Prebid Server version 3.3.0 or later.

  • For Prebid Server Java:

    • If you are using a Prebid.js version that is 8.18.0 or later, you must be using Prebid Server Java version 3.16.0 or later.

  1. Configure Prebid.js to send the ae field with a value of 1. For more information on how to set up the Protected Audience API in Prebid.js, see Receive Protected Audience API demand from Index using Prebid.js.

  2. Prebid Server will now automatically pass through the ae=1 field received from Prebid.js to Index. No other specific Prebid Server configuration is required.

Example

The following is an example that illustrates how to set up Prebid Server in your Prebid.js configuration:

pbjs.setConfig({
    s2sConfig: [{
        accountId: '1',
        bidders: ['ix'],
        adapter: 'prebidServer',
        enabled: true,
        endpoint: 'https://prebid-server.example.com/openrtb2/auction',
        syncEndpoint: 'https://prebid-server.example.com/cookie_sync',
        timeout: 500,
        extPrebid: {
            cache: {
                vastxml: { returnCreative: false }
            },
            targeting: {
                pricegranularity: {"ranges": [{"max":40.00,"increment":1.00}]}
            }
        }
    }]
})

For examples on bid requests and responses that include the Protected Audience API fields, see Examples of OpenRTB bid requests and responses.