SiteLinksAdExtension Data Object

 

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.

System_CAPS_ICON_important.jpg Important

At the end of Q3 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). You must be prepared for migration to Sitelink2AdExtension by September 30th. 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="SiteLinksAdExtension">
  <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>

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

ElementDescriptionData Type
SiteLinksA 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 inherits the following elements from the AdExtension object.

System_CAPS_ICON_note.jpg Note

The descriptions below are specific to sitelinks ad extensions, and might not apply to other objects that inherit the same elements from the AdExtension object.

ElementDescriptionData Type
DevicePreferenceNot 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
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.

There are currently no forward compatibility changes for the AdExtension object.

Add: Read-only
Update: Read-only
KeyValuePairOfstringstring array
IdThe unique Bing Ads identifier of the ad extension.

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

Note: 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
StatusThe 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
TypeThe 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
VersionThe 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

CampaignManagementService.svc v11

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

AdExtensionAssociation
AddAdExtensions
GetAdExtensionsByIds
UpdateAdExtensions
GetAccountMigrationStatuses

Show: