About the Traffic API

Prev Next

This article describes the DSP Traffic API and core traffic objects and their relationships.

Overview

The Yahoo DSP enables you to programmatically monitor, create, and manage advertising campaigns via resources that are exposed through the DSP Traffic API.

Yahoo DSP developers and partners can use these resources to manage advertisers, campaigns, lines, audiences, creatives, and more.

A resource is an object exposed through an endpoint. Resources are generally defined by multiple properties. These properties may be defined as integers, strings, arrays, or objects.

Endpoints

The Yahoo DSP API trafficking endpoint accepts requests for creating, updating and retrieving campaign related elements.

https://dspapi.admanagerplus.yahoo.com/traffic/

Public Names of Resources

The public names used for Yahoo DSP traffic objects is sometimes different than the name used for these objects in the DSP Traffic API.

Throughout the DSP Traffic API documentation the name of the resource is preferred over the public name. For example, the term beacon is used instead of the term pixel, which is used in the Yahoo DSP console.

The table maps the public name to the resource endpoint.

Public Name

Resource Endpoint

Seat

/traffic/seats

Advertiser Group

/traffic/accountgroups

Advertiser

/traffic/advertisers

Campaign

/traffic/campaigns

Composite Audience

/traffic/audiences/composite

Conversion Rule Audience

/traffic/audiences/conversion_rule

Device ID Audience

/traffic/audiences/device_id

Email / Phone Number Audience

/traffic/audiences/email_address

Lookalike Audience

/traffic/audiences/lookalike

Mail Domain Audience

/traffic/audiences/mrt

Mail Event Audience

/traffic/audiences/mail_event

Point of Interest Audience

/traffic/audiences/poi

Search Keyword Audience

/traffic/audiences/srt

Pixel

/traffic/pixels

Contextual

/traffic/contextuals

Site Lists and App Lists

/traffic/sitelists

User Group

/traffic/usergroups

Exchange

/traffic/exchanges

Deal

/traffic/deals

Creative

/traffic/creatives

Ad

/traffic/ads

Line

/traffic/lines

Bid Multiplier

/traffic/lines/{lineID}/bidmultiplier

Targeting

/traffic/lines/{lineID}/targeting