AdsApp.​Sitelink

    Represents a sitelink that can be part of an ad sitelink extension. Visit our Ad Extensions page for more information on sitelinks and other types of ad extensions.

    Methods:

    Member Type Description
    clearDescription1()
    		void Clears the first description line of the sitelink description.
    clearDescription2()
    		void Clears the second description line of the sitelink description.
    clearDescriptions()
    		void Clears both lines of the sitelink description.
    clearEndDate()
    		void Clears the sitelink's end date.
    clearLinkUrl()
    		void Clears the link URL of the sitelink.
    clearStartDate()
    		void Clears the sitelink's start date.
    getDescription1()
    		String Returns the first description line of the sitelink description.
    getDescription2()
    		String Returns the second description line of the sitelink description.
    getEndDate()
    		AdsApp.GoogleAdsDate Returns the end date of the sitelink, or null if no end date is set.
    getEntityType()
    		String Returns the type of this entity as a String , in this case, "Sitelink" .
    getId()
    		String Returns the ID of the sitelink.
    getLinkText()
    		String Returns the link text of the sitelink.
    getResourceName()
    		String Returns the resource name of the sitelink.
    getSchedules()
    		AdsApp.ExtensionSchedule[] Returns the scheduling of the sitelink.
    getStartDate()
    		AdsApp.GoogleAdsDate Returns the start date of the sitelink, or null if no start date is set.
    getStatsFor(dateRange)
    		AdsApp.Stats Returns stats for the specified date range.
    getStatsFor(dateFrom, dateTo)
    		AdsApp.Stats Returns stats for the specified custom date range.
    isMobilePreferred()
    		boolean Returns true if the sitelink specifies mobile device preference.
    setDescription1(description1)
    		void Sets the first description line of the sitelink description.
    setDescription2(description2)
    		void Sets the second description line of the sitelink description.
    setDescriptions(description1, description2)
    		void Sets the first and second lines of the sitelink description.
    setEndDate(date)
    		void Sets the sitelink's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
    setLinkText(linkText)
    		void Sets the link text of the sitelink.
    setMobilePreferred(isMobilePreferred)
    		void Sets the sitelink's device preference.
    setSchedules(schedules)
    		void Sets the sitelink scheduling.
    setStartDate(date)
    		void Sets the sitelink's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
    urls()
    		AdsApp.SitelinkUrls Provides access to the URL fields of this sitelink.

    clearDescription1()

    Clears the first description line of the sitelink description.

    Returns nothing.

    clearDescription2()

    Clears the second description line of the sitelink description.

    Returns nothing.

    clearDescriptions()

    Clears both lines of the sitelink description.

    Returns nothing.

    clearEndDate()

    Clears the sitelink's end date.

    Returns nothing.

    clearLinkUrl()

    Clears the link URL of the sitelink. To upgrade sitelinks to final URL, first clear the link URL, then set the final URL with SitelinkUrls.setFinalUrl .

    Returns nothing.

    clearStartDate()

    Clears the sitelink's start date.

    Returns nothing.

    getDescription1()

    Returns the first description line of the sitelink description.

    Return values:

    Type Description
    String Description line 1 of the sitelink.

    getDescription2()

    Returns the second description line of the sitelink description.

    Return values:

    Type Description
    String Description line 2 of the sitelink.

    getEndDate()

    Returns the end date of the sitelink, or null if no end date is set.

    For instance, if the end date of the sitelink is May 3, 2013, this would return the following object: {year: 2013, month: 5, day: 3} .

    Return values:

    Type Description
    AdsApp.GoogleAdsDate The sitelink's end date, or null if there's no end date.

    getEntityType()

    Returns the type of this entity as a String , in this case, "Sitelink" .

    Return values:

    Type Description
    String Type of this entity: "Sitelink" .

    getId()

    Returns the ID of the sitelink.

    Return values:

    Type Description
    String The ID of the sitelink.

    getLinkText()

    Returns the link text of the sitelink.

    Return values:

    Type Description
    String Link text of the sitelink.

    getResourceName()

    Returns the resource name of the sitelink.

    Return values:

    Type Description
    String The resource name of the sitelink.

    getSchedules()

    Returns the scheduling of the sitelink.

    Return values:

    Type Description
    AdsApp.ExtensionSchedule[] The scheduling of the sitelink.

    getStartDate()

    Returns the start date of the sitelink, or null if no start date is set.

    For instance, if the start date of the sitelink is May 3, 2013, this would return the following object: {year: 2013, month: 5, day: 3} .

    Return values:

    Type Description
    AdsApp.GoogleAdsDate The sitelink's start date, or null if there's no start date.

    getStatsFor(dateRange)

    Returns stats for the specified date range. Supported values:

    TODAY, YESTERDAY, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT, THIS_MONTH, LAST_MONTH, ALL_TIME .

    Example:

     var 
  
 stats 
  
 = 
  
 sitelink 
 . 
 getStatsFor 
 ( 
 "THIS_MONTH" 
 );

    Arguments:

    Name Type Description
    dateRange
    		 String Date range for which the stats are requested.

    Return values:

    Type Description
    AdsApp.Stats The stats for the specified date range.

    getStatsFor(dateFrom, dateTo)

    Returns stats for the specified custom date range. Both parameters can be either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD form. For instance, March 24th, 2013 is represented as either {year: 2013, month: 3, day: 24} or "20130324" . The date range is inclusive on both ends, so forDateRange("20130324", "20130324") defines a range of a single day.

    Arguments:

    Name Type Description
    dateFrom
    		 Object Start date of the date range. Must be either a string in YYYYMMDD form, or an object with year , month and day properties.
    dateTo
    		 Object End date of the date range. Must be either a string in YYYYMMDD form, or an object with year , month and day properties.

    Return values:

    Type Description
    AdsApp.Stats The stats for the specified date range.

    isMobilePreferred()

    Returns true if the sitelink specifies mobile device preference.

    Return values:

    Type Description
    boolean true if the sitelink specifies mobile device preference.

    setDescription1(description1)

    Sets the first description line of the sitelink description.

    Returns nothing.

    Arguments:

    Name Type Description
    description1
    		 String The first description line.

    setDescription2(description2)

    Sets the second description line of the sitelink description.

    Returns nothing.

    Arguments:

    Name Type Description
    description2
    		 String The second description line.

    setDescriptions(description1, description2)

    Sets the first and second lines of the sitelink description.

    Returns nothing.

    Arguments:

    Name Type Description
    description1
    		 String The first description line.
    description2
    		 String The second description line.

    setEndDate(date)

    Sets the sitelink's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.

    For instance, sitelink.setEndDate("20130503"); is equivalent to sitelink.setEndDate({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.

    Returns nothing.

    Arguments:

    Name Type Description
    date
    		 Object The new sitelink end date.

    setLinkText(linkText)

    Sets the link text of the sitelink.

    Returns nothing.

    Arguments:

    Name Type Description
    linkText
    		 String The link text.

    setMobilePreferred(isMobilePreferred)

    Sets the sitelink's device preference.

    Returns nothing.

    Arguments:

    Name Type Description
    isMobilePreferred
    		 boolean true sets the device preference to mobile. false clears the device preference.

    setSchedules(schedules)

    Sets the sitelink scheduling. Scheduling of a sitelink allows you to control the days of week and times of day during which the sitelink will show alongside your ads.

    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 
 }; 
 sitelink 
 . 
 setSchedules 
 ([ 
 mondayMorning 
 , 
  
 tuesdayMorning 
 ]);

    Returns nothing.

    Arguments:

    Name Type Description
    schedules
    		 AdsApp.ExtensionSchedule[] The new sitelink schedules.

    setStartDate(date)

    Sets the sitelink's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.

    For instance, sitelink.setStartDate("20130503"); is equivalent to sitelink.setStartDate({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.

    Returns nothing.

    Arguments:

    Name Type Description
    date
    		 Object The new sitelink start date.

    urls()

    Provides access to the URL fields of this sitelink. See Using Upgraded URLs for more information.

    Return values:

    Type Description
    AdsApp.SitelinkUrls Access to the URL fields of this sitelink.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: