Arguments:

Return values:

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:

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.Deprecated. This functionality has been deprecated. Please see the
announcement blog post for more information.

Return values:

Type

Description

boolean

true if this phone number is call only.

isMobilePreferred()

Returns true if the phone number specifies mobile device preference.

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.Deprecated. This functionality has been deprecated. It will start throwing errors on June 24,
2015. Please see the
announcement blog post 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:

Arguments:

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: