RTB Line Item Targeting Service

Overview

Allows to manage targeting settings.

List of methods

Targeting Rules

Here is a list of available targeting rules. All said rules derive from 'TargetingGroupRule' class, therefore only their own custom parameters are mentioned here. To see the full model schema, view method Get Activities Targeting by Activity ID parameters.

In order to identify the type of targeting rule, an additional property '$type' is passed alongside. '$type' contains a stringified name of the targeting rule class (see examples in 'dsp/vs1/targeting' endpoint documentation).

More information about audience targeting setup is available at adform help page.

If you get validation errors and not sure which targeting rule is invalid, use 'Cid' parameter. It is not saved in database and is used to identify which targeting rules are invalid.

List of Available Targeting Rules

TypeTitleModel SchemaProperties
BehaviorAudience Is

$type:"AudienceIsTargetingRule",

TrackingPoints:[]

  • TrackingPoints - Full model schema and possible values are available at '/dsp/v1/dictionaries/audiences?campaingId=00000' endpoint.

! Use it to target audience by profiling tracking points to guess what type the user is.

BehaviorAudience Is Not

$type:"AudienceIsNotTargetingRule",

TrackingPoints:[] 

  • TrackingPoints - Full model schema and possible values are available at '/dsp/v1/dictionaries/audiences?campaingId=00000' endpoint

! Same as above, except this one check what type the user is not.

BehaviorExternal Data

$type:"ExternalDataTargetingRule",

ProviderId:int,

TypeId:int,

ExternalDataValues:[] 

  • ProviderId - id of the provider whose external data use wants to use. Get all available providers from '/dsp/v1/dictionaries/externalDataProviders?campaingId=00000' endpoint.
  • TypeId - id of the external data categories. Get all available categories by provider from '/dsp/v1/dictionaries/externalDataCategories' endpoint.
  • ExternalDataValues - Values by provider whose Id is set as providerId. Full model schema and possible values are available at '/dsp/v1/dictionaries/externalDataCategories' endpoint.

! Additional targeting types that are provided by third party companies.

Re-targetingUser has clicked on campaign

$type:"HasClickedOnCampaignTargetingRule",

Campaigns:[],

OperationId:int,

Type:byte (optional),

TimeUnit:byte (optional),

Days:int (optional),

Hours:int (optional)

  • Campaigns - Campaigns that the user has clicked on. Full model schema and possible values are available at '/dsp/v1/dictionaries/campaigns' endpoint.
  • Type - when did the user visit tracking point. Possible values are: 0 - any time, 1 - during last days or hours, 2 - more then days or hours ago. The default is 0 (any time).
  • TimeUnit values - Is used when Type is set to 1 or 2 and describes the time unit to measure when user visited tracking points. Possible values : 0 - days, 1 - hours. The default is 0(days).
  • Days - must be provided, when TimeUnit is set to 0. The default is 0.
  • Hours - must be provided, when TimeUnit is set to 1. The default is 0.
  • OperationId - Campaign inclusion type. Available values : 2 - all tracking points, 1 - any tracking point. Default value is 1.

! Selecting this rule enables the targeting of users who have clicked on a certain campaign.

Re-targetingUser has not clicked on campaign

$type:"HasNotClickedOnCampaignTargetingRule",

Campaigns:[],

OperationId:int

  •  Campaigns - Campaigns that the user has clicked on. Full model schema and possible values are available at '/dsp/v1/dictionaries/campaigns?campaingId=00000' endpoint.
  • OperationId - Campaign inclusion type. Available values : 2 - all tracking points, 1 - any tracking point. Default value is 1.

Selecting this rule enables the targeting of users who have not clicked on a certain campaign.

Re-targetingEngaged with campaign

$type:"EngagedWithCampaignTargetingRule",

Campaigns:[],

Engagements:[],

OperationId:int,

Type:byte (optional),

TimeUnit:byte (optional),

Days:int (optional),

Hours:int (optional)

  • Campaigns - Campaigns that the user has engaged with. Full model schema and possible values are available at '/dsp/v1/dictionaries/campaigns?campaingId=00000' endpoint.
  • Engagements - Engagement types. Full model schema and possible values are available at '/dsp/v1/dictionaries/engagements' endpoint.
  • Type - when did the user engage with campaign. Possible values are: 0 - any time, 1 - during last days or hours, 2 - more then days or hours ago. The default is 0 (any time).
  • TimeUnit values - Is used when Type is set to 1 or 2 and describes the time unit to measure when user has engaged with campaign. Possible values : 0 - days, 1 - hours. The default is 0(days).
  • Days - must be provided, when TimeUnit is set to 0. The default is 0.
  • Hours - must be provided, when TimeUnit is set to 1. The default is 0.
  • OperationId - Campaign inclusion type. Available values : 2 - all tracking points, 1 - any tracking point. Default value is 1.

Selecting this rule enables targeting users who engaged with banners from various campaigns.n identifier.

Re-targetingHas not engaged with campaign

$type:"HasNotEngagedWithCampaignTargetingRule",

Campaigns:[],

Engagements:[],

OperationId:int

  • Campaigns - Campaigns that the user has not engaged with. Full model schema and possible values are available at '/dsp/v1/dictionaries/campaigns?campaingId=00000' endpoint.
  • Engagements - Engagement types. Full model schema and possible values are available at '/dsp/v1/dictionaries/engagements' endpoint.
  • OperationId - Campaign exclusion type. Available values : 2 - all tracking points, 1 - any tracking point. Default value is 1.

Selecting this rule enables targeting users who has not engaged with banners from various campaigns.

Re-targetingUser has visited the tracking point

$type:"VisitedTrackingPointTargetingRule",

TrackingPoints:[],

OperationId:int,

Type:byte (optional),

TimeUnit:byte (optional),

Days:int (optional),

Hours:int (optional)

  • TrackingPoints - Full model schema and values are available at '/dsp/v1/dictionaries/trackingpoints?campaingId=00000' endpoint.
  • OperationId - Tracking point inclusion type. Available values : 2 - all tracking points, 1 - any tracking point. Default value is 1.
  • Type - when did the user visit tracking point. Possible values are: 0 - any time, 1 - during last days or hours, 2 - more then days or hours ago. The default is 0 (any time).
  • TimeUnit values - Is used when Type is set to 1 or 2 and describes the time unit to measure when user visited tracking points. Possible values : 0 - days, 1 - hours. The default is 0(days).
  • Days - must be provided, when TimeUnit is set to 0. The default is 0.
  • Hours - must be provided, when TimeUnit is set to 1. The default is 0.

Allows targeting users who have visited a web-page with certain tracking points implemented.

Re-targetingUser has not visited the tracking point

$type:"HasNotVisitedTrackingPointTargetingRule",

TrackingPoints:[],

OperationId:int

  • TrackingPoints - Full model schema and values are available at '/dsp/v1/dictionaries/trackingpoints?campaingId=00000' endpoint.
  • OperationId - Tracking point inclusion type. Available values : 2 - all tracking points, 1 - any tracking point. Default value is 1.

Allows targeting users who have not visited a web-page with certain tracking points implemented.

TechnicalCookie list

$type:"CookieListTargetingRule",

FileName:string,

ListIndex:int(optional),

BatchId:int(optional)

  • FileName - name of the cookie list file that was previously uploaded using upload endpoint (/dsp/v1/upload/cookies).
  • ListIndex and BatchId - composite key, used to uniquely identify the rule. Use them, when updating activity targeting for faster request handling time (as to not delete and re-create the rule).

Enables targeting of users from uploaded cookie list.

 

TechnicalUser belongs to IP range

$type:"FromIpRangeTargetingRule",

FileName:string,

ListIndex:int,

BatchId:int(optional)

  • FileName - name of the IP range list file that was previously uploaded using upload endpoint (/dsp/v1/upload/ipranges).
  • ListIndex and BatchId - composite key, used to uniquely identify the rule. Use them, when updating activity targeting for faster request handling time (as to not delete and re-create the rule).

Enables targeting of users from uploaded IP ranges.

TechnicalUser does not belong to IP range

$type:"NotFromIpRangeTargetingRule",

FileName:string,

ListIndex:int,

BatchId:int(optional)

  • FileName - name of the IP range list file that was previously uploaded using upload endpoint (/dsp/v1/upload/ipranges).
  • ListIndex and BatchId - composite key, used to uniquely identify the rule. Use them, when updating activity targeting for faster request handling time (as to not delete and re-create the rule).

Enables targeting of users from uploaded IP ranges.

TechnicalDevice Identifier List(Mobile App Line Item only)

$type:"CookieListTargetingRule",

FileName:string,

ListIndex:int(optional),

BatchId:int(optional)

  • FileName - name of the Advertising IDs file that was previously uploaded using upload endpoint (/dsp/v1/upload/advertisingids).
  • ListIndex and BatchId - composite key, used to uniquely identify the rule. Use them, when updating activity targeting for faster request handling time (as to not delete and re-create the rule).

Enables targeting of users from uploaded Advertising IDs list.

 

TechnicalUser uses device

$type:"UsesDeviceTargetingRule",

Devices:[],

OSes:[]

  • Devices - Full model schema and possible values are available at '/dsp/v1/dictionaries/deviceTypes' endpoint, which contains full model schema as well.
  • OSes - Full model schema and possible values are available at '/dsp/v1/dictionaries/deviceTypes' endpoint, which contains full model schema as well.

Selecting this rule allows targeting users according to the device type they use.

TechnicalUser does not use device

$type:"DoesNotUseDeviceTargetingRule",

Devices:[],

OSes:[]

  • Devices - Full model schema and possible values are available at '/dsp/v1/dictionaries/deviceTypes' endpoint, which contains full model schema as well.
  • OSes - Full model schema and possible values are available at '/dsp/v1/dictionaries/deviceTypes' endpoint, which contains full model schema as well.

! Selecting this rule allows targeting users according to the device type they don't use.

TechnicalUser uses Internet service provider

$type:"UsesIspTargetingRule",

ISPs:[]

  • ISPs - Internet service providers. Full model schema and possible values are available at '/dsp/v1/dictionaries/internetServiceProviders' endpoint.

Selecting this rule allows targeting users by the internet service provider they are using.

TechnicalUser does not use Internet service provider

$type:"DoesNotUseIspTargetingRule",

ISPs:[]

  • ISPs - Internet service providers. Full model schema and possible values are available at '/dsp/v1/dictionaries/internetServiceProviders' endpoint.

Selecting this rule allows targeting users by the internet service provider they are not using

TechnicalConnection type

$type:"ConnectionTypeTargetingRule",

Mode:int,

Types:[],

SubTypes:[]

  • Mode - inclusion mode. Includes/excludes specified connection types. Available values: 0 - Include, 1 - Exclude.
  • Types - array of connection types. Available values: 0 - Unknown, 1 - Mobile, 2 - Wifi.
  • SubTypes - array of mobile connection subtypes. Available values: 1 - Mobile 2G, 2 - Mobile 3G, 3 - Mobile 4G.

Enables targeting of users who use/do not use specified connection type.

Geo & CultureUser uses language

$type:"UsesLanguageTargetingRule",

Languages:[]

  • Languages - Full model schema and possible values are available at '/dsp/v1/dictionaries/languages' endpoint.

Selecting this rule allows targeting users according to the language of their browser.

Geo & CultureUser does not use language

$type:"DoesNotUseLanguageTargetingRule",

Languages:[]

  • Languages - Full model schema and possible values are available at '/dsp/v1/dictionaries/languages' endpoint.

Selecting this rule allows targeting users according to the language of their browser.

Geo & CultureUser is from location

$type:"FromLocationTargetingRule",

Locations:[],

ZipCodes:[]

  • Locations - list of locations. Full model schema and possible values are available at '/dsp/v1/dictionaries/locations' endpoint.

! Enables targeting of users located in specified countries, cities or regions.

Geo & CultureUser is not from location

$type:"NotFromLocationTargetingRule",

Locations:[],

ZipCodes:[]

  • Locations - list of locations. Full model schema and possible values are available at '/dsp/v1/dictionaries/locations' endpoint.

Enables targeting of users that are not located in specified countries, cities or regions

Geo & CultureHyperlocal targeting

$type:"HyperlocalTargetingRule",

Mode:int,

Locations:[]

  • Mode - inclusion mode. Available values: 0 - Include. Exclusion is not supported yet.
  • Locations - array of hyperlocation objects. Hyperlocation object schema:
    • Longitude: float
    • Latitude: float
    • Radius: int (meters)
    • Address: string(optional)
    • Notes: string(optional)
    • Type: int (Available values: 0 - Coordinates, 1 - Address)

Enables targeting of users who use devices in specified areas.

Help

Still have questions?

If you can't find an answer to your question here, email our Support team