Multi-Targeting Object

In contrast to general targeting fields (that use the Targeting Object), audience targeting fields use the Multi-Targeting Object.

πŸ“˜

Multi-Targeting object

The href property in a Multi-Targeting object references a collection of Targeting Restrictions Objects.

The overall flow is similar to the Targeting Object, as used for Postal Code Targeting.

Multi-Targeting Object Schema

Name

Modifier and Defaults

Type

Description

state

Read-only

  • Possible values**:
    

    EXISTS
    Targeting exist -href returns an Audience Targeting Object with the targeting details.

    ALL
    No targeting -href returns an Audience Targeting Object with an emptycollection.

    UNSUPPORTED*
    Specialized targeting exists, but is not supported via the API or UI. (Contact your account manager for further information.)
    href isnull.

value

Read-only
null

N/A

This field is always null. It can be ignored.

href

Read-only

String

A reference to the specific audience targeting endpoint.

🚧

You must adhere to the restrictions defined for each field. Otherwise, the server will return 400 Bad Request.

The following code snippet depicts a sample campaign (ID: 1234) and it's audience targeting fields. In this example, targeting exists for audience_segments_multi_targeting only.

{
   "id": "1234",
   //..
   "audience_segments_multi_targeting": {
      "state": "EXISTS",
      "value": null,
      "href": "https://backstage.taboola.com/backstage/api/1.0/demo-advertiser/campaigns/1234/targeting/audience_segments"
   },
   "custom_audience_targeting": {
      "state": "ALL",
      "value": null,
      "href": "https://backstage.taboola.com/backstage/api/1.0/demo-advertiser/campaigns/1234/targeting/custom_audience"
   },
   "lookalike_audience_targeting": {
      "state": "ALL",
      "value": null,
      "href": "https://backstage.taboola.com/backstage/api/1.0/demo-advertiser/campaigns/1234/targeting/lookalike_audience"
   }
   //..
}
πŸ“˜

What's in a name

For legacy reasons, some audience field names use the term 'multi' (e.g. audience_segments_multi_targeting) - and some do not (e.g. custom_audience_targeting). The naming has no special significance.