Partner JS Inclusions and Parameters

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

The following tables include JavaScript codes for partners and parameters initialized through PubMatic Wrapper for the following partners:

  • PubMatic (automatically added)
  • AdForm
  • AOL

  • AppNexus
  • bRealtime
  • DistrictM
  • Index
  • PulsePoint
  • Rubicon
  • Sovrn

PubMatic

Property
Value
Mandatory
Explanation
Input Source
Key Namepub_idYPubMatic publisher IDPublisher Provided
Key NameskY

PubMatic server key flag indicating that slot mapping is at Ad Server Side.

Slot name would be generated based on KGP macro and sent as is to PubMatic.

Hardcoded to 'true'

 

AdForm

PropertyValueMandatoryExplanationInput SourceWrapper Parameter
End-pointDefault value is adx.adform.netNAdForm end-point domainPublisherAdForm Domain - While Adding Partner
Key NamemidYMaster Tag Id for AdFormPublisher ProvidedMaster Tag Id
Key NameinvNInventory CodePublisher ProvidedInventory Code
Key NameminipNHard Floor (Will be passed as is no currency conversion)Publisher ProvidedFloor

 

Response Mapping

PubMatic WrapperPartner Response KeyConversionExplanation
pwtecpwinbidN/ABid value (USD), Note: the response can be in different currency, which needds to be adjusted in Bid Adjustment.

 

Note: If the partner responds with currency in their header bidding response, be sure to clarify which currency they will respond with for your specific setup. Enter a suitable value in the Bid Adjustment field to account for currency conversion so that all responses can be compared in USD.

Please note that wrapper solution does not carry out any further currency conversions, and only takes bid adjustment field into account for these adjustments.

  

Sample Wrapper Mapping CSV

Master Tag IdInventory CodeFloor
1234567100.10

 

 

AOL

Property
Value
Mandatory
Explanation
Input Source
Wrapper Parameter
Partner Endpoint${'protocol'}://${'server'}/pubapi/3.0/${'network'}/${'placement'}
/${'pageid'}/${'sizeid'}/ADTECH;v=2;cmd=bid;cors=yes;
alias=${'alias'}${'bidfloor'};misc=${'misc'}
N/AThis is hardcoded in the codeN/AN/A
Key NamenetworkYAOL publisher IDPublisher ProvidedNetwork ID - While adding partner
Key NameserverYAOL server for endpointPublisher ProvidedServer Domain - While adding partner
Key NameplacementYAOL Identifier Ad TagPublisher ProvidedPlacement - In Mapping CSV
Key NamealiasNPublisher ProvidedPlacement Alias - In Mapping CSV
Key NamesizeIdNPublisher ProvidedSize Id - In Mapping CSV
Key NamebidFloorNPublisher ProvidedBid Floor - In Mapping CSV
Key NamepageIdNPublisher ProvidedPage Id - In Mapping CSV

 

Response Mapping

PubMatic Wrapper
Partner response key
Conversion
Explanation
pwtecp

response.seatbid[0].bid[0].ext.encp


OR


response.seatbid[0].bid[0].price

No

Bid value (USD)

pwtdeal

response.seatbid[0].bid[0].dealid

 

Note: If the partner responds with currency in their header bidding response, be sure to clarify which currency they will respond with for your specific setup. Enter a suitable value in the Bid Adjustment field to account for currency conversion so that all responses can be compared in USD.

Wrapper solution does not carry out any further currency conversions, and only takes bid adjustment field into account for these adjustments.

        

 
Sample Wrapper Mapping CSV

Page IdPlacementBid FloorPlacement AliasSize Id
13650220.2Banner_ATF3

 

AppNexus

Property
Value
Mandatory
Explanation
Input Source
Wrapper Parameter
Partner JS LibraryThe code is from PrebidN/AJS library URL is not required as the code for calling Appnexus Endpoint (http://ib.adnxs.com/jpt)Prebid CodeN/A
Key NameplacementIdYAppNexus adunit identifierPublisher ProvidedPlacement ID - In Mapping CSV
Key NamememberNMember ID for AppNexus, to be used in conjunction with invCodePublisher ProvidedMember ID - In Mapping CSV
Key NameinvCodeNInventory code from AppNexus to be used in conjunction with memberPublisher ProvidedInv Code - In Mapping CSV
Key NamequeryN

Optional Query Parameter.

Note: This is not currently supported as it will be depreciated soon by AppNexus (mentioned in Prebid Code)

Publisher ProvidedQuery - In Mapping CSV

 

Note: If the partner responds with currency in their header bidding response, be sure to clarify which currency they will respond with for your specific setup. Enter a suitable value in the Bid Adjustment field to account for currency conversion so that all responses can be compared in USD.

Wrapper solution does not carry out any further currency conversions, and only takes bid adjustment field into account for these adjustments.

           

Response Mapping

PubMatic Wrapper
Partner response key
Conversion
Explanation
pwtecpresult.cpmresult.cpm/10,000

Bid value (USD)

pwtdidresult.deal_idN/A

Deal ID

 

Sample Wrapper Mapping CSV

Placement IdMember IdInv CodeQuery
123456

 

bRealtime

Property
Value
Mandatory
Explanation
Input Source
Wrapper Parameter
Partner JS LibraryThe code is from PreBidN/AJS library URL is not required as the code for calling bRealtime Endpoint (http://ib.adnxs.com/jpt)Prebid CodeN/A
Key NameplacementIdYbRealtime adunit identifierPublisher ProvidedPlacement ID - In Mapping CSV
Key NamememberNMember ID for bRealtime, to be used in conjunction with invCodePublisher ProvidedMember ID - In Mapping CSV
Key NameinvcodeNInventory code from bRealtime to be used in conjunction with memberPublisher ProvidedInv Code - In Mapping CSV
Key NamequeryN

Optional Query Parameter.

Note: This is not currently supported as it will be depreciated soon by bRealtime (mentioned in Prebid Code)

Publisher ProvidedQuery - In Mapping CSV

Note: If the partner responds with currency in their header bidding response, be sure to clarify which currency they will respond with for your specific setup. Enter a suitable value in the Bid Adjustment field to account for currency conversion so that all responses can be compared in USD.

Wrapper solution does not carry out any further currency conversions, and only takes bid adjustment field into account for these adjustments.

          

Response Mapping

PubMatic Wrapper
Partner response key
Conversion
Explanation
pwtecpwinbidN/A

Bid value (USD)

Note: the response can be in different currency which needs to be adjusted in Bid Adjustment

  
pwtdidresult.deal_idN/A

Deal ID

 
Sample Wrapper Mapping CSV

Placement IDMember IDInv CodeQuery
123456

District M

Property
Value
Mandatory
Explanation
Input Source
Wrapper Parameter
Partner JS LibraryThe code is from PreBidN/AJS library URL is not required as the code for calling District M Endpoint (http://ib.adnxs.com/jpt)Prebid CodeN/A
Key NameplacementIdYDistrict M adunit identifierPublisher ProvidedPlacement ID - In Mapping CSV
Key NamememberNMember ID for District M, to be used in conjunction with invCodePublisher ProvidedMember ID - In Mapping CSV
Key NameinvcodeNInventory code from District M to be used in conjunction with memberPublisher ProvidedInv Code - In Mapping CSV
Key NamequeryN

Optional Query Parameter.

Note: This is not currently supported as it will be depreciated soon by District M (mentioned in Prebid Code)

Publisher ProvidedQuery - In Mapping CSV

Note: If the partner responds with currency in their header bidding response, be sure to clarify which currency they will respond with for your specific setup. Enter a suitable value in the Bid Adjustment field to account for currency conversion so that all responses can be compared in USD.

Wrapper solution does not carry out any further currency conversions, and only takes bid adjustment field into account for these adjustments.

           

Response Mapping

PubMatic Wrapper
Partner response key
Conversion
Explanation
pwtecpwinbidN/A

Bid value (USD)

Note: the response can be in different currency which needs to be adjusted in Bid Adjustment

  
pwtdidresult.deal_idN/A

Deal ID

 
Sample Wrapper Mapping CSV

Placement IDMember IDInv CodeQuery
123456

 

Index Exchange

Property
Value
Mandatory
Explanation
Input Source
Wrapper Parameter
End-point//as-sec.casalemedia.com/headertag?v=9&x3=1&fn=cygnus_index_parse_resN/AOpenRTB end-pointThis is fixedN/A
Key NamesiteIDYThe site ID STRINGPublisher ProvidedSite Id
Key NameidYIdentifier for SlotPublisher ProvidedSlot Id
Key Nametier2SiteIDNtier-2 SiteID STRINGPublisher ProvidedTier Two Site Id
Key Nametier3SiteIDNtier-3 SiteID STRINGPublisher ProvidedTier Three Site Id

 

Note: If the partner responds with currency in their header bidding response, be sure to clarify which currency they will respond with for your specific setup. Enter a suitable value in the Bid Adjustment field to account for currency conversion so that all responses can be compared in USD.

Wrapper solution does not carry out any further currency conversions, and only takes bid adjustment field into account for these adjustments.

           

Response Mapping

               

PubMatic Wrapper
Partner response key
Conversion
Explanation
pwtecpseatbid.bid[N].ext.pricelevelcent to Dollar

Bid value (USD)

Note: the response can be in different currency which needs to be adjusted in Bid Adjustment

           

 

Note: If the partner responds with currency in their header bidding response, be sure to clarify which currency they will respond with for your specific setup. Enter a suitable value in the Bid Adjustment field to account for currency conversion so that all responses can be compared in USD.

Wrapper solution does not carry out any further currency conversions, and only takes bid adjustment field into account for these adjustments.

 

Sample Wrapper Mapping CSV

       

site IdTier Two Site IdTier Three Site IdSlot Id
171681164110716411081357

 

PulsePoint

Property
Value
Mandatory
Explanation
Input Source
Wrapper Parameter
Partner Endpointhttp://bid.contextweb.com/header/tagYThis is hardcoded in the codeN/AN/A
Key NamecpYPulsePoint publisher IDPublisher ProvidedPublisher ID - In Mapping CSV
Key NamectYPulsePoint Identifier Ad TagPublisher ProvidedAd Tag ID - In Mapping CSV

Note: If the partner responds with currency in their header bidding response, be sure to clarify which currency they will respond with for your specific setup. Enter a suitable value in the Bid Adjustment field to account for currency conversion so that all responses can be compared in USD.

Wrapper solution does not carry out any further currency conversions, and only takes bid adjustment field into account for these adjustments.

        

Response Mapping

PubMatic Wrapper
Partner response key
Conversion
Explanation
pwtecpbidCpmNo

Bid value (USD)

 
Sample Wrapper Mapping CSV

Ad Tag Id
43245

 

Sovrn

Property
Value
Mandatory
Explanation
Input Source
Wrapper Parameter
Partner Endpoint//ap.lijit.com/rtb/bidN/AThis is hardcoded in the codeN/AN/A
Key NametagidYSovrn Ad Tag IdPublisher ProvidedTag ID - In Mapping CSV
Key NamebidfloorNFloor to be passed for the slot/ad-unitPublisher ProvidedBid Floor - In Mapping CSV

Note: If the partner responds with currency in their header bidding response, be sure to clarify which currency they will respond with for your specific setup. Enter a suitable value in the Bid Adjustment field to account for currency conversion so that all responses can be compared in USD.

Wrapper solution does not carry out any further currency conversions, and only takes bid adjustment field into account for these adjustments.

        

Response Mapping

PubMatic Wrapper
Partner response key
Conversion
Explanation
pwtecpsearbid.bid[i].priceN/A

Bid value (USD)

 
Sample Wrapper Mapping CSV

Placement IDBid Floor
1234561.20

Attachments

    Outcomes