To discuss and provide feedback on our products, join the official Google Ads Discord channel in theGoogle Advertising and Measurement Community server.
AdsApp.AccountSnippet
Represents a snippet that has been added to an account as an ad snippetextension. Visit ourAd Extensions pagefor more information on snippets and other types of ad extensions.
Clears the account-level snippet's end date.Deprecated.
Clears the account-level snippet's start date.Deprecated.
Returns the end date of the account-level snippet, or
Returns the type of this entity as a
Returns the header of the account-level snippet.
Returns the ID of the account-level snippet.
Returns the resource name of the account-level snippet.
Returns the scheduling of the account-level snippet.Deprecated.
Returns the start date of the account-level snippet, or
Returns stats for the specified date range. Supported values:
Returns stats for the specified custom date range. Both parameters can beeither an object containing year, month, and day fields, or an 8-digitstring in
Returns the values of the account-level snippet.
Returns
Sets the account-level snippet's end date from either an object containingyear, month, and day fields, or an 8-digit string in
Sets the header of the account-level snippet.
Sets the account-level snippet's device preference.Deprecated.
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 whichthe account-level snippet will show alongside your ads.
Sets the account-level snippet's start date from either an object containingyear, month, and day fields, or an 8-digit string in
Sets the values of the account-level snippet. At least three values, and atmost ten values should be added.
Methods:
| Member | Type | Description |
|---|---|---|
void | Clears the account-level snippet's end date. | |
void | Clears the account-level snippet's start date. | |
AdsApp.GoogleAdsDate | Returns the end date of the account-level snippet, ornull if noend date is set. | |
| getEntityType | String | Returns the type of this entity as aString, 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. |
AdsApp.ExtensionSchedule[] | Returns the scheduling of the account-level snippet. | |
AdsApp.GoogleAdsDate | Returns the start date of the account-level snippet, ornull ifno 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. |
boolean | Returnstrue if the account-level snippet specifies mobiledevice preference. | |
void | Sets the account-level snippet's end date from either an object containingyear, month, and day fields, or an 8-digit string inYYYYMMDDformat. | |
| setHeader | void | Sets the header of the account-level snippet. |
void | Sets the account-level snippet's device preference. | |
void | Sets the account-level snippet scheduling. | |
void | Sets the account-level snippet's start date from either an object containingyear, month, and day fields, or an 8-digit string inYYYYMMDDformat. | |
| setValues | void | Sets the values of the account-level snippet. |
clearEndDate()
Clears the account-level snippet's end date.Deprecated.Returns nothing.
clearStartDate()
Clears the account-level snippet's start date.Deprecated.Returns nothing.
getEndDate()
Returns the end date of the account-level snippet, ornull if noend 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}.Deprecated.Return values:
| Type | Description |
|---|---|
AdsApp.GoogleAdsDate | The account-level snippet's end date, ornull if there's no end date. |
getEntityType()
Returns the type of this entity as aString, in this case,"AccountSnippet".Return values:
| Type | Description |
|---|---|
String | Type of this entity:"AccountSnippet". |
getHeader()
Returns the header of the account-level snippet.Return values:
| Type | Description |
|---|---|
String | The header of the account-level snippet. |
getId()
Returns the ID of the account-level snippet.Return values:
| Type | Description |
|---|---|
String | The ID of the account-level snippet. |
getResourceName()
Returns the resource name of the account-level snippet.Return values:
| Type | Description |
|---|---|
String | The resource name of the account-level snippet. |
getSchedules()
Returns the scheduling of the account-level snippet.Deprecated.Return values:
| Type | Description |
|---|---|
AdsApp.ExtensionSchedule[] | The scheduling of the account-level snippet. |
getStartDate()
Returns the start date of the account-level snippet, ornull ifno 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}.Deprecated.Return values:
| Type | Description |
|---|---|
AdsApp.GoogleAdsDate | The account-level snippet's start date, ornull 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:
varstats=accountSnippet.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 beeither an object containing year, month, and day fields, or an 8-digitstring inYYYYMMDD form. For instance,March 24th,2013 is represented as either{year: 2013, month: 3, day:24} or"20130324". The date range is inclusive on bothends, soforDateRange("20130324", "20130324") defines a rangeof a single day.Arguments:
| Name | Type | Description |
|---|---|---|
| dateFrom | Object | Start date of the date range. Must be either a string inYYYYMMDD form, or an object withyear,month andday properties. |
| dateTo | Object | End date of the date range. Must be either a string inYYYYMMDD form, or an object withyear,month andday properties. |
Return values:
| Type | Description |
|---|---|
AdsApp.Stats | The stats for the specified date range. |
getValues()
Returns the values of the account-level snippet.Return values:
| Type | Description |
|---|---|
String[] | The values of the account-level snippet. |
isMobilePreferred()
Returnstrue if the account-level snippet specifies mobiledevice preference.Deprecated.Return values:
| Type | Description |
|---|---|
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 containingyear, month, and day fields, or an 8-digit string inYYYYMMDDformat.For instance,accountSnippet.setEndDate("20130503"); is equivalent toaccountSnippet.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 account-level snippet end date. |
setHeader(header)
Sets the header of the account-level snippet.See thestructured snippets header translations page for supported localizedheaders.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|---|---|
| header | String | The header of the account-level snippet. |
setMobilePreferred(isMobilePreferred)
Sets the account-level snippet's device preference.Deprecated.Returns nothing.
Arguments:
| Name | Type | Description |
|---|---|---|
| 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 whichthe 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 andTuesday from 8:00 to 11:00.
varmondayMorning={dayOfWeek:"MONDAY",startHour:8,startMinute:0,endHour:11,endMinute:0};vartuesdayMorning={dayOfWeek:"TUESDAY",startHour:8,startMinute:0,endHour:11,endMinute:0};accountSnippet.setSchedules([mondayMorning,tuesdayMorning]);
Returns nothing.
Arguments:
| Name | Type | Description |
|---|---|---|
| schedules | AdsApp.ExtensionSchedule[] | The new account-level snippet schedules. |
setStartDate(date)
Sets the account-level snippet's start date from either an object containingyear, month, and day fields, or an 8-digit string inYYYYMMDDformat.For instance,accountSnippet.setStartDate("20130503"); is equivalent toaccountSnippet.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:
| Name | Type | Description |
|---|---|---|
| date | Object | The new account-level snippet start date. |
setValues(values)
Sets the values of the account-level snippet. At least three values, and atmost ten values should be added.Returns nothing.
Arguments:
| Name | Type | Description |
|---|---|---|
| values | String[] | The values of the account-level snippet. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-14 UTC."],[[["Represents a snippet ad extension added to an account."],["Provides methods to manage snippet settings like start/end dates, header, and values."],["Allows for scheduling the snippet to run on specific days and times."],["Includes methods to retrieve performance statistics for the snippet."],["More information on ad extensions can be found on the Ad Extensions page."]]],[]]