Skip to content

Commit 16a4bfa

Browse files
authored
pub API: added requestBids.auctionId (prebid#1225)
1 parent 05871b9 commit 16a4bfa

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

dev-docs/publisher-api-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -565,6 +565,7 @@ Request bids. When `adUnits` or `adUnitCodes` are not specified, request bids fo
565565
| requestObj.timeout | Optional | `Integer` | Timeout for requesting the bids specified in milliseconds |
566566
| requestObj.bidsBackHandler | Optional | `function` | Callback to execute when all the bid responses are back or the timeout hits. Callback will be passed two parameters, the bids themselves and `timedOut`, which will be true if any bidders timed out. |
567567
| requestObj.labels | Optional | `Array of strings` | Defines [labels](#labels) that may be matched on ad unit targeting conditions. |
568+
| requestObj.auctionId | Optional | `String` | Defines an auction ID to be used rather than having the system generate one. This can be useful if there are multiple wrappers on a page and a single auction ID is desired to tie them together in analytics. |
568569

569570
<hr class="full-rule">
570571

0 commit comments

Comments
 (0)