AdsApp.​SitelinkBuilder

Example usage:

// Create a sitelink builder.
var sitelinkBuilder = AdsApp.extensions().newSitelinkBuilder();

// Create a sitelink operation.
var sitelinkOperation = sitelinkBuilder
  .withFinalUrl("http://www.example.com/join") // required
  .withLinkText("Join us now")                 // required
  .withMobilePreferred(true)                   // optional
  .build();

// Optional: examine the outcome. The call to isSuccessful()
// will block until the operation completes.
if (sitelinkOperation.isSuccessful()) {
  // Get the result.
  var sitelink = sitelinkOperation.getResult();
} else {
  // Handle the errors.
  var errors = sitelinkOperation.getErrors();
}

Methods:

build(buildLegacy)

Defaults to building the type of sitelink that is currently serving. If there are upgraded sitelinks, then an upgraded sitelink will be built by default. If there are only legacy sitelinks, then a legacy sitelink will be built by default. If there are neither, then an upgraded sitelink will be built by default.

Arguments:

Return values:

withCustomParameters(customParameters)

Custom parameters enable you to create your own ValueTrack parameters that you can assign your own IDs to.

The name of a custom parameter can contain only alphanumeric characters, and custom parameter values may not contain white space. When referring to the custom parameter in final URLs and tracking template, you should surround the custom parameter in braces, and prefix an underscore to its name, e.g. {_param}.

You can have up to 8 custom parameters for an entity. The key and value must not exceed 16 and 200 bytes respectively.

Custom parameters specified at a lower level entity will override the setting specified at a higher level entity, e.g., setting custom parameters at the ad group level overrides the setting at the campaign level, and custom parameters specified at the ad level override the setting at the ad group level.

See Using Upgraded URLs for more information.

Arguments:

Return values:

withDescription1(description1)

Arguments:

Return values:

withDescription2(description2)

Arguments:

Return values:

withEndDate(date)

For instance, sitelinkBuilder.withEndDate("20130503"); is equivalent to sitelinkBuilder.withEndDate({year: 2013, month: 5, day: 3});.

The change will fail and report an error if:

• the given date is invalid (e.g., {year: 2013, month: 5, day: 55}),
• the start date now comes after the end date, or
• it's a date in the past

Arguments:

Return values:

withFinalUrl(finalUrl)

The final URL represents the actual landing page for your sitelink. The final URL must be the URL of the page that the user ends up on after clicking on your ad, once all the redirects have taken place.

See Using Upgraded URLs for more information. Final URLs are required.

Arguments:

Return values:

withFinalUrlSuffix(suffix)

When parallel tracking is enabled, the final URL suffix gets appended to the final URL.

Arguments:

Return values:

withLinkText(linkText)

Arguments:

Return values:

withMobileFinalUrl(mobileFinalUrl)

The mobile final URL represents the actual landing page for your sitelink on a mobile device. The final mobile URL must be the URL of the page that the user ends up on after clicking on your ad on a mobile device, once all the redirects have taken place.

See Using Upgraded URLs for more information.

Arguments:

Return values:

withMobilePreferred(isMobilePreferred)

Arguments:

Return values:

withSchedules(schedules)

Passing in an empty array clears the scheduling field, causing the sitelink to run at all times.

The following example sets the sitelink to run on Mondays and Tuesday from 8:00 to 11:00.

 var mondayMorning = {
   dayOfWeek: "MONDAY",
   startHour: 8,
   startMinute: 0,
   endHour: 11,
   endMinute: 0
 };
 var tuesdayMorning = {
   dayOfWeek: "TUESDAY",
   startHour: 8,
   startMinute: 0,
   endHour: 11,
   endMinute: 0
 };

sitelinkBuilder.withSchedules([mondayMorning, tuesdayMorning]);

Arguments:

Return values:

withStartDate(date)

For instance, sitelinkBuilder.withStartDate("20130503"); is equivalent to sitelinkBuilder.withStartDate({year: 2013, month: 5, day: 3});.

The change will fail and report an error if:

• the given date is invalid (e.g., {year: 2013, month: 5, day: 55}),
• the given date is after the sitelink's end date,

Arguments:

Return values:

withTrackingTemplate(trackingTemplate)

You can optionally use the tracking template to specify additional tracking parameters or redirects. Google Ads will use this template to assemble the actual destination URL to associate with the ad.

A tracking template specified at a lower level entity will override the setting specified at a higher level entity, e.g., a tracking template set at the ad group level overrides the setting at the campaign level, and a tracking template specified at the ad level overrides the setting at the ad group level.

See Using Upgraded URLs for more information.

Arguments:

Return values: