Deals API V2 Targeting

This section describes the objects that can be used by both Suppliers and Buyers to describe the inventory they wish to associate with a deal when negotiating. Each of these objects should be used within their parent objects described in the relevant V2 Deals Sync API for Buyers or V2 Deals Sync API for Suppliers

Deals Audio Object

Audio Fields

Field	Type	Description
duration	float	The audio ad duration in seconds, for example, 15
duration_match	int	Indicates whether the creative duration must match the required duration, the possible values are: 1 The creative duration needs to be the same as the required duration 2 The creative duration may be the same as or less than required duration
skippable	bool	Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes, 2 = either.

{
  "audio":{
    "duration":1.25,
    "duration_match":1,
    "skippable":0
  }
}

Deals Display Object

Display Fields

Field	Type	Description
sizes	array of objects	Passes an array of objects specifying the accepted sizes in device independent pixels (DIPS) using height and width.

{
  "sizes":[
    {
      "w":100,
      "h":100
    },
    {
      "w":320,
      "h":70
    }
  ]
}

Deals Video Object

Video Fields

Field	Type	Description
duration	float	The video ad duration in seconds, for example, 15
duration_match	int	Indicates whether the creative duration must match the required duration, the possible values are: 1 The creative duration needs to be the same as the required duration 2 The creative duration may be the same as or less than required duration
skippable	bool	Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes, 2 = either.

{
  "video":{
    "duration":1.25,
    "duration_match":1,
    "skippable":0
  }
}

Deals Targeting Object

The targeting options let you include and/or exclude a set of criteria by including an array of objects with the targetings and how they are to be used.

Targeting Options

Field	Type	Description
type	string	This specifies whether the fields detailed in the values field should be included or excluded when used for targeting, takes two possible values "include" or "exclude"
values	array of objects	An array of targeting settings made from the possible targeting values.

Targeting Values

Field	Type	Description
device	object	Device object with details about the device to which the impression will be delivered, for more information, see the Device Object section.
inventory_type	array of strings	Indicates the inventory type of the deal, can be one or more of the following values: dooh, display, or video, e.g. ["dooh", "video"]
site	object	The Site object describing the site on which the ads will be show, see the Site Object section.
app	object	The app object describing the site on which the ads will be show, see the App Object section.

Device Object

Geo Fields

Field	Type	Description
geo	object	Indicates where the ad will be shown.
type	integer	Device type as defined by OpenRTB, for example, 4 1 Mobile/Tablet - General 2 Personal Computer 3 Connected TV 4 Phone 5 Tablet 6 Connected Device 7 Set Top Box

Geo Object

Geo Object Properties

Value	Type	Description
country	string	Country using ISO-3166-1 Alpha-3, for example, NLD
region	string	Region using ISO-3166-2 region codes, for example, NY

{
  "targeting":[
    {
      "device":{
        "type":{
          "type":"exclude",
          "values":[
            1,
            2,
            3
          ],
          "geo":{
            "type":"include",
            "values":[
              {
                "country":"DEU",
                "region":"NRW"
              },
              {
                "country":"USA",
                "region":"NY"
              }
            ]
          }
        }
      }
    }
  ]
}

Site Object

Site Object Properties

Value	Type	Description
domain	array of strings	Indicates the sites on which the deal will run.

{
  "targeting":[
    {
      "site":{
        "domain":{
          "type":"include",
          "values":[
            "example.com",
            "example2.com"
          ]
        }
      }
    }
  ]
}

App Object

Site Object Properties

Value	Type	Description
bundle	array of strings	Indicates the apps on which the deal will run using their bundle IDs.

{
  "targeting":[
    {
      "app":{
        "bundle":{
          "type":"include",
          "values":[
            "com.netflix",
            "198476220"
          ]
        }
      }
    }
  ]
}

Targeting Examples

Site and Geo

Geo targeting California and Nevada for certain sites on Mobile and Desktop

{
  "targeting": {
    "device": {
      "geo": {
        "type": "include",
        "values": [
          {
            "country": "US",
            "region": "CA"
          },
          {
            "country": "US",
            "region": "NV"
          }
        ]
      },
      "type": {
        "type": "include",
        "values": [
          1,
          2
        ]
      }
    },
    "inventory_type": [
      "site"
    ],
    "site": {
      "domain": {
        "type": "exclude",
        "values": [
          "my.site.com",
          "example.com"
        ]
      }
    }
  }
}

Device, App, and Geo

Targeting the Netflix app playing on TV devices in Washington

{
  "targeting": {
    "device": {
      "geo": {
        "type": "include",
        "values": [
          {
            "country": "US",
            "region": "WA"
          }
        ]
      },
      "type": {
        "type": "include",
        "values": [
          3
        ]
      }
    },
    "inventory_type": [
      "app"
    ],
    "app": {
      "bundle": {
        "type": "include",
        "values": [
          "com.netflix"
        ]
      }
    }
  }
}