Segment Targeting

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

Overview

If you have created audiences, you can target consumers based on those audiences using include and exclude conditions.

The Yahoo DSP supports SEGMENT targeting for lines serving display, video, and native ads.

Endpoint

Read Segments

The Yahoo DSP API provides an endpoint for reading the segments available for targeting:

GET /traffic/targeting/availablesegments

Read Targeted Segments

The Yahoo DSP API provides an endpoint for identifying the segments currently targeted by a line.

GET /traffic/lines/{id}/targeting

To learn more, refer to Read Line Targeting.

Target Segments

The Yahoo DSP API provides a single endpoint to add, update, remove, and clear the segments targeted by a line.

POST /traffic/lines/{id}/targeting

This is the same endpoint that is used for all targeting operations. The line ID must be specified in the endpoint path. All other parameters are specified in the body of the application/json payload. To learn more, refer to About Targeting.

Resources

Targeting Object

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

Note

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

Segments Object

The segments payload object enables you to Add/Update Segment Targeting, update-segments, remove-segments, or clear-all-segments targeted by a line.

Segments Included Object

The Read Line Targeting API returns the segmentsIncluded and segmentsExcluded objects along with other data about line targeting.

The segmentsIncluded object is a read-only object that displays information about the segments targeted by a line.

Segments Excluded Object

The Read Line Targeting API returns the segmentsIncluded and segmentsExcluded objects along with other data about line targeting.

The segmentsExcluded object is a read-only object that displays information about the segments excluded from targeting by a line.

Available Segments Object

The Read Available Segments API returns an array of Available Segment objects.

The Segment Segment object is a read-only object that displays information about a segment available for targeting.

Read Available Segments

Returns filtered list of segments that may be targeted.

GET /traffic/targeting/availablesegments/search?lineId={lineId}&accountId={accountId}query={query}&country_codes={country_codes}&limit={limit}&page={page}&type={type}&minAudienceSize={minAudienceSize}&maxAudienceSize={maxAudienceSize}

All of the accepted parameters are query parameters.

Parameters

Example Request

GET  https://dspapi.admanagerplus.yahoo.com/traffic/targeting/availablesegments/search?accountId=507&filterFacts=true&limit=20&lineId=277165&page=1&query=auto&country_codes=USA,GBR&status=Active&type=COMPOSITE%2CLOOKALIKE%2CWEBSITE%2CCONVERSIONRULE%2CCUSTOM%2CEMAIL%2CIPADDRESS%2CSRT%2CMRT%2CEVENTLEVEL%2CGEORETARGET%2CINTEREST%2CMIC%2CFACT

Example Response

{
  "response": [
    {
      "id": 50134447,
      "name": "Cuebiq > Mobile Audience > Retail > Auto Parts/Auto Repair Shoppers > Advance Auto Parts",
      "status": "ACTIVE",
      "hierarchy": [
        {
          "name": "Cuebiq > Mobile Audience > Retail > Auto Parts/Auto Repair Shoppers"
        },
        {
          "name": "Cuebiq > Mobile Audience > Retail"
        },
        {
          "name": "Mobile Audience"
        },
        {
          "name": "Cuebiq"
        },
        {
          "name": "Liveramp Third Party"
        },
        {
          "name": "3rd Party Data"
        },
        {
          "name": "All"
        }
      ],
      "audienceType": "DMP",
      "segmentType": "FACT",
      "reachCount": 21056761,
      "createdAt": "2017-02-09"
    },
    {
      "id": 50134434,
      "name": "Cuebiq > Mobile Audience > Retail > Auto Parts/Auto Repair Shoppers > O'Reilly Auto Parts",
      "status": "ACTIVE",
      "hierarchy": [
        {
          "name": "Cuebiq > Mobile Audience > Retail > Auto Parts/Auto Repair Shoppers"
        },
        {
          "name": "Cuebiq > Mobile Audience > Retail"
        },
        {
          "name": "Mobile Audience"
        },
        {
          "name": "Cuebiq"
        },
        {
          "name": "Liveramp Third Party"
        },
        {
          "name": "3rd Party Data"
        },
        {
          "name": "All"
        }
      ],
      "audienceType": "DMP",
      "segmentType": "FACT",
      "reachCount": 16431194,
      "createdAt": "2017-02-09"
    }
  ],
  "errors": null,
  "timeStamp": "2018-04-02T18:02:48Z"
}

Add/Update Segment Targeting

Add or update segment targeting for 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.

Example Request URL

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

Example Request Body (Add)

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

Example Request Body (Remove)

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

Additional Resources

• About Targeting

• Composite Audiences

• Device ID Audiences

• Email Address Audiences

• IP Address Audiences

• Lookalike Audience

• Mail Event Audience

• Mail Domain Audiences

• Search Keyword Audiences

• POI Audiences