Win-Loss Notification

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Jun 7, 2017
Version 4Show Document
  • View in full screen mode

Note: This document supports a set of APIs for older integrations.

If opted, DSP will receive win-loss reason of any of its recent bids in RTB bid request itself in post data. The post data will contain an object “wli” having following parameters.

Parameter
Mandatory
Multi-Valued
Description
rId
No
No
Unique request ID generated by PubMatic which is used to map the Bid-Request and Bid-Response. This will help to correlate the Bid-Notification with the specific Bid-Response. Limited to 40 bytes.
For example: 993DCB9F-9203-488C-818A-79FF231C921B
bCur
No
No
Currency of the winning bid value (wBid).
wBid
No
No
Bid (First Price) that won the auction.
Note: This value is always sent whether the DSP has won or lost the auction.
Csa
No
No
A value indicating whether a publisher is running an auction in their system for the given impression or not.  Possible values are:
  • 0 - The publisher is not running an auction for the impression.
  • 1 - The publisher is running an auction for the impression.
Note: Its default value is 0.
bId
No
No
Bid-ID string generated by the DSP and received in the bid response.
Note:
* The maximum length of this parameter’s value is 128 bytes.
* In case of a timeout, this parameter’s value will be empty.
st
No
No
Number denoting the status of the bid as follows.
  • 0 - The bid has won the auction.

    All the values other than zero denote that the bid has lost the auction and this value denotes the reason for the loss. For example,
  • 1 - Timeout on bid response,
  • 2 - Incomplete response, and so on.
The complete list of reasons why a bid will lose is given in the Win/Loss Notification Status table in the Reference section.
Note: Notifications will not be sent for zero price bids.

Note: Win loss notification is also supported for multi-bid.

 

Example for Win Notification:

 

A) In case of single bid

 

{
  ...
  "wli": {
    "rId": "371D32A4-F165-46DF-8845-20671EF134D0",
    "bCur": "JPY",
    "wBid": 20,
    "csa": 0,
    "bInfo": [
      { "bId": "abc123", "st": 0 }
    ]
  }
  ...
}

 

B) In case of multi-bid

{
  ...
  "wli": {
    "rId": "371D32A4-F165-46DF-8845-20671EF134D0",
    "bCur": "JPY",
    "wBid": 20,
    "csa": 1,
    "bInfo": [
      { "bId": "abc123", "st": 0 },
      { "bId": "abc123", "st": 5 },
      { "bId": "abc123", "st": 4 }
      ]
    }
  ...
}

Attachments

    Outcomes