Skip to content

Commit 2dbe298

Browse files
authored
Document new requestBids event argument (#6378)
1 parent d40d295 commit 2dbe298

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

dev-docs/publisher-api-reference/getEvents.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `getEvents` method returns a copy of all emitted events since the page loade
2323
The available events are:
2424

2525
{: .table .table-bordered .table-striped }
26-
| Event | Description | Callback Arguments |
26+
| Event | Description | Event argument |
2727
| --- | --- | --- |
2828
| auctionInit | The auction has started | Object containing auction details |
2929
| auctionEnd | The auction has ended | Object containing auction details |
@@ -38,7 +38,7 @@ The available events are:
3838
| bidWon | A bid has won | Bid response object |
3939
| bidTimeout | A bid timed out | Array of objects with timed out bids |
4040
| setTargeting | Targeting has been set | Hash of targeting values |
41-
| requestBids | Bids have been requested from adapters (i.e. pbjs.requestBids() was called) | None |
41+
| requestBids | Bids have been requested from adapters (i.e. pbjs.requestBids() was called) | The argument passed to [`requestBids`](https://docs.prebid.org/dev-docs/publisher-api-reference/requestBids.html), except that `adUnits` and `adUnitCodes` are always set and reflect the ad units involved in the auction. Event handlers may not modify `adUnitCodes`. |
4242
| addAdUnits | Ad units have been added to the auction | None |
4343
| adRenderFailed| Ad rendering failed | Object containing 'reason' and 'message' |
4444
| adRenderSucceeded | Ad rendering succeeded| Object containing 'doc', 'bid', and 'adId'. 'doc' is the DOM root containing the ad and may be `null` if it was rendered in a cross-origin iframe. This event indicates that the render function did not generate an error, it does not guarantee that tracking for this event has occurred yet.|

0 commit comments

Comments
 (0)