DynamicSearchAd Data Object - Campaign Management

Defines a dynamic search ad. With a dynamic search ads campaign, the ad title and display URL are generated automatically based on the website domain and language that you want to target. The combination of the Path1, Path2, and Text elements make the dynamic search ad unique.

Note

This feature is currently available in Canada, France, Germany, the United Kingdom, and the United States.

To get started with dynamic search ads, first you'll need to add a new Campaign with its type set to DynamicSearchAds. When you create the campaign, you'll need to include a DynamicSearchAdsSetting that specifies the target website domain and language.

Next, create a new AdGroup within the dynamic search ads campaign. You can add one or more Webpage criterion to each ad group that helps determine whether or not to serve dynamic search ads, by calling the AddAdGroupCriterions operation.

If you want to exclude certain portions of your website, you can add negative Webpage criterion at the campaign and ad group level using the respective AddCampaignCriterions and AddAdGroupCriterions service operations. The negative Webpage criterion at the campaign level applies to all ad groups within the campaign; however, if you define ad group level negative Webpage criterion, the campaign criterion is ignored for that ad group.

Whether the criterion is positive or negative, you can choose whether you want the criterion argument to match partial URLs, page content, page title, or categories that Bing thinks applies to your website. To discover the categories that you can use for Webpage criterion (positive or negative), use the GetDomainCategories operation with the Ad Insight service.

Finally you can add a DynamicSearchAd to the ad group. The ad title and display URL are generated automatically based on the website domain and language that you want to target.

Syntax

<xs:complexType name="DynamicSearchAd" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Ad">
      <xs:sequence>
        <xs:element minOccurs="0" name="Path1" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Path2" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="TextPart2" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

Element Description Data Type
Path1 The first part of the optional path that will be appended to the domain portion of your display URL. The display URL e.g. www.contoso.com will be generated from the domain of your display URL. Then if you have specified a value for Path 1 it will be appended to the display URL. If you have also specified a value for Path 2, then it will also be appended to the display URL after Path 1. For example if your domain is contoso.com, Path 1 is set to subdirectory1, and Path 2 is set to subdirectory2, then the URL displayed will be www.contoso.com/subdirectory1/subdirectory2.

The maximum input length of the path is 15 characters. Note that for languages with double-width characters e.g. Traditional Chinese the maximum input length of the path is 7 characters. Although dynamic text substitution is supported for other ad types like Expanded Text ads, it is not supported for dynamic search ads.

The path cannot contain the forward slash (/) or newline (\n) characters.

If the path includes a space, it will be replaced with an underscore (_) when the ad is shown.

Add: Optional
Update: Optional
string
Path2 The second part of the optional path that will be appended to the domain portion of your display URL. The display URL e.g. www.contoso.com will be generated from the domain of your dynamic search ads campaign level settings. Then if you have specified a value for Path 1 it will be appended to the display URL. If you have also specified a value for Path 2, then it will also be appended to the display URL after Path 1. For example if your domain is contoso.com, Path 1 is set to subdirectory1, and Path 2 is set to subdirectory2, then the URL displayed will be www.contoso.com/subdirectory1/subdirectory2.

You can only specify Path2 if Path1 is also set.

The maximum input length of the path is 15 characters. Note that for languages with double-width characters e.g. Traditional Chinese the maximum input length of the path is 7 characters. Although dynamic text substitution is supported for other ad types like Expanded Text ads, it is not supported for dynamic search ads.

The path cannot contain the forward slash (/) or newline (\n) characters.

If the path includes a space, it will be replaced with an underscore (_) when the ad is shown.

Add: Optional
Update: Optional
string
Text The first part of the ad description.

The text must contain at least one word.

The maximum input length of the copy is 90 characters. Note that for ad groups that use Traditional Chinese the maximum input length of the copy is 45 characters. Although dynamic text substitution is supported for other ad types like Expanded Text ads, it is not supported for dynamic search ads.

The text cannot contain the newline (\n) character.

Add: Required
Update: Optional
string
TextPart2 The second part of the ad description.

The text must contain at least one word.

The maximum input length of the copy is 90 characters. Note that for ad groups that use Traditional Chinese the maximum input length of the copy is 45 characters. Although dynamic text substitution is supported for other ad types like Expanded Text ads, it is not supported for dynamic search ads.

The text cannot contain the newline (\n) character.

This feature is only available for customers in the Dynamic Search Ads Text Part 2 pilot (GetCustomerPilotFeatures returns 600). If you are not in the pilot and you try to set this property an error will be returned. During calendar year 2019 this feature will be enabled for all customers.

Add: Optional
Update: Optional
string

The DynamicSearchAd object has Inherited Elements.

Inherited Elements

Inherited Elements from Ad

The DynamicSearchAd object derives from the Ad object, and inherits the following elements. The descriptions below are specific to DynamicSearchAd, and might not apply to other objects that inherit the same elements from the Ad object.

Element Description Data Type
AdFormatPreference This element is not applicable for dynamic search ads. string
DevicePreference This element is not applicable for dynamic search ads. long
EditorialStatus The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved.

Add: Read-only
Update: Read-only
AdEditorialStatus
FinalAppUrls This element is not applicable for dynamic search ads. AppUrl array
FinalMobileUrls This element is not applicable for dynamic search ads. string array
FinalUrls This element is not applicable for dynamic search ads. 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 2 pilot (GetCustomerPilotFeatures returns 566). If you are not in the pilot this property will be ignored and no error will be returned. During calendar year 2019 this feature will be enabled for all customers.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed.
string
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.

Currently there are no supported forward compatibility map key and value pairs for dynamic search ads.
KeyValuePairOfstringstring array
Id The unique Microsoft Advertising identifier of the ad.

Add: Read-only
Update: Required and Read-Only
long
Status The status of the ad.

You can set the ad status to Active or Paused.

Add: Optional
Update: Optional
AdStatus
TrackingUrlTemplate The tracking template to use as a default for all landing page URLs.

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 http://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
string
Type The type of the ad. This value is DynamicSearch when you retrieve an dynamic search ad. For more information about ad types, see the Ad Data Object Remarks.

Add: Read-only
Update: Read-only
AdType
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 2 pilot (GetCustomerPilotFeatures returns 565), 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. During calendar year 2019 the limit will be increased from 3 to 8 for all customers.

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

Requirements

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