AdsApp.​AccountSnippet

Represents a snippet that has been added to an account as an ad snippet extension. Visit our Ad Extensions page for more information on snippets and other types of ad extensions.

Methods:

MemberTypeDescription
clearEndDate void Clears the account-level snippet's end date.
clearStartDate void Clears the account-level snippet's start date.
getEndDate AdsApp.GoogleAdsDate Returns the end date of the account-level snippet, or null if no end date is set.
getEntityType String Returns the type of this entity as a String, in this case, "AccountSnippet".
getHeader String Returns the header of the account-level snippet.
getId String Returns the ID of the account-level snippet.
getResourceName String Returns the resource name of the account-level snippet.
getSchedules AdsApp.ExtensionSchedule[] Returns the scheduling of the account-level snippet.
getStartDate AdsApp.GoogleAdsDate Returns the start date of the account-level snippet, or null if no start date is set.
getStatsFor AdsApp.Stats Returns stats for the specified date range.
getStatsFor AdsApp.Stats Returns stats for the specified custom date range.
getValues String[] Returns the values of the account-level snippet.
isLegacy boolean Return true if the account-level snippet is legacy.
isMobilePreferred boolean Returns true if the account-level snippet specifies mobile device preference.
setEndDate void Sets the account-level snippet's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
setHeader void Sets the header of the account-level snippet.
setMobilePreferred void Sets the account-level snippet's device preference.
setSchedules void Sets the account-level snippet scheduling.
setStartDate void Sets the account-level snippet's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
setValues void Sets the values of the account-level snippet.

clearEndDate()

Clears the account-level snippet's end date.

Returns nothing.

clearStartDate()

Clears the account-level snippet's start date.

Returns nothing.

getEndDate()

Returns the end date of the account-level snippet, or null if no end date is set.

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

Return values:

TypeDescription
AdsApp.GoogleAdsDate The account-level snippet's end date, or null if there's no end date.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "AccountSnippet".

getHeader()

Returns the header of the account-level snippet.

Return values:

TypeDescription
String The header of the account-level snippet.

getId()

Returns the ID of the account-level snippet.

Return values:

TypeDescription
String The ID of the account-level snippet.

getResourceName()

Returns the resource name of the account-level snippet.

Return values:

TypeDescription
String The resource name of the account-level snippet.

getSchedules()

Returns the scheduling of the account-level snippet.

Return values:

TypeDescription
AdsApp.ExtensionSchedule[] The scheduling of the account-level snippet.

getStartDate()

Returns the start date of the account-level snippet, or null if no start date is set.

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

Return values:

TypeDescription
AdsApp.GoogleAdsDate The account-level snippet'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 = accountSnippet.getStatsFor("THIS_MONTH");

Arguments:

NameTypeDescription
dateRange String Date range for which the stats are requested.

Return values:

TypeDescription
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:

NameTypeDescription
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:

TypeDescription
AdsApp.Stats The stats for the specified date range.

getValues()

Returns the values of the account-level snippet.

Return values:

TypeDescription
String[] The values of the account-level snippet.

isLegacy()

Return true if the account-level snippet is legacy.

Return values:

TypeDescription
boolean true if the account-level snippet is legacy.

isMobilePreferred()

Returns true if the account-level snippet specifies mobile device preference.

Return values:

TypeDescription
boolean true if the account-level snippet specifies mobile device preference.

setEndDate(date)

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

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

NameTypeDescription
date Object The new account-level snippet end date.

setHeader(header)

Sets the header of the account-level snippet.

See the structured snippets header translations page for supported localized headers.

Returns nothing.

Arguments:

NameTypeDescription
header String The header of the account-level snippet.

setMobilePreferred(isMobilePreferred)

Sets the account-level snippet's device preference.

Returns nothing.

Arguments:

NameTypeDescription
isMobilePreferred boolean true sets the device preference to mobile. false clears the device preference.

setSchedules(schedules)

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

Passing in an empty array clears the scheduling field, causing the account-level snippet to run at all times.

The following example sets the account-level snippet 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
};

accountSnippet.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

NameTypeDescription
schedules AdsApp.ExtensionSchedule[] The new account-level snippet schedules.

setStartDate(date)

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

For instance, accountSnippet.setStartDate("20130503"); is equivalent to accountSnippet.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 account-level snippet's end date.

Returns nothing.

Arguments:

NameTypeDescription
date Object The new account-level snippet start date.

setValues(values)

Sets the values of the account-level snippet. At least three values, and at most ten values should be added.

Returns nothing.

Arguments:

NameTypeDescription
values String[] The values of the account-level snippet.