ImageAdExtension Data Object - Campaign Management

Defines an ad extension that specifies an image with alternative text to include in an expanded text ad.

You can associate an image ad extension with the account or with campaigns and ad groups in the account. For each account, only 1,000 campaigns and 1,000 ad groups can be associated with image ad extensions. Each entity (account, campaign, or ad group) can be associated with up to 6 image ad extensions.


<xs:complexType name="ImageAdExtension" xmlns:xs="">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
        <xs:element minOccurs="0" name="AlternativeText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element minOccurs="0" name="FinalMobileUrls" nillable="true" type="q38:ArrayOfstring" xmlns:q38="" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string">
              <DefaultValue EmitDefaultValue="false" xmlns="" />
        <xs:element minOccurs="0" name="FinalUrls" nillable="true" type="q39:ArrayOfstring" xmlns:q39="" />
        <xs:element minOccurs="0" name="ImageMediaIds" nillable="true" type="q40:ArrayOflong" xmlns:q40="" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />


Element Description Data Type
AlternativeText Alternative description of the image media for usability. If the image could not be displayed, the alternative text is used instead.

The maximum length for this element is 35 characters.

Add: Optional
Update: Optional
Description Description that can be used by the advertiser, agency, or account manager to track, label, or manage image media. This description is not displayed with the ad or image.

The maximum length for this element is 100 characters.

Add: Optional
Update: Optional
DestinationUrl The URL of the webpage to take the user to when they click the image.

The URL can contain dynamic text strings such as {keyword}. For more information, see What tracking or URL parameters can I use?.

The URL can contain a maximum of 1,024 characters. If the URL does not specify a protocol, the system uses the HTTP protocol when a user clicks the ad. If the URL specifies the HTTP protocol when you add an ad, the service will remove the http:// protocol string (the HTTP protocol string does not count against the 1,024 character limit); however, the service will not remove an HTTPS protocol string (https://) from the URL.

If the URL is not specified for the image ad extension, the URL of the ad is used.

Add: Optional
Update: Optional
FinalAppUrls Not supported for image ad extensions. AppUrl array
FinalMobileUrls Not supported for image ad extensions. string array
FinalUrls Not supported for image ad extensions. string array
FinalUrlSuffix Not supported for image ad extensions. string
ImageMediaIds The identifiers of the images to include in the ad. You may not specify media identifiers for more than one image of the same aspect ratio. In other words each of the referenced images must have different aspect ratios.

You can specify up to four (4) image media identifiers. While the minimum required is one image media ID, in order to qualify for all ad placements you must provide four image media identifiers, where each ID corresponds to an Image of one of the four supported Media types (aspect ratios). The supported aspect ratios for audience ads are 16:9, 1.5:1, 4:3, and 1.2:1. For more information see the Image data object reference documentation.

You can get the identifier of each Image when you add them to the image library by calling the AddMedia operation. Otherwise after the media has been added to your image library you can get the media identifiers with the GetMediaMetaDataByAccountId operation.

Add: Required
Update: Optional
long array
TrackingUrlTemplate Not supported for image ad extensions. string
UrlCustomParameters Not supported for image ad extensions. CustomParameters

The ImageAdExtension object has Inherited Elements.

Inherited Elements

Inherited Elements from AdExtension

The ImageAdExtension object derives from the AdExtension object, and inherits the following elements. The descriptions below are specific to ImageAdExtension, and might not apply to other objects that inherit the same elements from the AdExtension object.

Element Description Data Type
DevicePreference Not supported for image ad extensions. long
ForwardCompatibilityMap The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version.

There are currently no forward compatibility changes for the AdExtension object.

Add: Read-only
Update: Read-only
KeyValuePairOfstringstring array
Id The unique Microsoft Advertising identifier of the ad extension.

Add: Read-only and Required
Update: Read-only
Scheduling This element is not supported for image ad extensions. Scheduling is supported for other ad extension types. Schedule
Status The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions.

Add: Read-only
Update: Read-only
Type The type of the ad extension. This value is ImageAdExtension when you retrieve an image ad extension.

Add: Read-only
Update: Read-only

For more information about ad extension types, see the Ad Extension Data Object Remarks.
Version The number of times the contents of the ad extension has been updated. The version is set to 1 when you add the extension and is incremented each time it's revised.

Add: Read-only
Update: Read-only


Service: CampaignManagementService.svc v12