Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Ad
Bid
Expand Minimize

ImageAdExtension Data Object

System_CLiX_note Note

Currently this feature is only available for pilot participants. For more information, see GetCustomerPilotFeatures Service Operation.

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

The ImageAdExtension object derives from the AdExtension object. For a list of inherited elements, see the AdExtension object.

<xs:complexType name="ImageAdExtension">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <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 type="xs:long" name="ImageMediaId"/>
        <xs:element xmlns:q53="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaIds" nillable="true" type="q53:ArrayOflong"/>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

Element

Description

Data Type

Add

Update

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.

string

Optional

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.

string

Optional

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 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.

System_CLiX_noteNote

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

string

Optional

Optional

ImageMediaId

The identifier of the image to include in the ad.

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.

System_CLiX_noteNote

You must specify either ImageMediaId or ImageMediaId, but not both. The ImageMediaId element is deprecated and will be removed in Bing Ads API version 10. You should use ImageMediaIds. If ImageMediaIds is specified the ImageMediaId element will be ignored.

long

Optional

Optional

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 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.

System_CLiX_noteNote

You must specify either ImageMediaId or ImageMediaId, but not both. The ImageMediaId element is deprecated and will be removed in Bing Ads API version 10. You should use ImageMediaIds. If ImageMediaIds is specified the ImageMediaId element will be ignored.

long

Optional

Optional

Requirements

CampaignManagementService.svc v9

Namespace: https://bingads.microsoft.com/CampaignManagement/v9

Community Additions

ADD
Show:
© 2015 Microsoft