Add auctionOptions.suppressStaleRender#2939
Conversation
dev-docs/publisher-api-reference.md
Outdated
| #### Auction Options | ||
|
|
||
| The `auctionOptions` object passed to `pbjs.setConfig` provides a method to specify bidders that the Prebid auction will no longer wait for before determing the auction has completed. This may be helpful if you find there are a number of low performing and/or high timeout bidders in your page's rotation. | ||
| The `auctionOptions` object controls aspects relate to auctions. The `secondaryBidders` field specifies bidders that the Prebid auction will no longer wait for before determining the auction has completed. This may be helpful if you find there are a number of low performing and/or high timeout bidders in your page's rotation. The `suppressStaleRender` field prevents `banner` bids from being rendered more than once. It should only be enabled after auto-refreshing is implemented correctly. |
There was a problem hiding this comment.
@pycnvr - thanks for the docs Paul, but I don't think this paragraph needs to include descriptions of the options -- that can be in the table below. That said, I like your descriptions better than the ones in the table.
Also, minor typo: object controls aspects relate to auctions should be a 'd' in related.
There was a problem hiding this comment.
Thanks. Yeah that looks better.
dev-docs/publisher-api-reference.md
Outdated
| }); | ||
| {% endhighlight %} | ||
|
|
||
| ##### More on Stale Rendering |
There was a problem hiding this comment.
This doesn't seem like the only place we need to talk about autorefresh. Willing to copy this text to https://docs.prebid.org/dev-docs/examples/adunit-refresh.html ?
There was a problem hiding this comment.
It's actually on jsfiddle. I don't have access unfortunately.
There was a problem hiding this comment.
I don't mean in the example, but copying the text below here ("When auto-refreshing is done incorrectly...") outside the example on the page itself.
There was a problem hiding this comment.
Copy that block to the other page. Got it.
|
Unfortunately we're going to have to refactor this PR a bit to reflect the changes in the Pub API doc |
|
@bretg Moved update to the new file and fixed the link. Hopefully this is it. 😄 |
|
@bretg Both events work the same regardless of suppressStaleRender. |
|
Cool. Can you add a clarification to that extent or give me write perm? |
|
@bretg clarification added. thx. |
Added usage on config auctionOptions.suppressStaleRender
See prebid/Prebid.js#6707