Inventory Filters
Inventory filters are a crucial feature used in various settings across the platform. They are utilized in SSP and Endpoint settings to filter inventory, and in DSP and Profile settings as targeting tools. Additionally, there are Global Inventory Filters, which hold the highest priority and can be set once to apply across the entire platform. These filters include:
- Advanced Filters:
- Rewarded Only: Activate to process OpenRTB requests only with rewarded traffic. Rewarded traffic is identified based on the presence of certain values in the fields of the OpenRTB request. The OpenRTB request that will be sent to the DSP will contain all the indicated fields filled in.
- BidRequest.imp.rwdd = 1 (integer) /true (boolean): The attribute "rwdd": 1 or "rwdd": true in the Imp Object indicates whether the user receives a reward for viewing the ad, where 0/false means no reward, and 1/true means yes.
- BidRequest.imp.ext.placementType = “rewarded” [string]: The "placementType" extension in the Imp Object indicates that the ad placement is of the rewarded type.
- BidRequest.imp.ext.is_rewarded_inventory = 1 (integer) /true (boolean): The "is_rewarded_inventory" extension in the Imp Object, when set to 1/true, signifies that the inventory is rewarded.
- BidRequest.imp.ext.is_rewarded = 1 (integer) /true (boolean): The "is_rewarded" extension in the Imp Object, when set to 1/true, indicates that the ad is rewarded.
- BidRequest.imp.ext.rewarded = 1 (integer) /true (boolean): The "rewarded" extension in the Imp Object, when set to 1/true, suggests that the ad placement involves a reward.
- BidRequest.imp.ext.videotype = “rewarded” [string]: The "videotype" extension in the Imp Object, when set to “rewarded”, specifies that the video is of the rewarded type.
- BidRequest.imp.banner/video/native.ext.is_rewarded_inventory = 1 (integer) /true (boolean): The "is_rewarded_inventory" extension within the Banner, Video, or Native object, when set to 1/true, indicates rewarded inventory.
- BidRequest.imp.banner/video/native.ext.is_rewarded = 1 (integer) /true (boolean): The "is_rewarded" extension within the Banner, Video, or Native object, when set to 1/true, signifies that the ad is rewarded.
- BidRequest.imp.banner/video/native.ext.rewarded = 1 (integer) /true (boolean): The "rewarded" extension within the Banner, Video, or Native object, when set to 1/true, suggests that the ad placement involves a reward.
-
Full Chain Only: Activate to process OpenRTB requests with the complete supply chain. This indicates that the chain contains all nodes involved in the transaction leading back to the owner of the site, app or other medium of the inventory. The "complete" attribute in the Supply Chain object, when set to 1, indicates that the supply chain is complete, 0 = incomplete. A bid request with an incomplete supply chain will be flagged as fraudulent. We currently support the following Supply Chain parameter signals in a bid request:
- BidRequest.Source.schain.complete = 1 (integer): for OpenRTB 2.6 or later.
- BidRequest.source.ext.schain.complete = 1 (integer): for OpenRTB 2.5.
- BidRequest.ext.schain.complete = 1 (integer): for OpenRTB 2.4 or prior.
- Interstitial Only: Activate to process OpenRTB requests with the attribute "instl": 1 in the Imp Object; BidRequest.imp.instl = 1 (integer). A value of "1" indicates that the ad is interstitial or fullscreen, while "0" means the ad is not interstitial. Impressions within a bid request that do not meet this requirement will be marked as fraudulent.
- Only Skippable Video: Activate to process OpenRTB requests with the attribute "skip": 1 of the Video Object; BidRequest.imp.video.skip = 1 (integer). A value of "1" means that the video player allows video to be skipped, while "0" means it doesn't allow skipping. If the 'skip' attribute is absent or set to 0, the entire bid request will be filtered out. If a particular impression contains no Video object, it will be filtered, but the bid request will remain valid.
- Direct Dial1: By activating the toggle and entering comma-separated deal IDs in the corresponding field (Private Deal IDs, Public Deal IDs), you can target specific deals. When an Impression Opportunity (IO) comes in, the system checks these IDs to determine how to handle it. If the IO is marked for a private auction (has attribute "private_auction": 1 in the Pmp Object), the system follows these steps:
- Deal Object Presence: The system checks if the IO includes a deal object. If it doesn’t, the IO is filtered out as it has an invalid deal structure.
- Private Deal Settings: The system then checks if private deal settings are configured. If not, the IO is filtered out, assuming it’s meant for private auction only.
- Deal ID Match: The system looks for at least one matching Deal ID from the Private Deal IDs you provided. If no match is found, the IO is filtered out.
- Processing the Deal: If all checks pass, the IO is processed using the terms specified in the matching deal, such as bid floor, currency, and web domain.
- If the IO is marked for a public auction (has attribute "private_auction": 0 in the Pmp Object), the system follows these steps:
- Deal Object Presence: The system checks if the IO includes a deal object. If it doesn’t, the IO is processed using the standard flow.
- Non-private Deal Settings: The system then checks if non-private deal settings are configured. If not, the IO is processed using the standard flow.
- Deal ID Match: The system looks for at least one matching Deal ID from the Public Deal IDs you provided. If no match is found, the IO is processed using the standard flow.
- Processing the Deal: If all checks pass, the IO is processed using the terms specified in the matching deal.
- Handling Multiple Matches: The system works with the first matched deal. If two or more deals from the request match the provided IDs, the system will process only one, chosen randomly.
- API Framework: Process impression opportunities only with specific API frameworks supported by the placement, as defined in AdCOM 1.0). Supported frameworks include:
- VPAID 1.0
- VPAID 2.0
- MRAID 1.0
- ORMMA
- MRAID 2.0
- MRAID 3.0
- OMID 1.0
- SIMID 1.0
- SIMID 1.1
- Connection Type: Filter requests based on network connection type (as per AdCOM 1.0). The 'connectiontype' attribute value in the bid request (BidRequest.device.connectiontype) is compared with the allowed connection types configured in the UI. If the 'connectiontype' attribute value in the bid request is not among the allowed types, the entire request will be filtered. The available network connection types include:
- Ethernet
- Wi-Fi
- Cellular Network - Unknown Generation
- Cellular Network - 2G
- Cellular Network - 3G
- Cellular Network - 4G
- Cellular Network - 5G
- Device ID: Enter device IDs separated by commas and save them as either a Whitelist or Blacklist. Alternatively, utilize the Files functionality. Device ID (IFA) - an industry-compliant identifier for advertising. The values in the bid request (BidRequest.device.ifa) are compared with the list of blacklisted or whitelisted IDs. If the IFA is not found in the whitelist or is in the blacklist, the bid request will be filtered.
- Device Type: Select the device type. The value of the "devicetype" attribute in the bid request (BidRequest.device.devicetype) is compared with the list of allowed types. If the device type is not in the list, the entire request gets filtered. The available types of devices include:
- Mobile / Tablet - General
- Computer
- Tablet
- Mobile
- Connected TV
- Connected Device
- Set Top Box
- Out-of-home (OOH) device
- Domain or Bundle: Enter comma-separated domains or bundles as a Whitelist/Blacklist manually, or use the Files option for bulk upload. A domain can represent a website or an app, such as 'mysite.com'. In the context of OpenRTB bid requests, a 'bundle' attribute in the App Object is the store ID of the app in an app store. Refer to the OTT/CTV Store Assigned App Identification Guidelines for details on expected strings for CTV app stores. For mobile apps in the Google Play Store, use bundle or package names (e.g., 'com.foo.mygame'). For Apple App Store apps, use a numeric ID. Please note that the value is case-sensitive, meaning that uppercase and lowercase letters are treated as distinct characters. The values in the bid request (BidRequest.app.bundle, BidRequest.site.domain) are compared with the list of blacklisted or whitelisted domains/bundles. If the domain or bundle is not found in the whitelist or is in the blacklist, the bid request will be filtered.
-
Environment: Choose one or both options to show relevant ads. Options include:
- External Publisher ID: This refers to either BidRequest.app.publisher.id or BidRequest.site.publisher.id in an OpenRTB Bid request, depending on whether the request pertains to a web or in-app environment. Enter Publisher IDs separated by commas manually or use the Files. If the Publisher ID is in the blacklist or not in the whitelist, the bid request will be filtered. Please note that the value is case-sensitive, meaning that uppercase and lowercase letters are treated as distinct characters.
- Geo location: Select the country, region, or city. Save all the chosen items as a group for convenient reuse, and store them as either a whitelist or blacklist. The determined Geo location (Country, Region, City) of a bid request are then compared with the corresponding values in the user interface. If any match is found in the blacklist or if the location is not in the whitelist, the bid request will be filtered.
- Ad Type: Select one or more Ad Types to process only Impression Opportunities that include at least one of the selected types. If any of the selected ad types in the UI match those in the bid request (BidRequest.imp.banner, BidRequest.imp.video, BidRequest.imp.native, BidRequest.imp.audio), the request will be considered valid, and all Ad Type objects will proceed unchanged. If none of the selected Ad Types are found in the request, the bid request will be filtered out. This filtering does not alter the Ad Type data in the request and statistics. The available ad types are:
- Banner
- Native
- Audio
- Video
- Inventory Content Category: Choose one or more categories and save them as a Whitelist/Blacklist. Content categories, or taxonomy, aid in describing the content of website pages, ensuring the display of relevant ads. We check and match the categories in the bid request with those selected in the UI, following the listed order below. If category validation fails at any of these checking stages, the entire bid request will be filtered out. The order is as follows:
- BidRequest.site/app.cat: a "cat" attribute in the Site or App object.
- BidRequest.site/app.pagecat: a "pagecat" attribute in the Site or App object.
- BidRequest.site/app.sectioncat: a "sectioncat" attribute in the Site or App object.
- BidRequest.site/app.content.cat: a "cat" attribute in the Site.content or App.content field.
- IP: Enter a list of IP addresses as a Whitelist/Blacklist either manually, or using the Files option. IP addresses can be in either IPv4 or IPv6 format. Please note, that IP address ranges are not supported. The entered IP addresses will then be matched with those sent in the bid request (BidRequest.device.ip). If found in the blacklist or not in the whitelist, the entire request will be filtered out.
- Operating System: Adjust ad delivery on specific operating systems. If none of the selected OSs in the UI matches those in the bid request, it will be filtered out.
- Language: Select one or more languages to target the placement of your ads, aligning with the user's language settings and the language of the site. The language specified in the bid request is extracted from the following fields: BidRequest.device.language, BidRequest.device.langb, BidRequest.site.content.language and BidRequest.app.content.language. These values are then compared with the selected languages in the Language filter. If there is no match found, the entire request will be filtered out.
- Location Type: Source of location data for incoming requests. This works only for requests containing BidRequest.device.geo.type along with both latitude and longitude parameters. Requests missing these will be automatically filtered out. The available options include:
- GPS / Location Services: Location derived from GPS data.
- IP Address: Location based on the user’s IP address.
- User Provided: Location data supplied by the user, such as during registration.
-
Supply Chain Length4: Select a number from 1 to 10 to specify the supply chain node count.
- SSP/Endpoint Filter: This filter compares the number of nodes in the incoming request's supply chain. It is independent of the 'complete' parameter.
- DSP/Profile Targeting: This option compares the node count in the outgoing request's supply chain, including the platform's added node. It is also independent of the 'complete' parameter.
- Supply Chain Participant (ASI): Enter one or more ASIs, separated by commas, or use the Files option for bulk upload. The ASI values extracted from the bid request (BidRequest.source.schain, BidRequest.source.ext.schain, BidRequest.ext.schain) are compared against those listed in the blacklist. If any ASI is found in the blacklist, the corresponding bid request will be filtered out.
- Size2: Select one or more ad sizes to process impression opportunities with.
- Publisher Tag ID3: Enter case-sensitive Publisher tag IDs, separated by commas. These values are passed as an extension for Prebid and SDK connections. You can input them manually or via Files option.
- BidSwitch Targeting Groups5: Enter targeting group IDs, separated by commas. Only impression opportunities associated with these specific targeting groups will be processed. For more details, refer to the official BidSwitch Documentation.
1Available for Endpoint's Inventory Filters only.
2Available for Profile and Bid Floor targeting settings only.
3Available for Profile, Deal and Bid Floor targeting settings only.
3Available for Profile, Deal and Bid Floor targeting settings only.
4Available for SSP, Endpoint filters and DSP, Profile targeting settings only.
5Available for BidSwitch SSP, BidSwitch Endpoint, DSP and Profile targeting settings only.
Updated on December 27, 2024