Represents a phone number that can be part of an ad call extension. Visit our [Ad Extensions](https://developers.google.com/google-ads/scripts/docs/features/ad-extensions) page for more information on phone numbers and other types of ad extensions.

### Methods:

| Member | Type | Description |
|---|---|---|
| [clearEndDate()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#clearEndDate) | `void` | Clears the phone number's end date. |
| [clearStartDate()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#clearStartDate) | `void` | Clears the phone number's start date. |
| [getCountry()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#getCountry) | `String` | Returns the two character country code of the advertiser's phone number. |
| [getEndDate()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#getEndDate) | `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_googleadsdate` | Returns the end date of the phone number, or `null` if no end date is set. |
| [getEntityType()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#getEntityType) | `String` | Returns the type of this entity as a `String`, in this case, `"PhoneNumber"`. |
| [getId()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#getId) | `String` | Returns the ID of the phone number. |
| [getPhoneNumber()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#getPhoneNumber) | `String` | Returns the advertiser's phone number that gets appended to the ad. |
| [getResourceName()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#getResourceName) | `String` | Returns the resource name of the phone number. |
| [getSchedules()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#getSchedules) | `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_extensionschedule` | Returns the scheduling of the phone number. |
| [getStartDate()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#getStartDate) | `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_googleadsdate` | Returns the start date of the phone number, or `null` if no start date is set. |
| [getStatsFor(dateRange)](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#getStatsFor_dateRange) | `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_stats` | Returns stats for the specified date range. |
| [getStatsFor(dateFrom, dateTo)](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#getStatsFor_dateFrom-dateTo) | `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_stats` | Returns stats for the specified custom date range. |
| [isCallOnly()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#isCallOnly) | `boolean` | Returns `true` if this phone number is call only. |
| [isMobilePreferred()](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#isMobilePreferred) | `boolean` | Returns `true` if the phone number specifies mobile device preference. |
| [setCallOnly(callOnly)](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#setCallOnly_callOnly) | `void` | If set to `true`, only the advertiser's phone number will get displayed. |
| [setCountry(country)](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#setCountry_country) | `void` | Sets the two character country code of the advertiser's phone number. |
| [setEndDate(date)](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#setEndDate_date) | `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(isMobilePreferred)](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#setMobilePreferred_isMobilePreferred) | `void` | Sets the phone number's device preference. |
| [setPhoneNumber(phoneNumber)](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#setPhoneNumber_phoneNumber) | `void` | Sets the advertiser's phone number that gets appended to the ad. |
| [setSchedules(schedules)](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#setSchedules_schedules) | `void` | Sets the phone number scheduling. |
| [setStartDate(date)](https://developers.google.com/google-ads/scripts/docs/reference/adsapp/adsapp_phonenumber#setStartDate_date) | `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.

> [!WARNING]
> **Deprecated.**

Returns nothing.

## `clearStartDate()`

Clears the phone number's start date.

> [!WARNING]
> **Deprecated.**

Returns nothing.

## `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 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}`.

> [!WARNING]
> **Deprecated.**

### Return values:

| Type | Description |
|---|---|
| `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/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:

| Type | Description |
|---|---|
| `String` | Type of this entity: `"PhoneNumber"`. |

## `getId()`

Returns the ID of the phone number.

### Return values:

| Type | Description |
|---|---|
| `String` | The ID of the 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 phone number.

### Return values:

| Type | Description |
|---|---|
| `String` | The resource name of the phone number. |

## `getSchedules()`

Returns the scheduling of the phone number.

### Return values:

| Type | Description |
|---|---|
| `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/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}`.

> [!WARNING]
> **Deprecated.**

### Return values:

| Type | Description |
|---|---|
| `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/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:

| Name | Type | Description |
|---|---|---|
| dateRange | `String` | Date range for which the stats are requested. |

### Return values:

| Type | Description |
|---|---|
| `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/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 |
|---|---|
| `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/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.

> [!WARNING]
> **Deprecated.**This functionality has been deprecated.

### Return values:

| Type | Description |
|---|---|
| `boolean` | `true` if this phone number is call only. |

## `isMobilePreferred()`

Returns `true` if the phone number specifies mobile device preference.

> [!WARNING]
> **Deprecated.**

### Return values:

| Type | Description |
|---|---|
| `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.

> [!WARNING]
> **Deprecated.** This functionality has been deprecated. See the [announcement blog post](https://ads-developers.googleblog.com/2015/02/new-callonly-creative-type-in-adwords.html) for more information.

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 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.

> [!WARNING]
> **Deprecated.**

Returns nothing.

### Arguments:

| Name | Type | Description |
|---|---|---|
| date | `Object` | The new phone number end date. |

## `setMobilePreferred(isMobilePreferred)`

Sets the phone number's device preference.

> [!WARNING]
> **Deprecated.**

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

| Name | Type | Description |
|---|---|---|
| schedules | `https://developers.google.com/google-ads/scripts/docs/reference/adsapp/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.

> [!WARNING]
> **Deprecated.**

Returns nothing.

### Arguments:

| Name | Type | Description |
|---|---|---|
| date | `Object` | The new phone number start date. |