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.

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

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

Merged
merged 4 commits into from
Jun 28, 2024

Conversation

sanved77
Copy link
Contributor

@sanved77 sanved77 commented Jun 19, 2024

🏷 Type of documentation

  • new bid adapter
  • update bid adapter
  • new feature
  • text edit only (wording, typos)
  • bugfix (code examples)
  • new examples

📋 Checklist

🖼️ Screenshot

image

Copy link

netlify bot commented Jun 19, 2024

Deploy Preview for prebid-docs-preview ready!

Name Link
🔨 Latest commit fce1630
🔍 Latest deploy log https://app.netlify.com/sites/prebid-docs-preview/deploys/6674819f2952aa0008732024
😎 Deploy Preview https://deploy-preview-5444--prebid-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -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.

@ChrisHuie ChrisHuie merged commit 32343ac into prebid:master Jun 28, 2024
5 checks passed
BIGOAds pushed a commit to BIGOAds/prebid.github.io that referenced this pull request Jul 5, 2024
…bid#5444)

* Adding docs for customHeader suppor for XHR call to Preid Server

* Added extra example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants