AdsApp.Price

Represents a price that has been added 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 price.
~~clearEndDate~~	`void`	Clears the price's end date.
clearPriceQualifier	`void`	Clears the price qualifier of the price.
~~clearStartDate~~	`void`	Clears the price's start date.
clearTrackingTemplate	`void`	Clears the tracking template of the price.
~~getEndDate~~	`AdsApp.GoogleAdsDate`	Returns the end date of the price, or `null` if no end date is set.
getEntityType	`String`	Returns the type of this entity as a `String`, in this case, `"Price"`.
getId	`String`	Returns the ID of the price.
getLanguage	`String`	Returns the language used for the price.
getPriceItems	`AdsApp.PriceItem[]`	Returns the price items in the price.
getPriceQualifier	`String`	Returns the price qualifier of the price.
getPriceType	`String`	Returns the price extension type of the price.
getResourceName	`String`	Returns the resource name of the price.
~~getSchedules~~	`AdsApp.ExtensionSchedule[]`	Returns the scheduling of the price.
~~getStartDate~~	`AdsApp.GoogleAdsDate`	Returns the start date of the 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 price.
isLegacy	`boolean`	Return `true` if the price is legacy.
~~isMobilePreferred~~	`boolean`	Returns `true` if the price specifies mobile device preference.
~~setEndDate~~	`void`	Sets the 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 price's device preference.
setPriceQualifier	`void`	Sets the price qualifier of the price.
setPriceType	`void`	Sets the price extension type of the price.
~~setSchedules~~	`void`	Sets the price scheduling.
~~setStartDate~~	`void`	Sets the 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 price.

`addPriceItem(priceItem)`

Adds a price item to the price.

Returns nothing.

Arguments:

Name	Type	Description
priceItem	`AdsApp.PriceItem`	The price item to add to the price.

`clearEndDate()`

Clears the price's end date.

Returns nothing.

`clearPriceQualifier()`

Clears the price qualifier of the price.

Returns nothing.

`clearStartDate()`

Clears the price's start date.

Returns nothing.

`clearTrackingTemplate()`

Clears the tracking template of the price.

Returns nothing.

`getEndDate()`

Returns the end date of the price, or null if no end date is set.

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

Return values:

Type	Description
`AdsApp.GoogleAdsDate`	The 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, "Price".

Return values:

Type	Description
`String`	Type of this entity: `"Price"`.

`getId()`

Returns the ID of the price.

Return values:

Type	Description
`String`	The ID of the price.

`getLanguage()`

Returns the language used for the price.

Return values:

Type	Description
`String`	The language used for the price.

`getPriceItems()`

Returns the price items in the price.

Return values:

Type	Description
`AdsApp.PriceItem[]`	The price items in the price.

`getPriceQualifier()`

Returns the price qualifier of the price.

Return values:

Type	Description
`String`	The price qualifier of the price.

`getPriceType()`

Returns the price extension type of the price.

Return values:

Type	Description
`String`	The price extension type of the price.

`getResourceName()`

Returns the resource name of the price.

Return values:

Type	Description
`String`	The resource name of the price.

`getSchedules()`

Returns the scheduling of the price.

Return values:

Type	Description
`AdsApp.ExtensionSchedule[]`	The scheduling of the price.

`getStartDate()`

Returns the start date of the price, or null if no start date is set.

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

Return values:

Type	Description
`AdsApp.GoogleAdsDate`	The 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 = price.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 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 price.

`isLegacy()`

Return true if the price is legacy.

Return values:

Type	Description
`boolean`	`true` if the price is legacy.

`isMobilePreferred()`

Returns true if the price specifies mobile device preference.

Return values:

Type	Description
`boolean`	`true` if the price specifies mobile device preference.

`setEndDate(date)`

Sets the price's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.

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

Returns nothing.

Arguments:

Name	Type	Description
priceQualifier	`String`	The price qualifier of the price.

`setPriceType(priceType)`

Sets the price extension type of the price.

Returns nothing.

Arguments:

Name	Type	Description
priceType	`String`	The price extension type of the price.

`setSchedules(schedules)`

Sets the price scheduling. Scheduling of a price allows you to control the days of week and times of day during which the price will show alongside your ads.

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

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

price.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

Name	Type	Description
schedules	`AdsApp.ExtensionSchedule[]`	The new price schedules.

`setStartDate(date)`

Sets the price's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.

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

Returns nothing.

Arguments:

Name	Type	Description
date	`Object`	The new price start date.

`setTrackingTemplate(trackingTemplate)`

Sets the tracking template of the 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.

See Using Upgraded URLs for more information.

Returns nothing.

Arguments:

Name	Type	Description
trackingTemplate	`String`	The tracking template of the price.

AdsApp.​Price

Methods:

addPriceItem(priceItem)

Arguments:

clearEndDate()

clearPriceQualifier()

clearStartDate()

clearTrackingTemplate()

getEndDate()

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()

Return values:

getStatsFor(dateRange)

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

getTrackingTemplate()

Return values:

isLegacy()

Return values:

isMobilePreferred()

Return values:

setEndDate(date)

Arguments:

setLanguage(language)

Arguments:

setMobilePreferred(isMobilePreferred)

Arguments:

setPriceQualifier(priceQualifier)

Arguments:

setPriceType(priceType)

Arguments:

setSchedules(schedules)

Arguments:

setStartDate(date)

Arguments:

setTrackingTemplate(trackingTemplate)

Arguments:

AdsApp.Price

`addPriceItem(priceItem)`

`clearEndDate()`

`clearPriceQualifier()`

`clearStartDate()`

`clearTrackingTemplate()`

`getEndDate()`

`getEntityType()`

`getId()`

`getLanguage()`

`getPriceItems()`

`getPriceQualifier()`

`getPriceType()`

`getResourceName()`

`getSchedules()`

`getStartDate()`

`getStatsFor(dateRange)`

`getStatsFor(dateFrom, dateTo)`

`getTrackingTemplate()`

`isLegacy()`

`isMobilePreferred()`

`setEndDate(date)`

`setLanguage(language)`

`setMobilePreferred(isMobilePreferred)`

`setPriceQualifier(priceQualifier)`

`setPriceType(priceType)`

`setSchedules(schedules)`

`setStartDate(date)`

`setTrackingTemplate(trackingTemplate)`