Represents a price that has been added to an ad group as an ad price
extension. Visit our
Ad Extensions page
for more information on prices and other types of ad extensions.
Methods:
| Member | Type | Description |
|---|
| addPriceItem |
void |
Adds a price item to the ad group-level price. |
clearEndDate |
void |
Clears the ad group-level price's end date. |
| clearPriceQualifier |
void |
Clears the price qualifier of the ad group-level price. |
clearStartDate |
void |
Clears the ad group-level price's start date. |
| clearTrackingTemplate |
void |
Clears the tracking template of the ad group-level price. |
| getAdGroup |
AdsApp.AdGroup |
Returns the ad group to which this ad group-level price belongs. |
| getBaseAdGroup |
AdsApp.AdGroup |
Returns the base ad group to which this ad group-level price belongs. |
| getBaseCampaign |
AdsApp.Campaign |
Returns the base campaign to which this ad group-level price belongs. |
| getCampaign |
AdsApp.Campaign |
Returns the campaign to which this ad group-level price 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 price, or null if no
end date is set. |
| getEntityType |
String |
Returns the type of this entity as a String, in this case,
"AdGroupPrice". |
| getId |
String |
Returns the ID of the ad group-level price. |
| getLanguage |
String |
Returns the language used for the ad group-level price. |
| getPriceItems |
AdsApp.PriceItem[] |
Returns the price items in the ad group-level price. |
| getPriceQualifier |
String |
Returns the price qualifier of the ad group-level price. |
| getPriceType |
String |
Returns the price extension type of the ad group-level price. |
| getResourceName |
String |
Returns the resource name of the ad group-level price. |
getSchedules |
AdsApp.ExtensionSchedule[] |
Returns the scheduling of the ad group-level price. |
getStartDate |
AdsApp.GoogleAdsDate |
Returns the start date of the ad group-level price, 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. |
| getTrackingTemplate |
String |
Returns the tracking template of the ad group-level price. |
| isLegacy |
boolean |
Return true if the ad group-level price is legacy. |
isMobilePreferred |
boolean |
Returns true if the ad group-level price specifies mobile
device preference. |
| removePriceItem |
void |
Removes a price item from the ad group-level price. |
setEndDate |
void |
Sets the ad group-level price's end date from either an object containing
year, month, and day fields, or an 8-digit string in YYYYMMDD
format. |
| setLanguage |
void |
Sets the language of the price. |
setMobilePreferred |
void |
Sets the ad group-level price's device preference. |
| setPriceQualifier |
void |
Sets the price qualifier of the ad group-level price. |
| setPriceType |
void |
Sets the price extension type of the ad group-level price. |
setSchedules |
void |
Sets the ad group-level price scheduling. |
setStartDate |
void |
Sets the ad group-level price's start date from either an object containing
year, month, and day fields, or an 8-digit string in YYYYMMDD
format. |
| setTrackingTemplate |
void |
Sets the tracking template of the ad group-level price. |
addPriceItem(priceItem)
Adds a price item to the ad group-level price.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| priceItem |
AdsApp.PriceItem |
The price item to add to the ad group-level price. |
clearEndDate()
Clears the ad group-level price's end date.
Returns nothing.
clearPriceQualifier()
Clears the price qualifier of the ad group-level price.
Returns nothing.
clearStartDate()
Clears the ad group-level price's start date.
Returns nothing.
clearTrackingTemplate()
Clears the tracking template of the ad group-level price.
Returns nothing.
getAdGroup()
Returns the ad group to which this ad group-level price belongs.
Return values:
| Type | Description |
|---|
AdsApp.AdGroup |
The ad group to which this ad group-level price belongs. |
getBaseAdGroup()
Returns the base ad group to which this ad group-level price belongs.
Return values:
| Type | Description |
|---|
AdsApp.AdGroup |
The base ad group to which this ad group-level price belongs. |
getBaseCampaign()
Returns the base campaign to which this ad group-level price belongs.
Return values:
| Type | Description |
|---|
AdsApp.Campaign |
The base campaign to which this ad group-level price belongs. |
getCampaign()
Returns the campaign to which this ad group-level price 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 price belongs or
null if it does
not belong to a search or display campaign. |
getEndDate()
Returns the end date of the ad group-level price, or
null if no
end date is set.
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:
| Type | Description |
|---|
AdsApp.GoogleAdsDate |
The ad group-level price's end date, or null if there's
no end date. |
getEntityType()
Returns the type of this entity as a
String, in this case,
"AdGroupPrice".
Return values:
| Type | Description |
|---|
String |
Type of this entity: "AdGroupPrice". |
getId()
Returns the ID of the ad group-level price.
Return values:
| Type | Description |
|---|
String |
The ID of the ad group-level price. |
getLanguage()
Returns the language used for the ad group-level price.
Return values:
| Type | Description |
|---|
String |
The language used for the ad group-level price. |
getPriceItems()
Returns the price items in the ad group-level price.
Return values:
getPriceQualifier()
Returns the price qualifier of the ad group-level price.
Return values:
| Type | Description |
|---|
String |
The price qualifier of the ad group-level price. |
getPriceType()
Returns the price extension type of the ad group-level price.
Return values:
| Type | Description |
|---|
String |
The price extension type of the ad group-level price. |
getResourceName()
Returns the resource name of the ad group-level price.
Return values:
| Type | Description |
|---|
String |
The resource name of the ad group-level price. |
getSchedules()
Returns the scheduling of the ad group-level price.
Return values:
getStartDate()
Returns the start date of the ad group-level price, or
null if
no start date is set.
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:
| Type | Description |
|---|
AdsApp.GoogleAdsDate |
The ad group-level price'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 = adGroupPrice.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. |
getTrackingTemplate()
Returns the tracking template of the ad group-level price.
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:
| Type | Description |
|---|
String |
The tracking template of the ad group-level price. |
isLegacy()
Return
true if the ad group-level price is legacy.
Return values:
| Type | Description |
|---|
boolean |
true if the ad group-level price is legacy. |
isMobilePreferred()
Returns
true if the ad group-level price specifies mobile
device preference.
Return values:
| Type | Description |
|---|
boolean |
true if the ad group-level price specifies mobile
device preference. |
removePriceItem(priceItem)
Removes a price item from the ad group-level price.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| priceItem |
AdsApp.PriceItem |
The price item to remove from the ad group-level price. |
setEndDate(date)
Sets the ad group-level price's end date from either an object containing
year, month, and day fields, or an 8-digit string in
YYYYMMDD
format.
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:
| Name | Type | Description |
|---|
| date |
Object |
The new ad group-level price end date. |
setLanguage(language)
Sets the language of the price. This field is required. Supported language
codes are:
- de
- en
- es
- es-419
- fr
- it
- ja
- nl
- pl
- pt-BR
- pt-PT
- ru
- sv
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| language |
String |
The code for the language of the price. |
setMobilePreferred(isMobilePreferred)
Sets the ad group-level price's device preference.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| isMobilePreferred |
boolean |
true sets the device preference to
mobile. false clears the device preference. |
setPriceQualifier(priceQualifier)
Sets the price qualifier of the ad group-level price.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| priceQualifier |
String |
The price qualifier of the ad group-level price. |
setPriceType(priceType)
Sets the price extension type of the ad group-level price.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| priceType |
String |
The price extension type of the ad group-level price. |
setSchedules(schedules)
Sets the ad group-level price scheduling. Scheduling of a ad group-level price allows you to control the days of week and times of day during which
the ad group-level price will show alongside your ads.
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)
Sets the ad group-level price's start date from either an object containing
year, month, and day fields, or an 8-digit string in
YYYYMMDD
format.
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:
| Name | Type | Description |
|---|
| date |
Object |
The new ad group-level price start date. |
setTrackingTemplate(trackingTemplate)
Sets the tracking template of the ad group-level price.
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:
| Name | Type | Description |
|---|
| trackingTemplate |
String |
The tracking template of the ad group-level price. |
