Sitelink Ad Extension Record - Bulk
Defines a sitelink ad extension that can be downloaded and uploaded in a bulk file.
You can associate a sitelink ad extension with the account or with campaigns and ad groups in the account. Each entity (account, campaign, or ad group) can be associated with up to 20 sitelink ad extensions. Use the Account Sitelink Ad Extension, Ad Group Sitelink Ad Extension, and Campaign Sitelink Ad Extension records to manage sitelink ad extension associations.
You can download all Sitelink Ad Extension records in the account by including the DownloadEntity value of SitelinkAdExtensions in the DownloadCampaignsByAccountIds or DownloadCampaignsByCampaignIds service request. Additionally the download request must include the EntityData scope. For more details about the Bulk service including best practices, see Bulk Download and Upload.
The following Bulk CSV example would add a new Sitelink Ad Extension to the account's shared library.
Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Start Date,End Date,Device Preference,Name,Ad Schedule,Use Searcher Time Zone,Sitelink Extension Order,Sitelink Extension Link Text,Sitelink Extension Destination Url,Sitelink Extension Description1,Sitelink Extension Description2,Final Url,Mobile Final Url,Tracking Template,Final Url Suffix,Custom Parameter
Format Version,,,,,,,,,,,6.0,,,,,,,,,,,,
Sitelink Ad Extension,Active,-17,0,,,ClientIdGoesHere,,,12/31/2020,,,(Monday[09:00-21:00]),FALSE,,Women's Shoe Sale 1,,Simple & Transparent.,No Upfront Cost.,https://www.contoso.com/womenshoesale,https://mobile.contoso.com/womenshoesale,,,{_promoCode}=PROMO1; {_season}=summer
If you are using the Bing Ads SDKs for .NET, Java, or Python, you can save time using the BulkServiceManager to upload and download the BulkSitelinkAdExtension object, instead of calling the service operations directly and writing custom code to parse each field in the bulk file.
var uploadEntities = new List<BulkEntity>();
// Map properties in the Bulk file to the BulkSitelinkAdExtension
var bulkSitelinkAdExtension = new BulkSitelinkAdExtension
{
// 'Parent Id' column header in the Bulk file
AccountId = 0,
// 'Client Id' column header in the Bulk file
ClientId = "ClientIdGoesHere",
// Map properties in the Bulk file to the
// SitelinkAdExtension object of the Campaign Management service.
SitelinkAdExtension = new SitelinkAdExtension
{
// 'Id' column header in the Bulk file
Id = sitelinkAdExtensionIdKey,
// 'Sitelink Extension Description1' column header in the Bulk file
Description1 = "Simple & Transparent.",
// 'Sitelink Extension Description2' column header in the Bulk file
Description2 = "No Upfront Cost.",
// 'Device Preference' column header in the Bulk file
DevicePreference = null,
// 'Text' column header in the Bulk file
DisplayText = "Women's Shoe Sale",
// 'Destination Url' column header in the Bulk file
DestinationUrl = "",
// 'Final Url' column header in the Bulk file
FinalUrls = new[] {
// Each Url is delimited by a semicolon (;) in the Bulk file
"https://www.contoso.com/womenshoesale"
},
// 'Mobile Final Url' column header in the Bulk file
FinalMobileUrls = new[] {
// Each Url is delimited by a semicolon (;) in the Bulk file
"https://mobile.contoso.com/womenshoesale"
},
// 'Tracking Template' column header in the Bulk file
TrackingUrlTemplate = null,
// 'Custom Parameter' column header in the Bulk file
UrlCustomParameters = new CustomParameters
{
// Each custom parameter is delimited by a semicolon (;) in the Bulk file
Parameters = new[] {
new CustomParameter(){
Key = "promoCode",
Value = "PROMO1"
},
new CustomParameter(){
Key = "season",
Value = "summer"
},
}
},
// 'Ad Schedule' column header in the Bulk file
Scheduling = new Schedule
{
// Each day and time range is delimited by a semicolon (;) in the Bulk file
DayTimeRanges = new[]
{
// Within each day and time range the format is Day[StartHour:StartMinue-EndHour:EndMinute].
new DayTime
{
Day = Day.Monday,
StartHour = 9,
StartMinute = Minute.Zero,
EndHour = 21,
EndMinute = Minute.Zero,
},
},
// 'End Date' column header in the Bulk file
EndDate = new Microsoft.BingAds.V13.CampaignManagement.Date
{
Month = 12,
Day = 31,
Year = DateTime.UtcNow.Year + 1
},
// 'Start Date' column header in the Bulk file
StartDate = null,
// 'Use Searcher Time Zone' column header in the Bulk file
UseSearcherTimeZone = false,
},
// 'Status' column header in the Bulk file
Status = AdExtensionStatus.Active,
},
};
uploadEntities.Add(bulkSitelinkAdExtension);
var entityUploadParameters = new EntityUploadParameters
{
Entities = uploadEntities,
ResponseMode = ResponseMode.ErrorsAndResults,
ResultFileDirectory = FileDirectory,
ResultFileName = DownloadFileName,
OverwriteResultFile = true,
};
var uploadResultEntities = (await BulkServiceManager.UploadEntitiesAsync(entityUploadParameters)).ToList();
For a Sitelink Ad Extension record, the following attribute fields are available in the Bulk File Schema.
- Ad Schedule
- Client Id
- Custom Parameter
- Device Preference
- Editorial Location
- Editorial Reason Code
- Editorial Status
- Editorial Term
- End Date
- Final Url
- Final Url Suffix
- Id
- Mobile Final Url
- Modified Time
- Parent Id
- Publisher Countries
- Sitelink Extension Description1
- Sitelink Extension Description2
- Sitelink Extension Destination Url
- Sitelink Extension Link Text
- Start Date
- Status
- Tracking Template
- Use Searcher Time Zone
- Version
Ad Schedule
The list of day and time ranges that you want the ad extension to be displayed with your ads. Each day and time range includes the scheduled day of week, start/end hour, and start/end minute. Each day and time range is enclosed by left and right parentheses, and separated from other day and time ranges with a semicolon (;) delimiter. Within each day and time range the format is Day[StartHour:StartMinue-EndHour:EndMinute].
The possible values of StartHour range from 00 to 23, where 00 is equivalent to 12:00AM and 12 is 12:00PM.
The possible values of EndHour range from 00 to 24, where 00 is equivalent to 12:00AM and 12 is 12:00PM.
The possible values of StartMinute and EndMinute range from 00 to 60.
The following example demonstrates day and time ranges during weekdays from 9:00AM through 9:00PM: (Monday[09:00-21:00]);(Tuesday[09:00-21:00]);(Wednesday[09:00-21:00]);(Thursday[09:00-21:00]);(Friday[09:00-21:00])
Add: Optional. If you do not set this field, the ad extension will be eligible for scheduling anytime during the calendar start and end dates.
Update: Optional. The individual day and time ranges cannot be updated. You can effectively update the day and time ranges by sending a new set that should replace the prior set. The Ad Schedule, End Date, Start Date, and Use Searcher Time Zone fields depend on each other and are updated together. If you leave all of these fields empty during update, then none of them are updated. If you include values for any of these fields, then the prior values for all of these fields are removed or replaced. To remove all prior schedule settings, set each of these fields to delete_value.
Delete: Read-only
Client Id
Used to associate records in the bulk upload file with records in the results file. The value of this field is not used or stored by the server; it is simply copied from the uploaded record to the corresponding result record. It may be any valid string to up 100 in length.
Add: Optional
Update: Optional
Delete: Read-only
Custom Parameter
Your custom collection of key and value parameters for URL tracking.
In a bulk file, the list of custom parameters are formatted as follows.
Format each custom parameter pair as Key=Value, for example {_promoCode}=PROMO1.
Microsoft Advertising will accept the first 3 custom parameter key and value pairs that you include, and any additional custom parameters will be ignored. For customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635), 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.
Each key and value pair are delimited by a semicolon and space ("; "), for example {_promoCode}=PROMO1; {_season}=summer.
A Key cannot contain a semicolon. If a Value contains a semicolon it must be escaped as '\;'. Additionally if the Value contains a backslash it must also be escaped as '\'.
The Key cannot exceed 16 UTF-8 bytes, and the Value cannot exceed 200 UTF-8 bytes. For customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635), the Value limit increases to 250 UTF-8 bytes. The Key is required and the Value is optional. The maximum size of the Key does not include the braces and underscore i.e., '{', '_', and '}'.
Note
With the Bulk service the Key must be formatted with surrounding braces and a leading underscore, for example if the Key is promoCode, it must be formatted as {_promoCode}. With the Campaign Management service you cannot specify the surrounding braces and underscore.
Add: Optional
Update: Optional. If no value is set for the update, the prior setting is removed.
Delete: Read-only
Device Preference
This field determines whether the preference is for the ad extension to be displayed on mobile devices or all devices.
Possible values are All and Mobile, which differ from values used in the campaign management service.
The default value is All.
In the bulk download and upload results file, this field will never be empty. If you did not specify a device preference, the default value of All will be returned.
Add: Optional
Update: Optional. If no value is set or if you set this field to the delete_value string, then you are effectively resetting to the default value of All.
Delete: Read-only
Editorial Location
The component or property of the ad extension that failed editorial review.
Add: Read-only
Update: Read-only
Delete: Read-only
Editorial Reason Code
A code that identifies the reason for the failure. For a list of possible reason codes, see Editorial Reason Codes.
Add: Read-only
Update: Read-only
Delete: Read-only
Editorial Status
The editorial status of the ad extension.
Possible values are described in the table below.
Add: Read-only
Update: Read-only
Delete: Read-only
Editorial Term
The term that failed editorial review.
This field will not be set if a combination of terms caused the failure or if the failure was based on a policy violation.
Add: Read-only
Update: Read-only
Delete: Read-only
End Date
The ad extension scheduled end date string formatted as MM/DD/YYYY.
The end date is inclusive. For example, if you set this field to 12/31/2020, the ad extensions will stop being shown at 11:59 PM on 12/31/2020.
Add: Optional. If you do not specify an end date, the ad extension will continue to be delivered unless you pause the associated campaigns, ad groups, or ads.
Update: Optional. The end date can be shortened or extended, as long as the start date is either null or occurs before the new end date. If you set this field to the delete_value string, then you are effectively removing the end date. The Ad Schedule, End Date, Start Date, and Use Searcher Time Zone fields depend on each other and are updated together. If you leave all of these fields empty during update, then none of them are updated. If you include values for any of these fields, then the prior values for all of these fields are removed or replaced. To remove all prior schedule settings, set each of these fields to delete_value.
Delete: Read-only
Final Url
The landing page URL to use with optional tracking template and custom parameters.
The following validation rules apply to Final URLs and Final Mobile URLs.
The length of the URL is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit.
You may specify up to 10 items for both Final URLs and Final Mobile URLs; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility.
Each URL is delimited by a semicolon and space ("; ").
Usage of '{' and '}' is only allowed to delineate tags, for example "{lpurl}".
Each URL must be a well-formed URL starting with either http:// or https://.
If you specify Final Mobile URLs, you must also specify Final Url.
Add: Required
Update: Required
Delete: Read-only
Final Url Suffix
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.
Note
This feature is only available for customers in the Final URL Suffix Phase 3 pilot (GetCustomerPilotFeatures returns 636). If you are not in the pilot this property will be ignored and no error will be returned.
Add: Optional
Update: Optional. If no value is set for the update, the prior setting is removed.
Delete: Read-only
Id
The system-generated identifier of the ad extension.
Add: Optional. You must either leave this field empty, or specify a negative identifier. A negative identifier set for the ad extension can then be referenced in the Id field of dependent record types such as Ad Group Sitelink Ad Extension and Campaign Sitelink Ad Extension. This is recommended if you are adding new ad extensions and new dependent records in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Read-only and Required
Delete: Read-only and Required
Mobile 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. The HTTP or HTTPS protocol string does count towards the 2,048 character limit.
You may specify up to 10 items for both Final URLs and Final Mobile URLs; however, only the first item in each list is used for delivery. The service allows up to 10 for potential forward compatibility.
Each URL is delimited by a semicolon and space ("; ").
Usage of '{' and '}' is only allowed to delineate tags, for example "{lpurl}".
Each URL must be a well-formed URL starting with either http:// or https://.
If you specify Final Mobile URLs, you must also specify Final Url.
Also note that you may not specify Mobile Final Url if the Device Preference is set to Mobile.
Add: Optional
Update: Optional. If no value is set for the update, the prior setting is removed.
Delete: Read-only
Modified Time
The date and time that the entity was last updated. The value is in Coordinated Universal Time (UTC).
Note
The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.
Add: Read-only
Update: Read-only
Delete: Read-only
Parent Id
The system-generated identifier of the account that contains the ad extension.
This bulk field maps to the Id field of the Account record.
Add: Read-only
Update: Read-only
Delete: Read-only
Publisher Countries
The list of publisher countries or regions whose editorial guidelines do not allow the specified term.
In a bulk file, the list of publisher countries or regions are delimited with a semicolon (;).
Add: Read-only
Update: Read-only
Delete: Read-only
Sitelink Extension Description1
The site link description line 1.
The maximum input length is 35 characters. If any Traditional Chinese characters are included, the limit is 15 characters. Each Traditional Chinese character countes as two characters and each English character will count only as one character.
Note
If you specify Sitelink Extension Description1 then Sitelink Extension Description2 is required.
Add: Optional
Update: Optional. If no value is set for the update, the prior setting is removed.
Delete: Read-only
Sitelink Extension Description2
The site link description line 2.
The maximum input length is 35 characters. If any Traditional Chinese characters are included, the limit is 15 characters. Each Traditional Chinese character countes as two characters and each English character will count only as one character.
Note
If you specify Sitelink Extension Description2 then Sitelink Extension Description1 is required.
Add: Optional
Update: Optional. If no value is set for the update, the prior setting is removed.
Delete: Read-only
Sitelink Extension Destination Url
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 Microsoft Advertising help article How do I set up destination 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.
Important
If you are currently using Destination URLs, you must replace them with Final URLs. For more information, see URL Tracking with Upgraded URLs.
Add: Not allowed. The destination URL is deprecated, and instead you must set the Final Url field.
Update: Optional. The destination URL is deprecated, and instead you must set the Final Url field. You can either leave this field empty or set it to the delete_value string.
Delete: Read-only
Sitelink Extension Link Text
The site-link text displayed in the ad.
If you specify Sitelink Extension Description1 or Sitelink Extension Description2 then the display text can contain a maximum of 25 characters; otherwise, the display text can contain a maximum of 35 characters. If any Traditional Chinese characters are included, the limits are 11 characters given Sitelink Extension Description1 or Sitelink Extension Description2, and 15 characters otherwise. Each Traditional Chinese character countes as two characters and each English character will count only as one character.
Add: Required
Update: Required
Delete: Read-only
Start Date
The ad extension scheduled start date string formatted as MM/DD/YYYY.
The start date is inclusive. For example, if you set StartDate to 5/5/2020, the ad extensions will start being shown at 12:00 AM on 5/5/2020.
Add: Optional. If you do not specify a start date, the ad extension is immediately eligible to be scheduled.
Update: Optional. The start date can be shortened or extended, as long as the end date is either null or occurs after the new start date. If you set this field to the delete_value string, then you are effectively removing the start date and the ad extension is immediately eligible to be scheduled. The Ad Schedule, End Date, Start Date, and Use Searcher Time Zone fields depend on each other and are updated together. If you leave all of these fields empty during update, then none of them are updated. If you include values for any of these fields, then the prior values for all of these fields are removed or replaced. To remove all prior schedule settings, set each of these fields to delete_value.
Delete: Read-only
Status
The status of the ad extension.
Possible values are Active or Deleted.
Add: Optional. The default value is Active.
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Required. The Status must be set to Deleted.
Tracking Template
The tracking template to use for your sitelink 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
https://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. If no value is set for the update, the prior setting is removed.
Delete: Read-only
Use Searcher Time Zone
Determines whether to use the account time zone or the time zone of the search user where the ads could be delivered.
Set this property to TRUE if you want the ad extensions to be shown in the search user's time zone, and otherwise set it to FALSE.
Add: Optional. If you do not specify this field or leave it empty, the default value of FALSE will be set and the account time zone will be used.
Update: Optional. If you set this field to the delete_value string, then you are effectively resetting to the default value of FALSE. The Ad Schedule, End Date, Start Date, and Use Searcher Time Zone fields depend on each other and are updated together. If you leave all of these fields empty during update, then none of them are updated. If you include values for any of these fields, then the prior values for all of these fields are removed or replaced. To remove all prior schedule settings, set each of these fields to delete_value.
Delete: Read-only
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
Delete: Read-only