Skip to main content

User

Information known or derived about the human user of the device (the audience for advertising). The user ID is an exchange artifact and may be subject to rotation or other privacy policies. The user ID must be stable long enough to serve as the basis for frequency capping and retargeting.

idstringrequired

Publisher specific ID for the user.

Example: C785902B8150944B
data object[]

Optional. Array of Data objects for custom audience targeting. Use the data and segment objects together to define targeting criteria such as demographics and behaviour to target different audience sets.

When present, FCC serves only demand that targets those key-values. Publish segment names and values in FCC Ads Manager before sending them in requests.

  • Array [
  • namestringrequired

    Pass user_targeting in this field for custom targeting.

    Example: user_targeting
    segment object[]required

    Array of targeting segments. Each segment is a name and value pair. FCC applies OR logic to multiple values within the same segment and AND logic across different segment keys. Publish segment names and value options in FCC Ads Manager before sending them in requests.

  • Array [
  • namestringrequired

    Name of the data segment you configured in FCC Ads Manager.

    Example: key-id-1
    valuestringrequired

    One or more values for this segment key as a comma separated string.

    Example: value-id-11,value-id-12
  • ]
  • ]
  • geo object

    Optional. Geographical information about the user, if available.

    zipstring

    Zip or postal code of the user.

    Example: 110001
    ext object

    Optional. Extension to the User object for supplying additional info such as consent.

    consentboolean

    If true, FCC applies user targeting. If false, FCC does not apply user targeting for this request.

    Default value: true
    User
    {
    "id": "C785902B8150944B",
    "data": [
    {
    "name": "user_targeting",
    "segment": [
    {
    "name": "key-id-1",
    "value": "value-id-11,value-id-12"
    }
    ]
    }
    ],
    "geo": {
    "zip": "110001"
    },
    "ext": {
    "consent": true
    }
    }