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. 

Required parameters
Required parameters (MediaGuard only)
Optional parameters

Domain intended

Required | Desktop traffic only

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

Examples:

  • eff.org
  • m.wikipedia.org

User ID

Required | 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

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 value for this parameter should be 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 be the same as 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 should be consistent with the Publisher ID in OpenRTB and should be the same as the second field in ads.tx. One or more Publisher IDs will map to a single Supplier ID.

Examples:

  • pub-4177862836555934
  • testpub123

Transaction ID

Required | All traffic types

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

Example: 4d2ab6f3189e72166c3e8ca424aa1528


Prediction timeout

Required (MediaGuard only) | All traffic types

An integer between 0 and 4. This value represents a corresponding MediaGuard lookup, as shown below.

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


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 (iPhone X, iPad)
  • 2 - Desktop (Windows 10, MacOS Mojave)
  • 3 - Connected TV (Samsung, Sony, Vizio)
  • 4 - Phone (iPhone X, Nexus 5)
  • 5 - Tablet (iPad, Galaxy Tab)
  • 6 - Connected Device (Roku, Apple TV, Fire TV, Xbox, PlayStation)
  • 7 - Set-Top Box (Canoe, Comcast, Broadcom)

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)


Dimensions

Recommended | 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

Ad ID or Placement ID

Recommended | All traffic types

The unique identifier for the digital advertisement. 

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

Buy type

Recommended | 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

Recommended | All traffic types

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

Examples: 

  • US
  • GB
  • JP

Campaign ID

Optional | All traffic types

A unique identifier for tracking your advertising campaign. 


Creative ID

Optional | All traffic types

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