Overview

Platform targeting allows you to target video campaigns based on the device platform, operating system, browser, and connection type.

The `restrictions` object

The restrictions object contains an array of targeting rules that define which platforms your video campaign will target or exclude.

A sample object

{
  "restrictions": [
    {
      "type": "INCLUDE",
      "value": ["DESKTOP", "MOBILE"],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "OS"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "BROWSER"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "CONNECTION_TYPE"
    }
  ]
}

`type`

Possible values:

`type`	Description
`"INCLUDE"`	Target only the specified platforms
`"EXCLUDE"`	Block the specified platforms
`"ALL"`	No restrictions (target all platforms)

`value`

An array of platform values, operating system names, browser types, or connection types that correspond to the restriction_name. The array can contain multiple values for broader targeting or a single value for precise targeting.

`restriction_name`

Possible values:


`PLATFORM`	Target specific device platforms (desktop, mobile, tablet).
`OS`	Target specific operating systems (Windows, macOS, iOS, Android, Linux).
`BROWSER`	Target specific web browsers (Chrome, Safari, Firefox, Edge, IE).
`CONNECTION_TYPE`	Target based on internet connection type (WiFi, cellular, broadband, dial-up).

Targeting

Platform

Target specific device platforms (PLATFORM).

Set platform targeting

POST /backstage/api/1.0/{account_id}/video-campaigns/managed/{campaign_id}

{
  "restrictions": [
    {
      "type": "INCLUDE",
      "value": ["DESKTOP", "MOBILE"],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "OS"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "BROWSER"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "CONNECTION_TYPE"
    }
  ]
}

{
  "id": 12345678,
  "content_provider": 987654,
  "name": "Platform Targeted Campaign",
  "business_model": "CPM",
  "status": "ACTIVE",
  "start_date": "2024-06-01",
  "end_date": "2024-08-31",
  "restrictions": [
    {
      "type": "INCLUDE",
      "value": ["DESKTOP", "MOBILE"],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "OS"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "BROWSER"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "CONNECTION_TYPE"
    }
  ],
  "total_budget": 10000.0,
  "charge_rate": 5.50,
  "completed_views": 1500,
  "active": true
}

Platform values

Platform	Value
Desktop	`DESKTOP`
Mobile	`MOBILE`
Tablet	`TABLET`

Operating system

Target specific operating systems (OS).

Set operating system targeting

POST /backstage/api/1.0/{account_id}/video-campaigns/managed/{campaign_id}

{
  "restrictions": [
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "INCLUDE",
      "value": ["WINDOWS", "MACOS", "IOS", "ANDROID"],
      "restriction_name": "OS"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "BROWSER"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "CONNECTION_TYPE"
    }
  ]
}

{
  "id": 12345678,
  "content_provider": 987654,
  "name": "OS Targeted Campaign",
  "business_model": "CPM",
  "status": "ACTIVE",
  "start_date": "2024-06-01",
  "end_date": "2024-08-31",
  "restrictions": [
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "INCLUDE",
      "value": ["WINDOWS", "MACOS", "IOS", "ANDROID"],
      "restriction_name": "OS"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "BROWSER"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "CONNECTION_TYPE"
    }
  ],
  "total_budget": 10000.0,
  "charge_rate": 5.50,
  "completed_views": 1500,
  "active": true
}

Operating system values

Operating System	Value
Windows	`WINDOWS`
macOS	`MACOS`
iOS	`IOS`
Android	`ANDROID`
Linux	`LINUX`

Browser

Target specific web browsers (BROWSER).

Set browser targeting

POST /backstage/api/1.0/{account_id}/video-campaigns/managed/{campaign_id}

{
  "restrictions": [
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "OS"
    },
    {
      "type": "INCLUDE",
      "value": ["CHROME", "SAFARI", "FIREFOX"],
      "restriction_name": "BROWSER"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "CONNECTION_TYPE"
    }
  ]
}

{
  "id": 12345678,
  "content_provider": 987654,
  "name": "Browser Targeted Campaign",
  "business_model": "CPM",
  "status": "ACTIVE",
  "start_date": "2024-06-01",
  "end_date": "2024-08-31",
  "restrictions": [
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "OS"
    },
    {
      "type": "INCLUDE",
      "value": ["CHROME", "SAFARI", "FIREFOX"],
      "restriction_name": "BROWSER"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "CONNECTION_TYPE"
    }
  ],
  "total_budget": 10000.0,
  "charge_rate": 5.50,
  "completed_views": 1500,
  "active": true
}

Browser values

Browser	Value
Chrome	`CHROME`
Safari	`SAFARI`
Firefox	`FIREFOX`
Edge	`EDGE`
Internet Explorer	`IE`

Connection type

Target based on internet connection type (CONNECTION_TYPE).

Set connection type targeting

POST /backstage/api/1.0/{account_id}/video-campaigns/managed/{campaign_id}

{
  "restrictions": [
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "OS"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "BROWSER"
    },
    {
      "type": "INCLUDE",
      "value": ["WIFI", "CELLULAR", "BROADBAND"],
      "restriction_name": "CONNECTION_TYPE"
    }
  ]
}

{
  "id": 12345678,
  "content_provider": 987654,
  "name": "Connection Targeted Campaign",
  "business_model": "CPM",
  "status": "ACTIVE",
  "start_date": "2024-06-01",
  "end_date": "2024-08-31",
  "restrictions": [
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "OS"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "BROWSER"
    },
    {
      "type": "INCLUDE",
      "value": ["WIFI", "CELLULAR", "BROADBAND"],
      "restriction_name": "CONNECTION_TYPE"
    }
  ],
  "total_budget": 10000.0,
  "charge_rate": 5.50,
  "completed_views": 1500,
  "active": true
}

Connection type values

Connection Type	Value
WiFi	`WIFI`
Cellular	`CELLULAR`
Broadband	`BROADBAND`
Dial-up	`DIAL_UP`

A complete example

{
  "restrictions": [
    {
      "type": "INCLUDE",
      "value": ["DESKTOP", "MOBILE"],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "INCLUDE",
      "value": ["WINDOWS", "MACOS", "IOS", "ANDROID"],
      "restriction_name": "OS"
    },
    {
      "type": "EXCLUDE",
      "value": ["IE"],
      "restriction_name": "BROWSER"
    },
    {
      "type": "INCLUDE",
      "value": ["WIFI", "BROADBAND"],
      "restriction_name": "CONNECTION_TYPE"
    }
  ]
}

This example:

Targets desktop and mobile platforms (DESKTOP, MOBILE)
Includes Windows, macOS, iOS, and Android operating systems
Excludes Internet Explorer browser (IE)
Targets only WiFi and broadband connections (WIFI, BROADBAND)

Making updates

Update existing targeting

You can update platform targeting in two ways:

Example 1 - pass a complete set of targeting options

POST /backstage/api/1.0/{account_id}/video-campaigns/managed/{campaign_id}

{
  "restrictions": [
    {
      "type": "INCLUDE",
      "value": ["DESKTOP", "MOBILE"],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "INCLUDE",
      "value": ["WINDOWS", "MACOS"],
      "restriction_name": "OS"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "BROWSER"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "CONNECTION_TYPE"
    }
  ]
}

👍
Passing a complete set of targeting options
For maximum clarity, we recommend passing the full set of targeting options.

📘
POST
To update a video campaign, use the POST operation.

Example 2 - pass a subset of targeting options

POST /backstage/api/1.0/{account_id}/video-campaigns/managed/{campaign_id}

{
  "restrictions": [
    {
      "type": "INCLUDE",
      "value": ["DESKTOP"],
      "restriction_name": "PLATFORM"
    }
  ]
}

👍
Passing a subset of targeting options
You can pass a restrictions object with a subset of the available targeting options - e.g. with "PLATFORM" only. The other targeting options will remain unaffected.

Clear existing targeting

Remove all platform targeting restrictions by setting "type": "ALL" and "value": [] (empty array). You must provide a complete set of restrictions - an empty collection will result in an error.

POST /backstage/api/1.0/{account_id}/video-campaigns/managed/{campaign_id}

{
  "restrictions": [
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "OS"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "BROWSER"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "CONNECTION_TYPE"
    }
  ]
}

{
  "id": 12345678,
  "content_provider": 987654,
  "name": "Broad Platform Campaign",
  "business_model": "CPM",
  "status": "ACTIVE",
  "start_date": "2024-06-01",
  "end_date": "2024-08-31",
  "restrictions": [
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "PLATFORM"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "OS"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "BROWSER"
    },
    {
      "type": "ALL",
      "value": [],
      "restriction_name": "CONNECTION_TYPE"
    }
  ],
  "total_budget": 10000.0,
  "charge_rate": 5.50,
  "completed_views": 1500,
  "active": true
}

Platform Targeting

Overview

The `restrictions` object

A sample object

`type`

`value`

`restriction_name`

Targeting

Platform

Set platform targeting

Platform values

Operating system

Set operating system targeting

Operating system values

Browser

Set browser targeting

Browser values

Connection type

Set connection type targeting

Connection type values

A complete example

Making updates

Update existing targeting

Example 1 - pass a complete set of targeting options

Passing a complete set of targeting options

`POST`

Example 2 - pass a subset of targeting options

Passing a subset of targeting options

Clear existing targeting

Related pages

Overview

The restrictions object

A sample object

type

value

restriction_name

Targeting

Platform

Set platform targeting

Platform values

Operating system

Set operating system targeting

Operating system values

Browser

Set browser targeting

Browser values

Connection type

Set connection type targeting

Connection type values

A complete example

Making updates

Update existing targeting

Example 1 - pass a complete set of targeting options

Passing a complete set of targeting options

POST

Example 2 - pass a subset of targeting options

Passing a subset of targeting options

Clear existing targeting

Related pages

The `restrictions` object

`type`

`value`

`restriction_name`

`POST`