TextAd Data Object

 

Defines a text ad.

<xs:complexType name="TextAd">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Ad">
      <xs:sequence>
        <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
        <xs:element name="DisplayUrl" nillable="true" type="xs:string" />
        <xs:element name="Text" nillable="true" type="xs:string" />
        <xs:element name="Title" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

The TextAd object inherits elements from the Ad object. For a list of the inherited elements, see Inherited Elements below.

System_CAPS_ICON_note.jpg Note

The combination of the DestinationUrl, DisplayUrl, Text, and Title elements make the text ad unique.

ElementDescriptionData Type
DestinationUrlThe URL of the webpage to take the user to when they click the ad.

The URL can contain dynamic parameters such as {MatchType}.

For a list of supported parameters, see the Bing Ads help article What tracking or URL parameters can I use?.

The URL can contain a maximum of 1,024 characters. If the URL does not specify a protocol, the system uses the HTTP protocol when a user clicks the ad. If the URL specifies the HTTP protocol when you add an ad, the service will remove the http:// protocol string (the HTTP protocol string does not count against the 1,024 character limit); however, the service will not remove an HTTPS protocol string (https://) from the URL.

Important: If you are currently using Destination URLs, you must eventually replace them with Final URLs. For more information, see Tracking Templates for Landing Page URLs.

Note: This URL is used only if the keyword does not specify a destination URL.

Add: Required

Update: Optional
string
DisplayUrlThe URL to display in the ad.

The subdirectory of the display URL can contain dynamic text strings such as {keyword}; however, the URL hostname cannot contain dynamic text. For more information, see the Bing Ads help article Automatically customize your ads with dynamic text parameters.

The maximum input length of the URL is 200 characters, and can contain dynamic text strings. However, the ad will fail to display if the URL exceeds 35 characters after dynamic text substitution occurs.

Add: Required

Update: Optional
string
TextThe ad copy. The copy must contain at least one word. The ad’s copy and title combined must total at least three words.

The text can contain dynamic text strings such as {keyword}. For more information, see the Bing Ads help article Automatically customize your ads with dynamic text parameters.

The maximum input length of the copy is 300 characters, and can contain dynamic text strings. However, the ad will fail to display if the copy exceeds 71 characters after dynamic text substitution occurs. Note that for ad groups that use Traditional Chinese, the text is limited to 38 characters after substitution.

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

Add: Required

Update: Optional
string
TitleThe title of the ad. The title must contain at least one word. The ad’s copy and title combined must total at least three words.

The title can contain dynamic text strings such as {keyword}. For more information, see the Bing Ads help article Automatically customize your ads with dynamic text parameters.

The maximum input length of the title is 80 characters, and can contain dynamic text strings. However, the ad will fail to display if title exceeds 25 characters after dynamic text substitution occurs. Note that for ad groups that use Traditional Chinese, the title is limited to 15 characters after substitution.

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

Add: Required

Update: Optional
string

The TextAd object inherits the following elements from the Ad object.

System_CAPS_ICON_note.jpg Note

The descriptions below are specific to text ads, and might not apply to other objects that inherit the same elements from the Ad object.

ElementDescriptionData Type
DevicePreferenceThis element determines whether the preference is for text ads 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. You must define at least one text ad per ad group that is not mobile preferred, otherwise the ad will be eligible for all devices.

Add: Optional

Update: Optional
long
EditorialStatusThe 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
FinalAppUrlsNot supported for text ads.AppUrl array
FinalMobileUrlsThe mobile landing page URL.

Note: This URL is used only if the keyword does not specify a final mobile URL.

The following validation rules apply to Final URLs and Final Mobile URLs.

  • The length of the URL is limited to 2,048 characters.

    Note: The HTTP or HTTPS protocol string does count towards the 2,048 character limit.

  • You may specify up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 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 device preference is set to mobile.

Also note that for TextAd objects you may not specify FinalMobileUrls if the DevicePreference is set to 30001 (mobile).
string array
FinalUrlsThe landing page URL.

Note: This URL is used only if the keyword does not specify a final URL.

The following validation rules apply to Final URLs and Final Mobile URLs.

  • The length of the URL is limited to 2,048 characters.

    Note: The HTTP or HTTPS protocol string does count towards the 2,048 character limit.

  • You may specify up to 10 items for both FinalUrls and FinalMobileUrls; however, only the first item in each list is used for delivery. The service allows up to 10 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 device preference is set to mobile.

Also note that if this ad's TrackingUrlTemplate or UrlCustomParameters element are set, then at least one final URL is required.

Add: Required

Update: Optional
string array
ForwardCompatibilityMapThe list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.

For a list of valid key and value strings for this element, see Text Ad ForwardCompatibilityMap in the section below.

Add: Optional

Update: Optional
KeyValuePairOfstringstring array
IdThe unique Bing Ads identifier for the ad.

Add: Read-only

Update: Required and Read-only
long
StatusThe status of the ad.

Add: Optional

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

The following validation rules apply to tracking templates for Search and Content campaigns.

  • Tracking templates defined for lower level entities e.g. keyword override those set for higher level entities e.g. campaign. For more information, see Entity Hierarchy and Limits.

  • The length of the tracking template is limited to 2,048 characters.

    Note: 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}.

  • You can use any dynamic parameter supported by Bing Ads. For a list of supported parameters, see the Bing Ads help article What tracking or URL parameters can I use?

  • Bing Ads does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the final URL will include the key and value placeholders of your custom parameters without substitution. For example if your tracking template is for example http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}, and neither {_season} or {_promocode} are defined at the campaign, ad group, keyword, or ad level, then the final URL will be the same.



Add: Optional

Update: Optional
string
TypeThe type of the ad. This value is Text when you retrieve a text ad. For more information about ad types, see the Ad Data Object Remarks.

Add: Read-only

Update: Read-only
AdType
UrlCustomParametersYour custom collection of key and value parameters for URL tracking.

You may include up to 3 individual CustomParameter objects within the CustomParameters object. Each CustomParameter contains a Key and Value element.

On update, 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.

Add: Optional

Update: Optional
CustomParameters

The following is the list of keys that are available for the ForwardCompatibilityMap element of an Ad.

NativePreference

The NativePreference key is used to indicate whether or not you prefer the ad copy to be shown to users as a search or native ad. Search ads tend to be written as a call to action, whereas native ads should be written in more of an informational style. By defining at least one ad that should be used as native, the search ads will only be shown in search results.

System_CAPS_ICON_important.jpg Important

The NativePreference key is only applicable for the TextAd object, which inherits all elements from the Ad object. The NativePreference key will be ignored if specified for other ad types. You must define at least one text ad per ad group that is not native preferred, otherwise the ad copy of all text ads will be eligible for both search and native ads.

The possible values for the NativePreference key are as follows. If the NativePreference key is not specified, the default value is False.

  • False - The ad will be eligible for both search and native ad formats.
  • True - The ad will only be eligible for the native ad format.

CampaignManagementService.svc v10

Namespace: https://bingads.microsoft.com/CampaignManagement/v10

AddAdsDeleteAdsGetAdsByAdGroupIdGetAdsByEditorialStatusGetAdsByIdsUpdateAds

Community Additions

ADD
Show: