DisclaimerAdExtension Data Object - Campaign Management
Defines an ad extension that specifies disclaimer text to include in an expanded text ad or responsive search ad.
Syntax
<xs:complexType name="DisclaimerAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:AdExtension">
<xs:sequence>
<xs:element name="DisclaimerLayout" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
<xs:element xmlns:q67="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q67:ArrayOfstring" />
<xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
<xs:element xmlns:q68="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q68:ArrayOfstring" />
<xs:element minOccurs="0" name="LineText" nillable="true" type="xs:string" />
<xs:element name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PopupText" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Title" 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:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Elements
The DisclaimerAdExtension object has the following elements: DisclaimerLayout, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, LineText, Name, PopupText, Title, TrackingUrlTemplate, UrlCustomParameters.
| Element | Description | Data Type |
|---|---|---|
| DisclaimerLayout | The layout of the disclaimer. Can either be additionalLine or popup. | string |
| FinalAppUrls | Reserved. | 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. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty list, the previous setting will be deleted. |
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. Add: Required Update: Optional. If no value is set for the update, this setting is not changed. |
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, this setting is not changed. |
string |
| LineText | Required text if the disclaimer is in additionalLine layout. Max. length: 80 characters. |
string |
| Name | The name of the disclaimer. This is only used for reporting to help identify the extension. Max. length: 35 characters. |
string |
| PopupText | Required text if the disclaimer is in popup layout. Max. length: 500 characters. |
string |
| Title | The title of the popup in popup layout. Max. length: 75 characters |
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 no value is set for the update, this setting is not changed. If you set this element to an empty string (""), 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 3 CustomParameter objects that you include within the CustomParameters object, and any additional custom parameters will be ignored. 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 no value is set for the update, this setting is not changed. Set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object. |
CustomParameters |
The DisclaimerAdExtension object has Inherited Elements.
Inherited Elements
Inherited Elements from AdExtension
The DisclaimerAdExtension object derives from the AdExtension object, and inherits the following elements: DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version. The descriptions below are specific to DisclaimerAdExtension, 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 the ad extension. This value is DisclaimerAdExtension when you retrieve a location ad extension. Add: Read-only Update: Read-only For more information about ad extension types, see the Ad Extension Data Object 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
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for