The following describes how to create a Cedato HTML Player Supply item.
The procedure for creating a VAST and a CedatoX Supply item type is very similar and is also described below. The differences are indicated in each relevant section below.
To create a Supply item –
1. In the left pane, select SUPPLY ➔ MANAGE SUPPLY to display a list of previously defined Supply items.
2. Click the Create New button. A page of settings is displayed –
To access all the settings, simply scroll down the page or click on one of the options in the menu in the middle pane, such as RESTRICTIONS.
Fill out the different sections of this page in order to define the Supply.
Mandatory fields appear with an asterisk (*).
3. Click Save to create a Supply.
Note – When an HTML Player Supply item is created, Cedato automatically creates an HTML tag for it. This tag should be placed on the Publisher’s website. Refer to Creating a Cedato Tag for more information.
Settings – HTML Player or VAST
Define the Settings (shown above), as follows –
Supply Name* – Specify any free text unique name for this Supply item.
Supply Type – Select the type of Supply, which can be one of the following HTML Player (default), VAST, or CedatoX.
After a Supply has been saved, its Supply Type cannot be changed.
Each Supply Type provides slightly different configuration options in this page according to the functionality of the Supply item type. All of these are described below.
- HTML Player – The Cedato player. See a Defining an HTML Player Supply.
- VAST – A VAST Supply enables you to define a tag that has Demand items assigned to it to be played in other players (Cedato player/other). When the VAST receives a request from a 3rd party player, it uses the Cedato algorithm to decide which Demand (video ad) will play. See a Defining a VAST Supply.
- CedatoX – CedatoX provides a simple and smart way for two Cedato's partners to connect. It enables Cedato customers to expand their monetization options. See a Defining a CedatoX Supply.
Active – By default, a Supply is active, meaning that it is available for use. Making a Supply item inactive, does not block incoming requests. Therefore, you are expected to handle the removal of the player code as well.
Limited Assignment –The purpose of this feature is to have more control over sensitive supply items. By turning on the “Limited Assignment” toggle, the supply item will not be available for selection within the demand item’s edit page. Once the “Allow to assign Limited Assignment Supply” toggle is set to “On”:
The 'Limited Assignment Supply' items will become available for selection. Note:
- Once the supply item is set to Limited Assignment, it will be marked with an exclamation mark(!) on the top left side.
- The toggle is always set to “off” by default.
Environment* – In order to specify the environments of the Opportunities received through the Supply items, select one or two of the relevant buttons – Desktop , Mobile App , Mobile Web or CTV
Supply Partner – Enter a free-text name of the Cedato Supply partner or select from the dropdown menu, as follows –
- CedatoX Supply – Enter the partner ID. The Supply Partner Name is then automatically set according to the network name in the system.
– OR –
- VAST/HTML Player – From the dropdown menu, select one of the previously selected Supply Partner Names. You may also create a new one.
Note – You can select the name of a Supply Partner from the dropdown menu when the Supply item belongs to an existing Supply partner in order to ensure consistency in reports.
Floor CPM Price – Specify the minimum CPM that a Demand must have in order to receive requests to be played in this Supply item.
Supply Cost Type* – From the dropdown menu, select how the Supply source gets paid. Each option provides different fields to be filled in –
- Revshare – In the Revshare (%) field, specify the percentage of the income to be paid to the supply source. For example, entering 70% means that the supply source gets 70% of the revenue of this supply.
- Fixed CPM per Opportunities – In the CPM field, specify the amount of money to be paid to the Supply source per 1000 opportunities.
- Fixed CPM per Impressions – In the CPM field, specify the amount of money to be paid to the Supply source per 1000 impressions, meaning the payment is per 1000 played video ads on this Supply item.
- None – Indicates that the cost has not been set by you yet.
Allow Sound – Enables the option to play sound in an HTML player where permitted.
Auto Play – Starts the video automatically. This option is only relevant for an HTML Player Supply Type item. When this option is selected, it is recommended that the Allow Sound option be turned off.
Control Bar – Displays a control bar on top of the player. This option is only relevant for an HTML Player Supply Type item.
Rotation – Enables the player to play more than a single ad during each opportunity. For example, selecting the number 3 means that the player can play up to 4 ads. This option is only relevant for an HTML Player Supply Type item.
Settings – Supply CedatoX
Supply Cost Type* – For a CedatoX Supply item type only two options can be selected Revshare (which is described above) and Fixed CPM, as described below –
- Fixed CPM which specifies the amount of money to be paid to the Supply partner per 1000 impressions.
Partner Network ID – This option is only relevant for CedatoX Supply item types and is mandatory. A CedatoX Supply item type represents a connection between two Cedato partners, meaning two networks. In this field, the Demand-side CedatoX partner (who generated the CedatoX Supply) must specify the Cedato Network ID of the Supply-side CedatoX partner. The Supply-side CedatoX partner then sees this connection as an inactive Demand item in his/her Demand items list. This Demand item appears with the same name as the name specified by the connection creator.
Your Cedato partner must give you their Network ID for you to enter here. The Network ID can be seen at the top of the Network Settings page.
After you enter the partners Network ID, a verification message will appear, click Yes to approve.
In the Assigned Demand section, define the Demand items that are assigned to this Supply.
If no Demand items have been created yet, then go to Step 3, Creating Demand Items, and then come back to this step. Meanwhile, you can continue defining the Supply item(s).
Under the assigned Demand item –
- For CedatoX type Supply items only VAST,RTB,Prebid type Demand items appear.
- For HTML Player and VAST type Supply items, all Demand item types appear.
In the Content section, define the video content to be played when the player is visible. Content can be added to an HTML Player type Supply item. These options enable you to control the ad insertion timing. Adding content to the Player is not mandatory, meaning that you can use the player to show ads only.
- Poster Image – Specify the URL of an image to be displayed instead of a black screen while the video content/video ad is loading.
- Content Video – Specify the URL(s) of one or more MP4 videos. Each URL should appear in a different line by pressing the Enter key.
- Shuffle Video Playlist – Activate this option to randomly shuffle the list of videos in the Content Video field above.
- Content Click URL – To make the content clickable (so that it refers to a different URL), specify the URL to which to link if the viewer clicks on the Content Video.
- Loop Content – Plays the content video in a loop. This option is intended for players whose primary purpose is to play content.
- Show control bar on content playback only – This option is available only if the Control Bar under the Settings section is turned off. Selecting this option only shows the control bar when the Content Video is playing.
Note – Additional CDN charges will be applied if the content will be played on mobile devices, even if the file is hosted outside Cedato.
- Add Content Description – Specify the description to be applied to all content in the two fields above. To add a description, click the title. Three description fields are then displayed –
- Video Description – This is an optional field. Enter up to 100 characters. The Video Description is applied to all content videos. Even if multiple videos are listed in the Content Video field, this description applies to all of them. This information will be passed inside the correlating macros.
- Video Keyword – Enter up to 50 characters. Separate the keywords by a comma (,).
- Video Title – Enter up to 50 characters.
- Play Ad – Specify when the ad is played relative to the timing of the content. The following options are provided. Different fields appear for you to fill in for each option –
As Soon As Available – Once an ad is ready to play, the video content will be paused and the ad is played. Once the Ad has finished playing, the video content resumes. This mode is the default and should be used when the main objective of the player is to play ads. In the event that the Rotation setting is on, multiple ads can play one after another.
Pre Roll – Video content is not played until after the ad has finished playing. In the Ad Max Loading Time field, specify the maximum number of seconds to wait for an ad to load. If it doesn’t load within that time period, then it loses its turn. In case no ad has started by the defined Ad max loading time, the Content Video starts playing immediately. If the Poster image option is selected, then it is shown until either the video ad or Content Video starts. This option is useful for capturing the user’s attention while waiting for the content to load.
Mid Roll – The ad is played in the midst of the content. The Content Video plays until the ad is ready to play according to the Mid roll time interval. The video content is paused until the ad finishes playing. This is useful when playing long content, and using breaks for monetization. Make sure that the times you define are appropriate for the length of the video content. If the ad does not start by the defined Allowed delay for playing the Ad, then no ad is played for the specified amount of time and the content continues playing. First Ad Will Play After – The number of seconds after which a chance is given for the first ad to start playing.
Note ‒ If the Rotation setting is sent to None, it means that only a single ad can be played.
Post Roll – The ad plays after the Content Video finishes playing. Keep in mind that if Loop content is on, video ads are not shown.
Targeting – CedatoX
For a CedatoX Supply item type, an additional Targeting section appears, as shown below –
It enables you to specify the type of traffic that can send you requests to show ads, as follows –
- Country– Requests to show ads to traffic in these countries can be sent to you (select Include) or not (select Exclude) to traffic originating from these countries (you may drill down to DMA and state).
- Browser – Requests to show ads to traffic in these browsers, with the version(s) selected here.
- Operating System – Ads are only shown or not shown to traffic run from devices with these operating systems, with the version(s) selected here.
- Player Size – Enables you to target the size of the players. See Player Size Targeting.
In the Restrictions section –
- VAST Requests Limit – Use the VAST Requests Limit slider to set the ad request rate – between 1 and 5. Use the VAST Requests Limit By Scale (slider) to set the ad request rate – between 1 and 5. If you choose Min, then Cedato only sends a minimal amount of ad requests to each Demand item. If you choose Max, then Cedato sends as many ad requests as required to fill the Opportunity. Use the VAST Requests Limit By Value in order to specify the maximum amount of Ad requests sent to each demand item. The same setting exists on the Demand side. If the setting of the assigned Demand is different, then the actual VAST Requests Limit will be the lower of the two.
- Maximum Ad Requests per Opportunity – Specify the upper limit of the number of requests to be sent to the Demand per opportunity (meaning each time the player opens).
- Exclude VAST Vendors Domains – Enables to specify to which Demand Vendors the Supply won't send any requests. turn the toggle on and enter the correlated domain.
Restrictions Lists for IPs/Domains/App Bundles and Names
The additional option to include or exclude requests from specific Domains/App Names/App Bundles (whitelists/blacklists) is provided when you define a CedatoX or VAST Supply Type item. IP blacklists can also be created.
This option enables you to select a previously defined list or to define a new list.
Lists can be created to include or exclude domains, app names or app bundles. Other lists can be created to exclude IP addresses. See MORE ➔ MANAGE LISTS for more information.
In the Select List Type dropdown menu, select the None, Whitelist or Blacklist option. Only one or the other option can be selected – not both. A list of previously defined whitelists or blacklists appears in the dropdown menu (accordingly). Alternatively, you can click the new list option to define a new whitelist or blacklist. After you save a whitelist or blacklist, it appears in the edit page (immediately).
Receive traffic from Supply type (CedatoX)
An additional option appears for CedatoX Supply item types, which enables you to determine the type of Supply item from which you want to receive traffic.
For example, if you would only want to receive traffic from a Cedato Player, then only leave the HTML Player option selected. By default, both options are selected – HTML Player and VAST.
A Callback URL enables you to configure the destination to which events associated with this Supply item are reported, such as your system or a 3rd-party system.
To define a Callback –
1. In the Callbacks section, click + Add Callback.
2. Enter the Callback URL.
3. This Callback URL is comprised of corresponding parameters and macros. These macros must be replaced with the corresponding Cedato macros.
To display the list of available macros, click VIEW AVAILABLE MACROS. The following displays –
From this list, copy and replace the relevant macros into the URL.
Note – The DEMAND_ID and RPM macros are only relevant for Demand related events, such as Ad Start, Ad Complete, Ad Click and IVT Detection.
4. From the dropdown menu, select the event that fires the Callback so that when the event occurs, the associated system receives the relevant data –
Player Ready- Indicates the player was Loaded
Ad Start – Indicates an impression
Ad Complete- Indicates an ad was fully played
Ad Click – Indicates that the viewer has clicked the ad.
5. You can define additional Callbacks by clicking the +Add Callback option again, each to be triggered by a different event. Up to two Callbacks can be defined for each event type –
The following describes the Tags section for an HTML Player and VAST.
Tags (HTML Player)
A Tag is a self-optimizing intelligent code snippet that can be seamlessly used in the web page or app of any ad platform, exchange or direct publisher. The following describes how to customize this Tag.
To define a Tag –
1. In the Tags section, in the Tag Type dropdown menu select the type of code snippet to be created according to the player to be used.
2. The Supply Platform dropdown menu only appears if the Basic Player option is selected in the Tag Type dropdown menu (described above). Cedato provides as the relevant macros for each Supply platform. From the Supply Platform dropdown menu, select the platform so that the proper macros are used in the automatically generated Tag. After it is selected, the relevant macros are used in the Tag.
3. In the Size field, select one of the provided sizes (in pixels) for the player or define a custom size by specifying its height and width.
Each Publisher allocates a certain size in their web page/app for the player. The Size that you specify in this field determines the size of the player that will run inside that allocated space.
4. In the SubID field, you can specify a unique identifier for the subject matter to be included in reports.
If you leave Sub ID as EXTRACTED_DOMAIN (the default setting), the Sub ID is automatically populated with the Domain URL value.
5. The Secure field should be On (the default) when the player will be played on a secure page.
6. The Passback option (On) enables you to pass the opportunity to a different Ad server after a Set Timeout (described below) if no ad is playing. The player itself is stopped and removed.
When Passback – Set to On:
HTML Code – In the large text field, enter the Tag of the Passback code.
Set Timeout – Set the amount of time that Cedato waits for the ad to start before closing the player and passing the opportunity to an alternative ad server.
7. In the Network Domain Name dropdown menu, select the domain from which the Cedato player is served. Cedato provides every client with an exclusive domain.
8. You can click the Advanced Options field, to display additional options that you can configure for each Supply Type. This option is not relevant for the Basic player.
Tags (VAST Player)
The settings here are described in the Tags (HTML Player) section, except that there are less settings here.
An additional field named Supply Platform appears when you define a VAST Supply type Item. Five options are provided to specify on which type of player the VAST will play, as follows – Cedato, Google Ad Manager,JW Player, Sitescout or Peak226.
Supply Item’s Unique ID
A Supply item has a unique identifier number that can be seen at the top of the page next to its name, as shown below.