AdBookConnect Web Service
MethodGetDrop
AdBookConnect Web Service > All Operations Resource Group : GetDrop (Method)
Summary
Retrieve a Drop based on the specified DropID.
Request (IAdBookConnect_GetDrop_InputMessage)

The request body is of type http://www.FatTail.com/api:GetDrop.

Request Body Parameters

NameDescriptionData Type
DropID for the desired Drop object.xml:long

Overview

Sequence
dropId optional xs:long
200 Response (IAdBookConnect_GetDrop_OutputMessage)

The response body is of type http://www.FatTail.com/api:GetDropResponse.

Response Body Parameters

NameDescriptionData Type
Drop object requested.Drop

Overview

Sequence
Sequence
AdUnitID optional xs:long
This property is obsolete.  Use DropDynamicProperties with the DynamicProperty for Ad_Unit_IDs.
BillingCategory BillingCategory Simple Type
Payment disposition for the drop.
BillingModel optional BillingModel Simple Type
Revenue calculation method used for the drop.
DropDate xs:dateTime
Start date of the drop.
DropID optional xs:long
AdBook system ID for the drop.
DropNotes optional xs:string
Free form text field associated with the drop.
DropTargeting optional Targeting Complex Type
Targeting information for a drop.
Sequence
TargetingElementIDList optional ArrayOflong Complex Type
Collection of TargetingElementIDs selected.
Sequence
long 0..∞ xs:long
TargetingPackageIDList optional ArrayOflong Complex Type
Collection of TargetingPackageIDs selected.
Sequence
long 0..∞ xs:long
TargetingAllocationVersionId optional xs:long
Version ID if using targeting allocation versions.
EndDropDate xs:dateTime
End date for a drop.
ExternalID optional xs:string
Third party system ID used to map external entities to AdBook drops.
GroupID optional xs:long
ID used for grouping multiple drops together.
Impressions optional xs:long
Impressions booked on the drop.
MediaElementID xs:long
Position being booked on the drop.
OTFSponsorship optional xs:boolean
Flag to indicate the drop is an on-the-fly sponsorship.
OrderID xs:long
The ID of the order the drop is associated with.
Price optional xs:double
Booking price for the drop.
PriceTypeID xs:long
ID of the price type the price is based on.
Quantity optional xs:long
Impression or click quantity sold on the drop.
ServedByID optional xs:long
System ID for the configured ad server selected for a drop.
ThirdPartyAdServerID optional xs:long
System ID for the configured ThirdPartyAdServer.
TrafficAdTypeID optional xs:long
System ID for the configured ad type assigned to the drop.
TrafficDeliveryMakeGoodID optional xs:long
System ID for the make good method assigned to the drop.
TrafficDeliverySchedulingID optional xs:long
System ID for delivery scheduling assigned to the drop.
TrafficPriorityID optional xs:long
System ID for the ad server priority setting.
UpdateStatus optional InventoryUpdateStatus Simple Type
Update status for the inventory associated with the drop.
UpdateStatusText optional xs:string
Status text for the inventory update process.  If an error was encountered while updating inventory, it will be reported here.
DropDynamicProperties optional ArrayOfDynamicPropertyValue Complex Type
Collection of values for custom fields configured at the drop level for your organization.
Sequence
Sequence
DynamicPropertyID optional xs:long
AdBook system ID for the DynamicProperty.
Value optional xs:string
Value being assigned to the dynamic property.  The format of the value depends on the type specified in the DynamicProperty definition.
FrequencyCap optional xs:long
Frequency cap for the drop.
ActiveStatus optional ActiveStatus Simple Type
Indicates if the drop is cancelled or active.
DropCustomBillingSchedule optional DropCustomBillingSchedule Complex Type
The custom billing schedule associated with the drop.
Sequence
CustomBillingSchedule optional ArrayOfCustomBillingSchedule Complex Type
Sequence
Sequence
Amount xs:decimal
Date xs:dateTime
Quantity optional xs:string
ReadonlyProperties optional ArrayOfReadonlyPropertyValue Complex Type
Collection of calculated fields for the drop.
Sequence
Sequence
PropertyName optional xs:string
Value optional xs:string
DropCost optional xs:double
Fault Responses
FaultDescription
This fault returns a response body of type http://www.FatTail.com/api:IAdBookConnect_GetDrop_DataAccessFaultFault_FaultMessage.  
See Also
All Operations Resource GroupAdBookConnect Web Service