FilterLinkAdExtension Data Object - Campaign Management
Filter Link Extensions pair one header with between 3 and 10 clickable text values that tell customers more about your business.
You can associate a filter link ad extension with the account or with campaigns and ad groups in the account. Each entity (account, campaign, or ad group) can be associated with up to 20 filter link ad extensions. An expanded text ad will only include one filter link extension (one headline with 3 - 10 clickable values) per impression.
Syntax
<xs:complexType name="FilterLinkAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:AdExtension">
<xs:sequence>
<xs:element minOccurs="0" name="AdExtensionHeaderType" nillable="true" type="tns:AdExtensionHeaderType" />
<xs:element xmlns:q58="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q58:ArrayOfstring" />
<xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
<xs:element xmlns:q59="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q59:ArrayOfstring" />
<xs:element minOccurs="0" name="Language" nillable="true" type="xs:string" />
<xs:element xmlns:q60="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="Texts" nillable="true" type="q60:ArrayOfstring" />
<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 FilterLinkAdExtension object has the following elements: AdExtensionHeaderType, FinalMobileUrls, FinalUrls, FinalUrlSuffix, Language, Texts, TrackingUrlTemplate, UrlCustomParameters.
| Element | Description | Data Type |
|---|---|---|
| AdExtensionHeaderType | The header that is appended with a colon (:) and precedes the filter link values in the ad that is shown. Filter link headers will be shown in the language that you specify. For example, if you want header Amenities in English you must set the Language to English and the AdExtensionHeaderType to Amenities. If you want header Ausstattung (Amenities in German) you must set the Language to German and the AdExtensionHeaderType to Amenities. Add: Required Update: Required |
AdExtensionHeaderType |
| 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 |
| Language | The language you want to use for the filter link headers. Filter link headers will be shown in the language that you specify. For example, if you want header Amenities in English you must set the Language to English and the AdExtensionHeaderType to Amenities. If you want header Ausstattung (Amenities in German) you must set the Language to German and the AdExtensionHeaderType to Amenities. Add: Required Update: Required |
string |
| Texts | The text values that follow after the AdExtensionHeaderType component of the ad that is shown. Each text value that you choose can have a maximum length of 25 characters. Note that for Traditional Chinese characters, each value can have a maximum length of 12 characters. Add: Required Update: Required |
string array |
| 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 FilterLinkAdExtension object has Inherited Elements.
Inherited Elements
Inherited Elements from AdExtension
The FilterLinkAdExtension object derives from the AdExtension object, and inherits the following elements: DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version. The descriptions below are specific to FilterLinkAdExtension, and might not apply to other objects that inherit the same elements from the AdExtension object.
| Element | Description | Data Type |
|---|---|---|
| DevicePreference | Not supported for this ad extension type. | 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. There are currently no forward compatibility changes for the AdExtension object. Add: Read-only Update: Read-only |
KeyValuePairOfstringstring array |
| Id | The unique Microsoft Advertising identifier of the ad extension. Add: Read-only Update: Read-only and Required |
long |
| Scheduling | Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads. Add: Optional Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. To remove all scheduling set this element to an empty Schedule object. |
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. Add: Read-only Update: Read-only |
AdExtensionStatus |
| Type | The type of the ad extension. This value is FilterLinkAdExtension when you retrieve a filter link 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. Add: Not allowed Update: Not allowed |
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