AdsApp.​AdGroupSnippet

AI-generated Key Takeaways

outlined_flag

• An AdGroupSnippet represents a snippet extension added to an ad group.

• You can retrieve the associated ad group, base ad group, and campaign for an AdGroupSnippet.

• Methods are available to get and set the header and values of an AdGroupSnippet.

• You can retrieve performance statistics for an AdGroupSnippet over various date ranges.

Represents a snippet that has been added to an ad group as a snippet extension. See About structured snippet extensions for more information.

Methods:

Member	Type	Description
clearEndDate()	void	Clears the ad group-level snippet's end date.
clearStartDate()	void	Clears the ad group-level snippet's start date.
getAdGroup()	AdsApp.AdGroup	Returns the ad group to which this ad group-level snippet belongs.
getBaseAdGroup()	AdsApp.AdGroup	Returns the base ad group to which this ad group-level snippet belongs.
getBaseCampaign()	AdsApp.Campaign	Returns the base campaign to which this ad group-level snippet belongs.
getCampaign()	AdsApp.Campaign	Returns the campaign to which this ad group-level snippet belongs or null if it does not belong to a search or display campaign.
getEndDate()	AdsApp.GoogleAdsDate	Returns the end date of the ad group-level snippet, or null if no end date is set.
getEntityType()	String	Returns the type of this entity as a String, in this case, "AdGroupSnippet".
getHeader()	String	Returns the header of the ad group-level snippet.
getId()	String	Returns the ID of the ad group-level snippet.
getResourceName()	String	Returns the resource name of the ad group-level snippet.
getSchedules()	AdsApp.ExtensionSchedule[]	Returns the scheduling of the ad group-level snippet.
getStartDate()	AdsApp.GoogleAdsDate	Returns the start date of the ad group-level snippet, 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.
getValues()	String[]	Returns the values of the ad group-level snippet.
isMobilePreferred()	boolean	Returns true if the ad group-level snippet specifies mobile device preference.
setEndDate(date)	void	Sets the ad group-level snippet's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
setHeader(header)	void	Sets the header of the ad group-level snippet.
setMobilePreferred(isMobilePreferred)	void	Sets the ad group-level snippet's device preference.
setSchedules(schedules)	void	Sets the ad group-level snippet scheduling.
setStartDate(date)	void	Sets the ad group-level snippet's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
setValues(values)	void	Sets the values of the ad group-level snippet.

clearEndDate()

Clears the ad group-level snippet's end date.

Returns nothing.

clearStartDate()

Clears the ad group-level snippet's start date.

Returns nothing.

getAdGroup()

Returns the ad group to which this ad group-level snippet belongs.

Return values:

Type	Description
AdsApp.AdGroup	The ad group to which this ad group-level snippet belongs.

getBaseAdGroup()

Returns the base ad group to which this ad group-level snippet belongs.

Return values:

Type	Description
AdsApp.AdGroup	The base ad group to which this ad group-level snippet belongs.

getBaseCampaign()

Returns the base campaign to which this ad group-level snippet belongs.

Return values:

Type	Description
AdsApp.Campaign	The base campaign to which this ad group-level snippet belongs.

getCampaign()

Returns the campaign to which this ad group-level snippet belongs or null if it does not belong to a search or display campaign.

Return values:

Type	Description
AdsApp.Campaign	The campaign to which this ad group-level snippet belongs or null if it does not belong to a search or display campaign.

getEndDate()

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

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

Return values:

Type	Description
AdsApp.GoogleAdsDate	The ad group-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, "AdGroupSnippet".

Return values:

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

getHeader()

Returns the header of the ad group-level snippet.

Return values:

Type	Description
String	The header of the ad group-level snippet.

getId()

Returns the ID of the ad group-level snippet.

Return values:

Type	Description
String	The ID of the ad group-level snippet.

getResourceName()

Returns the resource name of the ad group-level snippet.

Return values:

Type	Description
String	The resource name of the ad group-level snippet.

getSchedules()

Returns the scheduling of the ad group-level snippet.

Return values:

Type	Description
AdsApp.ExtensionSchedule[]	The scheduling of the ad group-level snippet.

getStartDate()

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

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

Return values:

Type	Description
AdsApp.GoogleAdsDate	The ad group-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 = adGroupSnippet.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.

getValues()

Returns the values of the ad group-level snippet.

Return values:

Type	Description
String[]	The values of the ad group-level snippet.

isMobilePreferred()

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

Return values:

Type	Description
boolean	true if the ad group-level snippet specifies mobile device preference.

setEndDate(date)

Sets the ad group-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, adGroupSnippet.setEndDate("20130503"); is equivalent to adGroupSnippet.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 ad group-level snippet end date.

setHeader(header)

Sets the header of the ad group-level snippet.

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

Returns nothing.

Arguments:

Name	Type	Description
header	String	The header of the ad group-level snippet.

setMobilePreferred(isMobilePreferred)

Sets the ad group-level snippet'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 ad group-level snippet scheduling. Scheduling of a ad group-level snippet allows you to control the days of week and times of day during which the ad group-level snippet will show alongside your ads.

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

The following example sets the ad group-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
};

adGroupSnippet.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

Name	Type	Description
schedules	AdsApp.ExtensionSchedule[]	The new ad group-level snippet schedules.

setStartDate(date)

Sets the ad group-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, adGroupSnippet.setStartDate("20130503"); is equivalent to adGroupSnippet.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 ad group-level snippet's end date.

Returns nothing.

Arguments:

Name	Type	Description
date	Object	The new ad group-level snippet start date.

setValues(values)

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

Returns nothing.

Arguments:

Name	Type	Description
values	String[]	The values of the ad group-level snippet.