Audience Targeting Object Schema:
Name | Modifier and Defaults | Type | Description |
---|---|---|---|
collection | Required | Array <Targeting Restrictions Object> | Collection of Targeting Restrictions.
|
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 NamesParent and child objects both have a property called
collection
.
No PATCH OperationAudience Targeting does not support a PATCH operation - submitted values overwrite the old ones.
Remove An AudienceTo remove an audience, re-submit a new collection to the relevant audience targeting endpoint (omitting any relevant audiences).
Remove All AudiencesTo remove all audiences, submit an empty collection to the relevant audience targeting endpoint.
(See the Target NONE example above).