Profile Service
A profile is a set of targeting parameters, such as gender, age, geography, and frequency. It can be applied to several objects in the system, most of which are listed below. The most common use of the profile service is to run a campaign; you create a profile and then associate it with the Campaign Service. The campaign object includes fields such as flight dates and associated creatives.
- Except for segment targeting, parameters are absolute. For example, if the geographical target is set only to the United States, ONLY U.S.-based impressions will receive bids.
- Segment targeting uses and/or Boolean logic.
- Profiles must be associated with either an advertiser or a publisher, in order to be used with several other objects in the system, listed below.
Profiles can be used with several other objects in the system (listed below). Any fields in the profile that do not apply to the associated object will be ignored.
- Advertiser
- Line Item
- Creative
- Campaign
- Payment Rule
- Ad Quality Rule
It is also possible to refer to a profile within a deal object, while it is not necessary for the profile to be associated to an advertiser or publisher.
REST API
Add a new profile:
Modify an existing profile:
View all of the profiles for one of your advertisers:
View a specific profile for one of your advertisers:
To use this service for publisher profiles, replace advertiser_id
with publisher_id
.
JSON Fields
General
Field | Type | Description | Default | Required On |
---|---|---|---|---|
| int | The ID of the profile. | PUT, in query string | |
| string | A custom code for the profile. | ||
| string | Optional description. | ||
| Boolean | If true, the profile has been saved as a targeting template in the UI. To get profiles that are targeting templates in the UI, pass | false | |
| timestamp | Time of last modification to this profile. | ||
is_archived | boolean | Read-only. Indicates whether the profile has been automatically archived due to it's parent line item not being used (and therefore, having been archived). Once set to If a profile's parent line item or campaign is automatically archived, the profile will also be archived. In addition, once archived, the profile may not be associated with any line items or campaigns. | false | |
archived_on | timestamp | Read-only. The date and time on which the profile was archived (i.e., when the is_archived field was set to true ). | null |
Frequency
For details on Frequency and Recency Targeting and the below fields, please click here.
Field | Type | Description | Default | Required On |
---|---|---|---|---|
| int | The maximum number of impressions per person. If set, this value must be between 0 and 255. | null | |
| int | The minimum number of impressions per person per session. If set, this value must be between 0 and 255. | null | |
| int | The maximum number of impressions per person per session. If set, this value must be between 0 and 255. | null | |
| int | The maximum number of impressions per person per day. If set, this value must be between 0 and 255. | null | |
max_hour_imps | int | The maximum number of impressions per person per hour. If set, this value must be between 0 and 255. | null | |
max_week_imps | int | The maximum number of impressions per person per week. If set, this value must be between 0 and 255. | null | |
max_month_imps | int | The maximum number of impressions per person per month. If set, this value must be between 0 and 255. | null | |
| int | The minimum number of minutes between impressions per person. This field may not be set to | null | |
| int | The maximum number of impressions per page load from a single advertiser. Only applies to mtj ad calls (Customer login required). | null | |
require_cookie_for_freq_cap | Boolean | Indicates whether you want to serve only to users who use cookies, in order to maintain your frequency cap settings (because we cannot track the number of impressions without cookies). true indicates you will not serve to non-cookie users, thus maintaining the frequency settings. false indicates you will serve to non-cookie users and ignore the frequency cap settings for those users. Because this flag is only enforced when a frequency cap has been set, setting true will not require cookies for an object that has no frequency cap. | true |
Targeting
When multiple targets are set, only inventory that satisfies all targeting criteria is eligible. For example, if you target intended audience general
and inventory sources x, y, and z, then the profile will only target general
audience inventory from inventory sources x, y, and z. Note that you may not specify both the segment_targets
and segment_group_targets
fields in any POST
or PUT
calls (only one of the two may be specified).
Please be aware that some targets accept an array of objects rather than integers or strings. The format can be found in the examples at the bottom of this page.
For Programmatic Guaranteed Buying Line Items:
- You can only target one deal target (see Deal Targets below) and the
allow_unaudited
field must be set totrue
. - Do not set any other targeting fields.
Field | Type | Description | Default | Required On |
---|---|---|---|---|
| string | The timezone to be used with the daypart_targets. For more details, see API Timezones. Note that |
| |
| array of objects | The day parts during which to serve the campaign. See Daypart Targets below for more details. Note that if you do not set any daypart targets, the campaign will serve on all days of the week at all times. | ||
| array of objects | If you use The segment IDs to target, each of which has an associated action ( | ||
| array of objects | The segment groups to target. Whereas the Null segments cannot be added You may not add | ||
| enum | If using segment_targets, this defines the Boolean logic between the segments specified. If using segment_group_targets, this defines the Boolean logic between the segment groups (the Boolean logic between segments in a group is defined directly in the segment_group_targets array). Possible values: |
| |
| array of objects | The list of age ranges to target for this profile. The | ||
| object | The gender targeting used for the profile. Possible values for | ||
| array of objects | The country IDs to be either excluded or included in a profile, as defined by the | POST/PUT, when | |
| enum | Action to be taken on the |
| |
| array of objects | The region/state IDs to be either excluded or included in a profile, as defined by the | POST/PUT, when | |
| enum | Action to be taken on the |
| |
| array of objects | The IDs of designated market areas to be either excluded or included in a profile, as defined by the | ||
| enum | Action to be taken on the |
| |
| array of objects | The IDs of cities to be either included or excluded in a profile, as defined by the | POST/PUT, when | |
| enum | Action to be taken on the |
| |
| array of objects | List of domains to be either included or excluded in a profile, as defined by the | ||
| enum | Action to be taken on the |
| |
| array of objects | The IDs of domains lists to either include or exclude in a profile, as defined by the | ||
| enum | Action to be taken on the |
| |
| array of objects | RTB or other Networks' inventory you can target. You can use Inventory Resold or Reporting services to find platform placements. | ||
| array of objects | List of eligible sizes to be included in the profile. The sizes are in an array size objects, each object containing the width and height of each target size: When you enable roadblocking on a guaranteed line item, this value is combined with creative sizes on the line item and campaign to produce forecasting. The size with the lowest forecasted number of impressions will be returned as the forecasted capacity. | ||
seller_member_group_targets | array of objects | The seller member groups to be excluded or included in a profile. To target Xandr's direct supply, the format is: | ||
| array of objects | Seller member IDs to be either excluded or included in a profile. The specific format can be found in the example at the bottom of the page. | ||
| enum | Deprecated | null | |
video_targets
| object | Video target IDs to be included in a profile. See Video Targets below for the specific format. | ||
engagement_rate_targets | array of objects | Target specific, highly performant inventory based on historic performance. See Engagement Rate Targets below for details. | null | |
| array of objects | Managed/direct publisher IDs to be either excluded or included in a profile. The specific format can be found in the example at the bottom of the page. | ||
| array of objects | The sites IDs to be either excluded or included in a profile. Exclude or include is inherited from the | If you do not provide action with site_targets, action will default to NULL and profile.inventory_action will be used. | |
| array of objects | The placement IDs to be either excluded or included in a profile. Exclude or include is inherited from the | If you do not provide action with placement_targets, action will default to NULL and profile.inventory_action will be used. | |
| enum | Action to be taken on the |
| |
| object with string and array | The content categories to target for this profile as well as whether to allow unknown categories. See Content Category Targets below for more details and format. To retrieve content category IDs, use the Content Category Service. | ||
| array of objects | The deal IDs to be targeted by this profile. A deal is an agreement between a seller and buyer that may provide the buyer preferential pricing, access to exclusive inventory, reduced competition on inventory, or other opportunities. See Deal Targets below for more details and format. See Targeting Results for deal_action_include AND deal_targets Fields for more information on how the value of this field and the | ||
| array of objects | Third party publisher IDs to be either excluded or included in a profile. See the Inventory Resold Service for a list of IDs. | ||
| array of objects | List of network resold content categories to target for this profile. See the Inventory Resold Service for a list of IDs. | ||
| Boolean | If |
| |
| enum | Indicates the level of audit which inventory must meet in order to be eligible. Possible values: |
| |
| Boolean | If This setting overrides the seller trust settings in the For Programmatic Guaranteed Buying Line Items, |
| |
| enum | Indicates how the number of impressions seen by the user are counted during the current browsing session. Possible values: |
| |
| array of objects | The IDs of inventory attributes to target for this profile. You can use the Inventory Attribute Service to retrieve a list of IDs. | ||
| array of strings | The intended audience targets. Possible values: Example: To use the intended audience targeting, | ||
| array of objects | The IDs of the browser languages to either include or exclude in the profile, as defined by the | ||
| enum | Action to be taken on |
| |
| array of objects | The query string targets to either include or exclude in the profile, as defined by the | ||
| enum | Action to be taken on the |
| |
| enum | Boolean logic to be applied to the |
| |
postal_code_targets
| array of objects | The postal code IDs to target. For example: IDs can be fetched using the Postal Code Service. | ||
| array of objects | Deprecated. Use
| ||
| array of strings | The type(s) of supply to either include in or exclude from targeting, as defined by the Note: The | ||
| enum | Supply types are |
| |
| object | Every user is randomly assigned to 1 of 100 user groups, no group holding any advantage over another. You can use this field to target a specific range of these user groups. Also, you can use the The most common use for user group targets is defining user groups for A/B testing (customer login required) of campaign targeting strategies. Here's how it works: You set test user group targets in one profile and control user group targets in another. Then you apply the user group label to each affected campaign, using the label to identify the user group as test or control (see the | ||
position_targets | object | The fold positions to target. See Position Targets below for more details. | ||
| array of objects | The IDs of browsers to either include in or exclude from your targeting, as defined by the | ||
| enum | Action to be taken on the |
| |
| double | The latitude of the user's location. This must be between -90 and 90, with up to 6 decimal places, where south is negative and north is positive. A profile can be targeted to a specific location when GPS data is available from a mobile device. When lat/long targeting is set, users will only be targeted within the area defined by the center ( | ||
| double | The longitude of the user's location. This must be between -180 and 180, with up to 6 decimal places, where west is negative and east is positive. A profile can be targeted to a specific location when GPS data is available from a mobile device. When lat/long targeting is set, users will only be targeted within the area defined by the center ( | ||
| integer length in meters | See | ||
| array of objects | The models of mobile devices (i.e., iPhone) to either include in or exclude from your targeting, as defined by the | ||
| enum | Action to be taken on |
| |
| array of strings | The types of devices to either include in or exclude from your targeting, as defined by the Possible values:
See Device Type Targets below for format. | ||
| enum | Action to be taken on |
| |
| array of objects | The mobile carriers to either include in or exclude from your targeting, as defined by the | ||
| enum | Action to be taken on the |
| |
inventory_url_list_targets | array of objects | Contains a list of inventory list IDs (whitelists and/or blacklists). Used to attach a single whitelist and/or one or more blacklists to the profile.
See Inventory Lists for more details. | ||
| array of objects | The operating systems as a whole (e.g., Android, Apple iOS, Windows 7, etc.) to either include in or exclude from your targeting, as defined by the | ||
| enum | Action to be taken on |
| |
| Boolean | Read-only. If By default, newer profiles will have this field set to There is no way to update an older profile (or its duplicates) to set this field to |
| |
| array of objects | The list of specific operating systems to either include in or exclude from your targeting. Note that this array is used to target specific operating system versions, whereas This field will be respected only if | ||
| enum | Deprecated. Please use | "exclude" | |
| array of objects | Deprecated. Please use | ||
mobile_app_instance_targets | array of objects | A list of mobile app instances that you'd like to include or exclude from targeting. For field definitions, see Mobile App Instance Targets below. For more details about what mobile app instances are and how they work, see the Mobile App Instance Service. | ||
mobile_app_instance_action_include | Boolean | Whether to include the mobile app instances defined in mobile_app_instance_targets in your campaign targeting. | false | |
mobile_app_instance_list_targets | array of objects | This list contains mobile app instance lists (in other words, it's a list of lists). For field definitions, see Mobile App Instance List Targets below. For more information about mobile app instance lists are and how they work, see the Mobile App Instance List Service. | ||
mobile_app_instance_list_action_include | Boolean | Whether to include the mobile app instance lists defined in mobile_app_instance_list_targets in your campaign targeting. | false | |
deal_action_include | Boolean | Whether to include or exclude deals in campaign and/or line item targeting. When set to To target or exclude deals, in addition to setting this field to
See Targeting Results for deal_action_include AND deal_targets Fields for more information on how the value of this field and the | true | |
ip_range_list_targets | array of objects | A list of IP address ranges to be included or excluded from campaign targeting. For more information, see IP Range List Targets below, as well as the documentation for the IP Range List Service. | ||
key_value_targets | array of objects | A list of custom key/value targets. For details and examples, see Key Value Targets below.
| ||
ad_slot_position_action_include | Boolean | Intent to target specific slots in an ad pod. Note that you can target ad slots or ad bumpers, but not both. | false | |
ad_slot_position_targets | array of ints | The ad slot positions a buyer wants to serve on. -1 represents the last position, 0 represents the first. By default when ad_slot_position_action_include is set to false, an empty array means spending can happen on any position. Set ad_slot_position_action_include to true first if you want to use ad_slot_position_targets to specify positions to target. | empty array | |
ad_slot_intro_bumper_action_include | Boolean | This controls if the creative will target video intro positions for VAST video auctions. The default is | true | |
ad_slot_outro_bumper_action_include | Boolean | This controls if the creative will target video outro positions for VAST video auctions. The default is | true | |
screen_size_action
| string | Deprecated. | "exclude" | |
screen_size_targets
| array of objects | Deprecated. | ||
optimization_zone_action
| string | Not currently supported. | "exclude" | |
optimization_zone_targets
| array of objects | Not currently supported. | ||
created_on
| timestamp | Read-only. The date and time when the profile was created. | ||
is_expired
| Boolean | Read-only. If true, the object associated with the profile is expired. This field is only for internal purposes. | false | |
inventory_network_resold_targets
| array of objects | Deprecated. | ||
exelate_targets
| array of objects | Deprecated. | ||
inventory_url_whitelist_settings | object | This object contains fields used to determine how whitelists are applied to line item buying. See Inventory URL Whitelist Settings. | ||
ads_txt_authorized_only | Boolean | When The | false |
Targeting Results for deal_action_include
AND deal_targets
Fields
The following targeting results occur for these values of the deal_action_include
AND deal_targets
fields:
|
| Targeting Result |
---|---|---|
|
| Target no deals |
|
| Target all deals |
| Contains deal targets | Include these deals in targeting |
false | Contains deal targets | Exclude these deals in targeting |
Mobile App Instance Targets
For more information about mobile app instances, including instructions on adding them to your profile, see the Mobile App Instance Service.
Field | Type | Description |
---|---|---|
| int | The unique ID of the mobile app instance. |
| string | The bundle ID of this mobile app instance. |
| int | The OS family ID associated with this mobile app instance. |
Mobile App Instance List Targets
For more information about mobile app instance lists, including instructions on adding them to your profile, see the Mobile App Instance List Service.
Field | Type | Description |
---|---|---|
| int | The unique ID of the mobile app instance list. |
| string | The name of this mobile app instance list. |
| string | An optional description of the list's purpose or contents. |
Daypart Targets
Each object in the daypart_targets array includes the following fields. See the View a profile example below for formatting.
Field | Type | Description |
---|---|---|
| enum | The day of the week. Possible values: |
| int | The start hour for the daypart. This must be an integer between 0 and 23. The campaign will start serving at the beginning of the hour (6 is equivalent to "6:00" am). |
| int | The end hour for the daypart. This must be an integer between 0 and 23. The campaign will stop serving at the end of the hour (23 is equivalent to "23:59"). |
Segment Targets
You define the Boolean logic between segments with segment_boolean_operator
field outside of the array. If segment_boolean_operator
is AND
, then the profile will only target users that satisfy all segment targets. If the segment_boolean_operator
is OR
, then the profile will target users that satisfy any of the specified segments. For detailed guidance on Boolean logic for segment targeting, see Segment Targeting (Customer login required).
Field | Type | Description | Default | Required On |
---|---|---|---|---|
| int | The ID of the segment. | POST | |
| string | The custom code for the segment. | ||
| enum | Possible values: |
| |
| int | The lower bound for the amount of time since a user was added to the segment. |
| |
| int | The upper bound for the amount of time since a user was added to the segment. |
| |
| int | The exact segment value to target. Note: If you use other_in_list, you cannot use this field. | null | |
| int | The non-inclusive upper bound for segment value targeting. | null | |
| int | The non-inclusive lower bound for segment value targeting | null | |
| array | The list of segment values to target. Note: If you use other_equals, you cannot use this field. | null |
For other_equals
, other_less
, other_greater
, and other_in_list
, the segment value can be an "other" value passed by the segment pixel (customer login required) or can be related to segment query string values (see the "querystring_mapped" field in the Segment Service). For examples of how to target query string values in a segment, see other examples below.
Example
In this example, since the segment_boolean_operator
is AND
, the profile will target only users that fit in both segment 86 and segment 202.
Segment Group Targets
Each segment group object contains the following fields. Note that you define the Boolean logic between groups with the segment_boolean_operator
field outside of the array, and you define the Boolean logic between segments in a group with the boolean_operator
field within the group object. See the example below for formatting and for an example of the logic of combining segment_boolean_operator
and boolean_operator
. For detailed guidance on Boolean logic for segment targeting, see Segment Targeting (Customer login required).
Null segments cannot be added
You may not add null
segments to this array via POST
or PUT
.
Field | Type | Description | Default | Required On |
---|---|---|---|---|
boolean_operator | enum | The Boolean logic between segments in a segment group. Possible values: |
| POST |
id | int | The ID of the segment. | POST | |
code | string | The custom code for the segment. | ||
action | enum | Possible values: |
| |
start_minutes | int | The lower bound for the amount of time since a user was added to the segment. |
| |
expire_minutes | int | The upper bound for the amount of time since a user was added to the segment. |
| |
other_equals | string | The exact segment value to target. Note: If you use other_in_list, you cannot use this field. | null | |
other_less | int | The non-inclusive upper bound for segment value targeting. | null | |
other_greater | int | The non-inclusive lower bound for segment value targeting | null | |
other_in_list | array | The list of segment values to target. Note: If you use other_equals, you cannot use this field. | null |
For other_equals, other_less, other_greater, and other_in_list, the segment value can be an "other" value passed by the segment pixel (customer login required) or can be related to segment query string values (see the "querystring_mapped" field in the Segment Service). For examples of how to target query string values in a segment, see other examples below.
Example
In this example, since the segment_boolean_operator
is OR
and the boolean_operator
for each group is AND
, the profile will target only users that fit in both segment 11 and segment 22 or both segment 33 and segment 44.
Age Targets
Field | Type | Description | Default | Required On |
---|---|---|---|---|
allow_unknown | Boolean | Determines whether to include targets where age is not know. | False | |
ages | array of objects | The age ranges targeted in this profile. |
ages object:
Field | Type | Description |
---|---|---|
low | int | The lower bound of the age range (min 13). |
high | int | The upper bound of the age range (max 100). |
Example:
Gender Targets
The gender_targets
object contains the following fields.
Field | Type | Description | Default | Required On |
---|---|---|---|---|
gender | enum | The gender of the user. Possible values: | null | POST |
allow_unknown | Boolean | If true , target ad calls where the gender of the user is not available. | false |
Country Targets
Each object in the country_targets
array contains the following fields.
Field | Type | Description |
---|---|---|
id | int | The ID of the country. You can use the Country Service to retrieve a complete list of country IDs. |
name | string | Read-only. The name of the country. |
code | string | Read-only. The code for the country. |
Example
Region Targets
Each object in the region_targets
array contains the following fields.
Field | Type | Description |
---|---|---|
id | int | The ID of the region. You can use the Region Service to retrieve a list of region IDs. |
name | string | Read-only. The name of the region. |
code | string | Read-only. The code for the region. |
country_name | string | Read-only. The name of the country to which the region belongs. |
country_code | string | Read-only. The code for the country to which the region belongs. |
Example
City Targets
Each object in the city_targets
array contains the following fields.
Field | Type | Description |
---|---|---|
id | int | The ID of the city to target. You can use the City Service to retrieve a list of city IDs. |
name | int | Read-only. The name of the city to target. |
region_name | string | Read-only. The name of the region to which the city belongs. |
region_code | string | Read-only. The code of the region to which the city belongs. |
country_name | enum | Read-only. The name of the country to which the region belongs. |
country_code | enum | Read-only. The code of the country to which the region belongs. |
Example
Inventory Lists
Each object in the inventory_url_list_targets
array includes the following fields.
Field | Type | Description | Required on |
---|---|---|---|
deleted | Boolean | Read-only. Indicates whether the inventory list has been deleted. | |
| int | The ID of the whitelist or blacklist to be applied.
| POST , PUT |
list_type | string | Read-only. Denotes whether the list is a blacklist or whitelist. Valid values are The | |
name | string | Read-only. Name of the whitelist or blacklist. | |
exclude | Boolean | If true , the inventory list will be excluded from targeting (i.e., treated as a blacklist). If false , the inventory list will be included in targeting (i.e., treated as a whitelist). |
Example
Content Category Targets
The content_category_targets
object includes the allow_unknown
field, which is a Boolean, and the content_category
array. Each object in the content_category
array contains the following fields.
Field | Type | Description | Default | Required On |
---|---|---|---|---|
id | int | The ID of the content category to target. | null | POST |
action | num | The action to take for this content category. Possible values: |
|
Example
Video Targets
The video_targets
object contains the allow_unknown_playback_method
, allow_unknown_context
, allow_unknown_player_size
fields and the
playback_methods
,
contexts
,
player_sizes
arrays.
Field | Type | Description | Default |
---|---|---|---|
| Boolean | Use this field to target inventory where the playback method is unknown. Set this field to If you are not targeting specific playback methods, this field will have no effect on targeting. | false |
| Boolean | Use this field to target inventory where the context is unknown. Set this field to If you are not targeting specific contexts, this field will have no effect on targeting. | false |
allow_unknown_player_size
| Boolean | Use this field to target inventory where the player size is unknown. Set this field to If you are not targeting specific player sizes, this field will have no effect on targeting. | false |
When you do NOT set any specific video targeting options, you will target all inventory, including undefined inventory.
Ensure that you have elected to include or exclude intro and outro creatives by setting them in the ad_slot_intro_bumper_action_include
and ad_slot_outro_bumper_action_include
fields.
Contexts
Contexts
The default value is an empty array, and will target any roll position. The contexts
array contains objects with the following fields:
Field | Type | Description |
---|---|---|
id | int | The ID of the context. Possible values:
|
name | string | Read-only. Possible values: |
Playback Methods
The default value is an empty array, and will target any playback method. The playback_methods
array contains the following fields:
Field | Type | Description |
---|---|---|
id | int | The ID of the playback method. Possible values:
|
name | string | Read-only. Possible values: |
Player Sizes
The default value is an empty array, and will target any player size. The player_sizes
array contains objects with the following fields:
Field | Type | Description |
---|---|---|
id | int | The ID of the player size. Possible values:
|
name | string | Read-only. Possible values: |
min_width | int | Read-only. The minimum width of the player, in pixels. |
max_width | int | Read-only. The maximum width of the player, in pixels. |
Example
Engagement Rate Targets
The engagement_rate_targets
array of objects is used to target specific, highly performant inventory based on historic performance. You can use targeting criteria to purchase either video inventory with a high completion rate, or highly viewable inventory, by specifying the desired video completion rate or viewability rate.
Field | Type | Description |
---|---|---|
engagement_rate_type | enum | The targeting criteria. Possible values:
|
engagement_rate_pct | int | Possible values: 1 - 100. |
Deal Targets
Each object in the deal_targets
array contains the following fields.
To target or exclude deals, in addition to setting the fields within this array as needed, you must also:
- Set the
deal_action_include
field totrue
orfalse
(depending on inclusion or exclusion) - When using ALIs, set the
deals
field totrue
within thesupply_strategies
array of the Line Item Service - Programmatic Guaranteed Buying Line Items can only have one deal target in the
deal_targets
array.
Field | Type | Description |
---|---|---|
id | int | The ID of the deal. To retrieve the IDs of your deals, use the Deal Buyer Access Service. |
name | string | Read-only. The name of the deal. |
code | string | Read-only. The custom code for the deal. For deals with external supply partners, this is generally the string that you will use to identify the deal. |
Example
Position Targets
The position_targets
object contains the following fields.
Field | Type | Description | Default |
---|---|---|---|
allow_unknown | Boolean | If true, the profile will target placements for which the fold position is not known. | false |
positions | array of objects | The fold positions to target. Possible values: "above" or "below". |
Example
Device Model Targets
Each object in the device_model_targets
array contains the following fields.
To retrieve the IDs of device models registered in our system, use the Device Model Service.
Field | Type | Description |
---|---|---|
id | int | The ID of the device model. |
name | string | Read-only. The name of the device model, i.e., |
Example
Device Type Targets
The device_type_targets
array can contain one or more of the following strings:
phone
tablet
pc
tv
gameconsole
stb
Example
Carrier Targets
Each object in the carrier_targets
array contains the following fields.
To retrieve the IDs of mobile carriers registered in our system, use the Carrier Service.
The ability to target by carrier refers to the fact that you can target devices currently using that carrier's network. You are not able to target subscribers of the network.
For example, a Verizon iPhone using a 4G network can be targeted as Verizon when on 4G, but not when the user is connected to their home wifi.
Field | Type | Description |
---|---|---|
id | int | The ID of the mobile carrier. |
name | string | Read-only. The name of the mobile carrier. |
country | enum | Read-only. The ISO code for the country in which the carrier operates. |
Example
IP Range List Targets
For more information about IP range lists, see the IP Range List Service .
Per profile, you can target up to 10 "include" IP range lists (include
set to true
in the IP range list) and no more than 1 "exclude" IP range list (include
set to false
in the IP range list). The excluded IP ranges must be a subset of the included IP ranges.
Field | Type | Description |
---|---|---|
id | int | The unique ID of this IP range list. |
name | string | Read-only. The name of this IP range list. |
include | Boolean | Read-only. Whether to include or exclude the IP ranges in the IP range list. This is defined in the IP range list itself, not in the profile |
description | string | Read-only. An optional description of the list's purpose or contents. |
Operating System Extended Targets
The operating_system_extended_targets
array specifies operating system versions (e.g., Android 3.x, Apple iOS 6, etc.) to either include in or exclude from your targeting. Note that this array is used to target specific operating system versions, whereas operating_system_family_targets
is used to target all versions of operating systems.
OS Family Targets and OS Extended Targets Work Together
The OS Family and OS Extended Targets are most effective when used together. For examples of how to use their combined targeting capabilities, see the example Use OS Family Targets and OS Extended Targets together below.
To use operating_system_extended_targets
, you must set use_operating_system_extended_targeting
to true
. Once a profile is created using the operating_system_extended_targets
, you will not be allowed to set use_operating_system_extended_targeting
to false
or populate the operating_system_targets
fields on PUT.
Each object in the operating_system_extended_targets
array contains the following fields.
Field | Type | Description |
---|---|---|
id | int | The ID of the operating system version. To retrieve the IDs of operating system versions registered in our system, use the Operating System Extended Service . |
name | string | Read-only. The name of the operating system version, e.g., |
action | enum | Action to be taken on |
Example
Operating System Family Targets
The operating_system_family_targets
array specifies the operating systems as a whole (e.g., Android, Apple iOS, Windows 7, etc.) to either include in or exclude from your targeting, as defined by the operating_system_family_action
field. Note that this field is used to target all versions of operating systems, whereas operating_system_targets
is used to target specific versions of operating systems.
OS Family Targets and OS Extended Targets Work Together
The OS Family and OS Extended Targets are most effective when used together. For examples of how to use their combined targeting capabilities, see the example Use OS Family Targets and OS Extended Targets together below.
Each object in the operating_system_family_targets
array contains the following fields.
Field | Type | Description |
---|---|---|
id | int | The ID of the operating system family. To retrieve the IDs of operating system families registered in our system, use the Operating System Family Service . |
name | string | Read-only. The name of the operating system family, i.e., |
Example
Key Value Targets
The key_value_targets field defines the combination of custom keys and values that are targeted in this profile. The field is a parsed version of a logical expression.
You can find more information on how key value targeting works and details on how to parse out expressions for the profile service at Custom Key Value Targeting .
key_value_targets object
Field | Type | Description |
---|---|---|
kv_expression | object | This is a wrapper object that contains all the key/value targeting objects, including the header and exp objects. |
Field | Type | Description |
---|---|---|
header | object | Versioning information used to evaluate the expression. |
exp | object | The regular expression that defines the combination of key/values. |
header object
Field | Type | Value | Description |
---|---|---|---|
an_version | string | 1.0 | The version of the back-end engine evaluating the expression. Current version is 1.0. This field is required on PUT and POST. |
client_version | string | 1.0 | The version of the client-facing implementation of the expression (the format shown in the example below). Current version is 1.0. This field is required on PUT and POST. |
exp object
Field | Type | Description |
---|---|---|
typ | string | The operators used in the expression. Possible values include:
The operators and, or, and not can be used only with sub-expressions. The operators gt, lt, gte and lte can be used only with numeric values. All operators must be lowercase. |
sbe | exp object | An object containing the sub-expression (the elements of the expression). |
key | string | The name of the targeting key |
vtp | type | This field identifies the data type of the expression value. The value you enter in this field must match the field and type of the corresponding value field. The following values are valid:
|
vnm | numeric value | The value as a 32-bit signed float (for example, 25.3). Numbers can be up to 13 digits (with a maximum of six digits to the right of the decimal point). |
vst | string | The value as a string. |
vna | array of numeric values | A set of values as an array of floats. |
vsa | array of strings | A set of values as an array of strings. |
Example
Inventory URL Whitlist Settings
The fields in this object are used to set how whitelists attached to a line item will be applied. All whitelists will be applied to RTB buying by default. You can additionally choose to apply the whitelists to Managed buying as well.
Field | Type | Description | Default |
---|---|---|---|
apply_to_managed | boolean | Designates whether the whitelist is to be applied to managed buying. If set to Set this field to | false |
apply_to_rtb | boolean | Read-only. All whitelists associated with the line item will be applied to RTB buying. | true |
Example
Examples
View a profile
Target a range of query string values
Target a list of query string values
Target an exact query string value
Target specific countries