AvailabilityRequest Complex Type

Description

Information needed to query for availability for a specified media element.

Namespace

http://www.FatTail.com/api

Base Type

Extension of AdBookConnectEntity Complex Type

Overview

AvailabilityRequest Extension of AdBookConnectEntity Complex Type

Information needed to query for availability for a specified media element.

Sequence

AvailibilityTargeting optional Targeting Complex Type

TargetingInformation to consider in availability calculations.

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.

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.

Used By

AvailabilityRequest Element
AvailabilityRequest Element
availParam Element

Source

<xs:complexType name="AvailabilityRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension xmlns:q431="http://www.FatTail.com/api" base="q431:AdBookConnectEntity">
      <xs:sequence>
        <xs:element minOccurs="0" name="AvailibilityTargeting" nillable="true" type="q431:Targeting">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;TargetingInformation to consider in availability calculations.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="DropID" nillable="true" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;When set, the availability values will exclude impressions sold on the drop specified by this ID.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="EndDate" type="xs:dateTime">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;End date of the period for which availability is being requested.&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;ID of the position for which availability is being requested.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="OnTheFlySponsorship" type="xs:boolean">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Indicates that "On the fly sponsorship" rules should be in effect for the availability calculation.&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;Price to use when comparing against existing preemptible drops.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="PriceTypeID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;ID of the price type used when comparing prices for existing preemptible drops.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="StartDate" type="xs:dateTime">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Start date of the period for which availability is being requested.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>