Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding docs for customHeader suppor for XHR call to Preid Server #5444

Merged
merged 4 commits into from
Jun 28, 2024
Merged

Adding docs for customHeader suppor for XHR call to Preid Server #5444

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a07384
Adding docs for customHeader suppor for XHR call to Preid Server
sanved77 Jun 19, 2024
ed7d063
Merge branch 'master' into custom-header-support-doc
sanved77 Jun 19, 2024
e35665e
Added extra example
sanved77 Jun 20, 2024
fce1630
Merge branch 'master' into custom-header-support-doc
sanved77 Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions dev-docs/modules/prebidServer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,20 +56,20 @@ The same bidder cannot be set in both configs. For example:
```javascript
pbjs.setConfig({
s2sConfig: [
{
name: "pbs-appnexus",
accountId: '12345',
bidders: ['appnexus','pubmatic'],
defaultVendor: 'appnexus',
timeout: 300,
},
{
name: "pbs-rubicon",
accountId: '678910',
bidders: ['rubicon'],
defaultVendor: 'rubicon',
timeout: 300,
},
{
name: "pbs-appnexus",
accountId: '12345',
bidders: ['appnexus','pubmatic'],
defaultVendor: 'appnexus',
timeout: 300,
},
{
name: "pbs-rubicon",
accountId: '678910',
bidders: ['rubicon'],
defaultVendor: 'rubicon',
timeout: 300,
},
sanved77 marked this conversation as resolved.
Show resolved Hide resolved
],
});
```
Expand All @@ -96,6 +96,7 @@ There are many configuration options for s2sConfig:
| `defaultTtl` | Optional | Integer | Configures the default TTL in the Prebid Server adapter to use when Prebid Server does not return a bid TTL - 60 if not set |
| `adapterOptions` | Optional | Object | Arguments will be added to resulting OpenRTB payload to Prebid Server in every impression object at request.imp[].ext.BIDDER. See the example above. |
| `extPrebid` | Optional | Object | Arguments will be added to resulting OpenRTB payload to Prebid Server in request.ext.prebid. See the examples below. |
| `customHeader` | Optional | Object | These custom headers will be included in the XHR call to the bidder's endpoint. This will allow you to send data specific to your use case. The format consists of an object where the keys represent the header names and the values correspond to the respective header values. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the docs @sanved77 , but I think it would be useful to describe what's in the object with an example. I think an example value would be { "Header1": "Value1", "Header2": "Value2"}, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me. Will add that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.


If `endpoint` and `syncEndpoint` are objects, these are the supported properties:

Expand Down