RTB Query Parameters
This section of the documentation describes the specifics of server-to-server setup.
Use the RTB query parameter configuration reference for the Endpoint URL, available in your account dashboard (see the “Codes” tab in the Supply section) to:
– configure & integrate server-side advertising Demand Tags;
– generate Endpoint URLs for publisher integrations.
As you can see in the EndPoint URL template below, it includes the AdPlayer.Pro Ad Placement ID and other required parameters by default, whereas you can pass any additional parameters, according to the configuration reference (see below), using the same formatting.
Endpoint URL template:
https://bid.adplayer.pro/v1/rtb/xml/1?placementId=CHVYwGxCCX4v&mimes=MIMES&page=PAGE&gdpr=GDPR
Note! The server-to-server integration will override all AdPlayer.Pro video player settings, configured for the Ad Placement.
RTB Query Parameter Configuration Reference
| Name | Query Parameter | OpenRTB Parameter | Description |
| Placement ID | placementId= | – | Required. Passes the AdPlayer.Pro Ad Placement ID. |
| Page | page= | site.page | Required. Passes a publisher’s website page. Example: |
| MIMES | mimes= | imp.video.mimes | Required. Passes the mime type support info. Examples: |
| GDPR | gdpr= | regs.ext.gdpr | Required for the EU traffic.
Indicates an End User is from the EU, hence the GDPR regulation applies. Possible values: If empty, a callee should do geo IP lookup, since GDPR applies for the EU IP addresses. |
| Consent | gdpr_consent= | user.ext.consent | Required for the EU traffic.
Passes a consent string, e.g. IAB’s TCF 2.0* from various Consent Management Platforms (CMP’s). *May also accept numeric values for a CTV consent. |
| US Privacy | us_privacy= | regs.ext.us_privacy | Required for the US traffic.
Passes consent info for users from the US, primarily from California. Possible values: |
| COPPA | coppa= | regs.coppa | Required for the US traffic.
Passes info regarding the traffic that is subject to the Children’s Online Privacy Protection Act of the United States. Possible values: |
| Width | w= | imp.video.w | Passes the video player width in pixels.
Example: 300 |
| Height | h= | imp.video.h | Passes the video player height in pixels.
Example: 250 |
| Domain | domain= | site.domain OR app.domain |
Passes a webpage/app domain.
Example: |
| Latitude | lat= | device.geo.lat | Passes End User’s device latitude. |
| Longitude | lon= | device.geo.lon | Passes End User’s device longitude. |
| Extended IDs | eids= | – | Passes third-party identity provider data. |
| Device Maker | device_make= | device.make | Passes device maker info. |
| Device Model | device_model | device.model | Passes device model info. |
| ISP | isp= | device.carrier | Passes device carrier details. |
| Inventory Partner Domain | inv_partner_domain= | app.ext.inventorypartnerdomain OR site.ext.inventorypartnerdomain |
Passes partner domain info for cases, when a website or an app contains ad inventory that is owned by another partner. |
| IAB Category | ic= | site.cat OR app.cat |
Passes the IAB website/app category. |
| Minimum Duration | min_dur= | imp.video.minduration | Passes minimum ad duration in seconds. |
| Maximum Duration | max_dur= | imp.video.maxduration | Passes maximum ad duration in seconds. |
| Ad Position | ad_pos= | imp.video.pos | Passes the ad position info. Possible values: 0 – Unknown 1 – Above the Fold 2 – Locked (i.e. fixed position) 3 – Below the Fold 4 – Header 5 – Footer 6 – Sidebar 7 – Fullscreen For more info, please refer to the OpenRTB 2.6 documentation. |
| Placement | placement= | imp.video.placement | Passes the video ad placement info. Possible values: 1 – In-stream video ad placement 2 – In-banner ad placement 3 – In-article ad placement 4 – In-feed video ad placement 5 – Interstitial / Slider / Floating ad Example: 1 For more info, please refer to the OpenRTB 2.6 documentation. |
| Skippable | skip= | imp.video.skip | Passes info on whether the player enables an ad to be skipped. Possible values: 0 – Non-skippable ad 1 – Skippable ad Example: 1 For more info, please refer to the OpenRTB 2.6 documentation. |
| Production Quality | prodq= | app.content.prodq OR site.content.prodq |
Passes the content production quality info. Possible values: 0 – Unknown 1 – Professionally Produced 2 – Prosumer 3 – User-generated (UGC) For more info, please refer to the OpenRTB 2.6 documentation. |
| Protocols | protocols= | imp.video.protocols | Passes the ad protocol info.
For more info, please refer to the OpenRTB 2.6 documentation. |
| Playback Method | playbackmethod= | imp.video.playbackmethod | Passes the video playback method.
For more info, please refer to the OpenRTB 2.6 documentation. |
| API | api= | imp.video.api | Passes the video API info. |
| Plcmt | plcmt= | imp.video.plcmt | Passes the video ad placement details.
Possible values: Example: 1 For more info, please refer to the OpenRTB 2.6 documentation. |
| Start Delay | startdelay= | imp.video.startdelay | Passes the ad delay start info. |
| Delivery | delivery= | imp.video.delivery | Passes the video ad delivery info. |
| Skip After | skipafter= | imp.video.skipafter | Passes the info regarding the time in seconds, after which the ad can be skipped. |
| DNT | dnt= | device.dnt | Passes the “Do not track” info.
Possible values: 0 or 1, where dnt=1 essentially means an opt-out of targeted advertisements. |
| GPP String | gpp= | regs.ext.gpp | Passes the IAB Tech Lab GPP info. |
| GPP ID | gpp_sid= | regs.ext.gpp_sid | Passes the IAB Tech Lab GPP Section ID. |
| App Bundle | app_bundle= | app.bundle | Passes app bundle info. |
| App Name | app_name= | app.name | Passes app name info. |
| App Store URL | app_store_url= | app.storeurl | Passes an app store URL for the app. |
| Device ID | did= | device.ifa | Passes End User’s device ID. |
| Payment chain ID | payid= | source.pchain | Passes the payment chain ID. |
| SCHAIN | schain= | source.ext.schain | Passes the SupplyChain object info.
Example: exampleexchange.com,123%2CB,1,,, For more information, please refer to the IAB documentation. |
| Publisher ID | publisher_id= | site.publisher.id | Passes a publisher’s ID. |
| Content ID | content_id= | app.content.id OR site.content.id |
Passes a unique ID identifying the content (see “Content” object attributes in the OpenRTB 2.6 documentation). |
| Content Episode | content_episode= | app.content.episode OR site.content.episode |
Passes a content episode number (see OpenRTB 2.6 documentation). |
| Content Title | content_title= | app.content.title OR site.content.title |
Passes a content title (see OpenRTB 2.6 documentation). |
| Content Series | content_series= | app.content.series OR site.content.series |
Passes the content series info (see OpenRTB 2.6 documentation). |
| Content Season | content_season= | app.content.season OR site.content.season |
Passes the content season (see OpenRTB 2.6 documentation). |
| Content Genre | content_genre= | app.content.genre OR site.content.genre |
Passes the content genre (see OpenRTB 2.6 documentation). |
| Content Producer Name | content_producer_name= | app.content.producer.name OR site.content.producer.name |
Passes the content producer name (see OpenRTB 2.6 documentation). |
| Content Livestream | content_livestream= | app.content.livestream OR site.content.livestream |
Passes details on whether the content is being streamed live or not.
Possible values: For more info, please refer to OpenRTB 2.6 documentation. |
| Content Categories | content_categories= | content.cat | Passes an array of IAB Content categories that describe the content (see OpenRTB 2.6 documentation). |
| Content Keywords | content_keywords= | content.keywords | Passes a list of keywords (comma separated) describing the content (see OpenRTB 2.6 documentation). |
| Content Language | language= | app.content.language OR site.content.language |
Passes the content language using ISO-639-1-alpha-2 (see OpenRTB 2.6 documentation). |
| OMID Partner Name | omidpn= | source.ext.omidpn | Passes the identifier of the OM SDK integration. This is the same as the “name” parameter of the OMID Partner object.
Note! The presence of both omidpn= and omidpv= in the Tag will also inject the video.api field of the outbound bid requests. |
| OMID Partner Version | omidpv= | source.ext.omidpv | Optional. Passes the version of the OM SDK. This is the same as the “versionString” parameter of the OMID Partner object. |
| Debug | debug= | – | Optional. Extra dev-oriented parameter, specifically designed for troubleshooting purposes. Possible values: 1 – debug parameter is applied. Note! NOT recommended for using in Prod environments due to excessive server load risks. |