Skip to content

Latest commit

 

History

History
430 lines (319 loc) · 4.52 KB

ids-and-preferences.md

File metadata and controls

430 lines (319 loc) · 4.52 KB

Identifiers and preferences

A list of identifiers and some preferences

Property Type Description
preferences object

The current preferences of the user

Object details
Property Type Description
version string

A version number made of a "major" and a "minor" version numbers.

To be detailed.

Examples:

"0.1"
"0.407"
"10.0"
data object
Object details
Property Type Description
use_browsing_for_personalization boolean

Whether the user accepts (true) or not (false) that their browsing is used for personalization

source object

Signature based on input:

⚠️ Note that it uses data from identifiers:

preferences.source.timestamp + '\u2063' +
identifiers[type="prebid_id"].source.signature + '\u2063' +
preferences.data.key1 + '\u2063' + preferences.data[key1].value + '\u2063' +
preferences.data.key2 + '\u2063' + preferences.data[key2].value + '\u2063' +
...
preferences.data.keyN + '\u2063' + preferences.data[keyN].value
Object details
Property Type Description
timestamp integer

Time when data was signed

Example:

1643297316
domain string

The domain name of the entity that signed this data

Examples:

"a-domain-name.com"
"another.domain.co.uk"
signature string

The base64 representation of a data signature

Example:

"RYGHYsBUEwMgFgOJ9aUQl7ywl4xnqdmwWIgPbaIowbXbmZAFKLa7mcBJQuWh1wEskpu57SHn2mmCF6V5+cESgw=="
identifiers array

Type of each element in the array:

A pseudonymous identifier generated for a web user

Object details
Property Type Description
version string

A version number made of a "major" and a "minor" version numbers.

To be detailed.

Examples:

"0.1"
"0.407"
"10.0"
type enum (of string)

The identifier type, identifier of type paf_browser_id is mandatory and is "pivot"

Can only take one of these values:

  • "paf_browser_id"
persisted
(optional)
boolean

If set to false, means the identifier has not yet been persisted as a cookie.
Otherwise, means this identifier is persisted as a PAF cookie
(default value = true meaning if the property is omitted the identifier is persisted)

value string

The identifier value

Example:

"7435313e-caee-4889-8ad7-0acd0114ae3c"
source object

Signature based on input:

identifier.source.timestamp + '\u2063' + 
identifier.type + '\u2063'+
identifier.value
Object details
Property Type Description
timestamp integer

Time when data was signed

Example:

1643297316
domain string

The domain name of the entity that signed this data

Examples:

"a-domain-name.com"
"another.domain.co.uk"
signature string

The base64 representation of a data signature

Example:

"RYGHYsBUEwMgFgOJ9aUQl7ywl4xnqdmwWIgPbaIowbXbmZAFKLa7mcBJQuWh1wEskpu57SHn2mmCF6V5+cESgw=="