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

JS: update documentation for markWinningBidAsUsed/renderer #5709

Merged
merged 1 commit into from
Nov 22, 2024
Merged

JS: update documentation for markWinningBidAsUsed/renderer #5709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion dev-docs/publisher-api-reference/markWinningBidAsUsed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ sidebarType: 1
---


This function can be used to mark the winning bid as used. This is useful when running multiple video advertisements on the page, since these are not automatically marked as “rendered”.
This function can be used to mark the winning bid as used, removing it from the bid cache. This is useful when running multiple video advertisements on the page, since these are not automatically marked as “rendered”.

If you know the adId, then be specific, otherwise Prebid will retrieve the winning bid for the adUnitCode and mark it accordingly.

#### Argument Reference
Expand All @@ -18,3 +19,4 @@ If you know the adId, then be specific, otherwise Prebid will retrieve the winni
| --- | --- | --- |
| adUnitCode | `string` | (Optional) The ad unit code |
| adId | `string` | (Optional) The id representing the ad we want to mark |
| analytics | `boolean` | (Optional) if true, triggers the 'bidWon' event for the marked bid |
6 changes: 3 additions & 3 deletions dev-docs/show-outstream-video-ads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ Renderers can be attached to adUnits in three ways; Prebid will pick the first t

A renderer is an object containing these properties:

1. `url` -- Points to a file containing the renderer script.
2. `render` -- A function that tells Prebid.js how to invoke the renderer script.
3. `backupOnly` -- Optional field, if set to true, buyer or adapter renderer will be preferred
1. `render` -- A function that tells Prebid.js how to render a given bid.
2. `url` -- Optional, URL to a javascript file. If provided, Prebid.js will load it before invoking `render`.
3. `backupOnly` -- Optional, if set to true, buyer or adapter renderer will be preferred

In a multiFormat adUnit, you might want the renderer to only apply to only one of the mediaTypes. You can do this by defining the renderer on the media type itself.

Expand Down