API 1.3
Version 1.3 of the API adds support for deal IDs to be passed into the campaign API, as well as for a simpler set of channel aliases.
New campaign API field: Deal ID
The campaign API now supports passing in a Deal ID along with a seller. If this matches a deal ID that the seller has registered for compensation, the API will add this compensation to the measurement response for both this row and the total for the measured campaign. Note that this deal ID registration is not live in the 1.3 API, so using deal ID will not do anything yet.
Channel Aliases
The campaign and planning APIs now support channel mappings that better represent the way channels are described in ad servers. The table below describes how channel mappings work. For instance, passing channel "mobile" will first see if the inventory ID matches an entry in the display-app
channel, and if not, it will look for a mapping in display-web
. No changes are required if you are currently passing channels into the API.
Channel Alias | Try this first | Then this | Then this |
---|---|---|---|
display | display-web | display-app | |
mobile | display-app | display-web | |
video | streaming-video | linear-tv | display-web |
social | social | ||
audio | streaming-audio | ||
search | search | sponsored-listing |