AdsApp.​PhoneNumber

Represents a phone number that can be part of an ad call extension. Visit our Ad Extensions page for more information on phone numbers and other types of ad extensions.

Methods:

MemberTypeDescription
clearEndDate void Clears the phone number's end date.
clearStartDate void Clears the phone number's start date.
getCountry String Returns the two character country code of the advertiser's phone number.
getEndDate AdsApp.GoogleAdsDate Returns the end date of the phone number, or null if no end date is set.
getEntityType String Returns the type of this entity as a String, in this case, "PhoneNumber".
getId String Returns the ID of the phone number.
getPhoneNumber String Returns the advertiser's phone number that gets appended to the ad.
getResourceName String Returns the resource name of the phone number.
getSchedules AdsApp.ExtensionSchedule[] Returns the scheduling of the phone number.
getStartDate AdsApp.GoogleAdsDate Returns the start date of the 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 phone number is call only.
isLegacy boolean Return true if the phone number is legacy.
isMobilePreferred boolean Returns true if the 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 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 phone number's device preference.
setPhoneNumber void Sets the advertiser's phone number that gets appended to the ad.
setSchedules void Sets the phone number scheduling.
setStartDate void Sets the 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 phone number's end date.

Returns nothing.

clearStartDate()

Clears the phone number's start date.

Returns nothing.

getCountry()

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

Return values:

TypeDescription
String The country code of the phone number.

getEndDate()

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

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

Return values:

TypeDescription
AdsApp.GoogleAdsDate The 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, "PhoneNumber".

Return values:

TypeDescription
String Type of this entity: "PhoneNumber".

getId()

Returns the ID of the phone number.

Return values:

TypeDescription
String The ID of the phone number.

getPhoneNumber()

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

Return values:

TypeDescription
String The phone number as a string.

getResourceName()

Returns the resource name of the phone number.

Return values:

TypeDescription
String The resource name of the phone number.

getSchedules()

Returns the scheduling of the phone number.

Return values:

TypeDescription
AdsApp.ExtensionSchedule[] The scheduling of the phone number.

getStartDate()

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

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

Return values:

TypeDescription
AdsApp.GoogleAdsDate The 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 = phoneNumber.getStatsFor("THIS_MONTH");

Arguments:

NameTypeDescription
dateRange String Date range for which the stats are requested.

Return values:

TypeDescription
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:

NameTypeDescription
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:

TypeDescription
AdsApp.Stats The stats for the specified date range.

isCallOnly()

Returns true if this 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:

TypeDescription
boolean true if this phone number is call only.

isLegacy()

Return true if the phone number is legacy.

Return values:

TypeDescription
boolean true if the phone number is legacy.

isMobilePreferred()

Returns true if the phone number specifies mobile device preference.

Return values:

TypeDescription
boolean true if the 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:

NameTypeDescription
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:

NameTypeDescription
country String The new country code for the phone number.

setEndDate(date)

Sets the 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, phoneNumber.setEndDate("20130503"); is equivalent to phoneNumber.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:

NameTypeDescription
date Object The new phone number end date.

setMobilePreferred(isMobilePreferred)

Sets the phone number's device preference.

Returns nothing.

Arguments:

NameTypeDescription
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:

NameTypeDescription
phoneNumber String The phone number as a string.

setSchedules(schedules)

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

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

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

phoneNumber.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

NameTypeDescription
schedules AdsApp.ExtensionSchedule[] The new phone number schedules.

setStartDate(date)

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

Returns nothing.

Arguments:

NameTypeDescription
date Object The new phone number start date.