AdCreativeSizeFilter

System_CLiX_note Note

Atlas is now part of Facebook. To access Atlas API documentation, please click here.

Specifies the criteria to use to filter ad data based on the size of the creative that is associated with the ad.


<xs:complexType name="AdCreativeSizeFilter" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:complexContent mixed="false">
        <xs:extension base="tns:AdFilter">
            <xs:sequence>
                <xs:element minOccurs="0" name="Height" type="xs:int" />
                <xs:element minOccurs="0" name="Threshold" type="xs:int" />
                <xs:element minOccurs="0" name="Width" type="xs:int" />
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

Elements

Element

Description

Data Type

Height

The height, in pixels, to use for the creative size ad filter.

int

Threshold

The threshold to use for the creative size ad filter.

int

Width

The height, in pixels, to use for the creative size ad filter.

int

  • Either the Height or Width element value must be greater than 0.

  • The AdCreativeSizeFilter data object is derived from the AdFilter data object.

Conceptual Example

The creative size filter element values can be used in different combinations to produce different filter behavior. The following table describes some possible combinations.

Width

Height

Threshold

Result

300

250

0 or null

Retrieve ads that have a creative that is exactly 300 pixels wide by 250 pixels tall.

300

250

50

Retrieve ads that have a creative that meets the following criteria:

  • Width of 250 to 350 pixels.

  • Height of 200 to 300 pixels.

500

0 or null

0 or null

Retrieve ads that have a creative that is exactly 500 pixels wide, regardless of height.

0 or null

400

100

Retrieve ads that have a creative that is between 300 and 500 pixels tall, regardless of width.

Namespace

http://advertising.microsoft.com/v5/CreativeService/AtlasCreativeService/ml

Requirements

CreativeService.svc in version 5.

See Also

Reference

AdListCriteria

Show: