Availability Complex Type

Description

Availability information based on parameters requested.

Namespace

http://www.FatTail.com/api

Base Type

Extension of AdBookConnectEntity Complex Type

Overview

Availability Extension of AdBookConnectEntity Complex Type

Availability information based on parameters requested.

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.

Used By

Availability Element
Availability Element
GetAvailabilityResult Element

Source

<xs:complexType name="Availability" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:appinfo />
    <xs:documentation>&lt;summary&gt;
            Summary description for Availability
            &lt;/summary&gt;</xs:documentation>
  </xs:annotation>
  <xs:complexContent mixed="false">
    <xs:extension xmlns:q434="http://www.FatTail.com/api" base="q434:AdBookConnectEntity">
      <xs:sequence>
        <xs:element minOccurs="0" name="Availability100Percent" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Availability based on drops for orders that have an order status with 100% probability of closure.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="AvailabilityOversell" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Availability based on the configuration of the Oversell Percentage parameter.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="Available" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Availability value based on forecasted impressions vs. booked impressions for the position and dates requested.&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;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 minOccurs="0" name="EndDate" type="xs:dateTime">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;End date in the period requested in an availability request.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="Forecast" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Forecast for the period requested in the availability request.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" 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="Partial" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Availability factored by the close probability associated with the order status on all orders with drops on the requested position.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="Preemptible" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;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.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="StartDate" type="xs:dateTime">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Start date of the period for which availability was being requested.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="Targeting" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Availability factored by the collective allocation defined by TargetingElements specified in the request.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>