AdsApp.Message

Represents a message that can be part of a message extension. Visit our Ad Extensions page for more information on messages and other types of ad extensions.

Methods:

Member	Type	Description
clearEndDate	`void`	Clears the message's end date.
clearStartDate	`void`	Clears the message's start date.
getBusinessName	`String`	Returns the business name of the advertiser.
getCountryCode	`String`	Returns the two character country code of the advertiser's phone number.
getEndDate	`AdsApp.GoogleAdsDate`	Returns the end date of the message, or `null` if no end date is set.
getEntityType	`String`	Returns the type of this entity as a `String`, in this case, `"Message"`.
getExtensionText	`String`	Returns the extension text shown in the ad.
getId	`long`	Returns the ID of the message.
getMessageText	`String`	Returns the message text populating the messaging app.
getPhoneNumber	`String`	Returns the advertiser's phone number that gets appended to the ad.
getSchedules	`AdsApp.ExtensionSchedule[]`	Returns the scheduling of the message.
getStartDate	`AdsApp.GoogleAdsDate`	Returns the start date of the message, 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.
isMobilePreferred	`boolean`	Returns `true` if the message specifies mobile device preference.
setBusinessName	`void`	Sets the business name of the advertiser.
setCountryCode	`void`	Sets the two character country code of the advertiser's phone number.
setEndDate	`void`	Sets the message's end date from either an object containing year, month, and day fields, or an 8-digit string in `YYYYMMDD` format.
setExtensionText	`void`	Sets the extension text shown in the ad.
setMessageText	`void`	Sets the message text populating the messaging app.
setMobilePreferred	`void`	Sets the message's device preference.
setPhoneNumber	`void`	Sets the advertiser's phone number that gets appended to the ad.
setSchedules	`void`	Sets the message scheduling.
setStartDate	`void`	Sets the message's start date from either an object containing year, month, and day fields, or an 8-digit string in `YYYYMMDD` format.

`clearEndDate()`

Clears the message's end date.

Returns nothing.

`clearStartDate()`

Clears the message's start date.

Returns nothing.

`getBusinessName()`

Returns the business name of the advertiser.

Return values:

Type	Description
`String`	The business name of the advertiser.

`getCountryCode()`

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 message, or null if no end date is set.

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

Return values:

Type	Description
`AdsApp.GoogleAdsDate`	The message's end date, or `null` if there's no end date.

`getEntityType()`

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

Return values:

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

`getExtensionText()`

Returns the extension text shown in the ad.

Return values:

Type	Description
`String`	The extension text shown in the ad.

`getId()`

Returns the ID of the message.

Return values:

Type	Description
`long`	The ID of the message.

`getMessageText()`

Returns the message text populating the messaging app.

Return values:

Type	Description
`String`	The message text populating the messaging app.

`getPhoneNumber()`

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

Return values:

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

`getSchedules()`

Returns the scheduling of the message.

Return values:

Type	Description
`AdsApp.ExtensionSchedule[]`	The scheduling of the message.

`getStartDate()`

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

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

Return values:

Type	Description
`AdsApp.GoogleAdsDate`	The message'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 = message.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.

`isMobilePreferred()`

Returns true if the message specifies mobile device preference.

Return values:

Type	Description
`boolean`	`true` if the message specifies mobile device preference.

`setBusinessName(businessName)`

Sets the business name of the advertiser.

Returns nothing.

Arguments:

Name	Type	Description
businessName	`String`	The business name of the advertiser.

`setCountryCode(countryCode)`

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 message's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.

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

`setExtensionText(extensionText)`

Sets the extension text shown in the ad.

Returns nothing.

Arguments:

Name	Type	Description
extensionText	`String`	The extension text shown in the ad.

`setMessageText(messageText)`

Sets the message text populating the messaging app.

Returns nothing.

Arguments:

Name	Type	Description
messageText	`String`	The message text populating the messaging app.

`setMobilePreferred(isMobilePreferred)`

Sets the message'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 message scheduling. Scheduling of a message allows you to control the days of week and times of day during which the message will show alongside your ads.

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

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

 message.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

Name	Type	Description
schedules	`AdsApp.ExtensionSchedule[]`	The new message schedules.

`setStartDate(date)`

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

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

Returns nothing.

Arguments:

Name	Type	Description
date	`Object`	The new message start date.

AdsApp.​Message

Methods:

clearEndDate()

clearStartDate()

getBusinessName()

Return values:

getCountryCode()

Return values:

getEndDate()

Return values:

getEntityType()

Return values:

getExtensionText()

Return values:

getId()

Return values:

getMessageText()

Return values:

getPhoneNumber()

Return values:

getSchedules()

Return values:

getStartDate()

Return values:

getStatsFor(dateRange)

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

isMobilePreferred()

Return values:

setBusinessName(businessName)

Arguments:

setCountryCode(countryCode)

Arguments:

setEndDate(date)

Arguments:

setExtensionText(extensionText)

Arguments:

setMessageText(messageText)

Arguments:

setMobilePreferred(isMobilePreferred)

Arguments:

setPhoneNumber(phoneNumber)

Arguments:

setSchedules(schedules)

Arguments:

setStartDate(date)

Arguments:

AdsApp.Message

`clearEndDate()`

`clearStartDate()`

`getBusinessName()`

`getCountryCode()`

`getEndDate()`

`getEntityType()`

`getExtensionText()`

`getId()`

`getMessageText()`

`getPhoneNumber()`

`getSchedules()`

`getStartDate()`

`getStatsFor(dateRange)`

`getStatsFor(dateFrom, dateTo)`

`isMobilePreferred()`

`setBusinessName(businessName)`

`setCountryCode(countryCode)`

`setEndDate(date)`

`setExtensionText(extensionText)`

`setMessageText(messageText)`

`setMobilePreferred(isMobilePreferred)`

`setPhoneNumber(phoneNumber)`

`setSchedules(schedules)`

`setStartDate(date)`