Name | Modifier & Defaults | Type | Description |
---|---|---|---|
platform_targeting | Default: Targeting Object with type = ALL and value = [] (empty collection) | Targeting Object (INCLUDE only) Note: Use the Dictionary to fetch an up-to-date list of possible values. Target Platforms: DESK Desktop PHON Smartphone TBLT Tablet | List of platform device types (desktop/tablet/smartphone) on which to run the campaign. See: Platform Targeting |
The platform_targeting
field is updated directly via the campaigns endpoint - and the targeted collection is stored directly in the value
property:
{
// other Campaign fields...
"platform_targeting": {
"type": "INCLUDE",
"value": [
"PHON",
"TBLT"
],
"href": null
}
}
The
href
property is alwaysnull
.
Example
Update platform targeting:
POST /backstage/api/1.0/<<example_advertiser_id>>/campaigns/1234
{
"platform_targeting": {
"type" : "INCLUDE",
"value" : ["DESK"]
}
}
{
"platform_targeting": {
"type": "ALL"
}
}
The API will not attempt to validate the combined targeting for platform, OS and browser. (If the targeted combination does not exist, the campaign will not display.)