Stay organized with collections
Save and categorize content based on your preferences.
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.
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.
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}.
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}.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-29 UTC."],[[["The `AdGroupPhoneNumber` object in Google Ads Scripts represents a phone number added to an ad group as an ad call extension, allowing you to manage and retrieve information about it."],["You can use this object to get details like the associated ad group, phone number, country code, scheduling, and performance statistics."],["It provides functionalities to set the phone number, country code, and scheduling, though some features like setting call-only status and start/end dates are deprecated."],["While functionalities like setting call-only status and using `getStartDate()`/`getEndDate()` are deprecated, you can still utilize scheduling and `getStatsFor()` for controlling display times and retrieving performance data."],["For in-depth information and usage examples, refer to the official Google Ads Scripts documentation."]]],[]]
