AdSpendingSnapshot

1
2
3
4
5
{
    "Name": "Mopedo.Bidding.AdSpendingSnapshot",
    "Kind": "EntityResource",
    "Methods": ["GET", "DELETE", "REPORT", "HEAD"]
}

The DSP keeps track of bidding campaign spending using campaign spending snapshots. Each such snapshot holds data about the spending of a campaign during a given time period. The actual spending data is stored in AdSpendingSnapshot entities, that are connected to the campaign spending snapshot – one for each ad active for the given campaign during given time period. The bidding statistics of the campaign spending snapshot is calculated from each connected AdSpendingSnapshot entity.

This resource exists to allow clients to consume the ad spending snapshots directly, should they – for example – want to download them to an external system for statistical analysis. For more information about how the DSP stores spending data, and how reports can be built from it, see the reporting overview.

Format

Properties marked in bold are required.

Property name Type Description
CampaignSpendingSnapshot (hidden) CampaignSpendingSnapshot The campaign spending snapshot connected to this ad spending snapshot
AdId (hidden) string The ID of the ad that this ad spending snapshot encodes spending for
BuyerId (hidden) string The buyer id of the campaign that this ad spending snapshot encodes spending for
Period (hidden) string The period of the campaign spending snapshot
From (hidden) datetime The value of From of the campaign spending snapshot
To (hidden) datetime The value of To of the campaign spending snapshot
Currency (hidden) string The currency that this ad spending snapshot is encoded in
NrOfBids integer The number of bids during the period
NrOfWins integer The number of wins during the period
NrOfClicks integer The number of clicks during the period
TotalBidPrice Price The total bid price during the period
AverageBidPrice Price The average bid price during the period
TotalWinPrice Price The total win price during the period
AverageWinPrice Price The average win price during the period
WinRate float NrOfWins divided by NrOfBids (or 0 if there are no bids)
ClickRate float NrOfClicks divided by NrOfWins (or 0 if there are no wins)
IsZero boolean Was there no bidding events during the period?

Hidden properties can be included in response bodies by using the add meta-condition in the request URI.