Skip to content

Add auctionOptions.suppressStaleRender#2939

Merged
bretg merged 2 commits intoprebid:masterfrom
conversant:stale-render
Jun 7, 2021
Merged

Add auctionOptions.suppressStaleRender#2939
bretg merged 2 commits intoprebid:masterfrom
conversant:stale-render

Conversation

@pycnvr
Copy link
Contributor

@pycnvr pycnvr commented May 6, 2021

Added usage on config auctionOptions.suppressStaleRender

See prebid/Prebid.js#6707

#### 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks. Yeah that looks better.

});
{% endhighlight %}

##### More on Stale Rendering
Copy link
Contributor

Choose a reason for hiding this comment

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

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 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's actually on jsfiddle. I don't have access unfortunately.

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

@pycnvr pycnvr May 12, 2021

Choose a reason for hiding this comment

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

Copy that block to the other page. Got it.

@bretg
Copy link
Contributor

bretg commented Jun 3, 2021

Unfortunately we're going to have to refactor this PR a bit to reflect the changes in the Pub API doc

@pycnvr
Copy link
Contributor Author

pycnvr commented Jun 4, 2021

@bretg Moved update to the new file and fixed the link. Hopefully this is it. 😄

Copy link
Contributor

@bretg bretg left a comment

Choose a reason for hiding this comment

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

Thanks @pycnvr. Question. If suppressStaleRender is true, are the STALE_RENDER and BID_WON events still fired?

@pycnvr
Copy link
Contributor Author

pycnvr commented Jun 7, 2021

@bretg Both events work the same regardless of suppressStaleRender.

@bretg
Copy link
Contributor

bretg commented Jun 7, 2021

Cool. Can you add a clarification to that extent or give me write perm?

@pycnvr
Copy link
Contributor Author

pycnvr commented Jun 7, 2021

@bretg clarification added. thx.

@bretg bretg added LGTM and removed needs work labels Jun 7, 2021
@bretg bretg merged commit ed905b1 into prebid:master Jun 7, 2021
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.

2 participants

Comments