Demand
The “Demand” section functionality enables you to do the following:
- Add, switch on/off and delete Demand Tags
- Browse and edit basic Demand Tag settings
- Apply advanced Demand Tag settings, using macros.
- Track Demand Tag performance within the past 24 hours.
Let’s dive in into each in more details.
Create a New Demand Tag
To create a new Demand Tag:
1. Select an advertiser from the list on the left.
2. Click a blue “+” button.
3. Configure Demand Tag settings (see Demand Tag Configuration Reference).
4. Finish adding the Demand Tag by clicking “Create.”
Note! Read more about Demand creation from local video files in a separate section below.
Create a Demand Tag from Uploaded Video File
To create a Demand Tag from an uploaded video file:
1. Select an advertiser, then click a blue “+” button.
2. In the Demand Tag settings: select type “Video File.”
3. Click “Upload file.”
NB! Upload limits: only MP4 format, maximum size: 300MB, minimum width 240px.
4. Configure a landing page URL and event tracking URLs:
- “Impression” > filled ad impressions
- “Start” > ad starts
- “First quartile” > ads played to first quartile (25%)
- “Midpoint” > played to midpoint (50%)
- “Third quartile” > ads played to third quartile (75%)
- “Complete” > ads played to completion (100%)
- “Click tracking” > tracked clicks
Optional. Use the Skip button w/ delay, sec parameter to configure the Skip button display on the hosted video ad and its delay in seconds.
5. Click “Generate” to generate an editable VAST XML file for the Demand Tag.
6. Optional. Edit any VAST XML parameter/s, if needed.
7. Configure other Demand Tag parameters.
8. Click “Create.”
Demand Tag Configuration Reference
The AdPlayer.Pro demand tag configuration reference enlists the following options for demand tag setup (see screenshot):
Optional.No-fill opportunities frequency cappingLimits the maximum number of sequential no-fill opportunities for the Demand Tag – within a particular timeframe.
Enter the values in the following format: number of sequential no-fill opportunities/number of hours.
number/number
| Parameter | Description | Value |
| Name | Demand Tag name. | string |
| Type | Configures Demand Tag type:
Select one of the options from the drop-down menu. *Tip! The YouTube video ID includes 11 characters and is located after the / in the YouTube video URL (i.e. https://youtu.be/thisisaVdID). |
URL/ Header Bidding/ Video File/ XML/ YouTube/ oRTB |
| oRTB Parameters: | ||
| endpointUrl | Configures the endpoint URL. | string |
| Click “+oRTB Parameter” to configure one or more of the additional oRTB Parameters (see below) for the oRTB Demand Tag, when needed. | ||
| bidfloor | Optional. Configures the price floor for the bid. |
number |
| uid | Optional. Configures the user ID in the ad system. |
string |
| buyer_id | Optional. Configures the Buyer’s ID. |
string |
| Note! The macro values for parameters “Demand Tag ID”, “Height”, “Width”, “Referer” and “Referer page”, i.e. $$Demand_ID$$, $$HEIGHT, $$WIDTH$$, $$REFERER$$ and $$REFERER_PAGE$$ are assigned automatically by the player, hence you do NOT need to set them manually. | ||
| Client | Configures the ad format:
Select one of the options from the drop-down menu. |
VAST/Google IMA |
| URL | For URL Demand Tags: Enter the URL to xml, js file with all ad parameters. |
string (URL) |
| Header Bidding | For Header Bidding Demand Tags:
(1) Select a Prebid Partner and configure parameters using the setup constructor.* *Click “⊰” to configure additional optional parameters for the particular Prebid Partner. For more info on the parameters setup, please refer to the relevant Prebid Partner’s documentation:
OR (2) Click “Custom JSON” to enter JSON with all ad parameters.** **Click “Prettify” to format the JSON, if needed. |
string (JSON) |
| Performance-based Waterfall:*
*Contact your dedicated account manager to switch on the Performance-based Waterfall features. |
||
| Minimum CPM URL | ONLY applied for Performance-based Waterfall.
Configures the minimum CPMs for the Demand Tag URL and other specific URLs, competing in the waterfall, if specified. Note! Use this parameter in case the Advertiser doesn’t support macros for passing minimum CPM data in the Performance-based Waterfall (i.e. $$MIN_CPM$$ and $$MIN_CPM_IMA$$). Tip! Add multiple URLs with relevant minimum CPMs for one Advertiser’s Demand Tag if you wish to have them compete for ad display in the ad waterfall. |
string
number |
| CPM: | Configures the estimated CPM* value for a Demand Tag.
*Used for calculating the estimated revenue, displayed in Demand statistics reports. Note! The Demand Tag CPM settings are automatically shared to all Assigned Supply (i.e. override the Ad Placement CPM value, if configured) Important! If the “Force CPM” feature in the Supply settings is ON, the Demand Tag CPM will be overridden. |
– |
| Global | Configures the default global CPM value** for a Demand Tag for all countries (in US Dollars), other than those, for which the country-specific CPM value is configured.
Note! Adding the “Global CPM” value is preferable. |
number |
| By Country | Configures the CPM value for a Demand Tag for a specific country**.
Tip! Add manually or leave blank to apply the global CPM value instead. |
number |
| **Split by Platform | Optional.
Enables configuring the CPM value (Global and/or by Country) for a Demand Tag – separately, for Desktop and Mobile, if needed. Click “≺” and add the two values manually. Default value: OFF Note! If ON, both the Desktop and Mobile CPM values is preferable. |
true/false
If true: |
| Include countries | Optional.
Specifies countries for Demand Tag display. Add country codes, separated by comma with space, or leave blank. NB! If parameter settings for Demand Tag and Assigned Supply are different – none of the settings will be applied. |
string |
| Exclude countries | Optional.
Specifies countries, excluded from Demand Tag display. Add country codes, separated by comma with space, or leave blank. NB! If parameter settings for Demand Tag and Assigned Supply are different – all settings will be applied. |
string |
| Include domains | Optional.
Specifies domains for Demand Tag display. Enter domains, separated by comma with space, or leave blank. Tip! Enter BOTH *.example.com & example.com to include both the main domain and all its sub-domains. |
string |
| Exclude domains | Optional.
Specifies domains, excluded from Demand Tag display. Enter domains, separated by comma with space, or leave blank. Tip! Enter BOTH *.example.com & example.com to exclude both the main domain and all its sub-domains. |
string |
| Request capping | Configures the maximum number of ad requests for the Demand Tag within 24 hours. | number |
| Request capping per minute | Configures the maximum number of ad requests for the Demand Tag per 1 minute. | number |
| Overall impression limit | Configures the total maximum number of ad impressions for the Demand Tag.
*Tip! You can also configure Overall impression limit at the Advertiser level, if needed. |
number |
| Impressions capping | Configures the maximum number of ad impressions for the Demand Tag* for all users within 24 hours.
NB! The Demand Tag impression capping settings are automatically shared to all Assigned Supply. *Tip! You can also configure impressions capping at the Advertiser level, if needed. |
number |
| Frequency capping | Configures the maximum number of Demand Tag display within a defined time frame for 1 unique user.
Enter the values in the following format: number of shows/number of hours. NB! The Demand Tag frequency capping settings are automatically shared to all Assigned Supply. |
number/number |
| Disable rotation | Configures disabling rotation for Demand Tag.
Default value: false (i.e. Demand Tag rotation enabled). |
true/false |
| Disable replay | Configures disabling replay for Demand Tag.
Default value: false (i.e. Demand Tag replay enabled). |
true/false |
| Display once per cycle | Configures display limitations for Demand Tag.
Check the box to display only once per player lifecycle. |
true/false |
| “Learn more” button | Optional.
Check the box to display the custom “Learn more” button onhover ad content in the player, then configure its parameters (see “Learn more” text and “Learn more” link below). NB! The “Learn more” button will show, if the player displays a plain VAST ad unit, i.e. without extra ad setup layers included (e.g. added ad wrapper, etc.) |
true/false |
| “Learn more” text | Configures the text, displayed on the “Learn more” button.
NB! The maximum length of the button text is 50 characters. |
string |
| “Learn more” link | Configures the URL, which opens upon the “Learn more” button click. | string |
| Ad Schedule | Optional.
Configures the specific time frame, i.e. Start and End date & time, for Demand Tag display. Note! The operating time is UTC (cannot be changed). |
yy-mm-dd hh:mm // yy-mm-dd hh:mm |
Edit Demand Tag Settings
To edit Demand Tag settings:
1. Select an advertiser from the list on the left.
2. Click the Demand Tag to browse its current settings in the main window area.
3. Click “Edit” to edit the Demand Tag settings.
4. Click “Update” to apply changes.
Tip! Go to “Assigned Supply” tab to browse Assigned Supply details, if any.
Create a Demand Tag Copy
You can create similar Demand Tags for one advertiser, by creating a Demand Tag copy.
To create a Demand Tag copy:
1. Select an advertiser from the list on the left.
2. Click the advertiser’s Demand Tag.
3. Click “Copy” in the “Settings” tab.
Note! The option is NOT available for the “Video file” type of Demand Tags.
Demand Tag Examples
AdPlayer.Pro enables you to utilize a variety of Demand Tag examples – for testing purposes.
Please see the table below for more details.
| Demand Type | Demand Tag Example | Notes |
| VAST |
https://static.adplayer.pro/vast/demo.xml |
Select the “URL” Demand Tag type and “VAST” client in the Demand Tag configuration settings. |
| Google IMA |
https://pubads.g.doubleclick.net/gampad/ads?sz=640x480&iu=/124319096/external/ad_rule_samples&ciu_szs=300x250&ad_rule=1&impl=s&gdfp_req=1&env=vp&output=vmap&unviewed_position_start=1&cust_params=deployment%3Ddevsite%26sample_ar%3Dpreonly&cmsid=496&vid=short_onecue&correlator |
Select the “URL” Demand Tag type and “Google IMA” client in the Demand Tag configuration settings |
| Prebid |
{"biddersSpec":{"code":"video1","bids":[{"params":{"cid":"8CUX0H51C","crid":"776755783"},"bidder":"medianet"}]},"prebidConfigOptions":{"cache":{"url":"https://prebid.adnxs.com/pbc/v1/cache"}},"prebidPath":"https://static.adplayer.pro/player/pb/for-prod-8.30.0.js"}
|
Select the “Header Bidding” Demand Tag type in the configuration settings.
Our use of Cross Player Prebid Component also enables configuring custom params, if needed. The sample Demand Tag may not work in some geographical regions. |
| XML |
<VAST version="3.0"><Ad><InLine><AdSystem>GDFP</AdSystem><AdTitle>Demo</AdTitle><Description><![CDATA[Demo]]></Description><Creatives><Creative><Linear><Duration>00:00:11</Duration><VideoClicks><ClickThrough><![CDATA[../]]></ClickThrough></VideoClicks><MediaFiles><MediaFile delivery="progressive" width="640" height="360" type="video/mp4" scalable="true" maintainAspectRatio="true"><![CDATA[https://static.adplayer.pro/video/640.mp4]]></MediaFile></MediaFiles></Linear></Creative></Creatives></InLine></Ad></VAST> |
Select the “XML” Demand Tag type in the Demand Tag configuration settings. |
| YouTube | The YouTube video ID you need to enter includes 11 characters and is located after the / in the YouTube video URL (i.e. https://youtu.be/thisisaVdID). | Select the “YouTube” Demand Tag type in the Demand Tag configuration settings. |
AdPlayer.Pro Macros
| Macros | Description | Value |
| $$WIDTH$$ | Returns the player width, in pixels. | number |
| $$HEIGHT$$ | Returns the player height, in pixels. | number |
| $$REFERER$$ | Returns the webpage data, where the ad is served.
Example: domain.com/page |
string |
| $$REFERER_DOMAIN$$ | Returns the domain’s hostname, where the ad is served. | string |
| $$CLIENT_USER_AGENT$$ | Returns the сlient’s user agent data (navigator.userAgent). | string |
| $$RANDOM$$ | Returns a random numeric string. Example:correlator:0.34637356383 |
number |
| $$RANDOM_10$$ | Returns a random 10-digit integer. Example:correlator:4345645667 |
number |
| $$PUB_ID$$ | Returns the publisher’s website ID.* | string |
| $$PLACEMENT_ID$$ | Returns the ad placement ID. | string |
| $$MIN_CPM$$ | Returns the minimum CPM required for non-IMA ad display in a Performance-based Waterfall. | number |
| $$MIN_CPM_IMA$$ | Returns the minimum CPM required for IMA ad display in a Performance-based Waterfall. | number |
| $$TIMESTAMP$$ | Returns the current time, in milliseconds.* | number |
| $$REMOTE_IP$$ | Returns the client’s IP address data.* | string |
| $$REMOTE_COUNTRY$$ | Returns the client’s country code.*
Example: ES |
string |
| $$REMOTE_COUNTRY_NAME$$ | Returns the client’s country name in full.*
Example: Spain |
string |
*ONLY applied for Placement code and/or VAST code (see Ad Placement Codes).
Pass-through Macros
| Macros | Description | Value |
| $$LAT$$ | Passes user’s location latitude (also applicable for “appLat” parameter, specified in JS code). | number |
| $$LON$$ | Passes user’s location longitude (also applicable for “appLon” parameter, specified in JS code). | number |
| $$APP_BUNDLE$$ | Passes mobile app bundle name (“appBundle” parameter value, specified in JS code). | string |
| $$DNT$$ | Passes true/false value for “Do Not Track” parameter (“dnt” parameter value, specified in JS code). | 0/1 |
| $$APP_NAME$$ | Passes mobile app name (“appName” parameter value, specified in JS code). | string |
| $$APP_STORE_URL$$ | Passes link to mobile app page on the app store (“appStoreUrl” parameter value, specified in JS code). | URL |
| $$APP_VERSION$$ | Passes mobile app version (“appVersion” parameter value, specified in JS code). | string |
| $$DEVICE_ID$$ | Passes mobile device ID (“deviceId” parameter value, specified in JS code). | string |
| $$DEVICE_MAKE$$ | Passes mobile device manufacturer name (“deviceMake” parameter value, specified in JS code). | string |
| $$GDPR$$ | Passes an identifier 0 (no/-) or 1 (yes), if GDPR is required.
Used in tandem with the $$GDPR_CONSENT$$ macro. Note! You MUST implement IAB’s GDPR Transparency & Consent Framework for this to work. |
string |
| $$GDPR_CONSENT$$ | Passes a GDPR consent string, if GDPR is required (defined by $$GDPR$$ macro).
If GDPR is NOT required, $$GDPR_CONSENT$$ will be replaced by an empty string. Note! You MUST implement IAB’s GDPR Transparency & Consent Framework for this to work. |
string |
| $$CCPA$$ | Passes the US Privacy String.
Note! You MUST implement IAB’s CCPA Compliance Framework for this to work. |
string |
| $$C_PARAM_NAME$$ | Passes the custom parameter (“paramName” parameter value, specified in JS code).
Examples: |
string |