FraudSensor Parameters

FraudSensor’s detection tags collect signals based on the parameters included in each tag. The values from each parameter provide the data that HUMAN uses in its decisioning. The more values you pass through a tag, the more information HUMAN has to make those decisions.

Each tag is built by passing relevant parameter keys and values into the body of the tag. These values are often given in the form of macros (noted by a unique syntax using special characters) that automatically populate the relevant value for each instance of the tag.

Below you’ll find a list of the specific parameters that are used in FraudSensor’s detection tags, along with a description of each parameter. We’ve broken down this list into required, recommended, and optional tags. Certain parameters are only required for FraudSensor users who are also using MediaGuard and would like to close the loop between solutions.

Unless otherwise noted, all parameters are supported across all environments. 

Domain Intended

Required | Desktop traffic only

The domain where the event or impression will occur. This parameter includes the full top-level domain, but excludes the protocol and path.

Examples:

  • eff.org
  • m.wikipedia.org

App ID

Required | Mobile App and CTV traffic only

The app bundle in which the ad is run, as provided by the publisher. For in-app mobile and CTV traffic, the App ID value should match the App/Bundle ID (as outlined by IAB Tech Lab standards). This parameter is case-sensitive; do not alter the value by changing it to all lowercase or uppercase.

Examples:

  • iOS: 324715238
  • Android: com.example.Example
  • CTV: varies by device (e.g., Roku: 41468, Samsung: G15115002089, Vizio: vizio.tubitv)

Supplier ID

Required | All traffic types

The domain of the supplier of the traffic source. The value for this parameter should match the value in the first field of the ads.txt file. If you are using a supply-side platform (SSP), your platform may also be your supplier. 

Examples:

  • openx.com
  • adx.com
  • rubiconproject.com

Publisher ID

Required | All traffic types

The publisher of the traffic source. The value for this parameter must be consistent with the Publisher ID in OpenRTB and should match the value in the first field of the ads.txt file.. One or more Publisher IDs will map to a single Supplier ID.

Examples:

  • pub-4177862836555934
  • testpub123

Prediction Timeout

Required (MediaGuard only) | All traffic types

The state of a MediaGuard lookup request, corresponding to an integer between 0 and 4.

Possible values:

  • 0 - MediaGuard was not called
  • 1 - Response timeout
  • 2 - Error
  • 3 - Success
  • 4 - Other (client-specific performance condition)

Prediction ID

Required (MediaGuard only) | All traffic types

The value returned by a MediaGuard lookup request (lookupID key).

Example: defc04b9-6558-11e9-9196-1271b71e9caa


User ID

Recommended | All traffic types

A unique identifier for the user associated with the event. 

For in-app (mobile and CTV) traffic, provide the Device ID for the relevant device (e.g., IDFA for iOS, AAID for Android, RIDA for Roku, and so on). For web traffic, the value for this parameter should be a cookie or other unique identifier in your system.

To read more about IFA on OTT devices, consult IAB Tech Lab’s guide.

Examples:

  • Mobile: c3f927f4-3ef9-4b53-8887-d794c4daea82
  • CTV: 00000000-0000-0000-0000-000000000000
  • Web: d50dfe81909e606ac6a6801b14875058

Transaction ID

Recommended | All traffic types

The unique identifier generated for each event (also known as an impression). 

Example: 4d2ab6f3189e72166c3e8ca424aa1528


Media Type

Recommended | All traffic types

The media type of the inventory, corresponding to an integer between 1 and 4. For example, if your inventory is a video, your Media Type parameter should have a value of 2.

Possible values:

  • 1 - Banner (OpenRTB reference section 3.2.6)
  • 2 - Video (OpenRTB reference section 3.2.7)
  • 3 - Audio (OpenRTB reference section 3.2.8)
  • 4 - Native (OpenRTB reference section 3.2.9)

Note: These values (1, 2, 3, or 4) must be passed as strings and not as integers.

OpenRTB 2.5 Reference: sections 3.2.6-3.2.9, p.14-18


Device Type

Recommended | All traffic types

The device type where the inventory was run, corresponding to an integer between 1 and 7. For example, if your inventory was run on a tablet, your Device Type parameter should have a value of 5.

Possible values: 

  • 1 - Mobile/tablet
  • 2 - Desktop
  • 3 - Connected TV
  • 4 - Phone
  • 5 - Tablet
  • 6 - Connected device
  • 7 - Set-top box

Note: These values (1, 2, 3, 4, 5, 6, or 7) must be passed as strings and not as integers.

OpenRTB 2.5 Reference: Object: Device: devicetype (section 3.2.18, p.23)


Purchased Traffic

Whether an ad impression was received organically or purchased as part of a traffic arbitrage model.

Possible values:

  • 0 - Organic (not purchased)
  • 1 - Purchased 
  • null - Unknown 

Purchased Source

Recommended | All traffic types

The domain from which an ad's impression source was purchased (if Purchased Traffic = 1).

Examples:

  • facebook.com
  • google.com

Video/Audio Continuous Play

Recommended | All traffic types

Whether a video or audio ad is followed by another video or audio file that will automatically play (without user interaction) after the ad has ended.

Possible values:

  • 0 - No
  • 1 - Yes
  • null - Unknown

Video/Audio Auto-Play

Recommended | All traffic types

Whether a video or audio ad will play automatically (without user interaction).

Possible values:

  • 0 - No
  • 1 - Yes
  • null - Unknown 

Video/Audio Forced Duration

Recommended | All traffic types

The duration (in seconds) that a video or audio ad will play before the users are given the option to “skip” past it. 

If users are given the option to “skip” past the ad immediately after it begins, this parameter should have a value of 0.

Examples:

  • 0
  • 7.5
  • 30

Video/Audio Auto-Refresh

Recommended | All traffic types

The duration (in seconds) from the beginning of a video or audio ad (inclusive of its end time and any pause) at which the ad intends to refresh, providing the user with a subsequent advertisement. 

Examples:

  • 15
  • 24

Rendered Ad Type

Recommended | All traffic types

The type of ad rendered, corresponding to a value between 0 and 8.

Possible values:

  • 0 - Unknown 
  • 1 - Native/Display (rich media)
  • 2 - Native/Display (static)
  • 3 - Video/Audio (skippable in-stream ad)
  • 4 - Video/Audio (non-skippable in-stream ad) 
  • 5 - Video (video discovery ad)
  • 6 - Video (bumper ad)
  • 7 - Video (outstream ad)
  • 8 - Video (masthead ad)  

Campaign ID

Optional | All traffic types

A unique identifier for tracking your advertising campaign. 

Examples:

  • summersale20
  • bluthcampaign

Ad ID or Placement ID

Optional | All traffic types

A unique identifier for the digital ad. 

Note: Ad ID and Placement ID are interchangeable parameters tied to the same value; you may choose to use one or the other based on your needs, but using both parameters at once is not necessary.

Examples:

  • 4d2ab6f3189e72166c3e8ca424aa1528
  • 32928168991

Creative ID

Optional | All traffic types

A unique identifier for the ad creative (image, video, etc.) that is displayed to users.


Cache Buster

Optional | Desktop Mobile Web traffic only

A randomly-generated value that ensures each request URL is unique. These unique URLs will prompt users' devices to reload HUMAN's detection tag upon each new pageload rather than loading a cached version of the tag.

To use this feature properly, you must generate a new value and pass it through the Cache Buster parameter each time HUMAN's detection tag is loaded. FraudSensor does not automatically generate the required values.


Site ID

Optional | All traffic types

The site where your ad is displayed. This value may overlap with your Publisher ID; however, since this is a self-defined parameter rather than a globally-recognized identifier like the Publisher ID, you can use the Site ID for your own custom purposes.


Dimensions

Optional | All traffic types

The width and height of the ad creative, measured in pixels. This parameter is formatted as {width}x{height}.

Examples:

  • 300x500
  • 640x280

Buy Type

Optional | All traffic types

Whether the ad was purchased through programmatic buying or direct buying.

Possible values:

  • programmatic
  • direct

Note: These values must be passed as strings.


Geo

Optional | All traffic types

The two-letter ISO code of the country where the event originated.

Examples: 

  • US
  • GB
  • JP