The targeting object is provided as part of the API call when creating line items and creatives . The basic structure of this object is shown below:
Copy {
"targeting": {
"deviceTargets": [],
"adUnitTarget": {},
"userSegmentTargets": [],
"dateTarget": {},
"geospatialTargets": [],
"keyValueTargets": [],
"siteTarget": {},
"adUnitMatchingLabelTargets": [],
"categoryTargets": [],
"namedLocationTarget": {},
"dayPartingTargets": [],
"retargetingTargets": [],
"keywordTargets": [],
"ipAddressTarget": {},
"siteGroupTarget": {}
}
} Fields:
Name
Restriction
Description
adUnitMatchingLabelTargets
Device targets
Copy {
"deviceTargets": [
{
"targetedBrands": [
"ACER"
],
"targetedOSes": [
"ANDROID"
],
"targetedDeviceTypes": [
"DESKTOP"
]
},
{
"targetedBrands": [],
"targetedOSes": [],
"targetedDeviceTypes": [
"MOBILE"
]
}
]
} The device targets can be found with it's endpoint /devices .
UNKNOWN, DESKTOP, APPLE, NOKIA, HTC, SAMSUNG, SONY_ERICSSON, LG, MOTOROLA, RIM, HUAWEI, ZTE, ASUS, PANASONIC, FUJITSU, SHARP, NEC, KYOCERA, ACER
UNKNOWN, WINDOWS_PHONE, WINDOWS, MACINTOSH, IOS, ANDROID, LINUX, SUNOS, BSD, SYMBIAN, BLACKBERRY
Ad unit targets
Copy {
"adUnitTarget": {
"adUnits": [
{ "id": "d5f6mxj3jbhytmzg" },
{ "id": "jpbnjqy597pvygbm" }
]
}
} The id of the ad units can be found at this endpoint: /adunits .
Segment targets
Copy {
"userSegmentTargets": [
{
"userSegments": [
{ "id": "xxxxxxxxxxxx" }
],
"notUserSegments": [
{ "id": "yyyyyyyyyyyy" }
]
},
{
"userSegments": [
{ "id": "xxxxxxxxxxxx" }
],
"notUserSegments": [
{ "id": "yyyyyyyyyyyy" }
]
}
]
} The id of the segments can be found here at this endpoint: /segments .
When posting targeting data only the id of the adunit is required.
Date targets
Copy {
"dateTarget": {
"dateRanges": [
{
"first": "2018-01-02T00:00:00",
"second": "2018-01-10T23:30:00"
},
{
"first": "2018-01-11T00:00:00",
"second": "2018-01-12T00:00:00"
},
{
"first": "2018-01-11T00:00:00",
"second": "2018-01-11T23:30:00"
}
],
"timeZoneSetting": "SYSTEM"
},
} All dates must be specified as follows: yyyy-mm-ddThh:mm:ss.
An array containing the range objects.
Geospatial targets
Copy {
"geospatialTargets": [
{
"definition": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
17.9914856,
59.32968705
],
[
18.08074951,
59.34999583
],
[
18.13568115,
59.30866518
],
[
18.08074951,
59.28622753
],
[
17.9914856,
59.32968705
]
]
]
}
]
}
},
{
"definition": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
17.93380737,
59.24100683
],
[
17.93380737,
59.27610573
],
[
18.06976318,
59.27610573
],
[
18.06976318,
59.24100683
],
[
17.93380737,
59.24100683
]
]
]
}
]
}
}
],
} The polygons follow the format of GeoJson .
Key value targets
Copy {
"keyValueTargets": [
{
"entries": {
"key3": [
"value-3"
]
},
"notEntries": {}
},
// OR
{
"entries": {
"key4": [
"value-4"
]
},
"notEntries": {}
},
// OR
{
"entries": {
"key": [
"value"
],
// AND
"otherKey": [
"othervalue"
]
},
// AND NOT
"notEntries": {
"key2": [
"value-2"
]
}
}
]
} OR values are separated byt objects in the initial array.
AND values are separated with keys within entries
AND-NOTare speccified with notEntries as listed above.
Site targets
Copy {
"siteTarget": {
"sites": [
{ "id": "6vjwynnz2ptrvdcc" }
{ "id": "6lk3nvdkaai8a3jn" }
]
}
} The id of the sites can be found at this endpoint: /sites .
When posting targeting data only the id of the site is required.
Ad unit matching label targets
Copy {
"adUnitMatchingLabelTargets": [
{
"matchingLabels": [
"adunitLabel1"
]
},
{
"matchingLabels": [
"adunitLabel2"
]
}
]
} The ad unit matching labels has to be present on the ad unit for the matching label targeting to work.
For matching labels to work you will need to divide the targeting into separate objects as specified above.
Category targets
Copy {
"categoryTargets": [
{
"categories": [
"sport"
],
"notCategories": []
},
// OR
{
"categories": [
"color/blue"
],
"notCategories": []
},
// OR
{
"categories": [
"color/red/crimson",
//AND
"sports"
],
// AND NOT
"notCategories": [
"andnot"
]
}
]
} OR values are separated byt objects in the initial array.
AND values are added within the array.
AND-NOTare speccified with notEntries as listed above.
Location targets
Copy {
"namedLocationTarget": {
"locations": [
{ "id": 1172995 },
{ "id": 9373443 }
]
}
} The id of the location can be found at this endpoint: /location .
When posting targeting data only the id of the location is required.
Day parting targets
Copy {
"dayPartingTargets": [
{
"daysOfWeek": [
"TUESDAY",
"FRIDAY",
"WEDNESDAY",
"SATURDAY",
"MONDAY",
"THURSDAY",
"SUNDAY"
],
"hoursOfDay": [
1,
19,
20,
5,
21,
22,
23
],
"timeZoneSetting": "SYSTEM"
},
{
"daysOfWeek": [
"TUESDAY",
"WEDNESDAY",
"MONDAY",
"THURSDAY"
],
"hoursOfDay": [
2,
3,
23
],
"timeZoneSetting": "USER"
}
]
} you can add multiple dayparts by adding multiple objects.
The daypart object is divided in these paramters:
"MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
An array containing numbers 0 for 00:00 - 00:59, 1 for 01:00 - 01:59 etc. up to 23 for 23:00 - 23:59.
"USER" for user time zone and "SYSTEM" for the system time zone.
Keyword targets
Copy {
"keywordTargets": [
{
//AND
"keywords": [
"games",
"gambling"
],
"notKeywords": []
},
{
"keywords": [
"car"
],
"notKeywords": [
"ferrari",
"mazda"
]
},
{
"keywords": [
"sport"
],
"notKeywords": []
}
]
} OR values are separated byt objects in the initial array.
AND values are added within the array.
AND-NOTare speccified with notEntries as listed above.
Retargeting targets
Copy {
"retargetingTargets": [
{
"entries": {
"or-key": [
"or-value"
]
},
"notEntries": {}
},
// OR
{
"entries": {
"the-key": [
"value"
],
// AND
"and-key": [
"and-value"
]
},
// AND NOT
"notEntries": {
"and-not-key": [
"and-not-value"
]
}
}
]
} OR values are separated byt objects in the initial array.
AND values are added within the array.
AND-NOTare speccified with notEntries as listed above.
IP targets
Copy {
"ipAddressTarget": {
"addresses": [
"205.112.45.0/24",
"118.16.78.34"
]
},
} Contains addresses which is a comma seperated array of IP values. You can add multiple IP addresses by separating each individual one by a comma. For instance, inputting 118.16.78.34, 205.112.45.0/24 will match any of 118.16.78.34 and 205.112.45.0 through to 205.112.45.255. The IP targets follow the CIDR notation.
Site group targets
Copy {
"siteGroupTarget": {
"siteGroups": [
{ "id": "8zh8lh7n81s6l2m7" },
{ "id": "j38bl01t2pbtmzkg" }
]
}
} The id of the sites can be found at this endpoint: /sitegroups .
When posting targeting data only the id of the site is required.
Examples
A GET request for a targeting object:
Copy {
"targeting": {
"deviceTargets": [
{
"targetedBrands": [
"ACER"
],
"targetedOSes": [
"ANDROID"
],
"targetedDeviceTypes": [
"DESKTOP"
]
},
{
"targetedBrands": [],
"targetedOSes": [],
"targetedDeviceTypes": [
"MOBILE"
]
}
],
"adUnitTarget": {
"adUnits": [
{
"id": "d5f6mxj3jbhytmzg",
"name": "demo.adnuntius.com - 300 x 250",
"url": "/api/v1/adunits/d5f6mxj3jbhytmzg"
},
{
"id": "jpbnjqy597pvygbm",
"name": "demo.adnuntius.com - 980x240 - Panorama 02",
"url": "/api/v1/adunits/jpbnjqy597pvygbm"
}
]
},
"userSegmentTargets": [
{
"userSegments": [
{
"id": "xxxxxxxxxxxx",
"name": "Travel",
"description": "People interested in travel"
}
]
},
{
"userSegments": [
{
"id": "xxxxxxxxxxxx",
"name": "culture",
"description": "People interested in culture"
}
]
}
],
"dateTarget": {
"dateRanges": [
{
"first": "2018-01-02T00:00:00",
"second": "2018-01-10T23:30:00"
},
{
"first": "2018-01-11T00:00:00",
"second": "2018-01-12T00:00:00"
},
{
"first": "2018-01-11T00:00:00",
"second": "2018-01-11T23:30:00"
}
],
"timeZoneSetting": "SYSTEM"
},
"geospatialTargets": [
{
"definition": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
17.9914856,
59.32968705
],
[
18.08074951,
59.34999583
],
[
18.13568115,
59.30866518
],
[
18.08074951,
59.28622753
],
[
17.9914856,
59.32968705
]
]
]
}
]
}
},
{
"definition": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
17.93380737,
59.24100683
],
[
17.93380737,
59.27610573
],
[
18.06976318,
59.27610573
],
[
18.06976318,
59.24100683
],
[
17.93380737,
59.24100683
]
]
]
}
]
}
}
],
"keyValueTargets": [
{
"entries": {
"key3": [
"value-3"
]
},
"notEntries": {}
},
{
"entries": {
"key4": [
"value-4"
]
},
"notEntries": {}
},
{
"entries": {
"key": [
"value"
],
"otherKey": [
"othervalue"
]
},
"notEntries": {
"key2": [
"value-2"
]
}
}
],
"siteTarget": {
"sites": [
{
"id": "6vjwynnz2ptrvdcc",
"name": "demo.adnuntius.com",
"url": "/api/v1/sites/6vjwynnz2ptrvdcc"
},
{
"id": "6lk3nvdkaai8a3jn",
"name": "Other site for My test account",
"url": "/api/v1/sites/6lk3nvdkaai8a3jn"
}
]
},
"adUnitMatchingLabelTargets": [
{
"matchingLabels": [
"adunitLabel1"
]
},
{
"matchingLabels": [
"adunitLabel2"
]
}
],
"categoryTargets": [
{
"categories": [
"sport"
],
"notCategories": []
},
{
"categories": [
"color/blue"
],
"notCategories": []
},
{
"categories": [
"color/red/crimson",
"sports"
],
"notCategories": [
"andnot"
]
}
],
"namedLocationTarget": {
"locations": [
{
"id": 1172995,
"type": "CITY",
"name": "Norrköping",
"context": "Östergötland, Sweden, Europe"
},
{
"id": 9373443,
"type": "CITY",
"name": "Norrköping Ö",
"context": "Östergötland, Sweden, Europe"
}
]
},
"dayPartingTargets": [
{
"daysOfWeek": [
"SATURDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SUNDAY",
"MONDAY",
"TUESDAY"
],
"hoursOfDay": [
0,
16,
1,
17
],
"timeZoneSetting": "SYSTEM"
}
],
"retargetingTargets": [
{
"entries": {
"or-key": [
"or-value"
]
},
"notEntries": {}
},
{
"entries": {
"the-key": [
"value"
],
"and-key": [
"and-value"
]
},
"notEntries": {
"and-not-key": [
"and-not-value"
]
}
}
],
"keywordTargets": [
{
"keywords": [
"games",
"gambling"
],
"notKeywords": []
},
{
"keywords": [
"car"
],
"notKeywords": []
},
{
"keywords": [
"sport"
],
"notKeywords": []
}
],
"ipAddressTarget": {
"addresses": [
"205.112.45.0/24",
"118.16.78.34"
]
},
"siteGroupTarget": {
"siteGroups": [
{
"id": "8zh8lh7n81s6l2m7",
"name": "Additional site group",
"url": "/api/v1/sitegroups/8zh8lh7n81s6l2m7"
},
{
"id": "j38bl01t2pbtmzkg",
"name": "General Site Group",
"url": "/api/v1/sitegroups/j38bl01t2pbtmzkg"
}
]
}
}
} 