Line Targeting

Overview

BrightRoll DSP allows you to set up lines in your campaigns to target exchanges, deals, locations, demographics, ad positions, frequency, audiences, devices, days of the week, apps, URLs, page relevancy, mobile carriers, and languages.

Supported Targeting Types

There are several ways to get a list of the supported Targeting Types.

  1. Refer to the table below.
  2. Check the current list on the Targeting Types page.
  3. Use the URL below to get a list via an API request.
GET https://api.admanagerplus.yahoo.com/traffic/dictionary/targetingTypes

The following table provides details on the available targeting types:

Targeting Type Description Display Video Native
FREQUENCY_CAPPING Set a limit on how frequently an ad is shown to a user within a specified time frame. Y Y N
AD_POSITION Target the location on a page that you want your display ads to appear. Y N N
DEMOGRAPHIC Reach your desired audience with age and gender targeting. Y Y Y
TECHNOLOGY Target users based on the technologies in their computing environment such as device type, operating system (desktop and mobile) and browser. Y Y Y
DAY_PARTING Choose the days and times your display or video ads should serve. Y Y N
AB_TESTING If you have created user groups for A/B testing, you can target those user groups to see the results of your testing. Y Y N
PLAYER_SIZE Enable targeting based on the player size. N Y N
AD_INITIATION For video ads, you can set the type of ad initiation you want to target (Auto Initiated, User Initiated, Unknown, or All). N Y N
LANGUAGES Target lines based on the language users most frequently view in their browsers. Advertisers can target or exclude specific languages. Y Y N
VIEWABILITY You can set hard viewability goals for display and video line items. When you set a viewability threshold for a line item, viewability takes precedence over line item delivery, and you can expect line items to achieve and maintain the viewability goal. Y Y N
INVENTORY_TYPE You can explicitly target web vs. in-app supply. Y Y Y
BOT Note: Only available via special role. Ensure your ads are properly represented and delivered to real people, rather than to bot traffic. Y Y N
EXCHANGES A line can target one or more exchanges or available private marketplace deals (but not both). Y Y N
CONTEXTUALS If you have created contextuals for an advertiser, you can set up targeting to serve or exclude ads based on the contextual. Y Y N
SITE_LISTS If you have set app lists and/or site lists to include and/or exclude apps and URLs, you can target those app lists and/or site lists. Y Y N
SEGMENT If you have created audiences or pixels (beacons), you can perform line item targeting using include and exclude conditions. Native lines can target audiences but not pixels. Y Y Y
MOBILE_PLACEMENT Target mobile users with Interstitial and (Coming soon) Rewarded ads. Y Y N
CONNECTION

You can target users based on how they are connected to the internet (wi-fi, cellular, or both). You can also target Internet Service Providers (ISPs) and Mobile Carriers, as follows

  • If you target wi-fi customers, you can also target users connected through particular ISPs.
  • If you target cellular users, you can also target users connected through particular mobile carriers.
  • If you target All connection types, you can target both ISPs and mobile carriers.

Important If you target both ISPs and mobile carriers, the targeting uses OR logic and targets a user who is connected through either an ISP or a mobile carrier you choose.

Y Y N
GEOGRAPHY Location targeting enables you to target specific geographical areas. You can target a country, state, city, Nielsen Designated Marketing Area (DMA), ZIP or postal code, or a geofencing location. Native lines can only target by Country/State/City/DMA. You can set up geofencing to target users within a specified radius of a given address. Y Y Y

Fields (Common)

Line Targeting payload contains the following fields:

Name Description Type Targeting Type
id ID of the line. integer N/A
genders

Genders targeted.

  • MALE
  • FEMALE
  • UNKNOWN
  • ALL
array DEMOGRAPHIC
ages

Age ranges targeted.

  • 18-20
  • 21-24
  • 25-34
  • 35-44
  • 45-49
  • 50-54
  • 55-64
  • 65+
  • UNKNOWN
  • ALL
array DEMOGRAPHIC
threshold Acceptable in-target audience composition percentage for video ads. This value threshold indicates the percentage of impressions that reach the intended demographic. Valid values: 20, 30, 40, 50, 60, 70, 80. Note This field is valid when campaign targeting verification vendor is not Yahoo. integer DEMOGRAPHIC
frequencyCapPeriod

Frequency capping interval.

  • MINUTES
  • HOURLY
  • DAILY
  • WEEKLY
  • UNLIMITED - no limit to the number of times the ad can be displayed.
text FREQUENCY_CAPPING
frequencyCapValue

Number of impressions allowed for the selected frequencyCapPeriod. If frequencyCapPeriod selected is:

  • UNLIMITED - Do not provide frequencyCapValue in the payload.
  • MINUTES - Max allowed limit for a minute is 5.
  • HOURLY - Max allowed limit for a hour is 10.
  • DAILY - Max allowed limit for a day is 20.
  • WEEKLY - Max allowed limit for a week is 140.
  • MONTHLY - Max allowed limit for a month is 600.
integer FREQUENCY_CAPPING
serveUnknownUser
  • true - serve to unknown users.
  • false - serving is limited to users known to Yahoo.
boolean FREQUENCY_CAPPING
dayParting

Specifies the days of the week and hours of the day targeted.

To learn more, see Day Parting Targeting.

object DAY_PARTING
languages

Languages targeted.

  • UNKNOWN
  • ENGLISH
  • CHINESE
  • SPANISH
  • JAPANESE
  • PORTUGUESE
  • GERMAN
  • ARABIC
  • FRENCH
  • RUSSIAN
  • KOREAN
  • DUTCH
  • SWEDISH
  • ITALIAN
  • INDONESIAN
  • ALL
array LANGUAGES
inventoryTypes

Inventory types targeted.

  • WEB
  • APP
array INVENTORY_TYPE
bots

Bot fraud prevention partner.

  • DOUBLE_VERIFY
  • IAS
array BOT
userGroupEntry User group entry. Refer to User Groups. Note: For POST, you need to supply only the id field, not the entire object. object AB_TESTING
deviceTypes

Device types targeted.

  • DESKTOP
  • PHONE
  • TABLET
  • UNKNOWN
  • ALL
array TECHNOLOGY
os

OS types targeted.

  • MAC
  • WINDOWS
  • LINUX
  • OTHER
  • ALL
array TECHNOLOGY
browsers

Browser types targeted. Note: deviceTypes must be set to DESKTOP in order to target browsers.

  • IE
  • CHROME
  • FIREFOX
  • SAFARI
  • EDGE
  • ALL
array TECHNOLOGY
mobileOs

Mobile OS types targeted. Note: deviceTypes must be set to PHONE or TABLET in order to target mobileOs.

  • IOS
  • ANDROID
  • WINDOWS
  • RIM
  • OTHER
  • ALL
array TECHNOLOGY
adInitiations

For video ads, the targeted ad initiations.

  • AUTOINITIATED - The video starts without any user action.
  • USERINITIATED - The video starts only when the user clicks Play.
  • UNKNOWN
  • ALL
array AD_INITIATION
positions

For display ads, the location on a page where the ads will appear.

  • ABOVE_FOLD - The ad serves on the top 50% of the page.
  • PARTIAL_VIEW - At least 25% of the ad is visible.
  • BELOW_FOLD - The ad serves on the bottom 50% of the page.
  • UNKNOWN - The ad serves in an unknown ad position.
  • ALL
array AD_POSITION
playerSizes

For video ads, BrightRoll DSP determines the player size based on the width and height (in pixels) contained in the bid request. BrightRoll DSP extracts the larger of the two, and assigns a player size accordingly.

  • SMALL - <350px.
  • MEDIUM - 350px to 500px
  • LARGE - >=500px
  • UNKNOWN
  • ALL
array PLAYER_SIZE
inviewThreshold Viewability rate threshold the line should achieve. Valid values: [1 - 100]. float VIEWABILITY
publishers Publishers/exchanges targeted. Refer to Exchanges. Note: For POST, you need to supply only the id values in an array, not the entire publisher object. Note: You can not target both publishers and deals at the same time. array EXCHANGES
mobileCarriers Mobile carriers targeted. Note: For POST, you need to supply only the id field. array CONNECTION
isps ISPs targeted. Note: For POST, you need to supply only the id field. array CONNECTION
types Targeting types enabled and disabled for the line. Refer to types. array N/A
mobilePlacements

For mobile ads, whether or not to target Interstitial and/or (Coming soon) Rewarded ads.

  • INTERSTITIAL - Full screen mobile ads.
  • REWARDED - (Coming soon) Incentitivized mobile ads.
array MOBILE_PLACEMENT

Fields (Read)

In addition to the Common fields, the following fields are valid when reading (GET) the line targeting:

Name Description Type Targeting Type
dealsIncluded Private marketplace deals targeted. Refer to Deals. array EXCHANGES
contextualsIncluded Targeted contextuals which are marked as Included. Refer to :doc:`/traffic/contextual. array CONTEXTUALS
contextualsExcluded Targeted contextuals which are marked as Excluded. Refer to /traffic/contextual. array CONTEXTUALS
siteListsIncluded Targeted site / app lists which are marked as Included. Refer to Site Lists. array SITE_LISTS
siteListsExcluded Targeted site / app lists which are marked as Excluded. Refer to Site Lists. array SITE_LISTS
geosIncluded Targeted geo locations which are marked as Included. Refer to Geo Payload. array GEOGRAPHY
geosExcluded Targeted geo locations which are marked as Excluded. Refer to Geo Payload. array GEOGRAPHY
geoFencingsIncluded Targeted geo fencing locations. Refer to Geo Fencings Payload. array GEOGRAPHY
segmentsIncluded Targeted segments which are marked as Included. Refer to Segments Payload. array SEGMENT
segmentsExcluded Targeted segments which are marked as Excluded. Refer to Segments Payload. array SEGMENT
beaconsIncluded Targeted beacons (pixels) which are marked as Included. Refer to Beacons Payload. array SEGMENT
beaconsExcluded Targeted beacons (pixels) are marked as Excluded. Refer to Beacons Payload. array SEGMENT

Fields (Write)

In addition to the Common fields, the following fields are valid when creating or updating (POST) the line targeting:

Name Description Type Targeting Type
deals Private marketplace deals to target. To create or update targeted deals, refer to Deals Payload. To retrieve deals available for targeting, refer to Read Targeting Deals. Note: You can not target both publishers and deals at the same time. array EXCHANGES
contextuals Contextuals targeted or excluded. To create or update targeted contextuals, refer to Contextuals Payload. To retrieve contextuals available for targeting, refer to Read Targeting Contextuals. array CONTEXTUALS
siteLists Site / App lists targeted or excluded. To create or update targeted site / app lists, refer to Site Lists Payload. To retrieve site / app lists available for targeting, refer to Read Targeting Site Lists. array SITE_LISTS
geos Geographic locations targeted or excluded. To create or update targeted geo locations, refer to Geos Payload. To retrieve geo locations available for targeting, refer to Read Targeting Geos. Note: You can not target both geo locations and geo fencing at the same time. array GEOGRAPHY
geoFencings Geographic fencing addresses to target. To create or update targeted geo fencing addresses, refer to Geo Fencings Payload. Note: You can not target both geo locations and geo fencing at the same time. array GEOGRAPHY
segments Segments (Audiences) targeted or excluded. To create or update targeted segments, refer to Segments Payload. To retrieve segments (audiences) available for targeting, refer to Read Targeting Segments. Note: You can target both segments and pixels at the same time. array SEGMENT
beacons Pixels (Beacons) targeted or excluded. To create or update targeted pixels, refer to Beacons Payload. To retrieve pixels (beacons) available for targeting, refer to Read Targeting Pixels. Note: You can target both segments and pixels at the same time. array SEGMENT

“types” Payload

When reading (GET) existing line targeting, the types payload object shows all the targeting types which are enabled for the line.

When creating or updating (POST) line targeting, the types payload object contains all the targeting types which are to be enabled or modified.

Name Description Type
id (Read Only) ID of the targeting type. integer
name Targeting type name. Refer to Targeting Types. text
isTargeted
  • true - Targeting is enabled for the type.
  • false - Targeting is disabled for the type.
boolean

Example Payload (Partial)

{
  "types": [
    {
      "id": 8,
      "isTargeted": true,
      "name": "DAY_PARTING"
    },
    {
      "id": 3,
      "isTargeted": true,
      "name": "AD_POSITION"
    }
  ]
}

“deals” Payload

The deals payload object used for creating or updating the targeted Deals contains the following fields:

Name Description Type
added Deal IDs to target. array
removed Deal IDs to be removed from targeting. array
clearAll

Indicates if all existing targeted deals should be removed.

  • true - Remove all targeted Deals. This will disable EXCHANGES targeting.
  • false - (Default Value) Do not remove any targeted Deals.
boolean

To retrieve the Deals available for targeting, refer to section Read Targeting Deals.

To see a sample for targeting a Deal, refer to Deals Example.

“contextuals” Payload

The contextuals payload object used for creating or updating the targeted Contextuals contains the following fields:

Name Description Type
addedDoubleVerify Double Verify Contextual IDs to target. array
addedIAB IAB Contextual IDs to target. Note: Must provide a value for excludeIAB to indicate if the contextuals shold be included or excluded. array
excludeIAB

Indicates if the added IAB Contextual IDs are to be excluded or included.

  • true - All IDs in the addedIAB field will be excluded from targeting.
  • false - All IDs in the addedIAB field will be included in targeting.
boolean
addedIASBrandSafety IAS Brand Safety Contextual IDs to target. array
addedIASMediaQuality IAS Media Quality Contextual IDs to target. Note: Must provide a value for excludeIASMediQuality to indicate if the contextuals shold be included or excluded. array
excludeIASMediaQuality

Indicates if the added IAS Media Quality Contextual IDs are to be excluded or included.

  • true - All IDs in the addedIASMediaQuality field will be excluded from targeting.
  • false - All IDs in the addedIASMediaQuality field will be included in targeting.
boolean
addedIASContextual IAS Contextual IDs to target. Note: Must provide a value for excludeIASContextual to indicate if the contextuals shold be included or excluded. array
excludeIASContextual

Indicates if the added IAS Contextual IDs are to be excluded or included.

  • true - All IDs in the addedIASContextual field will be excluded from targeting.
  • false - All IDs in the addedIASContextual field will be included in targeting.
boolean
removed Contextual IDs to be removed from targeting. array
clearAll

Indicates if all existing targeted contextuals should be removed.

  • true - Remove all targeted Contextuals. This will disable CONTEXTUALS targeting.
  • false - (Default Value) Do not remove any targeted Contextuals.
boolean

To retrieve the Contextuals available for targeting, refer to section Read Targeting Contextuals.

To see a sample for targeting a Contextual, refer to Contextuals Example.

“siteLists” Payload

The siteLists payload object used for creating or updating the targeted Site / App Lists contains the following fields:

Name Description Type
added

Site/App Lists to target. This is an array of objects containing the following fields:

  • entityId - ID of the Site / App List to be added.
  • excluded - Indicates if the added IDs are to be excluded or included. true: exclude from targeting; false - include in targeting.
array
removed Site & App List IDs to be removed from targeting. array
clearAll

Indicates if all existing targeted site / app lists should be removed.

  • true - Remove all targeted Site / App Lists. This will disable SITE_LISTS targeting.
  • false - (Default Value) Do not remove any targeted Site / App Lists.
boolean

To retrieve the Site / App Lists available for targeting, refer to section Read Targeting SiteLists.

To see a sample for targeting a Site / App List, refer to Site List Example.

“geosIncluded” & “geosExcluded” Payload

When you retrieve line targeting information, geosIncluded and geosExcluded fields contain the included and excluded geographic locations. Note the following fields of interest:

Name Description
id Unique ID of the location.
name Location name.
level

Type of location.

  • City
  • State
  • Country
  • Dma

Example Response (Partial)

{
  "geosIncluded": [
    {
      "id": "###15#nor",
      "name": "More Og Romsdal, Norway",
      "description": "more og romsdal",
      "level": "State",
      "key": "15, nor",
      "excluded": false
    }
  ],
  "geosExcluded": [
    {
      "id": "##callahan#fl#usa",
      "name": "Callahan, Florida",
      "description": "callahan, fl",
      "level": "City",
      "key": "callahan, florida",
      "excluded": true
    }
  ]
}

“geos” Payload

The geos payload object used for creating or updating the targeted Geographic locations contains the following fields:

Name Description Type
added

Geo locations to target. This is an array of objects containing the following required fields:

  • name - Name of the Geo location to be added.
  • excluded - Indicates if the added names are to be excluded or included. true: exclude from targeting; false - include in targeting.
array
removedNames Unique Geo location names to be removed from targeting. array
clearAll

Indicates if all existing targeted Geo locations should be removed.

  • true - Remove all targeted Geo locations. This will disable GEOGRAPHY targeting.
  • false - (Default Value) Do not remove any targeted Geo location.
boolean

To retrieve the Geographic locations available for targeting, refer to section Read Targeting Geos.

To see a sample for targeting a Geographic location, refer to Geos Example.

“geoFencingsIncluded” Payload

When you retrieve line targeting information, geoFencingsIncluded field contain the included geo fencing locations. Note the following fields of interest:

Name Description
id Geo fencing ID.
country Geo Fencing address country name.
location Geo Fencing location. This is the address.
radius Radius of the geo fence. This is how far away a user can be from each addresses and still be targeted.
radiusUnit

Distance unit of the radius.

  • MILES
  • FEET
  • METERS

Example Response (Partial)

{
  "geoFencingsIncluded": [
    {
      "id": 138745,
      "country": "United States",
      "location": "328 Lomita Dr, Stanford, CA 94305",
      "latitude": 37.43249,
      "longitude": -122.17034,
      "radius": 5,
      "radiusUnit": "MILES"
    },
    {
      "id": 138746,
      "country": "United States",
      "location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
      "latitude": 37.42307,
      "longitude": -122.08414,
      "radius": 5,
      "radiusUnit": "MILES"
    }
  ]
}

“geoFencings” Payload

The geoFencings payload object used for creating or updating the targeted Geo Fencing locations contains the following fields:

Name Description Type
added

Geo Fence addresses to target. This is an array of objects containing the following required fields:

  • location - Addresses to target for Geo Fencing. Geo fencing will target users whose current location is within the specified distance from this addresses. The address needs to be in the following format: [Number] Address City State Zip. Note that Zip code / Postal code is optional.
array
removed Geo Fencing IDs to be removed from targeting. array
clearAll

Indicates if all existing targeted Geo Fencing addresses should be removed.

  • true - Remove all targeted Geo Fencing addresses. This will disable GEOGRAPHY targeting.
  • false - (Default Value) Do not remove any targeted Geo Fencing addresses.
boolean
radius Radius of the Geo Fence. This is how far away a user can be from each addresses and still be targeted. integer
radiusUnit

Distance unit of the radius.

  • MILES
  • FEET
  • METERS
text

To see a sample for Geo Fence targeting, refer to Geo Fencing Example.

“mobileCarriers” Payload

The mobileCarriers payload object used for creating or updating the targeted Mobile Carriers contains the following fields:

Name Description Type
mobileCarriers Carrier IDs to target. array
isps ISP IDs to target. array

To see a sample for Mobile Carrier targeting, refer to Mobile Carrier Example.

“segmentsIncluded” & “segmentsExcluded” Payload

When you retrieve line targeting information, segmentsIncluded and segmentsExcluded fields contain the included and excluded segments (audiences). Note the following fields of interest:

Name Description
id Unique ID of the segment.
name Segment name.
recency The lookback window (in days) that BrightRoll DSP uses to determine if a pixel fire occurred.
reachCount Number of unique user in this segment.
createdAt Creation timestamp.
audienceType Indicates the source of audience: Yahoo, 1st Party, 3rd Party.
segmentType

Segment (audience) type.

Example Response (Partial)

{
  "segmentsIncluded": [
    {
      "id": "20703845",
      "name": "MB Test - HHI 75k+",
      "recency": 30,
      "createdAt": "2016-05-04",
      "audienceType": "3rd Party",
      "segmentType": "COMPOSITE",
      "reachCount": 133208561
    }
  ],
  "segmentsExcluded": [
    {
      "id": "50348744",
      "name": "FlyWheel Studio Test",
      "recency": 90,
      "createdAt": "2017-10-13",
      "audienceType": "3rd Party",
      "segmentType": "COMPOSITE",
      "reachCount": 610304932
    }
  ]
}

“segments” Payload

The segments payload object used for creating or updating the targeted Segments (Audiences) contains the following fields:

Name Description Type
added

Segments to target. This is an array of objects containing the following required fields:

  • entityId - ID of the Segment to be added.
  • excluded - Indicates if the added IDs are to be excluded or included. true: exclude from targeting; false - include in targeting.
array
edit

Existing Segments/Audiences to change. This is an array of objects containing the following fields:

  • entityId - ID of the Segment to be changed.
  • excluded - Indicates if the edited IDs are to be excluded or included. true: exclude from targeting; false - include in targeting.
array
removed Segment IDs to be removed from targeting. array
clearAll

Indicates if all existing Segments should be removed.

  • true - Remove all targeted Segments.
  • false - (Default Value) Do not remove any targeted Segments.
boolean

To retrieve the Segments (Audiences) available for targeting, refer to section Read Targeting Segments.

To see a sample for targeting a Segment, refer to Segments Example (Add) and Segments Example (Remove).

“beaconsIncluded” & “beaconsExcluded” Payload

When you retrieve line targeting information, beaconsIncluded and beaconsExcluded fields contain the included and excluded pixels (beacons). Note the following fields of interest:

Name Description
id Unique ID of the beacon.
name Beacon name.
recency The lookback window (in days) that BrightRoll DSP uses to determine if a pixel fire occurred.
frequency The number of times a pixel needs to fire for a particular user, for that user to be included in or excluded from the audience.

Example Response (Partial)

{
  "beaconsIncluded": [
    {
      "id": "6434432",
      "name": "deswebsite new0",
      "recency": 30,
      "frequency": 5
    }
  ],
  "beaconsExcluded": [
    {
      "id": "6436593",
      "name": "DesTest Website Int 0",
      "recency": 55,
      "frequency": 1
    }
  ]
}

“beacons” Payload

The beacons payload object used for creating or updating the targeted Beacons (Pixels) contains the following fields:

Name Description Type
added

Beacons/Pixels to target. This is an array of objects containing the following required fields:

  • entityId - ID of the Beacon to be added.
  • excluded - Indicates if the added IDs are to be excluded or included. true: exclude from targeting; false - include in targeting.
  • recency - The lookback window (in days) that BrightRoll DSP should use to determine if a pixel fire occurred.
  • frequency - The number of times a pixel needs to fire for a particular user, for that user to be included in or excluded from the audience.
array
edit

Existing Beacons/Pixels to change. This is an array of objects containing the following fields:

  • entityId - ID of the Beacon to be changed.
  • excluded - Indicates if the edited IDs are to be excluded or included. true: exclude from targeting; false - include in targeting.
  • recency - The lookback window (in days) that BrightRoll DSP should use to determine if a pixel fire occurred.
  • frequency - The number of times a pixel needs to fire for a particular user, for that user to be included in or excluded from the audience.
array
removed Beacon IDs to be removed from targeting. array
clearAll

Indicates if all existing Beacons should be removed.

  • true - Remove all targeted Beacons.
  • false - (Default Value) Do not remove any targeted Beacons.
boolean

To retrieve the Beacons (Pixels) available for targeting, refer to section Read Targeting Pixels.

To see a sample for targeting a Pixel, refer to Pixels Example (Add), Pixels Example (Edit) and Pixels Example (Remove).

Read Line Targeting

To retrieve targeting data for a specific line, make a GET call with the id parameter.

GET https://dspapi.admanagerplus.yahoo.com/traffic/lines/{id}/targeting
Name Description Type Required?
id Line ID integer Y

The response will be the Line Targeting associated with the given ID.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting

Example Response

{
  "response": {
    "types": [
      {
        "name": "GEOGRAPHY",
        "id": 4,
        "isTargeted": true
      },
      {
        "name": "PLAYER_SIZE",
        "id": 14,
        "isTargeted": true
      },
      {
        "name": "TARGET_VIEWABILITY",
        "id": 13,
        "isTargeted": false
      },
      {
        "name": "AD_INITIATION",
        "id": 15,
        "isTargeted": true
      },
      {
        "name": "VIEWABILITY",
        "id": 24,
        "isTargeted": true
      },
      {
        "name": "VIDEO_INVENTORY",
        "id": 25,
        "isTargeted": true
      },
      {
        "name": "DEMOGRAPHIC",
        "id": 6,
        "isTargeted": true
      },
      {
        "name": "FREQUENCY_CAPPING",
        "id": 1,
        "isTargeted": true
      },
      {
        "name": "AB_TESTING",
        "id": 10,
        "isTargeted": true
      },
      {
        "name": "SEGMENT",
        "id": 12,
        "isTargeted": true
      },
      {
        "name": "TECHNOLOGY",
        "id": 7,
        "isTargeted": true
      },
      {
        "name": "DAY_PARTING",
        "id": 8,
        "isTargeted": false
      },
      {
        "name": "ENHANCED_DAY_PARTING",
        "id": 27,
        "isTargeted": true
      },
      {
        "name": "SITE_LISTS",
        "id": 9,
        "isTargeted": true
      },
      {
        "name": "CONTEXTUALS",
        "id": 2,
        "isTargeted": true
      },
      {
        "name": "EXCHANGES",
        "id": 11,
        "isTargeted": true
      },
      {
        "name": "MOBILE",
        "id": 16,
        "isTargeted": true
      },
      {
        "name": "LANGUAGES",
        "id": 19,
        "isTargeted": true
      },
      {
        "name": "SEAT_LEVEL_SITE_LISTS",
        "id": 20,
        "isTargeted": true
      },
      {
        "name": "BOT",
        "id": 21,
        "isTargeted": true
      },
      {
        "name": "INVENTORY_TYPE",
        "id": 26,
        "isTargeted": true
      },
      {
        "name": "MOBILE_PLACEMENT",
        "id": 29,
        "isTargeted": true
      }
    ],
    "mobileCarriers":[
      1
    ],
    "isps":[
      115
    ],
    "genders": [
      "MALE",
      "FEMALE"
    ],
    "ages": [
      "55-64",
      "65+",
      "18-20",
      "21-24",
      "45-49",
      "50-54"
    ],
    "days": [
      "ALL"
    ],
    "deviceTypes": [
      "UNKNOWN",
      "TABLET"
    ],
    "os": [
      "ALL"
    ],
    "browsers": [
      "ALL"
    ],
    "mobileOs": [
      "ANDROID",
      "RIM"
    ],
    "mobileCarriers": [
      "Verizon"
    ],
    "isps": [
      "Colt Technology Services"
    ],
    "languages": [
      "ENGLISH",
      "GERMAN"
    ],
    "inventoryTypes": [
      "APP"
    ],
    "playerSizes": [
      "MEDIUM",
      "LARGE"
    ],
    "adInitiations": [
      "USERINITIATED"
    ],
    "bots": [
      "DOUBLE_VERIFY"
    ],
    "positions": [
      "ALL"
    ],
    "mobilePlacements": [
      "REWARDED",
      "INTERSTITIAL"
    ],
    "userGroupEntry": {
      "id": 32659,
      "name": "sg2",
      "userGroupId": 14962,
      "trafficPercent": 56,
      "lowerBound": 0,
      "upperBound": 55
    },
    "frequencyCapPeriod": "HOURLY",
    "contextualsIncluded": [
      {
        "taxonomyType": "IAB",
        "id": 43505,
        "accountId": 7987,
        "name": "iabtest5566",
        "updatedAt": "2017-08-01T22:08:52Z",
        "categories": [
          {
            "id": 132269,
            "categoryId": 107
          },
          {
            "id": 132270,
            "categoryId": 102
          }
        ]
      }
    ],
    "contextualsExcluded": [
      {
        "taxonomyType": "DOUBLE_VERIFY",
        "id": 43236,
        "accountId": 7987,
        "name": "contextual_update_test",
        "updatedAt": "2017-07-17T23:58:28Z",
        "categories": [
          {
            "id": 131535,
            "categoryId": 6
          },
          {
            "id": 131536,
            "categoryId": 9
          }
        ]
      }
    ],
    "siteListsIncluded": [
      {
        "status": "ACTIVE",
        "type": "SITE_LIST",
        "id": 47539,
        "name": "TestSiteList_1459797912042",
        "accountId": 318286,
        "isShared": true,
        "updatedAt": "2016-04-04T19:25:12Z",
        "childrenCount": 1,
        "items": [
          {
            "id": 1019678,
            "itemName": "yahoo.com"
          }
        ]
      }
    ],
    "siteListsExcluded": [
      {
        "status": "ACTIVE",
        "type": "APP_LIST",
        "id": 56919,
        "name": "Test Mobile 11/28",
        "accountId": 1,
        "isShared": true,
        "updatedAt": "2016-11-29T01:00:47Z",
        "childrenCount": 1,
        "items": [
          {
            "id": 1978914,
            "itemName": "com.myyearbook.m"
          }
        ]
      }
    ],
    "publishers": [
      {
        "id": 3,
        "name": "BRXD"
      },
      {
        "id": 4,
        "name": "Rubicon"
      },
      {
        "id": 67,
        "name": "AdForm(BSW)"
      },
      {
        "id": 74,
        "name": "A9"
      }
    ],
    "geosIncluded": [
      {
        "id": "###ab#can",
        "name": "Alberta, Canada",
        "description": "alberta",
        "level": "State",
        "key": "ab, can",
        "excluded": false
      },
      {
        "id": "####can",
        "name": "Canada",
        "description": "canada",
        "level": "Country",
        "key": "can",
        "excluded": false
      },
      {
        "id": "###15#nor",
        "name": "More Og Romsdal, Norway",
        "description": "more og romsdal",
        "level": "State",
        "key": "15, nor",
        "excluded": false
      }
    ],
    "geosExcluded": [
      {
        "id": "##callahan#fl#usa",
        "name": "Callahan, Florida",
        "description": "callahan, fl",
        "level": "City",
        "key": "callahan, florida",
        "excluded": true
      }
    ],
    "segmentsIncluded": [
      {
        "id": "20604896",
        "name": "Penny Dreadful S3 BrightRoll Test",
        "recency": 30,
        "createdAt": "2015-12-08",
        "audienceType": "3rd Party",
        "segmentType": "COMPOSITE",
        "reachCount": 449491095
      }
    ],
    "segmentsExcluded": [
      {
        "id": "50348744",
        "name": "FlyWheel Studio Test",
        "recency": 90,
        "createdAt": "2017-10-13",
        "audienceType": "3rd Party",
        "segmentType": "COMPOSITE",
        "reachCount": 617452399
      },
      {
        "id": "20703845",
        "name": "MB Test - HHI 75k+",
        "recency": 30,
        "createdAt": "2016-05-04",
        "audienceType": "3rd Party",
        "segmentType": "COMPOSITE",
        "reachCount": 135984850
      }
    ],
    "beaconsIncluded": [
      {
        "id": "6436593",
        "name": "DesTest Website Int 0",
        "recency": 30,
        "frequency": 7
      }
    ],
    "beaconsExcluded": [
      {
        "id": "6434432",
        "name": "deswebsite new0",
        "recency": 50,
        "frequency": 1
      }
    ],
    "threshold": 40,
    "frequencyCapValue": 2,
    "serveUnknownUser": true,
    "inviewThreshold": 2
  },
  "errors": null,
  "timeStamp": "2018-01-12T01:57:40Z"
}

Read Targeting Deals

To retrieve a filtered list of Deals available for targeting, make a GET call with the supported query parameters.

GET https://api.admanagerplus.yahoo.com/traffic/targeting/deals?lineId={lineId}&query={query}
Name Description Type Required?
lineId Line ID integer Y
query Search term. Use url encoding conventions (i.e. a space should be replaced with a + or %20). Provide a partial search string or leave it empty to get all results. text Y

The response will be a list of matching Deals. Refer to Deals for detailed explanation.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/deals?lineId=365277&query=spot

Example Response

{
  "response": [
    {
      "status": "ACTIVE",
      "id": 102,
      "name": "nospotbuy",
      "exchangeId": 3,
      "exchangeDealId": "nospotbuy",
      "description": "nospotbuy",
      "reservePrice": 0,
      "spotbuy": false,
      "accountIsExcluded": false
    },
    {
      "status": "ACTIVE",
      "id": 89,
      "name": "spotbuydeal",
      "exchangeId": 9,
      "exchangeDealId": "1233",
      "description": "spotbuy",
      "reservePrice": 1,
      "spotbuy": false,
      "accountIsExcluded": false
    }
  ],
  "errors": null,
  "timeStamp": "2017-07-13T04:19:40Z"
}

Read Targeting Contextuals

To retrieve a filtered list of Contextuals available for targeting, make a GET call with the supported query parameters.

GET https://api.admanagerplus.yahoo.com/traffic/targeting/contextuals?lineId={lineId}&taxonomyType={taxonomyType}&query={query}
Name Description Type Required?
lineId Line ID integer Y
taxonomyType

Taxonomy type.

  • IAB - IAB Contextual.
  • DOUBLE_VERIFY - Double Verify Brand Safety. Note: Requires additonal role.
  • IAS_BRAND_SAFETY - IAS Brand Safety. Note: Requires additonal role.
  • IAS_MEDIA_QUALITY - IAS Media Quality. Note: Requires additonal role.
  • IAS_CONTEXTUAL - IAS Contextual. Note: Requires additonal role.
text Y
query Search term. Use url encoding conventions (i.e. a space should be replaced with a + or %20). text Y

The response will be a list of matching Contextuals. Refer to Contextuals for detailed explanation.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/contextuals?lineId=365277&taxonomyType=IAB&query=test

Example Response

{
  "response": [
    {
      "taxonomyType": "IAB",
      "id": "43188",
      "name": "contextual_update_test"
    },
    {
      "taxonomyType": "IAB",
      "id": "41843",
      "name": "test-iab"
    }
  ],
  "errors": null,
  "timeStamp": "2017-07-27T21:30:07Z"
}

Read Mobile Carriers

To retrieve a filtered list of Mobile Carriers available for targeting, make a POST call with the supported payload.

POST https://dspapi.admanagerplus.yahoo.com/traffic/targeting/carriers
Name Description Type Required?
countries ISO3 country code Array Y
locations geofencing address Array N

The response will be a list of matching carriers.

Example Request

POST https://dspapi.admanagerplus.yahoo.com/traffic/targeting/carriers
{
  "countries": ["isl"],
  "locations": []
}

Example Response

{
  "response": [
    {
      "id": "5",
      "name": "Voxbone"
    },
    {
      "id": "371",
      "name": "Nova"
    },
    {
      "id": "372",
      "name": "Siminn"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-10T21:30:42Z"
}

Read ISPs

To retrieve a filtered list of ISPs available for targeting, make a POST call with the supported payload.

POST https://dspapi.admanagerplus.yahoo.com/traffic/targeting/isps
Name Description Type Required?
countries ISO3 country code Array Y
locations geofencing address Array N

The response will be a list of matching ISPs.

Example Request

POST https://dspapi.admanagerplus.yahoo.com/traffic/targeting/isps
{
  "countries": ["isl"],
  "locations": []
}

Example Response

{
  "response": [
    {
      "id": "190",
      "name": "Verizon"
    },
    {
      "id": "185",
      "name": "Vodafone"
    },
    {
      "id": "208",
      "name": "Skylogic"
    },
    {
      "id": "141",
      "name": "Colt Technology Services"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-16T21:29:35Z"
}

Read Targeting SiteLists

To retrieve a filtered list of Site / App Lists available for targeting, make a GET call with the supported query parameters.

GET https://api.admanagerplus.yahoo.com/traffic/targeting/sitelists?lineId={lineId}&page={page}&limit={limit}&sort={sort}&dir={dir}&query={query}
Name Description Type Required?
lineId Line ID integer Y
page Page number integer N
limit Total number of items to return. Maximum allowed value is 100. integer N
sort Column to sort by text N
dir Sort direction. Valid values: asc, desc text N
query Search term. Use url encoding conventions (i.e. a space should be replaced with a + or %20). Provide a partial search string or leave it empty to get all results. text Y

The response will be a list of matching Site / App Lists. Refer to Site Lists for detailed explanation.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/sitelists?limit=2&lineId=365277&query=test

Example Response

{
  "response": [
    {
      "typeName": "APP_LIST",
      "id": 56919,
      "name": "Test Mobile 11/28",
      "createdAt": "2016-11-29T01:00:47Z"
    },
    {
      "typeName": "SITE_LIST",
      "id": 62187,
      "name": "test site list",
      "createdAt": "2017-05-31T22:35:59Z"
    }
  ],
  "errors": null,
  "timeStamp": "2017-08-03T05:18:34Z"
}

Read Targeting Geos

To retrieve a filtered list of Geos available for targeting, make a GET call with the supported query parameters.

GET https://api.admanagerplus.yahoo.com/traffic/targeting/geos?page={page}&limit={limit}&sort={sort}&dir={dir}&query={query}&countryCode={countryCode}
Name Description Type Required?
page Page number integer N
limit Total number of items to return. Maximum allowed value is 100. integer N
sort Column to sort by text N
dir Sort direction. Valid values: asc, desc text N
query Search term. Use url encoding conventions (i.e. a space should be replaced with a + or %20). Provide a partial search string or leave it empty to get all results. text Y
countryCode Country code to use when searching for postal codes. Use the key field from Targeting Countries response. text N

The response contains the following fields of interest:

Name Description
id Unique ID of the location. This value will be used for Geo targeting.
name Location name.
level
  • City
  • State
  • Country
  • Dma

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/geos?dir=desc&limit=20&page=1&query=san+francisco&sort=name

Example Response (Partial)

{
  "response": [
    {
      "id": "##south san francisco#ca#usa",
      "name": "South San Francisco, California",
      "description": "south san francisco, ca",
      "level": "City",
      "key": "south san francisco, california",
      "code": "3555"
    },
    {
      "id": "807####usa",
      "name": "San Francisco-oak-san Jose",
      "description": "san francisco-oak-san jose",
      "level": "Dma",
      "key": "807",
      "code": "807"
    }
  ],
  "errors": null,
  "timeStamp": "2017-10-17T18:21:26Z"
}

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/geos?countryCode=usa&query=9512

Example Response (Partial)

{
  "response": [
    {
      "id": "#49512###usa",
      "name": "49512",
      "level": "Zip",
      "key": "#49512###usa",
      "code": "12779404"
    },
    {
      "id": "#95123###usa",
      "name": "95123",
      "level": "Zip",
      "key": "#95123###usa",
      "code": "12797574"
    }
  ],
  "errors": null,
  "timeStamp": "2017-10-18T04:31:49Z"
}

Read Targeting Countries

To retrieve a filtered list of Countries available for targeting, make a GET call with the supported query parameters.

GET https://api.admanagerplus.yahoo.com/traffic/targeting/countries?query={query}
Name Description Type Required?
query Search term. Use url encoding conventions (i.e. a space should be replaced with a + or %20). Provide a partial search string or leave it empty to get all results. text Y

The response contains the following fields of interest:

Name Description
key Value to use for countryCode parameter when retrieving supported geos.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/countries?query=usa

Example Response

{
  "response": [
    {
      "id": "####usa",
      "name": "United States",
      "description": "united states of america/usa",
      "level": "Country",
      "key": "usa",
      "code": "840"
    }
  ],
  "errors": null,
  "timeStamp": "2017-10-18T04:03:17Z"
}

Read Targeting Pixels (Beacons)

To retrieve a filtered list of Pixels (Beacons) available for targeting, make a GET call with the supported query parameters.

GET https://api.admanagerplus.yahoo.com/traffic/targeting/pixels?lineId={lineId}&query={query}
Name Description Type Required?
lineId Line ID integer Y
query Search term. Use url encoding conventions (i.e. a space should be replaced with a + or %20). Provide a partial search string or leave it empty to get all results. text Y

The response contains the following fields of interest:

Name Description
id Unique ID of the pixel. This value can be used to target the beacon.
name Pixel name.
createdAt (Read-Only) Creation timestamp.
type

Type of pixel.

  • CONVERSION
  • RETARGETING

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/pixels?lineId=365277&query=test

Example Response

{
  "response": [
    {
      "id": "6508331",
      "name": "test dot broker conversion rule",
      "createdAt": "2016-07-19T21:44:35Z",
      "type": "CONVERSION"
    },
    {
      "id": "6508393",
      "name": "test dot broker retargeting",
      "createdAt": "2016-07-28T06:13:38Z",
      "type": "RETARGETING"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-05T02:23:02Z"
}

Read Targeting Mail Domain Audience Categories

Returns a list of categories that can be used to target mail domain audiences.

Example Request

Example Response

{
  "response": [
    {
      "id": 1,
      "category": "Animals and Pets"
    },
    {
      "id": 2,
      "category": "Automotive"
    },
    {
      "id": 3,
      "category": "Computers"
    },
    {
      "id": 4,
      "category": "Coupons"
    },
    {
      "id": 5,
      "category": "Entertainment"
    },
    {
      "id": 6,
      "category": "Movies",
      "parentCategoryId": 5
    },
    {
      "id": 7,
      "category": "Music",
      "parentCategoryId": 5
    },
    {
      "id": 8,
      "category": "Television",
      "parentCategoryId": 5
    },
    {
      "id": 9,
      "category": "Ticketing and Live Events",
      "parentCategoryId": 5
    },
    {
      "id": 10,
      "category": "Entertainment—Other",
      "parentCategoryId": 5
    },
    {
      "id": 11,
      "category": "Finance"
    },
    {
      "id": 12,
      "category": "Banking",
      "parentCategoryId": 11
    },
    {
      "id": 13,
      "category": "Credit Cards",
      "parentCategoryId": 11
    },
    {
      "id": 14,
      "category": "Identity Theft and Fraud Protection",
      "parentCategoryId": 11
    },
    {
      "id": 15,
      "category": "Insurance",
      "parentCategoryId": 11
    },
    {
      "id": 16,
      "category": "Investment",
      "parentCategoryId": 11
    },
    {
      "id": 17,
      "category": "Loans and Mortgages",
      "parentCategoryId": 11
    },
    {
      "id": 18,
      "category": "Tax",
      "parentCategoryId": 11
    },
    {
      "id": 19,
      "category": "Finance—Other",
      "parentCategoryId": 11
    },
    {
      "id": 20,
      "category": "Food and Nutrition"
    },
    {
      "id": 21,
      "category": "Beverages",
      "parentCategoryId": 20
    },
    {
      "id": 22,
      "category": "Groceries",
      "parentCategoryId": 20
    },
    {
      "id": 23,
      "category": "Nutrition and Supplements",
      "parentCategoryId": 20
    },
    {
      "id": 24,
      "category": "Recipes",
      "parentCategoryId": 20
    },
    {
      "id": 25,
      "category": "Restaurants",
      "parentCategoryId": 20
    },
    {
      "id": 26,
      "category": "Health and Beauty"
    },
    {
      "id": 27,
      "category": "Beauty and Personal Care",
      "parentCategoryId": 26
    },
    {
      "id": 28,
      "category": "Health",
      "parentCategoryId": 26
    },
    {
      "id": 29,
      "category": "Hobbies"
    },
    {
      "id": 30,
      "category": "Jobs"
    },
    {
      "id": 31,
      "category": "Life Stages"
    },
    {
      "id": 32,
      "category": "Education",
      "parentCategoryId": 31
    },
    {
      "id": 33,
      "category": "Moving",
      "parentCategoryId": 31
    },
    {
      "id": 34,
      "category": "Parenting and Children",
      "parentCategoryId": 31
    },
    {
      "id": 35,
      "category": "Wedding",
      "parentCategoryId": 31
    },
    {
      "id": 36,
      "category": "Life Stages—Other",
      "parentCategoryId": 31
    },
    {
      "id": 37,
      "category": "Marketing and Advertising"
    },
    {
      "id": 39,
      "category": "Marketing and Advertising—Other",
      "parentCategoryId": 37
    },
    {
      "id": 40,
      "category": "Military"
    },
    {
      "id": 41,
      "category": "News"
    },
    {
      "id": 42,
      "category": "Politics"
    },
    {
      "id": 43,
      "category": "Religion"
    },
    {
      "id": 44,
      "category": "Retail"
    },
    {
      "id": 45,
      "category": "Apparel",
      "parentCategoryId": 44
    },
    {
      "id": 46,
      "category": "Gifts",
      "parentCategoryId": 44
    },
    {
      "id": 47,
      "category": "Home",
      "parentCategoryId": 44
    },
    {
      "id": 48,
      "category": "Home Improvement",
      "parentCategoryId": 44
    },
    {
      "id": 49,
      "category": "Luxury Goods",
      "parentCategoryId": 44
    },
    {
      "id": 50,
      "category": "Office Supply",
      "parentCategoryId": 44
    },
    {
      "id": 51,
      "category": "Retail—Other",
      "parentCategoryId": 44
    },
    {
      "id": 52,
      "category": "Romance and Dating"
    },
    {
      "id": 53,
      "category": "Small Business and B2B"
    },
    {
      "id": 54,
      "category": "Social Networks"
    },
    {
      "id": 55,
      "category": "Sports"
    },
    {
      "id": 56,
      "category": "Technology and Electronics"
    },
    {
      "id": 57,
      "category": "Telecommunications"
    },
    {
      "id": 58,
      "category": "Travel"
    },
    {
      "id": 59,
      "category": "Vacations",
      "parentCategoryId": 58
    },
    {
      "id": 60,
      "category": "Air and Charter",
      "parentCategoryId": 58
    },
    {
      "id": 61,
      "category": "Car Rental",
      "parentCategoryId": 58
    },
    {
      "id": 62,
      "category": "Cruises",
      "parentCategoryId": 58
    },
    {
      "id": 63,
      "category": "Hotels and Lodging",
      "parentCategoryId": 58
    },
    {
      "id": 64,
      "category": "Travel—Other",
      "parentCategoryId": 58
    },
    {
      "id": 65,
      "category": "Trucking and Freight"
    },
    {
      "id": 66,
      "category": "Utilities and Energy"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-05T21:52:10Z"
}

Read Targeting Segments (Audiences)

To retrieve a filtered list of Segments (Audiences) available for targeting, make a GET call with the supported query parameters.

GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/segments?lineId={lineId}&query={query}&limit={limit}&page={page}
Name Description Type Required?
lineId Line ID. integer Y
query Search term. Use url encoding conventions (i.e. a space should be replaced with a + or %20). text Y
limit Total number of items to return. Default is 50. integer N
page Page number. integer N

The response will be a list of matching segments.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/segments?lineId=365277&limit=2&query=test

Example Response

{
  "response": [
    {
      "id": 50190959,
      "name": "product test - saga test",
      "segmentType": "EVENTLEVEL",
      "reachCount": 504024
    },
    {
      "id": 50348744,
      "name": "FlyWheel Studio Test",
      "segmentType": "COMPOSITE",
      "reachCount": 605620290
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-05T20:04:22Z"
}

Create / Update Line Targeting

To create or update an existing Line Targeting, make a POST call with a payload body and id parameter. Example payloads are provided for each targeting type individually below.

POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/{id}/targeting
Name Description Type Required?
id Line ID integer Y

Example: DEMOGRAPHIC

{
  "id": 365277,
  "genders": [
    "ALL"
  ],
  "ages": [
    "21-24",
    "65+",
    "UNKNOWN"
  ],
  "threshold": "60",
  "types": [
    {
      "name": "DEMOGRAPHIC",
      "isTargeted": true
    }
  ]
}

Example: FREQUENCY_CAPPING

{
  "id": 365277,
  "frequencyCapPeriod": "MONTHLY",
  "frequencyCapValue": 4,
  "serveUnknownUser": true,
  "types": [
    {
      "name": "FREQUENCY_CAPPING",
      "isTargeted": true
    }
  ]
}

Example: DAY_PARTING

{
  "id": 365277,
  "days": [
    "MONDAY",
    "SATURDAY",
    "SUNDAY"
  ],
  "hours": [
  ],
  "types": [
    {
      "name": "DAY_PARTING",
      "isTargeted": true
    }
  ]
}

Example: LANGUAGES

{
  "id": 365277,
  "languages": [
    "ENGLISH",
    "FRENCH"
  ],
  "types": [
    {
      "name": "LANGUAGES",
      "isTargeted": true
    }
  ]
}

Example: INVENTORY_TYPE

{
  "id": 365277,
  "inventoryTypes": [
    "WEB"
  ],
  "types": [
    {
      "name": "INVENTORY_TYPE",
      "isTargeted": true
    }
  ]
}

Example: BOT

{
  "id": 365277,
  "bots": [
    "IAS"
  ],
  "types": [
    {
      "name": "BOT",
      "isTargeted": true
    }
  ]
}

Example: AB_TESTING

{
  "id": 365277,
  "userGroupEntry": {
    "id": 32658
  },
  "types": [
    {
      "name": "AB_TESTING",
      "isTargeted": true
    }
  ]
}

Example: TECHNOLOGY

{
  "id": 355970,
  "targetings": {
    "deviceTypes": [
      "DESKTOP",
      "PHONE"
    ],
    "os": [
      "ALL"
    ],
    "browsers": [
      "FIREFOX"
    ],
    "mobileOs": [
      "IOS"
    ]
  },
  "types": [
    {
      "name": "TECHNOLOGY",
      "isTargeted": true
    }
  ]
}

Example: AD_INITIATION

{
  "id": 365277,
  "adInitiations": [
    "USERINITIATED"
  ],
  "types": [
    {
      "name": "AD_INITIATION",
      "isTargeted": true
    }
  ]
}

Example: AD_POSITION

{
  "id": 307438,
  "targetingLines": {
    "positions": [
      "ABOVE_FOLD"
    ]
  },
  "types": [
    {
      "name": "AD_POSITION",
      "isTargeted": true
    }
  ]
}

Example: PLAYER_SIZE

{
  "id": 365277,
  "playerSizes": [
    "SMALL",
    "LARGE"
  ],
  "types": [
    {
      "name": "PLAYER_SIZE",
      "isTargeted": true
    }
  ]
}

Example: MOBILE_PLACEMENT

{
  "id": 365277,
  "mobilePlacements": [
    "REWARDED",
    "INTERSTITIAL"
  ],
  "types": [
    {
      "name": "MOBILE_PLACEMENT",
      "isTargeted": true
    }
  ]
}

Example: VIEWABILITY

{
  "id": 365277,
  "inviewThreshold": 1.56,
  "types": [
    {
      "name": "VIEWABILITY",
      "isTargeted": true
    }
  ]
}

Example: PUBLISHERS

{
  "id": 365277,
  "publishers": [
    3,
    4
  ],
  "types": [
    {
      "name": "EXCHANGES",
      "isTargeted": true
    }
  ]
}

Example: DEALS

{
  "id": 365277,
  "deals": {
    "removed": [],
    "clearAll": false,
    "added": [
      2264423
    ]
  },
  "types": [
    {
      "name": "EXCHANGES",
      "isTargeted": true
    }
  ]
}

Example: CONTEXTUALS

{
  "id": 365277,
  "contextuals": {
    "clearAll": false,
    "excludeIAB": false,
    "addedDoubleVerify": [
      41842
    ],
    "addedIAB": [
      41848,
      41843
    ],
    "removed": []
  },
  "types": [
    {
      "name": "CONTEXTUALS",
      "isTargeted": true
    }
  ]
}

Example: SITE_LISTS

{
  "id": 365277,
  "siteLists": {
    "removed": [],
    "clearAll": false,
    "added": [
      {
        "excluded": false,
        "entityId": 40367
      },
      {
        "excluded": true,
        "entityId": 61574
      }
    ]
  },
  "types": [
    {
      "name": "SITE_LISTS",
      "isTargeted": true
    }
  ]
}

Example: GEOS

{
  "id": 365277,
  "geos": {
    "removedNames": [],
    "clearAll": false,
    "added": [
      {
        "excluded": false,
        "name": "###15#nor"
      },
      {
        "excluded": true,
        "name": "##callahan#fl#usa"
      }
    ]
  },
  "types": [
    {
      "name": "GEOGRAPHY",
      "isTargeted": true
    }
  ]
}

Example: GEO FENCING

{
  "id": 365277,
  "geoFencings": {
    "clearAll": false,
    "removed": [
    ],
    "added": [
      {
        "location": "328 Lomita Dr, Stanford, CA 94305"
      },
      {
        "location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043"
      }
    ],
    "radius": 5,
    "radiusUnit": "MILES"
  },
  "types": [
    {
      "name": "GEOGRAPHY",
      "isTargeted": true
    }
  ]
}

Example: MOBILE CARRIER

{
  "id": 365277,
  "mobileCarriers": [1,532],
  "isps": [1,2],
  "types": [
    {
      "name": "CONNECTION",
      "isTargeted": true
    }
  ]
}

Example: SEGMENTS (Add)

{
  "id": 365277,
  "segments": {
    "added": [
      {
        "excluded": false,
        "entityId": 20703845
      },
      {
        "excluded": true,
        "entityId": 50348744
      }
    ]
  },
  "types": [
    {
      "name": "SEGMENT",
      "isTargeted": true
    }
  ]
}

Example: SEGMENTS (Remove)

{
  "id": 365277,
  "segments": {
    "removed": [
      50348744
    ]
  },
  "types": [
    {
      "name": "SEGMENT",
      "isTargeted": true
    }
  ]
}

Example: PIXELS (Add)

{
  "id": 365277,
  "beacons": {
    "added": [
      {
        "excluded": false,
        "entityId": 6436593,
        "recency": 30,
        "frequency": 7
      },
      {
        "excluded": true,
        "entityId": 6434432,
        "recency": 50,
        "frequency": 1
      }
    ]
  },
  "types": [
    {
      "name": "SEGMENT",
      "isTargeted": true
    }
  ]
}

Example: PIXELS (Edit)

{
  "id": 365277,
  "beacons": {
    "edited": [
      {
        "excluded": false,
        "entityId": 6436593,
        "recency": 55,
        "frequency": 2
      }
    ]
  },
  "types": [
    {
      "name": "SEGMENT",
      "isTargeted": true
    }
  ]
}

Example: PIXELS (Remove)

{
  "id": 365277,
  "beacons": {
    "removed": [
      6436593
    ]
  },
  "types": [
    {
      "name": "SEGMENT",
      "isTargeted": true
    }
  ]
}

Delete Line Targeting

Line Targeting deletion is not supported by the API.

Carrier/ISP Targeting Rules

Because the ISPs and mobile carriers available for targeting depend on the locations you are targeting, you’ll need to set up location targeting before you can target ISPs or carriers. You can target countries, states, cities, or designated marketing areas (DMAs).

Changes in Geo targeting Impact to Carrier/ISP targeting
New Geo-targeting (DMA or Geo-fencing) is added, but Carrier/ISP targeting is not changed Carrier/ISP targeting remains unchanged
Geo-targeting (DMA or Geo-fencing) is narrowed The existing Carrier/ISP targeting will be validated. It stays unchanged if it is valid. Otherwise, no change will be made and an error will be returned
Geo-targeting type is changed from DMA to Geo-fence or vice versa The existing Carrier/ISP targeting will be validated. It stays unchanged if it is valid. Otherwise, no change will be made and an error will be returned
Geo-targeting is turned off If connection targeting is not yet disabled, an error will be returned