os_targeting

Name

Modifier & Defaults

Type

Description

os_targeting

Default:
Targeting Object with type = ALL and value = [] (empty collection)

Targeting Object

The targeting object should contain the list of targeted OS families.

Note: Use the Dictionary to fetch an up-to-date list of possible values.

Possible Values:

Mac OS X
Linux
Windows
iOS
Android

A list of operating systems to target/exclude for the campaign.

See: OS Targeting

The os_targeting field is updated directly via the campaigns endpoint - and the targeted collection is stored directly in the value property:

{
  // other Campaign fields...
   "os_targeting": {
      "type": "INCLUDE",
      "value": [
         {
            "os_family": "Android",
            "sub_categories": []
         },
         {
            "os_family": "iOS",
            "sub_categories": [
               "iOS_9",
               "iOS_10"
            ]
         }
      ],
      "href": null
   }
}

πŸ“˜

To target specific versions of an operating system, include the sub_categories property. If omitted, sub_categories will include all versions.

πŸ“˜

The href property is always null.

🚧

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.)