Image Data Object - Campaign Management
Defines an image that can be added to an account's media library.
Syntax
<xs:complexType name="Image" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:Media">
<xs:sequence>
<xs:element minOccurs="0" name="Data" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Elements
The Image object has the following elements: Data.
| Element | Description | Data Type |
|---|---|---|
| Data | A base64 string that represents the image or icon to add to the library. The base64 string can contain a maximum of 102,400 characters. For information about restrictions and supported data types, see Remarks below. |
string |
The Image object has Inherited Elements.
Inherited Elements
Inherited Elements from Media
The Image object derives from the Media object, and inherits the following elements: Id, MediaType, Text, Type. The descriptions below are specific to Image, and might not apply to other objects that inherit the same elements from the Media object.
| Element | Description | Data Type |
|---|---|---|
| Id | The unique Microsoft Advertising identifier of the media. Add: Read-only |
long |
| MediaType | The type of media to add to the library. The recommended media type is "GenericImage". For media that will be used with an ImageAdExtension, the supported values are GenericImage, Image16x9, Image15x10, Image4x3, and Image12x10. For media that will be used with a ResponsiveAd, the supported values are GenericImage, Image1x1, Image191x100, and Image4x1. For more information about supported aspect ratios, see the Remarks section below. Add: Required |
string |
| Text | The image alt text. | string |
| Type | The media type. For more information about media types, see the Media Data Object Remarks. Add: Read-only |
string |
Remarks
The image media type indicates the supported aspect ratio of the uploaded image.
We recommend the "GenericImage" with dimensions of 703 width x 368 height or above, in pixels.
All supported sub type values with corresponding dimension and aspect ratio restrictions are described below.
| Sub Type | Aspect Ratio | Minimum Dimension |
|---|---|---|
| GenericImage | Varies | 40 width x 20 height, in pixels |
| Image16x9 | 16:9 | 640 width x 360 height, in pixels |
| Image15x10 | 1.5:1 | 300 width x 200 height, in pixels |
| Image4x3 | 4:3 | 100 width x 75 height, in pixels |
| Image1x1 | 1:1 | 128 width x 128 height, in pixels |
| Image191x100 | 1.91:1 | 703 width x 368 height, in pixels |
| Image4x1 | 4:1 | 512 width x 128 height, in pixels |
Note
The maximum width and height in pixels are 2592 and 2048 independently, and you must still maintain one of the supported aspect ratios. For example, if the sub type is Image191x100 and the width is 2592, then the height must be 1357.
Images with animation are not supported. The following MIME types are supported.
- GIF
- JPEG
- PNG
Tip
The PNG images are converted to JPEG. If you are not satisfied with the quality after conversion, we recommend that you provide JPEG directly.
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13