Retrieve availability information.
The request body is of type http://www.FatTail.com/api:GetAvailability.
Request Body Parameters
Overview
 |
 |
Sequence
|
|
Sequence
|
|
Sequence
| |
|
DropID optional xs:long
When set, the availability values will exclude impressions sold on the drop specified by this ID.
|
|
EndDate xs:dateTime
End date of the period for which availability is being requested.
|
|
MediaElementID xs:long
ID of the position for which availability is being requested.
|
|
OnTheFlySponsorship optional xs:boolean
Indicates that "On the fly sponsorship" rules should be in effect for the availability calculation.
|
|
Price optional xs:double
Price to use when comparing against existing preemptible drops.
|
|
PriceTypeID optional xs:long
ID of the price type used when comparing prices for existing preemptible drops.
|
|
StartDate xs:dateTime
Start date of the period for which availability is being requested.
| | | | |
The response body is of type http://www.FatTail.com/api:GetAvailabilityResponse.
Response Body Parameters
| Name | Description | Data Type |
|---|
| GetAvailabilityResult | Availability properties for all different types of availability based on the parameters in the request. | Availability |
Overview
|
|
Sequence
|
|
Sequence
|
Availability100Percent optional xs:long
Availability based on drops for orders that have an order status with 100% probability of closure.
|
|
AvailabilityOversell optional xs:long
Availability based on the configuration of the Oversell Percentage parameter.
|
|
Available optional xs:long
Availability value based on forecasted impressions vs. booked impressions for the position and dates requested.
|
|
DropID optional xs:long
When set, the availability values will exclude impressions sold on the drop specified by this ID.
|
|
EndDate optional xs:dateTime
End date in the period requested in an availability request.
|
|
Forecast optional xs:long
Forecast for the period requested in the availability request.
|
|
MediaElementID optional xs:long
ID of the position for which availability is being requested.
|
|
Partial optional xs:long
Availability factored by the close probability associated with the order status on all orders with drops on the requested position.
|
|
Preemptible optional xs:long
Availability based on exclusion of drops that are on preemptible orders with a lower price than the price specified in the availability request. Price types must match for drops to be considered for exclusion.
|
|
StartDate optional xs:dateTime
Start date of the period for which availability was being requested.
|
|
Targeting optional xs:long
Availability factored by the collective allocation defined by TargetingElements specified in the request.
| | | | |
