About Targeting

This article describes resources that enable you to read and define line targeting.

Overview

Verizon Media DSP enables you to target exchanges, deals, locations, demographics, ad positions, frequency, audiences, devices, and more.

Endpoint

traffic/lines/{lineId}/targeting

Use the following HTTP methods:

  • Use the GET method to view existing line targeting.

  • Use the POST method to create new line targeting.

  • Use the PUT method to update existing line targeting.

Resources

Targeting Types

Your ability to target consumers is constrained by the creatives served by the line.

The Verizon Media DSP supports the following targeting types:

Targeting Type

Description

Display

Video

Native

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

Y

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

AD_POSITION

Target the location on a page that you want your display ads to appear.

Y

N

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

Y

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

Y

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

Y

ENHANCED_DAY_PARTING

Choose the days and hours your display or video ads should serve.

Y

Y

Y

DEMOGRAPHIC

Reach your desired audience with age and gender targeting.

Y

Y

Y

EXCHANGES

A line can target or block one or more exchanges or target available private marketplace deals.

Y

Y

Y

FREQUENCY_CAPPING

Set a limit on how frequently an ad is shown to a user within a specified time frame.

Y

Y

Y

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

INVENTORY_TYPE

You can explictly target web vs. in-app supply.

Y

Y

Y

LANGUAGES

Target lines based on the language users most frequently view in their browsers. Advertisers can target or exclude specific languages.

Y

Y

Y

PLAYER_SIZE

Enable targeting based on the player size.

N

Y

N

VIDEO_CONTENT_LENGTH

Enable targeting based on the video content length.

N

Y

N

SEGMENT

If you have created audiences, you can perform line item targeting using include and exclude conditions.

Y

Y

Y

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

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

MOBILE_PLACEMENT

Enable targeting of consumers with intersitial and rewarded ads.

Y

Y

Y

Targeting Object

The targeting resource is the standard Verizon Media DSP resource for targeting consumers based on their profiles, behaviors, and ad content.

This resource comprises multiple fields that enable you to specify line targeting across many types of targets including the SEGMENT, EXCHANGES, and CONNECTION target types.

Note

Read-only fields are returned by Read Line Targeting requests.

Field

Description

Data Type

Target Type

genders

Specifies the genders targeted.

  • MALE

  • FEMALE

  • UNKNOWN

  • ALL

array

DEMOGRAPHIC

ages

Specifies the age ranges targeted.

  • 18-20

  • 21-24

  • 25-34

  • 35-44

  • 45-49

  • 50-54

  • 55-64

  • 65-999

  • UNKNOWN

  • ALL

array

DEMOGRAPHIC

threshold

Specifies the acceptable in-target audience composition percentage for video ads.

The value indicates the percentage of impressions that reach the intended demographic.

  • 20

  • 30

  • 40

  • 50

  • 60

  • 70

  • 80

Note: This field is valid when campaign targeting verification vendor is not Yahoo.

integer

DEMOGRAPHIC

frequencyCapPeriod

Specifies the frequency cap interval.

  • MINUTES

  • HOURLY

  • DAILY

  • WEEKLY

  • UNLIMITED - No limit to the number of times the ad can be displayed.

string

FREQUENCY_CAPPING

frequencyCapValue

Specifies the number of imporessions all for the selected frequencyCapPeriod. If frequencyCapPeriod selected is:

  • UNLIMITED - Do not provide frequencyCapPeriod in the payload.

  • MINUTES - The maximum time limit allowed for a minute is 5.

  • HOURLY - The maximum time limit allowed for a hour is 10.

  • DAILY - The maximum time limit allowed for a day is 20.

  • WEEKLY - The maximum time limit allowed for a week is 140.

  • MONTHLY - The maximum time limit allowed for a month is 600.

string

FREQUENCY_CAPPING

serveUnknownUser

Specifies whether the ad is served to known or unknown users:

  • If true, serve to unknown users.

  • If false, serve to known users only.

boolean

FREQUENCY_CAPPING

dayParting

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

To learn more, see Day Parting Targeting.

object

ENHANCED_DAY_PARTING

languages

Specifies the languages targeted:

  • UNKNOWN

  • ENGLISH

  • CHINESE

  • SPANISH

  • JAPANESE

  • PORTUGUESE

  • GERMAN

  • ARABIC

  • FRENCH

  • RUSSIAN

  • DUTCH

  • SWEDISH

  • ITALIAN

  • INDONESIAN

  • ALL

array

LANGUAGES

inventoryTypes

Specifies the inventory types targeted:

  • WEB

  • APP

  • ALL

array

INVENTORY_TYPE

bots

Specifies the bot fraud prevention partner:

  • DOUBLE_VERIFY

  • IAS

array

BOT

userGroupEntry

Specifies the user group entry.

For POST, you need to supply the id field, not the entire object.

object

AB_TESTING

deviceTypes

Specifies the device types targeted:

  • DESKTOP

  • PHONE

  • TABLET

  • UNKNOWN

  • ALL

array

TECHNOLOGY

os

Specifies the operating system types targeted:

  • MAC

  • WINDOWS

  • LINUX

  • OTHER

  • ALL

array

TECHNOLOGY

browsers

Specifies the browser types targeted.

Note: deviceTypes must be set to DESKTOP to target browsers.

array

TECHNOLOGY

mobileOs

Specifies the mobile OS types targeted.

Note: deviceTypes must be set to PHONE or TABLET to target mobileOs.

array

TECHNOLOGY

adInitiations

For video ads, specifies how the targeted ad is initiated:

  • AUTOINITIATED - The video starts without any user action.

  • USERINITIATED - The video starts only if the user clicks Play.

  • ANDROID

  • UNKNOWN

  • ALL

array

AD_INITIATION

positions

For display ads, specifies location on the page where the ad appears:

  • ABOVE_FOLD - The ad serves on the top 50% of the page.

  • PARTIAL_VIEW - The ad serves when 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 position.

  • ALL

array

AD_POSITION

playerSizes

For video ads, the platform determines the player size based on height and width (in pixels) specified in the bid request. The platform extracts the larger of the two and assigns a player size:

  • SMALL - Less than 350 pixels.

  • MEDIUM - Between 350 and 500 pixels.

  • LARGE - Greater than 500 pixels.

  • UNKNOWN

  • ALL - All player sizes.

array

PLAYER_SIZE

videoContentLength

Video content length is the duration of the video a user is about to watch, not the duration of the ad. Valid values include:

  • UP_TO_TWO_MINUTES - Any video that is less than 2 minutes long.

  • TWO_TO_FIVE_MINUTES - Any video between 2:00 - 4:59 minutes in length.

  • FIVE_TO_THIRTY_MINUTES - Any video between 5:00 - 29:59 minutes in length.

  • MORE_THAN_THIRTY_MINUTES - Any video 30 minutes or longer.

  • UNKNOWN - Any available video length.

  • ALL

array

VIDEO_CONTENT_LENGTH

mobileCarriers

Specifies the mobile carriers and ISPs targeted.

Note: To target a mobile carrier, you need only specify the id field only.

array

CONNECTION

publishers

Specifies the IDs of publishers/exchanges targeted. To learn more, see Exchange Targeting.

array

EXCHANGES

deals

Specifies private marketplace deals to target.

  • To create or update targeted deals, see Deals Payload Object.

  • To read deals that can be targeted, see read-targeting-deals.

array

EXCHANGES

contextuals

Specifies contexutals to target or exclude from targeting.

array

CONTEXTUALS

siteLists

Specifies site lists and app lists to target or exclude from targeting.

array

SITE_LISTS

geos

Specifies geographic locations to target or exclude from targeting.

  • To create or update targeted geographic locations, see Geo.

  • To read geographic locations that can be targeted, see Read Geos to Target.

Note: You cannot target both geographic locations and geofencing locations at the same time.

array

GEOGRAPHY

geoFencings

Specifies geo fencing locations to target or exclude from targeting.

To create or update targeted geo fencing locations, see Geo Fencing.

Note: You cannot target both geographic locations and geofencing locations at the same time.

array

GEOGRAPHY

segments

Specifies segments to target or exclude from targeting.

array

SEGMENT

publishersIncluded

A read-only array that specifies the publishers/exchanges included in targeting.

To learn more, see Exchange Targeting.

array

EXCHANGES

publishersExcluded

A read-only array that specifies the publishers/exchanges excluded from targeting.

To learn more, see Exchange Targeting.

array

EXCHANGES

dealsIncluded

A read-only array that specifies the deals included in targeting.

To learn more, see Exchange Targeting.

array

EXCHANGES

contextualsIncluded

A read-only array that specifies the contextuals included in targeting.

To learn more, see Contextuals Targeting.

array

CONTEXTUALS

contextualsExcluded

A read-only array that specifies the contextuals excluded from targeting.

To learn more, see Contextuals Targeting.

array

CONTEXTUALS

siteListsIncluded

A read-only array of site lists and app lists that are included in targeting. To learn more, see Site List Targeting.

array

SITE_LISTS

siteListsExcluded

A read-only array of site lists and app lists that are excluded from targeting. To learn more, see Site List Targeting.

array

SITE_LISTS

geosIncluded

A read-only array of geo locations included in targeting.

To learn more, see Geos Included Object.

array

GEOGRAPHY

geosExcluded

A read-only array of geofencing locations excluded from targeting by the line.

To learn more, see Geos Excluded Object.

array

GEOGRAPHY

geoFencingsIncluded

A read-only array of geofencing locations included in targeting by the line.

To learn more, see Geo Fencing.

array

GEOGRAPHY

segmentsIncluded

A read-only array that shows the segments included in targeting.

To learn more, see Segments Included Object.

array

SEGMENT

segmentsExcluded

A read-only array that shows the segments excluded from targeting.

To learn more, see Segments Included Object.

array

SEGMENT

mobilePlacements

Specifies the mobile placement types:

  • INTERSTITIAL - Interstitial ads are mobile placements that cover all or most of the user’s screen on an app.

  • REWARDED - Rewarded ads allow users to opt-in to watching, or otherwise consuming, ads in exchange for some kind of benefit (i.e. points, lives, virtual goods, or premium content).

  • ALL - Target all mobile placement types.

array

MOBILE_PLACEMENT

types

Specifies the targeting types enabled and disabled for the line.

To learn more, see Targeting Types.

array

N/A

Target Types Object

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

Data Type

id

Specifies the target type.

integer

name

Specifies the name of the target type.

For a complete list of target types, see target-types.

string

isTargeted

Specifies whether the target type is enabled or disabled for the line.

  • If true, the target type is enabled.

  • If false, the target type is disabled.

boolean

Example Payload (Partial)

{
  "types": [
    {
      "isTargeted": true,
      "name": "SITE_LISTS"
    },
    {
      "isTargeted": true,
      "name": "AD_POSITION"
    }
  ]
}

Read Line Targeting

Returns targeting data for the specific line.

GET /traffic/lines/{id}/targeting

Parameters

Name

Parameter Type

Description

Data Type

Required

id

path

Specifies the ID of line.

integer

Y

Example Request

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

Example Response

The response returns information about target types the targeted by the line.

{
  "response": {
    "types": [
      {
        "name": "GEOGRAPHY",
        "isTargeted": true
      },
      {
        "name": "PLAYER_SIZE",
        "isTargeted": true
      },
      {
        "name": "VIDEO_CONTENT_LENGTH",
        "isTargeted": true
      },
      {
        "name": "AD_INITIATION",
        "isTargeted": true
      },
      {
        "name": "VIDEO_INVENTORY",
        "isTargeted": true
      },
      {
        "name": "DEMOGRAPHIC",
        "isTargeted": true
      },
      {
        "name": "FREQUENCY_CAPPING",
        "isTargeted": true
      },
      {
        "name": "AB_TESTING",
        "isTargeted": true
      },
      {
        "name": "SEGMENT",
        "isTargeted": true
      },
      {
        "name": "TECHNOLOGY",
        "id": 7,
        "isTargeted": true
      },
      {
        "name": "ENHANCED_DAY_PARTING",
        "isTargeted": false
      },
      {
        "name": "SITE_LISTS",
        "isTargeted": true
      },
      {
        "name": "CONTEXTUALS",
        "isTargeted": true
      },
      {
        "name": "EXCHANGES",
        "isTargeted": true
      },
      {
        "name": "MOBILE",
        "isTargeted": true
      },
      {
        "name": "LANGUAGES",
        "isTargeted": true
      },
      {
        "name": "SEAT_LEVEL_SITE_LISTS",
        "isTargeted": true
      },
      {
        "name": "BOT",
        "isTargeted": true
      },
      {
        "name": "INVENTORY_TYPE",
        "isTargeted": true
      }
    ],
    "mobileCarriers": [
      "Verizon"
    ],
    "isps": [
      "Colt Technology Services"
    ],
    "genders": [
      "MALE",
      "FEMALE"
    ],
    "ages": [
      "55-64",
      "65-999",
      "18-20",
      "21-24",
      "45-49",
      "50-54"
    ],
    "days": [
      "ALL"
    ],
    "deviceTypes": [
      "UNKNOWN",
      "TABLET"
    ],
    "os": [
      "ALL"
    ],
    "browsers": [
      "ALL"
    ],
    "mobileOs": [
      "ANDROID",
      "IOS"
    ],
    "languages": [
      "ENGLISH",
      "GERMAN"
    ],
    "inventoryTypes": [
      "APP"
    ],
    "playerSizes": [
      "MEDIUM",
      "LARGE"
    ],
    "videoContentLength": [
      "UP_TO_TWO_MINUTES",
      "UNKNOWN"
    ],
    "adInitiations": [
      "USERINITIATED"
    ],
    "bots": [
      "DOUBLE_VERIFY"
    ],
    "positions": [
      "ALL"
    ],
    "userGroupEntry": {
      "id": 32659,
      "name": "sg2",
      "userGroupId": 14962,
      "trafficPercent": 56,
      "lowerBound": 0,
      "upperBound": 55
    },
    "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": [
      {
        "id": 47539,
        "name": "TestSiteList_1459797912042",
        "accountName": "test-advertiser",
        "createdAt": "2018-11-13T00:50:23Z",
        "updatedAt": "2018-11-13T00:52:11Z",
        "totalSites": 3,
        "type": "SITE_LIST"
      }
    ],
    "siteListsExcluded": [
      {
        "id": 56919,
        "name": "Test Mobile 11/28",
        "accountName": "test-advertiser",
        "createdAt": "2017-04-10T23:21:39Z",
        "updatedAt": "2019-08-21T20:29:58Z",
        "totalSites": 1,
        "type": "APP_LIST"
      }
    ],
    "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
      }
    ],
    "threshold": 40,
    "frequencyCapValue": 2,
    "frequencyCapPeriod": "HOURLY",
    "serveUnknownUser": true,
    "enableViewabilityFreqCap": false,
  },
  "errors": null,
  "timeStamp": "2018-01-12T01:57:40Z"
}

Add/Update Line Targeting

Adds or updates the specified targets for the specified line.

POST traffic/lines/{id}/targeting/

Parameters

All requests to add or update targets to a line require id and types fields.

For each targeting type the line targets, you must specify the payload for that target.

Example Request

The line ID is specified in the path of the resource endpoint:

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

All other parameters are specified in the body of the application/json payload.

{
  "id": 412063,
  "deviceTypes": [
    "DESKTOP",
    "PHONE"
  ],
  "os": [
    "MAC"
  ],
  "browsers": [
    "FIREFOX"
  ],
  "mobileOs": [
    "IOS",
    "ANDROID"
  ],
  "iosVersionRange":[
    "10.1", "12.1"
  ],
  "androidVersionRange":[
    "8", "latest"
  ],
  "mobileMakes": [
    4,
    5,
    6
  ],
  "mobileModels": [
    12,
    20
  ],
  "types": [
    {
      "name": "TECHNOLOGY",
      "id": 7,
      "isTargeted": true
    }
  ]
}