API ReferenceAnnouncementsCommunity Discussion
API ReferenceCommunity DiscussionAnnouncementsSubscribeLog In
API Reference

Audience Targeting Restrictions Object

The Audience Targeting Object (above) stores an array of these objects in its collection property.

NameModifier and DefaultsTypeDescription
typeRequiredString

Possible values:

INCLUDE
Values should be included (whitelisted).
EXCLUDE
Values should be excluded (blacklisted).
Whether the listed values should be blacklisted or whitelisted.

Notes:

In contrast to Postal Codes Targeting, this type property does not support ALL. To remove targeting, submit an Audience Targeting Object (previous topic) with [] (empty collection).

Marketplace Audiences and Lookalike Audiences do not support EXCLUDE.
collectionRequiredArray <Variant>

The data type varies:

Marketplace Audiences:
Collection of targeted audiences_ids (Longs).

Custom Audiences:
Collection of targeted audiences_ids (Longs).

Lookalike Audiences:
Collection of Lookalike Audience Objects.
The collection of targeted values.

You can use the Dictionary to fetch a list of available Marketplace Audiences (aka Audience Segments) for your account. See: Get Marketplace Audiences.

🚧

Audience Segments and Lookalike Audiences do not support EXCLUDE.

🚧

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