http://adgear.com/api/schemas/xml#input

http://adgear.com/api/schemas/xml#input
element publisher_placement

Documentation

				Entity used when creating or updating a publisher placement in AdGear

Properties

This component is not nillable.

Nested Element Summary

xs:long

format_id
AdGear's internal ID of the format of the placement

adgear:frequency_cap

frequency_cap
Frequency cap for this placement ; Set to nil to remove an existing frequency cap definition

xs:string

name
The name of the placement

placement_memberships_attributes
List of child placement memberships to be created, updated or deleted ; Each placement membership ties a single ad unit under this placement

adgear:placement_objective

placement_objective_attributes
Objective for this placement, defining such attributes as billing start and end dates, and delivery goals

placement_rules_attributes
List of child placement rules to be created, updated or deleted ; Each placement rule defines an inventory item (for example: A Site, or an Ad Spot, or a Zone) to be booked under this placement

xs:long

scheduling_priority
Delivery and scheduling priority of this placement compared to other competing placements

selection_mechanism_type
The selection mechanism to be used when deciding between multiple ad units attached to the placement

xs:string

targeting_rule
The targeting rule the placement must qualify for before serving ; See the dedicated documentation of AdGear's targeting language for valid targeting rule constructs and syntax

targeting_type
Specifies which form of targeting, if any, the placement should respect.

xs:string

tile_name
The name of a tile group the placement belongs to, if any ; Multiple placements, within the same campaign, belonging to the same tiling group (keyed by name) will be served in a "tiling" setup by AdGear where possible

xs:string

weekly_periods_schedule
A string of exactly 168 characters, each "0" or "1" indicating whether this placement can be served during the given hour in the week or not ; Is logically divided into 7 consequtive days of 24 hours each (hence the 168) ; First day is Sunday ; An empty weekly_periods_schedule is logically the same as the string filled with 168 "1"s ; Used in conjunction with weekly_periods_relativity

xs:string

weekly_periods_schedule_relativity
The "relativity" of the specified weekly periods schedule, if any ; Leave blank to indicate that the weekly periods schedule is relative to the browsing user's local time ; Set to a valid Timeone name to indicate the weekly periods schedule is relative to the given fixed time zone ; Used in conjunction with weekly_periods_schedule

Source

<xs:element name="publisher_placement">
  <xs:complexType>
    <xs:all>
      <xs:element minOccurs="0" name="name" type="xs:string">
      </xs:element>
      <xs:element minOccurs="0" name="format_id" type="xs:long">
      </xs:element>
      <xs:element minOccurs="0" name="scheduling_priority" type="xs:long">
      </xs:element>
      <xs:element minOccurs="0" name="weekly_periods_schedule_relativity" nillable="true" type="xs:string">
      </xs:element>
      <xs:element minOccurs="0" name="weekly_periods_schedule" type="xs:string">
      </xs:element>
      <xs:element minOccurs="0" name="placement_rules_attributes">
        <xs:complexType>
          <xs:sequence>
            <xs:element maxOccurs="unbounded" name="placement_rule" type="adgear:placement_rule">
            </xs:element>
          </xs:sequence>
          <xs:attribute fixed="array" name="type" type="xs:NMTOKEN" use="required"/>
        </xs:complexType>
      </xs:element>
      <xs:element minOccurs="0" name="placement_objective_attributes" type="adgear:placement_objective">
      </xs:element>
      <xs:element minOccurs="0" name="frequency_cap" nillable="true" type="adgear:frequency_cap">
      </xs:element>
      <xs:element minOccurs="0" name="targeting_type">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="none">
            </xs:enumeration>
            <xs:enumeration value="wizard">
            </xs:enumeration>
            <xs:enumeration value="advanced">
            </xs:enumeration>
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="targeting_rule" nillable="true" type="xs:string">
      </xs:element>
      <xs:element minOccurs="0" name="selection_mechanism_type">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="none">
            </xs:enumeration>
            <xs:enumeration value="weighted">
            </xs:enumeration>
            <xs:enumeration value="rotated">
            </xs:enumeration>
            <xs:enumeration value="optimized">
            </xs:enumeration>
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="placement_memberships_attributes">
        <xs:complexType>
          <xs:sequence>
            <xs:element maxOccurs="unbounded" name="placement_membership" type="adgear:placement_membership">
            </xs:element>
          </xs:sequence>
          <xs:attribute fixed="array" name="type" type="xs:NMTOKEN" use="required"/>
        </xs:complexType>
      </xs:element>
      <xs:element minOccurs="0" name="tile_name" nillable="true" type="xs:string">
      </xs:element>
    </xs:all>
  </xs:complexType>
</xs:element>

http://adgear.com/api/schemas/xml#inputelement publisher_placement

http://adgear.com/api/schemas/xml#input
element publisher_placement