ImageAdExtension Data Object


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

<xs:complexType name="ImageAdExtension">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
        <xs:element type="xs:string" name="AlternativeText" nillable="true"/>
        <xs:element type="xs:string" name="Description" nillable="true" minOccurs="0"/>
        <xs:element type="xs:string" name="DestinationUrl" nillable="true" minOccurs="0"/>
        <xs:element xmlns:q57="" minOccurs="0" name="FinalAppUrls" nillable="true" type="q57:ArrayOfAppUrl"/>
        <xs:element xmlns:q58="" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q58:ArrayOfstring"/>
        <xs:element xmlns:q59="" minOccurs="0" name="FinalUrls" nillable="true" type="q59:ArrayOfstring"/>
        <xs:element xmlns:q60="" name="ImageMediaIds" nillable="true" type="q60:ArrayOflong"/>
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string"/>
        <xs:element xmlns:q61="" minOccurs="0" name="UrlCustomParameters" nillable="true" type="q61:CustomParameters"/> 

The ImageAdExtension object inherits elements from the AdExtension object. For a list of the inherited elements, see Inherited Elements below.

ElementDescriptionData Type
AlternativeTextAlternative 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
DescriptionDescription 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
DestinationUrlThe 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 Dynamic Text for Ad Extension URL.

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.

Note: If not specified for an image, the URL of the TextAd is used.

Add: Optional

Update: Optional
FinalAppUrlsReserved for future use.AppUrl array
FinalMobileUrlsReserved for future use.string array
FinalUrlsReserved for future use.string array
ImageMediaIdsThe 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 native 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 native 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
TrackingUrlTemplateReserved for future use.string
UrlCustomParametersReserved for future use.CustomParameters

The ImageAdExtension object inherits the following elements from the AdExtension object.

System_CAPS_ICON_note.jpg Note

The descriptions below are specific to image ad extensions, and might not apply to other objects that inherit the same elements from the AdExtension object.

ElementDescriptionData Type
ForwardCompatibilityMapThe list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.

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

Add: Read-only

Update: Read-only
KeyValuePairOfstringstring array
IdThe unique Bing Ads identifier of the ad extension.

Add: Read-only and Required

Update: Read-only
SchedulingDetermines the calendar day and time ranges when the ad extension is eligible to be shown in ads.

Note: Not everyone has this feature yet. If you don’t, don’t worry. It’s coming soon.

Add: Optional

Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. To remove all scheduling set this element to an empty Schedule object.

Get: This element is not returned in the AdExtension object by default. You must include Scheduling in the optional ReturnAdditionalFields flags when calling GetAdExtensionsAssociations and GetAdExtensionsByIds.
StatusThe 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
TypeThe 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.
VersionThe 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

CampaignManagementService.svc v10



Community Additions