Audience Targeting Object

Audience Targeting Object Schema:

Name

Modifier and Defaults

Type

Description

collection

Required

Array <Targeting Restrictions Object>

Collection of Targeting Restrictions.
Submit[] (empty array) to target NONE for the given targeting type.

Note: For Audience Segment Targeting and Lookalike Audience Targeting, the collection property contains a single Targeting Restrictions Object with a type of INCLUDE. (These 2 targeting types do not support EXCLUDE.)

🚧

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

Some sample Audience Targeting Objects:

{
   "collection": []
}
{
    "collection": [
        {
            "collection": [
                112233,
                12123,
                123876,
                123,
                1687024,
                9876
            ],
            "type": "INCLUDE"
        }
    ]
}
{
    "collection": [
        {
            "collection": [
                123456,
                12345
            ],
            "type": "INCLUDE"
        },
        {
            "collection": [
                98765,
                87654
            ],
            "type": "EXCLUDE"
        }
    ]
}
{
    "collection": [
        {
            "collection": [
                {
                    "rule_id": 5253453,
                    "similarity_level": 15
                },
                {
                    "rule_id": 444487,
                    "similarity_level": 25
                }
            ],
            "type": "INCLUDE"
        }
    ]
}

πŸ“˜

The above examples could be in a request or response body.

πŸ“˜

Field Names

Parent and child objects both have a property called collection.

πŸ“˜

No PATCH Operation

Audience Targeting does not support a PATCH operation - submitted values overwrite the old ones.

πŸ“˜

Remove An Audience

To remove an audience, re-submit a new collection to the relevant audience targeting endpoint (omitting any relevant audiences).

πŸ“˜

Remove All Audiences

To remove all audiences, submit an empty collection to the relevant audience targeting endpoint.
(See the Target NONE example above).