AdsApp.​CampaignSnippet

  • Represents a snippet extension added to a campaign for displaying additional information.

  • Provides methods to manage the snippet's header, values, scheduling, and device preference.

  • Allows retrieval of stats for specific date ranges.

  • Can be associated with search, display, and Performance Max campaigns.

  • Many methods related to start and end dates, scheduling, and mobile preference are deprecated.

 Represents a snippet that has been added to a campaign as a snipppet extension. See About structured snippet extensions for more information.

Methods:

MemberTypeDescription
clearEndDate() void Clears the campaign-level snippet's end date.
clearStartDate() void Clears the campaign-level snippet's start date.
getBaseCampaign() AdsApp.Campaign Returns the base campaign to which this campaign-level snippet belongs.
getCampaign() AdsApp.Campaign Returns the campaign to which this campaign-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 campaign-level snippet, or null if no end date is set.
getEntityType() String Returns the type of this entity as a String, in this case, "CampaignSnippet".
getHeader() String Returns the header of the campaign-level snippet.
getId() String Returns the ID of the campaign-level snippet.
getPerformanceMaxCampaign() AdsApp.PerformanceMaxCampaign Returns the performance max campaign to which this campaign-level snippet belongs or null if it does not belong to a performance max campaign.
getResourceName() String Returns the resource name of the campaign-level snippet.
getSchedules() AdsApp.ExtensionSchedule[] Returns the scheduling of the campaign-level snippet.
getStartDate() AdsApp.GoogleAdsDate Returns the start date of the campaign-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 campaign-level snippet.
isMobilePreferred() boolean Returns true if the campaign-level snippet specifies mobile device preference.
setEndDate(date) void Sets the campaign-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 campaign-level snippet.
setMobilePreferred(isMobilePreferred) void Sets the campaign-level snippet's device preference.
setSchedules(schedules) void Sets the campaign-level snippet scheduling.
setStartDate(date) void Sets the campaign-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 campaign-level snippet.

clearEndDate()

Clears the campaign-level snippet's end date.

Returns nothing.

clearStartDate()

Clears the campaign-level snippet's start date.

Returns nothing.

getBaseCampaign()

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

Return values:

TypeDescription
AdsApp.Campaign The base campaign to which this campaign-level snippet belongs.

getCampaign()

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

Return values:

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

getEndDate()

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

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

Return values:

TypeDescription
AdsApp.GoogleAdsDate The campaign-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, "CampaignSnippet".

Return values:

TypeDescription
String Type of this entity: "CampaignSnippet".

getHeader()

Returns the header of the campaign-level snippet.

Return values:

TypeDescription
String The header of the campaign-level snippet.

getId()

Returns the ID of the campaign-level snippet.

Return values:

TypeDescription
String The ID of the campaign-level snippet.

getPerformanceMaxCampaign()

Returns the performance max campaign to which this campaign-level snippet belongs or null if it does not belong to a performance max campaign.

Return values:

TypeDescription
AdsApp.PerformanceMaxCampaign The performance max campaign to which this campaign-level snippet belongs or null if it does not belong to a performance max campaign.

getResourceName()

Returns the resource name of the campaign-level snippet.

Return values:

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

getSchedules()

Returns the scheduling of the campaign-level snippet.

Return values:

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

getStartDate()

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

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

Return values:

TypeDescription
AdsApp.GoogleAdsDate The campaign-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 = campaignSnippet.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 campaign-level snippet.

Return values:

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

isMobilePreferred()

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

Return values:

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

setEndDate(date)

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

setHeader(header)

Sets the header of the campaign-level snippet.

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

Returns nothing.

Arguments:

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

setMobilePreferred(isMobilePreferred)

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

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

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

campaignSnippet.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

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

setStartDate(date)

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

Returns nothing.

Arguments:

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

setValues(values)

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

Returns nothing.

Arguments:

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