ADNUNTIUS
  • Adnuntius Documentation
  • Adnuntius Advertising
    • Overview
    • Getting Started
      • Ad Server for Agencies
      • Ad Server for Publishers
    • User Interface Guide
      • Dashboards
      • Advertising
        • Advertisers
        • Orders
        • Line Items
        • Line Item Templates
        • Creatives
        • Library Creatives
        • Targeting
        • Booking Calendar
        • Reach Analysis
        • Smoothing
      • Inventory
        • Sites
        • Adunits
        • External Ad Units
        • Site Rulesets
        • Blocklists
        • Site Groups
        • Earnings Accounts
        • Ad Tag Generator
      • Reports and Statistics
        • The Statistics Defined
        • The 4 Impression Types
        • Templates and Schedules
        • Report Translations
      • Queries
        • Advertising Queries
        • Publishing Queries
      • Users
        • Users
        • Teams
        • Roles
        • Notification Preferences
        • User Profile
      • Design
        • Layouts and Examples
        • Marketplace Products
        • Products
        • Coupons
      • Admin
        • API Keys
        • CDN Uploads
        • Custom Events
        • Reference Data
        • Email Translations
        • Context Services
        • External Demand Sources
        • Data Exports
        • Tiers
        • Network
    • API Documentation
      • API Requests
      • Targeting object
      • API Filters
      • Endpoints
        • /adunits
        • /adunittags
        • /advertisers
        • /article2
        • /creativesets
        • /assets
        • /authenticate
        • /contextserviceconnections
        • /coupons
        • /creatives
        • /customeventtypes
        • /deliveryestimates
        • /devices
        • /earningsaccounts
        • /librarycreatives
        • /lineitems
        • /location
        • /orders
        • /reachestimate
        • /roles
        • /segments
        • /segments/upload
        • /segments/users/upload
        • /sitegroups
        • /sites
        • /sspconnections
        • /stats
        • /teams
        • /tiers
        • /users
    • Requesting Ads
      • Javascript
        • Requesting an Ad
        • Layout Support
        • Utility Methods
        • Logging Options
        • Prebid
      • HTTP
      • Cookieless Advertising
      • VAST
      • Open RTB
      • Recording Conversions
      • Prebid Server
      • Prebid
      • Android SDK
      • IOS SDK
    • Creative Guide
      • HTML5 Creatives
    • Page
  • Adnuntius Marketplace
    • Overview
    • Getting Started
      • For Network Owners
      • For Media Buyers
        • Marketplace Advertising
          • Advertisers
          • Orders
          • Line Items
          • Line Item Templates
          • Placements (in progress)
          • Creatives
            • High Impact Formats
          • Library Creatives
          • Booking Calendar
          • Reach Analysis
          • Targeting
          • Smoothing
      • For Publishers
        • Marketplace Inventory
          • Sites
          • Adunits
          • Site Groups
          • Rulesets (in progress)
          • Blocklists
          • Ad Tag Generator
        • Design
          • Layouts
          • Marketplace Products
  • Adnuntius Self-Service
    • Overview
    • Getting Started
    • User Interface Guide
    • Marketing Tips (Work in Progress)
  • Adnuntius Data
    • Overview
    • Getting Started
    • User Interface Guide
      • Segmentation
        • Triggers
        • Segments
        • Folders
      • Fields
        • Fields
        • Mappings
      • Queries
      • Admin
        • Users, Teams and Roles
        • Data Exports
        • Network
    • API documentation
      • Javascript API
        • User Profile Updates
        • Page View
        • User Synchronisation
        • Get user segments
      • HTTP API
        • /page
        • /visitor
        • /sync
        • /segment
      • Profile Fields
    • Segment Sharing
  • Adnuntius Connect
    • Integration Guide (Work in Progress)
      • Prebid - Google ad manager
      • Privacy GTM integration
      • Consents API
      • TCF API
    • UI Guide (Work in Progress)
      • Containers and Dashboards
      • Privacy (updates in progress)
      • Variables, Triggers and Tags
      • Integrations (in progress)
      • Prebid Configuration
      • Publish
  • Adnuntius Email Advertising
    • Getting Started
  • Other Useful Information
    • Macros for click tracker
    • Setup Adnuntius via prebid in GAM
    • Identification and Privacy
      • User Identification
      • Permission to use Personal Data (TCF2)
      • Data Collection and Usage
      • Am I Being Tracked?
    • Header bidding implementation
    • Adnuntius Slider
    • Whitelabeling
    • Firewall Access
    • Ad Server Logs
    • Send segments Cxense
    • Setup deals in GAM
    • Render Key Values in ad
    • Parallax for Ad server Clients
  • Troubleshooting
    • FAQs
    • How do I contact support?
    • Adnuntius System Status
  • Adnuntius High Impact
    • Publisher onboarding
    • High Impact configuration
    • Guidelines for High impact creatives
Powered by GitBook
On this page
  • Device targets
  • Ad unit targets
  • Segment targets
  • Date targets
  • Geospatial targets
  • Key value targets
  • Site targets
  • Ad unit matching label targets
  • Category targets
  • Location targets
  • Day parting targets
  • Keyword targets
  • Retargeting targets
  • IP targets
  • Site group targets
  • Examples
  1. Adnuntius Advertising
  2. API Documentation

Targeting object

Last updated 3 years ago

The targeting object is provided as part of the API call when creating and . The basic structure of this object is shown below:

{
    "targeting": {
        "deviceTargets": [],
        "adUnitTarget": {},
        "userSegmentTargets": [],
        "dateTarget": {},
        "geospatialTargets": [],
        "keyValueTargets": [],
        "siteTarget": {},
        "adUnitMatchingLabelTargets": [],
        "categoryTargets": [],
        "namedLocationTarget": {},
        "dayPartingTargets": [],
        "retargetingTargets": [],
        "keywordTargets": [],
        "ipAddressTarget": {},
        "siteGroupTarget": {}
    }
}

Fields:

Name
Restriction
Description

deviceTargets

Array

adUnitTarget

Object

userSegmentTargets

Array

dateTarget

Object

geospatialTargets

Array

keyValueTargets

Array

siteTarget

Object

adUnitMatchingLabelTargets

Array

categoryTargets

Array

namedLocationTarget

Object

dayPartingTargets

Array

retargetingTargets

Array

keywordTargets

Array

ipAddressTarget

Object

siteGroupTarget

Object

Device targets

{
"deviceTargets": [
    {
        "targetedBrands": [
                "ACER"
            ],
            "targetedOSes": [
                "ANDROID"
            ],
            "targetedDeviceTypes": [
                "DESKTOP"
            ]
        },
        {
            "targetedBrands": [],
            "targetedOSes": [],
            "targetedDeviceTypes": [
                "MOBILE"
            ]
        }
    ]

}
Name
Data type
Values

targetedBrands

String

UNKNOWN, DESKTOP, APPLE, NOKIA, HTC, SAMSUNG, SONY_ERICSSON, LG, MOTOROLA, RIM, HUAWEI, ZTE, ASUS, PANASONIC, FUJITSU, SHARP, NEC, KYOCERA, ACER

targetedOSes

String

UNKNOWN, WINDOWS_PHONE, WINDOWS, MACINTOSH, IOS, ANDROID, LINUX, SUNOS, BSD, SYMBIAN, BLACKBERRY

targetedDeviceTypes

String

DESKTOP, TABLET, MOBILE

Ad unit targets

{
    "adUnitTarget": {
        "adUnits": [
            { "id": "d5f6mxj3jbhytmzg" },
            { "id": "jpbnjqy597pvygbm" }
        ]
    }
}

Segment targets

{
    "userSegmentTargets": [
        {
            "userSegments": [
                { "id": "xxxxxxxxxxxx" }
            ],
            "notUserSegments": [
                { "id": "yyyyyyyyyyyy" }
            ]
        },
        {
            "userSegments": [
                { "id": "xxxxxxxxxxxx" }
            ],
            "notUserSegments": [
                { "id": "yyyyyyyyyyyy" }
            ]
        }
    ]
}

When posting targeting data only the id of the adunit is required.

Date targets

{
    "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.

Name
Data type
Values

dateTarget

Object

The date target object.

dateRanges

Array

An array containing the range objects.

first

String

Start of the date range.

second

String

End of the date range.

Geospatial targets

{
    "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
                                ]
                            ]
                        ]
                    }
                ]
            }
        }
    ],
}

Key value targets

{
    "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

{
    "siteTarget": {
        "sites": [
            { "id": "6vjwynnz2ptrvdcc" }
            { "id": "6lk3nvdkaai8a3jn" }
        ]
    }
}

When posting targeting data only the id of the site is required.

Ad unit matching label targets

{
    "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

{
    "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

{

    "namedLocationTarget": {
        "locations": [
            { "id": 1172995 },
            { "id": 9373443 }
        ]
    }
}

When posting targeting data only the id of the location is required.

Day parting targets

{
    "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:

Name
Data type
Values

daysOfWeek

Array

"MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"

hoursOfDay

Array

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.

timeZoneSetting

String

"USER" for user time zone and "SYSTEM" for the system time zone.

Keyword targets

{
    "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

{
    "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

{
    "ipAddressTarget": {
        "addresses": [
            "205.112.45.0/24",
            "118.16.78.34"
        ]
    },
}

Site group targets

{
    "siteGroupTarget": {
        "siteGroups": [
            { "id": "8zh8lh7n81s6l2m7" },
            { "id": "j38bl01t2pbtmzkg" }
        ]
    }
}

When posting targeting data only the id of the site is required.

Examples

A GET request for a targeting object:

{
    "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"
                }
            ]
        }
    }
}

The device targets can be found with it's endpoint .

The id of the ad units can be found at this endpoint: .

The id of the segments can be found here at this endpoint: .

The polygons follow the format of .

The id of the sites can be found at this endpoint: .

The id of the location can be found at this endpoint: .

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 notation.

The id of the sites can be found at this endpoint: .

line items
creatives
/devices
/adunits
/segments
GeoJson
/sites
/location
CIDR
/sitegroups
deviceTargets
adUnitTarget
userSegmentTargets
dateTarget
geospatialTargets
keyValueTargets
siteTarget
adUnitMatchingLabelTargets
categoryTargets
namedLocationTarget
dayPartingTargets
retargetingTargets
keywordTargets
ipAddressTarget
siteGroupTarget