Technology Targeting

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

Overview

Technology targeting enables you to target consumers based on the technologies in their computing environment. Consumers may be targeted by device type, operating system, mobile operating system, browser, and mobile device make or model.

The Verizon Media DSP supports TECHNOLOGY targeting for lines serving display, video, and native ads.

Endpoint

/traffic/lines/{id}/targeting
  • A GET request enables you to view technology targeted by the specified line.

  • A POST request enables you to target technology with the specified line.

Resources

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 TECHNOLOGY target type.

The targeting resource is defined by the following TECHNOLOGY targeting type-specific fields:

Targeting Object

The targeting resource is defined by the following TECHNOLOGY targeting type-specific fields:

Parameter

Parameter Type

Description

Data Type

Required

id

path

Specifies the line ID.

integer

Y

deviceTypes

body

Specifies the device types targeted. Valid options include:

  • DESKTOP

  • PHONE

  • TABLET

  • UNKNOWN

  • ALL

array

N

os

body

Specifies the operating system types targeted. Valid options include:

  • MAC

  • WINDOWS

  • LINUX

  • OTHER

  • ALL

array

N

browsers

body

Specifies the browser types targeted. Valid options include:

  • IE

  • CHROME

  • FIREFOX

  • SAFARI

  • EDGE

  • ALL

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

array

N

mobileOS

body

Specifies the mobile OS types targeted. Valid options include:

  • IOS

  • ANDROID

  • WINDOWS

  • OTHER

  • ALL

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

array

N

mobileMakes

body

Specifies an array of mobile make IDs. To retrieve a list of mobile makes, use the Read Mobile Makes API.

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

Note: The mobileOS parameter and the mobileMakes parameters must align.

array

Y

mobileModels

body

Specifies an array of mobile model IDs. To retrieve a list of mobile models, use the Read Mobile Models API.

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

Note: The mobileMakes parameter and the mobileModels parameters must align.

array

Y

iosVersionRange

body

Specifies an array of iOS version numbers. To use the latest version of iOS in the range, specify a single beginning value. The Verizon Media DSP will automatically close the range with LATEST.

To view available iOS versions, use Read Mobile OS Versions.

array

N

androidVersionRange

body

Specifies an array of Android version numbers. To use the latest version of the Android in the range, specify a single beginning value. The Verizon Media DSP will automatically close the range with LATEST.

To view available Android versions, use Read Mobile OS Versions.

array

N

types

body

Specifies an array of targeting types to update, enable, or disable.

TECHNOLOGY targeting type must be specified to apply the changes.

To learn more, see Targeting Types.

array

Y

Mobile Make Object

The Read Mobile Makes API returns an array of Mobile Make objects.

Field

Description

Data Type

id

Specifies the ID number of the mobile make.

integer

mobileMake

Specifies the name of the mobile make.

string

mobileOS

Specifies the name of the mobile operating system.

string

Mobile Model Object

The Read Mobile Models API returns an array of Mobile Model objects.

Field

Description

Data Type

id

Specifies the ID number of the mobile model.

integer

modelName

Specifies the name of the mobile model.

string

deviceType

Specifies the name of the mobile device type.

string

mobileOS

Specifies the name of the mobile operating system.

string

mobileMake

Specifies the name of the mobile make.

string

Read Technology Targets

Returns a list of targets for the specified line.

GET /traffic/lines/{id}/targeting

The resource returns information about all of the target types enabled and all of the targets specified for the line including deviceTypes, os, browsers, and mobileOS.

To learn more, see Read Line Targeting.

Example Request URL

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

Example Response

{
  "response": {
    "types": [
      {
        "name": "TECHNOLOGY",
        "isTargeted": true
      }
    ],
    "mobileMakes": [
      "LG"
    ],
    "mobileModels": [
      "iPhone 6S",
      "Apple iPhone SE"
    ],
    "deviceTypes": [
      "PHONE",
      "DESKTOP"
    ],
    "os": [
      "ALL"
    ],
    "browsers": [
      "ALL"
    ],
    "mobileOS": [
      "ANDROID",
      "IOS"
    ]
  },
  "errors": null,
  "timestamp": "2018-02-22T00:24:22Z"
}

Add/Update Technology Targeting

Add or update the technology targeting for the specific line.

POST traffic/lines/{id}/targeting/

Parameters

The line ID is specified in the path of the URL. All other parameters are specified in the body of the application/json payload.

Depending on the parameters specified, you can target consumers based on device types, operating systems, browsers, mobile operating systems, mobile device makes or mobile device models.

Device type, mobile OS, mobile make, and mobile model targeting are interdependent.

  • The mobileOS parameter constrains the mobileMakes parameter.

  • The deviceType parameter constrains the mobileModels parameter.

  • The mobileMakes parameter constrains the mobileModels parameter.

To learn more, see Status and Error Codes.

Example Request URL

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

Example Request Body

{
  "mobileMakes": [
    1
  ],
  "mobileModels": [
    9
  ],
  "deviceTypes": [
    "DESKTOP",
    "PHONE"
  ],
  "os": [],
  "browsers": [],
  "mobileOS": [
    "IOS"
  ],
  "iosVersionRange": [
    "11.0"
  ],
  "androidVersionRange": [
    "7.1"
  ],
  "types": [
    {
      "name": "TECHNOLOGY",
      "isTargeted": true
    }
  ]
}

Example Response

{
  "response": {
    "types": [
      {
        "name": "TECHNOLOGY",
        "isTargeted": true
      }
    ],
    "deviceTypes": [
      "DESKTOP",
      "PHONE"
    ],
    "os": [],
    "browsers": [],
    "mobileOS": [
      "ALL"
    ],
    "IOSVersions": [
      "11.0",
      "LATEST"
    ],
    "AndriodVersions": [
      "7.1",
      "LATEST"
    ],
    "mobileMakes": [
      "Apple"
    ],
    "mobileModels": [
      "Google Nexus 6"
    ]
  },
  "errors": null,
  "timeStamp": "2018-04-19T21:47:05Z"
}

Status and Error Codes

Code

Description

422

One or more mobile model(s) selected are not compatible with the selected mobile OS(s)

422

Make and model selections are not compatible with the selected device type.

422

Specify mobile devices by mobile model or mobile make, but not both. One or more of the specified mobile models belongs to specified mobile make.

422

One or more mobile make(s) selected are not compatible with the selected mobile OS(s)

Read Mobile Makes

Returns a list of mobile makes.

GET /traffic/targeting/mobilemakes

If no query parameters are specified, mobile makes are returned for all operating systems.

The resource returns an array of Mobile Make objects that include the mobileOS, mobileMake, id. Use the mobile make ID to target consumers based on their mobile make. To learn more, see Add/Update Technology Targeting.

Parameters

All parameters are specified as a query appended to the end of the endpoint URL.

Parameter

Parameter Type

Description

Data Type

Required

mobileOSes

query

Specifies a comma-separated list of mobile operating systems. Available options include:

  • OTHER

  • IOS

  • ANDROID

  • WINDOWS

If no parameters are specified, mobile makes are returned for all operating systems.

string

N

Example Request URL

GET traffic/targeting/mobilemakes?mobileOSes=IOS,ANDROID

Example Response

{
  "response": [
    {
      "id": 1,
      "mobileMake": "Apple",
      "mobileOS": "IOS"
    },
    {
      "id": 2,
      "mobileMake": "Google",
      "mobileOS": "ANDROID"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-12T01:07:13Z"
}

Read Mobile Models

Returns a list of mobile makes.

GET /traffic/targeting/mobilemodels

If no query parameters are specified, mobile models are returned for all operating systems and device types.

The resource returns an array of Mobile Model objects that include the modelName, mobileMake, id. Use the mobile model ID to target consumers based on their mobile model. To learn more, see Add/Update Technology Targeting.

Parameters

All parameters are specified as a query appended to the end of the endpoint URL.

Parameter

Parameter Type

Description

Data Type

Required

mobileOSes

query

Specifies a comma-separated list of mobile operating systems. Available options include:

  • OTHER

  • IOS

  • ANDROID

  • WINDOWS

If no parameters are specified, mobile models are returned for all operating systems.

string

N

deviceTypes

query

Specifies a comma-separated list of device types. Available options include:

  • PHONE

  • TABLET

If no parameters are specified, mobile models are returned for all device types.

string

N

limit

query

Specifies the page size.

integer

N

page

query

Specifies the page number.

integer

N

Example Request URL

GET traffic/targeting/mobilemodels?mobileOSes=IOS,ANDROID&deviceTypes=PHONE&limit=5000&page=1

Example Response

{
  "response": [
    {
      "id": 1,
      "modelName": "Sony Xperia Z3",
      "deviceType": "Phone",
      "mobileOS": "ANDROID",
      "mobileMake": "Sony"
    },
    {
      "id": 2,
      "modelName": "HTC One M7",
      "deviceType": "Phone",
      "mobileOS": "ANDROID",
      "mobileMake": "HTC"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-12T01:07:13Z"
}

Read Mobile OS Versions

Returns a list of iOS or Android mobile operating system versions.

GET /traffic/mobileosversions

Parameters

All parameters are specified as a query appended to the end of the endpoint URL.

Parameter

Parameter Type

Description

Data Type

Required

mobileOS

path

Specifies the mobile make. Valid options include: IOS and Android.

If no mobileOS parameter is specified, the resource returns all iOS and Android versions.

string

N

Example Request URL

GET traffic/targeting/mobileosversions?mobileOSes=IOS,ANDROID

Example Response

{
  "IOSVersions": [
    "1.0",
    "1.1",
    "2.0",
    "2.1",
    "2.2",
    "3.0",
    "3.1",
    "3.2",
    "4.0",
    "4.1",
    "4.2",
    "4.3",
    "5.0",
    "5.1",
    "6.0",
    "6.1",
    "7.0",
    "7.1",
    "8.0",
    "8.1",
    "8.2",
    "8.3",
    "8.4",
    "9.0",
    "9.1",
    "9.2",
    "9.3",
    "10.0",
    "10.1",
    "10.2",
    "10.3",
    "11.0"
  ]
}

See also

About Targeting