SiteLink Data Object

 

Defines a site link to include in an ad. The link should take the user to content in your website that is relevant in the context of the ad.

System_CAPS_ICON_important.jpg Important

During calendar year 2017, Bing Ads will upgrade all SiteLinksAdExtension objects (contains multiple sitelinks per ad extension) to Sitelink2AdExtension objects (contains one sitelink per ad extension). If you are interested in upgrading earlier, please reach out to your account manager or contact support. For more details please see Upgrade from Multiple Sitelinks to One Sitelink Per Extension.

<xs:complexType name="SiteLink">
  <xs:sequence>
    <xs:element minOccurs="0" name="Description1" nillable="true" type="xs:string"/>
    <xs:element minOccurs="0" name="Description2" nillable="true" type="xs:string"/>
    <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string"/>
    <xs:element minOccurs="0" name="DevicePreference" nillable="true" type="xs:long"/>
    <xs:element name="DisplayText" nillable="true" type="xs:string"/>
    <xs:element xmlns:q49="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" minOccurs="0" name="FinalAppUrls" nillable="true" type="q49:ArrayOfAppUrl"/>
    <xs:element xmlns:q50="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q50:ArrayOfstring"/>
    <xs:element xmlns:q51="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q51:ArrayOfstring"/>
    <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string"/>
    <xs:element name="Scheduling" type="tns:Schedule" nillable="true" minOccurs="0">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element xmlns:q52="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" minOccurs="0" name="UrlCustomParameters" nillable="true" type="q52:CustomParameters"/>
  </xs:sequence>
</xs:complexType>

ElementDescriptionData Type
Description1The site link description line 1.

If Simplified Chinese or Traditional Chinese characters are included, the limit is 15 characters. For English and all other languages, the limit is 35 characters.

Note: If you specify Description1 then Description2 is required.

Add: Optional

Update: Optional
string
Description2The site link description line 2.

If Simplified Chinese or Traditional Chinese characters are included, the limit is 15 characters. For English and all other languages, the limit is 35 characters.

Note: If you specify Description2 then Description1 is required.

Add: Optional

Update: Optional
string
DestinationUrlImportant: If you are currently using Destination URLs, you must eventually replace them with Final URLs. For more information, see URL Tracking with Upgraded URLs.The URL of the webpage that users are taken to when they click the site link.

The URL can contain dynamic parameters such as {MatchType}. For a list of supported parameters, see the Available parameters section within the Bing Ads help article Learn more about each click: Use URL tracking.

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.

Add: Required

Update: Optional
string
DevicePreferenceThis element determines whether the preference is for site links 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.

Add: Optional

Update: Optional
long
DisplayTextThe site-link text displayed in the ad.

For Simplified Chinese and Traditional Chinese, if you specify Description1 or Description2 then the display text can contain a maximum of 11 characters; otherwise, the display text can contain a maximum of 15 characters.

For English and all other languages, if you specify Description1 or Description2 then the display text can contain a maximum of 25 characters; otherwise, the display text can contain a maximum of 35 characters.

Add: Required

Update: Optional
string
FinalAppUrlsReserved for future use.AppUrl array
FinalMobileUrlsThe mobile 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.

    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 you may not specify FinalMobileUrls if the DevicePreference is set to 30001 (mobile).

Add: Optional

Update: Optional
string array
FinalUrlsThe 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.

    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 site link's TrackingUrlTemplate or UrlCustomParameters element are set, then at least one final URL is required.

Add: Optional

Update: Optional
string array
SchedulingDetermines the calendar day and time ranges when the sitelink is eligible to be shown in ads.

Note: Not everyone has this feature yet. If you don’t, don’t worry. It’s coming soon.

Note: This element is used instead of - not in addition to - setting the Scheduling element of the sitelinks ad extension; A Scheduling element is not included in the SiteLinksAdExtension object. (For all other ad extension types including Sitelink2AdExtension, the AdExtension object will include the Scheduling element.)

Add: Optional

Update: Optional. If you set this element null, any existing scheduling set for the sitelink will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the sitelink. To remove all scheduling set this element to an empty Schedule object.

Get: This element is not returned in the SiteLink object by default. You must include Scheduling in the optional ReturnAdditionalFields flags when calling GetAdExtensionsAssociations and GetAdExtensionsByIds.
Schedule
TrackingUrlTemplateThe 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 Bing Ads 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 Hierarchy and 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}.

  • 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 landing page 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, criterion, keyword, or ad level, then the landing page URL will be the same.



Add: Optional

Update: Optional
string
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

CampaignManagementService.svc v10

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

SiteLinksAdExtension

Community Additions

ADD
Show: