VideoAdExtension Data Object - Campaign Management

Article
10/16/2024

Defines an ad extension with a video and call-to-action button.

Syntax

<xs:complexType name="VideoAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="ActionText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="AlternativeText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q65="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q65:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q66="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q66:ArrayOfstring" />
        <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="ThumbnailId" nillable="true" type="xs:long" />
        <xs:element minOccurs="0" name="ThumbnailUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
        <xs:element minOccurs="0" name="VideoId" nillable="true" type="xs:long" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The VideoAdExtension object has the following elements: ActionText, AlternativeText, DisplayText, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, Name, ThumbnailId, ThumbnailUrl, TrackingUrlTemplate, UrlCustomParameters, VideoId.

Element	Description	Data Type
ActionText	The action text for the video asset.	string
AlternativeText	The alt text for the video asset.	string
DisplayText	The display text for the video asset.	string
FinalAppUrls	For future use.	AppUrl array
FinalMobileUrls	The landing page URL for mobile devices. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 list items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 list items for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. - You may not specify FinalMobileUrls if the DevicePreference is set to 30001 (mobile). Add: Optional Update: Optional. If no value is set for the update, the prior setting is removed.	string array
FinalUrls	The landing page URL. The following validation rules apply to Final URLs and Final Mobile URLs. - The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - You may specify up to 10 list items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 list items for potential forward compatibility. - Usage of '{' and '}' is only allowed to delineate tags, for example {lpurl}. - Final URLs must each be a well-formed URL starting with either http:// or https://. - If you specify FinalMobileUrls, you must also specify FinalUrls. - You may not specify FinalMobileUrls if the DevicePreference is set to 30001 (mobile). Add: Optional Update: Optional. If no value is set for the update, the prior setting is removed.	string array
FinalUrlSuffix	The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides. This feature is only available for customers in the Final URL Suffix Phase 3 pilot (GetCustomerPilotFeatures returns 636). If you are not in the pilot this property will be ignored and no error will be returned. Add: Optional Update: Optional. If no value is set for the update, the prior setting is removed.	string
Name	The name of the video asset.	string
ThumbnailId	The ID of the thumbnail asset.	long
ThumbnailUrl	The thumbnail URL of the video asset. Add: Unsupported Update: Unsupported	string
TrackingUrlTemplate	The tracking template to use as a default for all FinalUrls and FinalMobileUrls. The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Microsoft Advertising help article What tracking or URL parameters can I use? - Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Limits. - The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit. - The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}. - Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is `https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}` and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same. Add: Optional Update: Optional. If you set this element null, the previous setting will be deleted.	string
UrlCustomParameters	Your custom collection of key and value parameters for URL tracking. Microsoft Advertising will accept the first 8 CustomParameter objects that you include within the CustomParameters object, and if you include more than 8 custom parameters an error will be returned. Each CustomParameter includes Key and Value elements. For customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635), Microsoft Advertising will accept the first 8 custom parameter key and value pairs that you include, and if you include more than 8 custom parameters an error will be returned. Add: Optional Update: Optional. If you set this element null, the previous setting will be deleted.	CustomParameters
VideoId	The ID of the video.	long

The VideoAdExtension object has Inherited Elements.

Inherited Elements

Inherited Elements from AdExtension

The VideoAdExtension object derives from the AdExtension object, and inherits the following elements: DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version. The descriptions below are specific to VideoAdExtension, and might not apply to other objects that inherit the same elements from the AdExtension object.

Element	Description	Data Type
DevicePreference	This element determines whether the preference is for the ad extension to be displayed on mobile devices or all devices. To specify a preference for mobile devices, set this element to 30001. To specify all devices, set this element to 0 (zero) or leave the element nil. By default, this element will be nil. This element is only applicable for the AppAdExtension and SitelinkAdExtension types.	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. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.	KeyValuePairOfstringstring array
Id	The unique Microsoft Advertising identifier of the ad extension.	long
Scheduling	Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads.	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.	AdExtensionStatus
Type	The type of ad extension. For more information, see Remarks.	string
Version	Tracks the number of times the ad extension has been updated. The version is set to 1 when the ad extension is created, and increments by one after each update.	int

Requirements

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

Share via