Skip to content

Commit

Permalink
Update ix-server.md
Browse files Browse the repository at this point in the history
added a section for Protected Audience API instructions
  • Loading branch information
rimaburder-index authored Dec 9, 2024
1 parent 2bd11ce commit a56c4a3
Showing 1 changed file with 37 additions and 3 deletions.
40 changes: 37 additions & 3 deletions dev-docs/bidders/ix-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ privacy_sandbox: paapi
* [Call Index from Prebid Mobile SDK](#call-index-from-prebid-mobile-sdk)
* [Call Index from CTV/long-form video environment](#call-index-from-ctvlong-form-video-environment)
* [Call Index from any other server-to-server OpenRTB environment](#call-index-from-any-other-server-to-server-openrtb-environment)
* [Receive Protected Audience API demand from Index](#paapi)
* [Bid request parameters](#bid-request-parameters)
* [Banner](#banner)
* [Video](#video)
Expand Down Expand Up @@ -83,7 +84,6 @@ If you are hosting your own Prebid Server instance, depending on whether you are
```

* Edit the below existing entry and include your publisher ID in the `s` parameter:
{% raw %}

```javascript
userSync:
Expand Down Expand Up @@ -129,8 +129,6 @@ If you are hosting your own Prebid Server instance, depending on whether you are
url: "https://ssum.casalemedia.com/usermatch?s=<PUBLISHER ID>&gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&cb={{.RedirectURL}}"
```

{% endraw %}

<a id="call-index"></a>

### Publisher instructions to call Index through Prebid Server
Expand Down Expand Up @@ -238,6 +236,42 @@ To request bids from Index:
}],
```
<a id="paapi"></a>
### Receive Protected Audience API demand from Index
Publishers who want to use the Protected Audience API with Prebid Server, must first set up their inventory to be eligible for Protected Audience API in Prebid.js. Prebid Server will automatically pass through the on-device auction signals received from Prebid.js to 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 7.44.0 and 8.51.0, you must be using Prebid Server version 2.1.0 or later. For a Prebid.js version that is 8.52.0 or later, you must be using Prebid Server version 3.3.0 or later.

Check failure on line 246 in dev-docs/bidders/ix-server.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Unordered list indentation

dev-docs/bidders/ix-server.md:246:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md007.md

Check failure on line 246 in dev-docs/bidders/ix-server.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Lists should be surrounded by blank lines

dev-docs/bidders/ix-server.md:246 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* **For Prebid Server Go:** If..."] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md032.md
* **For Prebid Server Java:** If you are using a Prebid.js version that is 7.44.0 or later, you must be using Prebid Server Java version 3.16.0 or later.

Check failure on line 247 in dev-docs/bidders/ix-server.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Unordered list indentation

dev-docs/bidders/ix-server.md:247:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md007.md

Check failure on line 247 in dev-docs/bidders/ix-server.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Lists should be surrounded by blank lines

dev-docs/bidders/ix-server.md:247 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* **For Prebid Server Java:** ..."] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md032.md
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 the [Protected Audience API support](/dev-docs/bidders/ix.html#protected-audience-api-support) section in our Prebid.js documentation on the Prebid site.

Check failure on line 248 in dev-docs/bidders/ix-server.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Lists should be surrounded by blank lines

dev-docs/bidders/ix-server.md:248 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. Configure Prebid.js to send..."] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md032.md
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:
```javascript
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}]}
}
}
}]
})
```

<a id="bid-request-parameters"></a>

### Bid request parameters
Expand Down

0 comments on commit a56c4a3

Please sign in to comment.