Exchange Targeting

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

Overview

A line can target one or more publishers and available private marketplace deals.

  • Publisher. To learn more, see Exchanges.

  • Deal. To learn more, see Deals.

The Verizon Media DSP supports EXCHANGES targeting for lines serving display and video ads.

Endpoint

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

  • A POST request enables you to target exchanges 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.

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

Parameter

Parameter Type

Definition

Data Type

Required

id

path

Specifies the line lD.

integer

Y

publishers

body

Specifies the exchanges to target.

To learn more, see publishers-object.

array

Y

includePublishers

body

Indicates if the added Publisher IDs are to be targeted (included) or blocked (excluded).

  • true - (Default Value) All IDs in the publishers field will be targeted (included).

  • false - All IDs in the publishers field will be blocked (excluded).

boolean

N

deals

body

Specifies private marketplace deals to target.

To learn more, see Deals Payload Object.

array

Y

dealsIncluded

body

A read-only array that identifies the private marketplace deals targeted for the line.

array

N/A

publishersIncluded

body

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

array

N/A

publishersExcluded

body

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

array

N/A

Note

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

Deals Payload Object

The deals payload object enables you to add or update the deals targeted by a line. The object contains the following fields:

Name

Description

Data Type

added

Specifies an array of deals to target. Deals are identified by dealId.

To retrieve a list of deals for targeting, use the Read Target Deals resource.

array

removed

Deal IDs to be removed from targeting.

array

clearAll

Indicates if all existing targeted deals should be removed. By default, false.

  • If true, remove all targeted deals. This will disable EXCHANGES targeting.

  • If false, do not remove any targeted deals.

boolean

Read Target Publishers

Retrieves a list of publishers that may be targeted for the specified line.

GET /traffic/targeting/publishers?lineId={lineId}&query={query}

All of the accepted parameters are query parameters.

Parameters

Parameter

Description

Data Type

Required

lineId

Specifies the line ID.

integer

Y

query

Specifies the 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.

string

Y

Read Target Deals

Retrieves a list of deals that may be targeted for the specified line.

GET /traffic/targeting/deals?accountId={accountId}&lineId={lineId}&query={query}

All of the accepted parameters are query parameters.

Parameters

Parameter

Description

Data Type

Required

accountId`

Specifies the advertiser ID.

Required to search for advertiser-level audiences.

integer

N

lineId

Specifies the line ID.

integer

Y

query

Specifies the 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.

string

Y

Example Request URL

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"
}

Add/Updates Deal Targeting

Add or update the deals targeted by the specified 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.

Parameter

Parameter Type

Definition

Data Type

Required

id

path

Specifies the line lD.

integer

Y

deals

body

Specifies a payload object that defines the deals to be added, removed, or cleared for targeting.

object

Y

types

body

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

EXCHANGES targeting type must be specified to apply the changes.

To learn more, see Targeting Types.

array

Y

Example Request URL

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

Example Request Body

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

Example Response

{
  "response": {
    "types": [
      {
        "name": "EXCHANGES",
        "isTargeted": true
      }
    ],
    "dealsIncluded": [
      {
        "id": 2264423,
        "name": "deal for targeting",
        "exchangeId": 3,
        "exchangeDealId": "43434",
        "description": "line deal",
        "reservePrice": 1,
        "spotbuy": false,
        "accountIsExcluded": false,
        "status": "ACTIVE"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2019-10-17T13:46:22.796Z"
}

Add/Remove Publisher Targeting

Add or update the publishers targeted by the specified 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.

Parameter

Parameter Type

Definition

Data Type

Required

id

path

Specifies the line lD.

integer

Y

publishers

body

Specifies an array of publishers to target.

array

Y

includePublishers

body

Indicates if the added Publisher IDs are to be targeted (included) or blocked (excluded).

  • true - (Default Value) All IDs in the publishers field will be targeted (included).

  • false - All IDs in the publishers field will be blocked (excluded).

boolean

N

types

body

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

EXCHANGES targeting type must be specified to apply the changes.

To learn more, see Targeting Types.

array

Y

Example Request URL

POST traffic/lines/365277/targeting/

Example Request Body

{
  "publishers": [
    1,
    2
  ],
  "includePublishers": true,
  "types": [
    {
      "name": "EXCHANGES",
      "isTargeted": true
    }
  ]
}

Example Response

{
  "response": {
    "types": [
      {
        "name": "EXCHANGES",
        "isTargeted": true
      }
    ],
    "publishersIncluded": [
      {
        "id": 1,
        "name": "MoPub"
      },
      {
        "id": 2,
        "name": "Verizon Media Mobile Exchange"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2019-10-17T13:54:40.077Z"
}