Drop Complex Type

Description

Represents a line item on an Order.

Namespace

http://www.FatTail.com/api

Base Type

Extension of AdBookConnectEntity Complex Type

Overview

Drop Extension of AdBookConnectEntity Complex Type

Represents a line item on an Order.

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

DynamicPropertyValue 0..∞ DynamicPropertyValue Complex Type

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

BillingDateType BillingDateType Simple Type

CustomBillingSchedule optional ArrayOfCustomBillingSchedule Complex Type

Sequence

CustomBillingSchedule 0..∞ CustomBillingSchedule Complex Type

Sequence

Amount xs:decimal

Date xs:dateTime

Quantity optional xs:string

ReadonlyProperties optional ArrayOfReadonlyPropertyValue Complex Type

Collection of calculated fields for the drop.

Sequence

ReadonlyPropertyValue 0..∞ ReadonlyPropertyValue Complex Type

Sequence

PropertyName optional xs:string

Value optional xs:string

DropCost optional xs:double

Used By

Drop Element
Drop Element
Drop Element
GetDropResult Element
drop Element
drop Element
CreateDropResult Element
drop Element

Source

<xs:complexType name="Drop" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension xmlns:q278="http://www.FatTail.com/api" base="q278:AdBookConnectEntity">
      <xs:sequence>
        <xs:element minOccurs="0" name="AdUnitID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;AdBook system ID for the ad unit.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="BillingCategory" type="q278:BillingCategory">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Payment disposition for the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="BillingModel" type="q278:BillingModel">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Revenue calculation method used for the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="DropDate" type="xs:dateTime">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Start date of the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="DropID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;AdBook system ID for the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="DropNotes" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Free form text field associated with the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="DropTargeting" nillable="true" type="q278:Targeting">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Targeting information for a drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="EndDropDate" type="xs:dateTime">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;End date for a drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="ExternalID" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Third party system ID used to map external entities to AdBook drops.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="GroupID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;ID used for grouping multiple drops together.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="Impressions" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Impressions booked on the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="MediaElementID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Position being booked on the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="OTFSponsorship" type="xs:boolean">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Flag to indicate the drop is an on-the-fly sponsorship.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="OrderID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;The ID of the order the drop is associated with.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="Price" type="xs:double">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Booking price for the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="PriceTypeID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;ID of the price type the price is based on.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="Quantity" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Impression or click quantity sold on the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="ServedByID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;System ID for the configured ad server selected for a drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="ThirdPartyAdServerID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;System ID for the configured ThirdPartyAdServer.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="TrafficAdTypeID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;System ID for the configured ad type assigned to the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="TrafficDeliveryMakeGoodID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;System ID for the make good method assigned to the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="TrafficDeliverySchedulingID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;System ID for delivery scheduling assigned to the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="TrafficPriorityID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;System ID for the ad server priority setting.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="UpdateStatus" type="q278:InventoryUpdateStatus">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Update status for the inventory associated with the drop.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="UpdateStatusText" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Status text for the inventory update process.  If an error was encountered while updating inventory, it will be reported here.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="DropDynamicProperties" nillable="true" type="q278:ArrayOfDynamicPropertyValue">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
            <xs:documentation>&lt;summary&gt;Collection of values for custom fields configured at the drop level for your organization.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="FrequencyCap" type="xs:long">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="ActiveStatus" type="q278:ActiveStatus">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="DropCustomBillingSchedule" nillable="true" type="q278:DropCustomBillingSchedule">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="ReadonlyProperties" nillable="true" type="q278:ArrayOfReadonlyPropertyValue">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="DropCost" nillable="true" type="xs:double">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>