AdSpirit will provide an endpoint URL in order to connect to the AdServer. This URL usually look like
http://clientname.adspirit.de/rtb/getbid.php?...
The url can use the following parameters. Most parameters are optional:
|
Parameter |
Description |
|
&wsid= (sometimes &pid= or &pnm= are used) |
Integer. AdSpirits internal ID for this connection |
|
&rtbprovider= or &rtb= |
String. Description of the protocol used. For OpenRTB use “openrtb” as value |
|
&useprenca= or &upa= |
String. Description of which price encoding macro AdSpirit shall output with the code. (Value "&upa=-x-" can be used as a synonym for &useprenca=${AUCTION_PRICE} |
|
&useprencmode= or &upm= |
Char. Description of which price encryption mode is used by AdSpirit. |
|
&dataid= |
Integer. AdSpirits internal ID for the user-syncing database. |
|
&asm= |
Integer. AdSpirits internal ID for this client. This parameter is mandatory if you bidder is not able to send HTTP Host-Header. |
|
&outputfilter= or &opf= |
String. Description if the output generated by AdSpirit should be transformed in a certain way. |
|
&oneline=1 |
Integer. If present, indicates that the output code shall be in one single code-line. |
|
&ignoremime=1 or &igm=1 |
Integer. If present, indicates that AdSpirit shall ignore the mime-header send via OpenRTB blocklist. |
|
&ignorebytpe=1 or &igb=1 |
Integer. If present, indicates that AdSpirit shall ignore the btype-header send via OpenRTB blocklist. |
|
&ignorebattr=1 or &iga=1 |
Integer. If present, indicates that AdSpirit shall ignore the battr-header send via OpenRTB blocklist. |
|
&admnoenc=1 |
Integer. If present, indicates that the “adm” output will NOT be urlencoded. |
|
&usenurl=1 |
Integer. If present, AdSpirit will send bid responses with a fully valid and functional “nurl” property. The URL provided with this property must then be used in order to receive the html-markup. If present, AdSpirit will not send the “adm” property. |
|
&setseatid |
String. If present, AdSpirit will set this value as “seat” object in bid response. |
|
&noext=1 |
Integer. If present, AdSpirit will not send “ext” objects in bid response. |
|
&nonurl=1 or &nnu=1 |
Integer. If present, AdSpirit will not send “nurl” property in bid response. |
|
&nocid=1 |
Integer. If present, AdSpirit will not send “cid” properties in bid response. |
|
&nocrid=1 |
Integer. If present, AdSpirit will not send crid |
|
&allowzerobid=1 |
Integer. If present, AdSpirit will respond with HTML-codes ("adm") even in case the bid is 0.00 (Zero). |
| &add_adv=1 | Integer. If present, AdSpirit will add a property ext -> advertiser with the Advertisername in it. |
|
&add_advname=1 |
Integer. If present, AdSpirit will add a property ext -> advertiser_name with the Advertisername in it. |
| &add_avn=1 | Integer. If present, AdSpirit will add a property ext -> avn with the Advertisername in it. |
|
&add_agencyname=1 |
Integer. If present, AdSpirit will add a property ext -> agency_name with the Agencyname in it. |
|
&add_agn=1 |
Integer. If present, AdSpirit will add a property ext -> agn with the Agencyname in it. |
| &add_landing=1 | Integer. If present, AdSpirit will add a property ext -> landigpage with the creative landing page in it. |