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

Update PBS Auction Endpoint Doc #3940

Merged
merged 2 commits into from
Aug 10, 2022

Conversation

SyntaxNode
Copy link
Contributor

Primarily updating the "Prebid Server ORTB2 Extension Summary" section for improved readability and with updated content. I've improved readability by separating request and response fields to their own separate tables (the Adapter Sees? column does not apply to the response, use <wbr> to provide breakpoint hints instead of spaces which can lead to rendering artifacts, and folded the Example column into the description. At large desktop size, the entire table now fits within the article area.

Updated misc things along the way, as commented to explain why.

@netlify
Copy link

netlify bot commented Aug 2, 2022

Deploy Preview for prebid-docs-preview ready!

Name Link
🔨 Latest commit fcef089
🔍 Latest deploy log https://app.netlify.com/sites/prebid-docs-preview/deploys/62e966f9fa14df00086ca5fd
😎 Deploy Preview https://deploy-preview-3940--prebid-docs-preview.netlify.app/prebid-server/endpoints/openrtb2/pbs-endpoint-auction
📱 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 settings.

@@ -41,7 +41,7 @@ This is a sample OpenRTB 2.5 bid request:
"prebid": {
"bidder": {
"bidderA": {
"placement": 12883451
"placement": 12345
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This request was changed from AppNexus specific to a general example. I'm expanding on that with an obviously fake placement id and using the standard bidderA in more places.


1. bidResponse.seatbid[].bid[].exp + 60: as set by the bidder's adapter
2. request.imp[].exp + 60: as set by the incoming request
3. account config: cache_ttl.{banner,video,native,audio} + 60
4. global config: cache.default_ttl_seconds.{banner,video,native,audio} + 60
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This section was outdated.

#### Other OpenRTB Fields

Prebid Server doesn't do any special processing on any other fields, but passes them
all to the bid and analytics adapters.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Worded differently in the section header. Please advise if you disagree this is an improvement.

### OpenRTB Extensions

#### Conventions

OpenRTB 2.5 permits exchanges to define their own extensions to any object from the spec.
OpenRTB 2.x permits exchanges to define their own extensions to any object from the spec.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We don't support OpenRTB 2.6 yet, but starting to make more generic references for some sections where it makes sense now.

}
}
}
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The example had invalid json. Fixed and aligned with our global "bidderA" naming approach.

}
}
```
```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Continuing to break away from always using appnexus and rubicon in examples. Let's be more inclusive. :) Also fixed indentation such that bullet point 3 is not changed to 1 by markdown.

@MartianTribe MartianTribe merged commit 45cdeaf into prebid:master Aug 10, 2022
@SyntaxNode SyntaxNode deleted the pbs_auctionendpoint branch April 19, 2023 22:48
jlaso pushed a commit to AuDigent/prebid.github.io that referenced this pull request Nov 6, 2024
* Update PBS Auction Endpoint Doc

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

Successfully merging this pull request may close these issues.

2 participants