Page tree



Before using PubMatic APIs, first generate the API Token. For more information, refer to  Getting Started with PubMatic APIs .

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

PubMatic maintains its own list of buyer ids as well as DSP specific Buyer ID list as well.  It also does mapping between PubMatic’s buyer ID and DSPs specific Buyer ID.


There are two scenarios for buyer ID mapping:

  1. DSP wants to use their Buyer ID: In this scenario, PubMatic gets DSP specific buyer ID as mentioned above.
  2. If DSP doesn’t want to share their Buyer ID, then PubMatic asks DSP to use PubMatic’s Buyer ID. In this case, the DSP will have to maintain mapping between their Buyer ID and PubMatic Buyer ID. However, PubMatic will maintain its own Buyer ID list as DSP specific Buyer ID list.


Example:

  1. PubMatic’s buyer ID list contains two entries:
                     

    Buyer IDBuyer Name
    1Agency 1
    2Agency 2
  2. Now, DSP 1 is willing to share their Buyer ID list with us:
                     

    Buyer IDBuyer Name
    11Agency 1
    12Agency 2
  3. PubMatic will maintain mapping as following:
                           

    Buyer IDBuyer NameDSPDSP Buyer ID
    1Agency 1DSP 111
    2Agency 2DSP 112
  4. Now, DSP 2 is not willing to share their Buyer ID list with us. They expect PubMatic to send PubMatic’s Buyer ID. In this case, we will map PubMatic’s Buyer ID as DSPs Buyer ID:
                           

    Buyer IDBuyer NameDSPDSP Buyer ID
    1Agency 1DSP 21
    2Agency 2DSP 22

By doing so, DSP2 will receive PubMatic’s buyer ID and DSP 1 will receive DSP 1’s Buyer ID.

This approach is simplest and will maintain consistency. However, we will have to ensure that mappings are entered and updated for DSPs.

Request

                                 

PropertyMandatoryMulti ValuedDescription
idYesNoDeal Identifier.
buyerIdNoNoThis parameter has now been deprecated and will be eventually phased out.
auctionIdYesNo

Auction type. Possible values are:

  • 1 - First price auction, that is, the bid’s eCPM will be used in the auction irrespective of the deal’s eCPM if the bid’s eCPM >= deal’s eCPM and if it wins, bid’s eCPM will be considered for the revenue calculation.
  • 2 - Second price auction, that is, the bid’s eCPM will be used in the auction irrespective of the deal’s eCPM and if it wins, the second price computation will be performed for the revenue calculation.
  • 3 - Fixed price auction, that is, the deal’s eCPM will be used in the auction if the bid’s eCPM >= deal’s eCPM and if it wins, the deal’s eCPM will be considered for the revenue calculation.

 
floorYesNoMinimum value expected by publisher for this deal.

Response

               

PropertyMandatoryMulti ValuedDescription
dealIdNoNoIf the bid is intended to be a Private Marketplace bid, then the Demand Partner must pass back the appropriate Deal ID for the Demand Partner’s bid. If the bid was not sent for any particular Private Marketplace, then the Deal ID parameter must not be returned. If the bid comes back with a dealId that is not valid then, that bid will be considered for general auction.

⇧ Top