Connection Targeting

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

Overview

Yahoo DSP mobile targeting enables you to target consumers based on their Internet connection type (Wi-Fi, Cellular, or both), Internet Service Providers (isps), or mobile carriers (mobileCarriers):

  • If you target Wi-Fi customers, you can also target consumers connected through particular ISPs.

  • If you target cellular users, you can also target consumers connected through particular mobile carriers.

  • If you target all connection types, you can target both ISPs and mobile carriers.

If you target both ISPs and mobile carriers, the platform targets consumers who are connected through either the ISPs or the mobile carriers specified.

The Yahoo DSP supports CONNECTION targeting for lines serving display and video ads.

Mobile & Location Targeting Rules

The mobile carriers and ISP available for targeting depend on locations targeted. You must specify GEOGRAPHIC targeting before you can target ISPs or carriers.

The Yahoo DSP enables you to target countries, states, cities, or designated marketing areas (DMAs). To learn more, refer to Geography Targeting.

  • If GEOGRAPHY-based targeting (geo or geoFencing) is expanded and CONNECTION-based targeting is not updated, CONNECTION-based targeting is unchanged.

  • If GEOGRAPHY-based targeting (geo or geoFencing) is narrowed, the platform validates the existing CONNECTION-based targeting parameters. If valid, CONNECTION-based targeting is unchanged. If invalid, no change is made, but an error is returned.

  • If GEOGRAPHY-based targeting is changed from geo to geoFencing or vice versa, the platform validates the existing CONNECTION-based targeting parameters. If valid, CONNECTION-based targeting is unchanged. If invalid, no change is made, but an error is returned.

  • If GEOGRAPHY-based targeting is disabled, CONNECTION targeting is disabled as well.

Endpoint

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

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

Resources

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

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

Note

Connection targeting parameters can only be specified if CONNECTION targeting is enabled.

Parameter

Parameter Type

Description

Data Type

Required

id

path

Specifies the line ID.

integer

Y

mobileCarriers

body

Specifies an array of mobile carrier IDs to target. All available mobile carriers can be specified using ["ALL"].

To get a list of available mobile carriers by country or geo-fencing address, refer to Read Mobile Carriers.

array

Y

mobileCarriersExcluded

body

Specifies the mobile carriers to block. All available Mobile Carriers can be specified using ["ALL"].

To get a list of available mobile carriers by country or geo-fencing address, refer to Read Mobile Carriers.

array

N

isps

body

Specifies an array of ISPs to target. All available ISPs can be specified using ["ALL"].

To get a list of available ISPs by country or geo-fencing address, refer to Read ISPs by Country.

array

Y

ispsExcluded

body

Specifies an array of ISPs to block. All available ISPs can be specified using ["ALL"].

To get a list of available ISPs by country or geo-fencing address, refer to Read ISPs by Country.

array

N

types

body

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

CONNECTION targeting type must be specified to apply the changes.

To learn more, refer to Targeting Types.

array

Y

Note

For a complete list of targeting resource fields, refer to Targeting Object.

Read Mobile Carriers

Returns a filtered list of mobile carriers available for targeting.

POST /traffic/targeting/carriers

Parameters

The resource takes the following parameters:

Parameter

Parameter Type

Description

Data Type

Required

countries

body

Specifies an array of ISO 3166 country codes. If not specified, defaults to usa.

array

Y

locations

body

Specifies an array of geofencing addresses.

array

N

Example Request URL

POST https://dspapi.admanagerplus.yahoo.com/traffic/targeting/carriers

Example Request Body

{
  "countries": ["usa"],
  "locations": []
}

Example Response

The response returns a list of matching carriers.

{
  "response": [
    {
      "id": "2",
      "name": "Verizon"
    },
    {
      "id": "204",
      "name": "Mtn"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-10T21:30:42Z"
}

Read ISPs by Country

Returns a list of ISPs available in the specified countries or geofencing addresses.

POST /traffic/targeting/isps

Parameters

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

Parameter

Parameter Type

Description

Data Type

Required

countries

body

Specifies an array of ISO 3166 country codes. If not specified, defaults to usa.

array

Y

locations

body

Specifies one or more locations identified by geofencing address strings.

array

N

Example Request URL

POST https://dspapi.admanagerplus.yahoo.com/traffic/targeting/isps

Example Request Body

To filter ISPs by country, specify one or more ISO 3166 country codes:

{
  "countries": [
    "usa"
  ],
  "locations": []
}

To filter ISPs by geofencing location, specify one or more location string:

{
  "countries": [],
  "locations": [
    "2 Waters Park Dr, San Mateo, CA 94403",
    "One Infinite Loop, Cupertino, CA 95014"
  ]
}

Example Response

{
  "response": [
    {
      "id": "124",
      "name": "Bell Canada"
    },
    {
      "id": "193",
      "name": "Orange"
    },
    {
      "id": "181",
      "name": "Mediacom"
    },
    {
      "id": "228",
      "name": "The Planet"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-12T01:07:13Z"
}

Add/Update Connection Targets

Adds or updates connection targets for the specified line. Consumers may be targeted based on their ISPs or mobile carriers.

POST /traffic/lines/{id}/targeting

The CONNECTION targeting type must be enabled in the body of the application/json payload.

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.

Example Request URL

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

Example Request Body

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

Example Response

{
  "response": {
    "types": [
      {
        "name": "CONNECTION",
        "isTargeted": true
      }
    ],
    "mobileCarriers": [
      "AT&T"
    ],
    "geosIncluded": [
      {
        "id": "########usa",
        "name": "United States",
        "description": "united states of america/usa",
        "level": "Country",
        "key": "usa",
        "excluded": false
      }
    ],
    "geosExcluded": [],
    "frequencyCapValue": 0,
    "serveUnknownUser": true
  },
  "errors": null,
  "timeStamp": "2017-12-29T21:59:10Z"
}

Status and Error Codes

Field

Description

200

Error converting response.

400

Payload is missing.

422

Required field [mobileCarriers] is missing.

422

Required field [isps] is missing.

422

Connection targeting and Geo targeting are not compatible.

400

Field types has invalid value.

Additional Resources

About Targeting