AdsApp.​AdGroupPrice

Stay organized with collections Save and categorize content based on your preferences.

Methods:

addPriceItem(priceItem)

Returns nothing.

Arguments:

clearEndDate()

Returns nothing.

clearPriceQualifier()

Returns nothing.

clearStartDate()

Returns nothing.

clearTrackingTemplate()

Returns nothing.

getAdGroup()

Return values:

getBaseAdGroup()

Return values:

getBaseCampaign()

Return values:

getCampaign()

Return values:

getEndDate()

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

Return values:

getEntityType()

Return values:

getId()

Return values:

getLanguage()

Return values:

getPriceItems()

Return values:

getPriceQualifier()

Return values:

getPriceType()

Return values:

getResourceName()

Return values:

getSchedules()

Return values:

getStartDate()

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

Return values:

getStatsFor(dateRange)

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 = adGroupPrice.getStatsFor("THIS_MONTH");

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

getTrackingTemplate()

You can optionally use the tracking template to specify additional tracking parameters or redirects. Google Ads will use this template to assemble the actual destination URL to associate with the ad.

A tracking template specified at a lower level entity will override the setting specified at a higher level entity, e.g., a tracking template at the ad group level overrides the setting at the campaign level.

See Using Upgraded URLs for more information.

Return values:

isLegacy()

Return values:

isMobilePreferred()

Return values:

removePriceItem(priceItem)

Returns nothing.

Arguments:

setEndDate(date)

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

setLanguage(language)

• de
• en
• es
• es-419
• fr
• it
• ja
• nl
• pl
• pt-BR
• pt-PT
• ru
• sv

Returns nothing.

Arguments:

setMobilePreferred(isMobilePreferred)

Returns nothing.

Arguments:

setPriceQualifier(priceQualifier)

Returns nothing.

Arguments:

setPriceType(priceType)

Returns nothing.

Arguments:

setSchedules(schedules)

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

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

adGroupPrice.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

setStartDate(date)

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

Returns nothing.

Arguments:

setTrackingTemplate(trackingTemplate)

You can optionally use the tracking template to specify additional tracking parameters or redirects. Google Ads will use this template to assemble the actual destination URL to associate with the ad.

A tracking template specified at a lower level entity will override the setting specified at a higher level entity, e.g., a tracking template at the ad group level overrides the setting at the campaign level.

See Using Upgraded URLs for more information.

Returns nothing.

Arguments: