AdsApp.AdGroupPhoneNumber

Represents a phone number that has been added to an ad group as an ad call extension. Visit our Ad Extensions page for more information on phone numbers and other types of ad extensions.

Methods:

Member	Type	Description
~~clearEndDate~~	`void`	Clears the ad group-level phone number's end date.
~~clearStartDate~~	`void`	Clears the ad group-level phone number's start date.
getAdGroup	`AdsApp.AdGroup`	Returns the ad group to which this ad group-level phone number belongs.
getBaseAdGroup	`AdsApp.AdGroup`	Returns the base ad group to which this ad group-level phone number belongs.
getBaseCampaign	`AdsApp.Campaign`	Returns the base campaign to which this ad group-level phone number belongs.
getCampaign	`AdsApp.Campaign`	Returns the campaign to which this ad group-level phone number belongs or `null` if it does not belong to a search or display campaign.
getCountry	`String`	Returns the two character country code of the advertiser's phone number.
~~getEndDate~~	`AdsApp.GoogleAdsDate`	Returns the end date of the ad group-level phone number, or `null` if no end date is set.
getEntityType	`String`	Returns the type of this entity as a `String`, in this case, `"AdGroupPhoneNumber"`.
getId	`String`	Returns the ID of the ad group-level phone number.
getPhoneNumber	`String`	Returns the advertiser's phone number that gets appended to the ad.
getResourceName	`String`	Returns the resource name of the ad group-level phone number.
getSchedules	`AdsApp.ExtensionSchedule[]`	Returns the scheduling of the ad group-level phone number.
~~getStartDate~~	`AdsApp.GoogleAdsDate`	Returns the start date of the ad group-level phone number, 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.
~~isCallOnly~~	`boolean`	Returns `true` if this ad group-level phone number is call only.
isLegacy	`boolean`	Return `true` if the ad group-level phone number is legacy.
~~isMobilePreferred~~	`boolean`	Returns `true` if the ad group-level phone number specifies mobile device preference.
~~setCallOnly~~	`void`	If set to `true`, only the advertiser's phone number will get displayed.
setCountry	`void`	Sets the two character country code of the advertiser's phone number.
~~setEndDate~~	`void`	Sets the ad group-level phone number's end date from either an object containing year, month, and day fields, or an 8-digit string in `YYYYMMDD` format.
~~setMobilePreferred~~	`void`	Sets the ad group-level phone number's device preference.
setPhoneNumber	`void`	Sets the advertiser's phone number that gets appended to the ad.
setSchedules	`void`	Sets the ad group-level phone number scheduling.
~~setStartDate~~	`void`	Sets the ad group-level phone number's start date from either an object containing year, month, and day fields, or an 8-digit string in `YYYYMMDD` format.

`clearEndDate()`

Clears the ad group-level phone number's end date.

Returns nothing.

`clearStartDate()`

Clears the ad group-level phone number's start date.

Returns nothing.

`getAdGroup()`

Returns the ad group to which this ad group-level phone number belongs.

Return values:

Type	Description
`AdsApp.AdGroup`	The ad group to which this ad group-level phone number belongs.

`getBaseAdGroup()`

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

Return values:

Type	Description
`AdsApp.AdGroup`	The base ad group to which this ad group-level phone number belongs.

`getBaseCampaign()`

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

Return values:

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

`getCampaign()`

Returns the campaign to which this ad group-level phone number 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 phone number belongs or `null` if it does not belong to a search or display campaign.

`getCountry()`

Returns the two character country code of the advertiser's phone number.

Return values:

Type	Description
`String`	The country code of the phone number.

`getEndDate()`

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

For instance, if the end date of the ad group-level phone number 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 phone number's end date, or `null` if there's no end date.

`getEntityType()`

Returns the type of this entity as a String, in this case, "AdGroupPhoneNumber".

Return values:

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

`getId()`

Returns the ID of the ad group-level phone number.

Return values:

Type	Description
`String`	The ID of the ad group-level phone number.

`getPhoneNumber()`

Returns the advertiser's phone number that gets appended to the ad.

Return values:

Type	Description
`String`	The phone number as a string.

`getResourceName()`

Returns the resource name of the ad group-level phone number.

Return values:

Type	Description
`String`	The resource name of the ad group-level phone number.

`getSchedules()`

Returns the scheduling of the ad group-level phone number.

Return values:

Type	Description
`AdsApp.ExtensionSchedule[]`	The scheduling of the ad group-level phone number.

`getStartDate()`

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

For instance, if the start date of the ad group-level phone number 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 phone number'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 = adGroupPhoneNumber.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.

`isCallOnly()`

Returns true if this ad group-level phone number is call only. If true, only the advertiser's phone number will get displayed. If false, the link to the advertiser's website will be shown alongside.

Return values:

Type	Description
`boolean`	`true` if this ad group-level phone number is call only.

`isLegacy()`

Return true if the ad group-level phone number is legacy.

Return values:

Type	Description
`boolean`	`true` if the ad group-level phone number is legacy.

`isMobilePreferred()`

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

Return values:

Type	Description
`boolean`	`true` if the ad group-level phone number specifies mobile device preference.

`setCallOnly(callOnly)`

If set to true, only the advertiser's phone number will get displayed. If set to false, the link to the advertiser's website will be shown as well.

Returns nothing.

Arguments:

Name	Type	Description
callOnly	`boolean`	The value for call only setting.

`setCountry(country)`

Sets the two character country code of the advertiser's phone number.

Returns nothing.

Arguments:

Name	Type	Description
country	`String`	The new country code for the phone number.

`setEndDate(date)`

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

For instance, adGroupPhoneNumber.setEndDate("20130503"); is equivalent to adGroupPhoneNumber.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 phone number end date.

`setMobilePreferred(isMobilePreferred)`

Sets the ad group-level phone number's device preference.

Returns nothing.

Arguments:

Name	Type	Description
isMobilePreferred	`boolean`	`true` sets the device preference to mobile. `false` clears the device preference.

`setPhoneNumber(phoneNumber)`

Sets the advertiser's phone number that gets appended to the ad.

Returns nothing.

Arguments:

Name	Type	Description
phoneNumber	`String`	The phone number as a string.

`setSchedules(schedules)`

Sets the ad group-level phone number scheduling. Scheduling of a ad group-level phone number allows you to control the days of week and times of day during which the ad group-level phone number will show alongside your ads.

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

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

adGroupPhoneNumber.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

Name	Type	Description
schedules	`AdsApp.ExtensionSchedule[]`	The new ad group-level phone number schedules.

`setStartDate(date)`

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

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

Returns nothing.

Arguments:

Name	Type	Description
date	`Object`	The new ad group-level phone number start date.

AdsApp.​AdGroupPhoneNumber

Methods:

clearEndDate()

clearStartDate()

getAdGroup()

Return values:

getBaseAdGroup()

Return values:

getBaseCampaign()

Return values:

getCampaign()

Return values:

getCountry()

Return values:

getEndDate()

Return values:

getEntityType()

Return values:

getId()

Return values:

getPhoneNumber()

Return values:

getResourceName()

Return values:

getSchedules()

Return values:

getStartDate()

Return values:

getStatsFor(dateRange)

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

isCallOnly()

Return values:

isLegacy()

Return values:

isMobilePreferred()

Return values:

setCallOnly(callOnly)

Arguments:

setCountry(country)

Arguments:

setEndDate(date)

Arguments:

setMobilePreferred(isMobilePreferred)

Arguments:

setPhoneNumber(phoneNumber)

Arguments:

setSchedules(schedules)

Arguments:

setStartDate(date)

Arguments:

AdsApp.AdGroupPhoneNumber

`clearEndDate()`

`clearStartDate()`

`getAdGroup()`

`getBaseAdGroup()`

`getBaseCampaign()`

`getCampaign()`

`getCountry()`

`getEndDate()`

`getEntityType()`

`getId()`

`getPhoneNumber()`

`getResourceName()`

`getSchedules()`

`getStartDate()`

`getStatsFor(dateRange)`

`getStatsFor(dateFrom, dateTo)`

`isCallOnly()`

`isLegacy()`

`isMobilePreferred()`

`setCallOnly(callOnly)`

`setCountry(country)`

`setEndDate(date)`

`setMobilePreferred(isMobilePreferred)`

`setPhoneNumber(phoneNumber)`

`setSchedules(schedules)`

`setStartDate(date)`