Video Data Object - Campaign Management

Defines the Video Data Object.

Note

Not everyone has this feature yet. If you don't, don't worry - it's coming soon!

Syntax

XML

<xs:complexType name="Video" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AspectRatio" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="CreatedDateTimeInUTC" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="DurationInMilliseconds" nillable="true" type="xs:int" />
    <xs:element minOccurs="0" name="FailureCode" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="ModifiedDateTimeInUTC" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="SourceUrl" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ThumbnailUrl" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Url" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "AspectRatio": "ValueHere",
  "CreatedDateTimeInUTC": "ValueHere",
  "Description": "ValueHere",
  "DurationInMilliseconds": IntValueHere,
  "FailureCode": "ValueHere",
  "Id": "LongValueHere",
  "ModifiedDateTimeInUTC": "ValueHere",
  "SourceUrl": "ValueHere",
  "Status": "ValueHere",
  "ThumbnailUrl": "ValueHere",
  "Url": "ValueHere"
}

Elements

The Video object has the following elements: AspectRatio, CreatedDateTimeInUTC, Description, DurationInMilliseconds, FailureCode, Id, ModifiedDateTimeInUTC, SourceUrl, Status, ThumbnailUrl, Url.

Element	Description	Data Type
AspectRatio	The video's aspect ratio. Possible values are 16:9, 9:16, 4:3, 3:4, 1:1, 5:4, and 4:5.	string
CreatedDateTimeInUTC	The date and time the video was created, in Coordinated Universal Time.	dateTime
Description	The description of the video asset. Add: Supported Update: Supported	string
DurationInMilliseconds	The duration in milliseconds of the video asset. Add: Unsupported Update: Unsupported	int
FailureCode	Read the description for each possible error code below. AssetDataInvalid: The file downloaded from the URL is not a video. VideoDownloadError: The provided URL is not accessible. AssetDataInvalidWidth: The video frame width is less than 120 pixels. AssetDataInvalidHeight: The video frame height is less than 120 pixels. InvalidDuration: The video duration is less than 6 seconds. VideoOverweight: The video file size is greater than 2 GB. VideoTranscodingError: A general failure code that represents a transcoding issue. This is controlled by Azure Media Service. Learn more about encoding video and JobErrorCode.	string
Id	The identifier of the video.	long
ModifiedDateTimeInUTC	The date and time the video was last modified, in Coordinated Universal Time.	dateTime
SourceUrl	The original URL of the video. Note: SourceUrl must be a direct download URL. Add: Supported and Required	string
Status	The status of the video asset. The status can be Draft, Active, Deleted or Failed. Add: Unsupported Update: Supported	string
ThumbnailUrl	The thumbnail URL of the video asset. Add: Unsupported Update: Unsupported	string
Url	The URL where the video is hosted. Note: URL is reserved for internal usage. Add: Supported Update: Supported	string

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Used By

AddVideos
AdRecommendationVideoSuggestion
GetVideosByIds
UpdateVideos