Skip to content
This repository was archived by the owner on May 8, 2025. It is now read-only.

Commit b93ffda

Browse files
committed
Match the and/or structure of the function
1 parent 3f9ddb7 commit b93ffda

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

dev-docs/publisher-api-reference.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1795,15 +1795,16 @@ In the event of collisions, querystring values passed via `options.params` take
17951795
### pbjs.markWinningBidAsUsed(markBidRequest)
17961796

17971797
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”.
1798+
If you know the adId, then be specific, otherwise Prebid will retrieve the winning bid for the adUnitCode and mark it accordingly.
17981799

17991800
#### Argument Reference
18001801

1801-
##### The `markBidRequest` object
1802+
##### The `markBidRequest` object (use one or both)
18021803

18031804
{: .table .table-bordered .table-striped }
18041805
| Param | Type | Description |
18051806
| --- | --- | --- |
1806-
| adUnitCode | `string` | The ad unit code |
1807-
| adId | `string` | The id representing the ad we want to mark |
1807+
| adUnitCode | `string` | (Optional) The ad unit code |
1808+
| adId | `string` | (Optional) The id representing the ad we want to mark |
18081809

18091810
</div>

dev-docs/show-video-with-a-dfp-video-tag.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -134,21 +134,17 @@ Display banners are rendered with the help of the renderAd function. This functi
134134
```javascript
135135
pbjs.requestBids({
136136
bidsBackHandler: function(bids) {
137-
// The video advertisement you want to show
138-
const bid = ...
139-
140137
var videoUrl = pbjs.adServers.dfp.buildVideoUrl({
141138
adUnit: videoAdUnit,
142-
bid: bid
143139
params: {
144140
iu: '/19968336/prebid_cache_video_adunit'
145141
}
146142
});
147143

148144
// Mark the bid, used in buildVideoUrl, as used
149145
pbjs.markWinningBidAsUsed({
150-
adUnitCode: videoAdUnit.code
151-
adId: bid.adId
146+
adUnitCode: videoAdUnit.code // optional if you know the adId
147+
adId: bid.adId // optional
152148
});
153149

154150
invokeVideoPlayer(videoUrl);

0 commit comments

Comments
 (0)