ImageAd

System_CLiX_note Note

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

Defines an Atlas image ad.

<xs:complexType name="ImageAd">
   <xs:complexContent mixed="false">
      <xs:extension base="tns:AdBase">
         <xs:sequence>
            <xs:element minOccurs="0" name="AdExit" nillable="true" type="tns:AdExit"/>
            <xs:element minOccurs="0" name="Asset" nillable="true" type="xs:base64Binary"/>
         </xs:sequence>
      </xs:extension>
   </xs:complexContent>
</xs:complexType>

Elements

Element

Description

Data Type

CreateAd

Updateable by Using UpdateAd

AdExit

An AdExit object that contains information about the click-through URL that belongs to the image ad.

AdExit

Required

Yes; see AdExit for more information.

Asset

A byte array that represents the image file to use for the image ad.

  • The following file types are currently supported: .gif, .jpg.

  • The asset file size cannot exceed one megabyte (MB).

For an example of how to convert an image file into a byte array, see How to Convert an Asset File to a Byte Array in C#.

byte[]

Required when the CreativeId element is not specified; otherwise, should not be defined.

No

Inherited Elements

The elements in the following table are inherited from the AdBase object.

ElementDescriptionData Type

AdTag

A string that contains a unique identifier for the image ad

string

CreativeDescription

A description of this ad’s creative.

string

CreativeId

A GUID indicating the ID of the creative for this ad.

Guid

Id

The ID of this ad.

Guid

IsDefaultAd

Indicates whether or not this is the default ad.

boolean

RevisionInfo

The revision info for this ad.

RevisionInfo

When the UpdateAdRequest.Ad element specifies an ImageAd object, only the ImageAd elements that are listed as updateable can be updated by the Atlas Creative Management API.

  • If an ImageAd element that is listed as not updateable is specified, the element is ignored and its existing value remains unchanged.

  • If an ImageAd element that is listed as updateable is not specified, its existing value remains unchanged.

Namespace

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

Requirements

CreativeService.svc in version 5.

Show: