SiteLinksAdExtension Data Object - Campaign Management

Defines an object with multiple sitelinks per ad extension. You can use the sitelinks to promote certain products, services, or sections of your website and take potential customers to exactly the information they were searching for. This can increase both click-through-rate and conversions.

Note

During calendar year 2017, Bing Ads upgraded all SiteLinksAdExtension objects (contains multiple sitelinks per ad extension) to Sitelink2AdExtension objects (contains one sitelink per ad extension). In a future version of the API the deprecated sitelink programming interface will be consolidated and the '2' suffix will be removed from the new sitelink ad extensions.

Syntax

<xs:complexType name="SiteLinksAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element name="SiteLinks" nillable="true" type="tns:ArrayOfSiteLink" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

Element Description Data Type
SiteLinks A list of site links. Each object contains a link to a webpage on your website. You can specify a maximum of 10 site links, and the search engine determines a subset of links to include in the ad. If you specify the Description1 and Description2 elements of each site link, then up to four site links will be displayed.

Add: Required
Update: Required
SiteLink array

The SiteLinksAdExtension object has Inherited Elements.

Inherited Elements

Inherited Elements from AdExtension

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

Element Description Data Type
DevicePreference Not supported.

For SiteLinksAdExtension objects, you specify the DevicePreference for each SiteLink, otherwise the operation will fail if you attempt to set the ad extension level DevicePreference element.
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 Bing Ads identifier of the ad extension.

Add: Read-only and Required
Update: Read-only
long
Scheduling This element is not supported at the parent site link ad extension level.

Whereas this element is not applicable for the SiteLinksAdExtension object, you can specify a Scheduling element within each individual SiteLink object (nested list within the SiteLinksAdExtension). For most other ad extension types including Sitelink2AdExtension, the AdExtension object will include the Scheduling element.

Add: Not applicable.
Update: Not applicable.
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 SiteLinksAdExtension when you retrieve a sitelinks ad extension.

Add: Read-only
Update: Read-only

For more information about ad extension types, see the Ad Extension Data Object Remarks.
string
Version The number of times the contents of the ad extension has been updated. The version is set to 1 when you add the extension and is incremented each time it's revised.

Add: Read-only
Update: Read-only
int

Requirements

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