AdsApp.​MobileApp

Represents a mobile app that can be part of an ad app extension. Visit our Ad Extensions page for more information on mobile apps and other types of ad extensions.

Methods:

Member	Type	Description
clearEndDate	void	Clears the mobile app's end date.
clearLinkUrl	void	Clears the link URL of the mobile app.
clearStartDate	void	Clears the mobile app's start date.
getAppId	String	Returns the application store-specific ID of the mobile app.
getEndDate	AdsApp.GoogleAdsDate	Returns the end date of the mobile app, or null if no end date is set.
getEntityType	String	Returns the type of this entity as a String, in this case, "MobileApp".
getId	long	Returns the ID of the mobile app.
getLinkText	String	Returns the link text of the mobile app.
getLinkUrl	String	Returns the link URL of the mobile app.
getSchedules	AdsApp.ExtensionSchedule[]	Returns the scheduling of the mobile app.
getStartDate	AdsApp.GoogleAdsDate	Returns the start date of the mobile app, 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.
getStore	String	Returns the application store to which the application belongs.
isMobilePreferred	boolean	Returns true if the mobile app specifies mobile device preference.
setAppId	void	Sets the application store-specific ID of the mobile app.
setEndDate	void	Sets the mobile app's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
setLinkText	void	Sets the link text of the mobile app.
setLinkUrl	void	Sets the link URL of the mobile app.
setMobilePreferred	void	Sets the mobile app's device preference.
setSchedules	void	Sets the mobile app scheduling.
setStartDate	void	Sets the mobile app's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
setStore	void	Sets the application store to which the application belongs.
urls	AdsApp.MobileAppUrls	Provides access to the URL fields of this mobile app.

clearEndDate()

Clears the mobile app's end date.

Returns nothing.

clearLinkUrl()

Clears the link URL of the mobile app. To upgrade mobile apps to final URL, first clear the link URL, then set the final URL with MobileAppUrls.setFinalUrl.

Returns nothing.

clearStartDate()

Clears the mobile app's start date.

Returns nothing.

getAppId()

Returns the application store-specific ID of the mobile app.

Return values:

Type	Description
String	The application store-specific ID of the mobile app.

getEndDate()

Returns the end date of the mobile app, or null if no end date is set.

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

Return values:

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

getEntityType()

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

Return values:

Type	Description
String	Type of this entity: "MobileApp".

getId()

Returns the ID of the mobile app.

Return values:

Type	Description
long	The ID of the mobile app.

getLinkText()

Returns the link text of the mobile app.

Return values:

Type	Description
String	The link text of the mobile app.

getLinkUrl()

Returns the link URL of the mobile app.

Deprecated. This method is deprecated. Link URLs will become read-only on July 1, 2015. We recommend that you upgrade to using final URLs instead. See Using Upgraded URLs for more information.

Return values:

Type	Description
String	The link URL of the mobile app.

getSchedules()

Returns the scheduling of the mobile app.

Return values:

Type	Description
AdsApp.ExtensionSchedule[]	The scheduling of the mobile app.

getStartDate()

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

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

Return values:

Type	Description
AdsApp.GoogleAdsDate	The mobile app'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 = mobileApp.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.

getStore()

Returns the application store to which the application belongs. Possible return values: "iOS", "Android".

Return values:

Type	Description
String	The application store to which the application belongs.

isMobilePreferred()

Returns true if the mobile app specifies mobile device preference.

Return values:

Type	Description
boolean	true if the mobile app specifies mobile device preference.

setAppId(appId)

Sets the application store-specific ID of the mobile app.

Returns nothing.

Arguments:

Name	Type	Description
appId	String	The application store-specific ID of the mobile app.

setEndDate(date)

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

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

setLinkText(linkText)

Sets the link text of the mobile app.

Returns nothing.

Arguments:

Name	Type	Description
linkText	String	The link text of the mobile app.

setLinkUrl(linkUrl)

Sets the link URL of the mobile app.

Deprecated. This method will be sunset when link URLs become read-only on July 1, 2015. Please use MobileAppUrls.setFinalUrl instead. See Using Upgraded URLs for more information.

Returns nothing.

Arguments:

Name	Type	Description
linkUrl	String	The link URL of the mobile app.

setMobilePreferred(isMobilePreferred)

Sets the mobile app's device preference.

Returns nothing.

Arguments:

Name	Type	Description
isMobilePreferred	boolean	true sets the device preference to mobile. false clears the device preference.

setSchedules(schedules)

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

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

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

 mobileApp.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

Name	Type	Description
schedules	AdsApp.ExtensionSchedule[]	The new mobile app schedules.

setStartDate(date)

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

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

Returns nothing.

Arguments:

Name	Type	Description
date	Object	The new mobile app start date.

setStore(store)

Sets the application store to which the application belongs. Possible parameter values: "iOS", "Android".

Returns nothing.

Arguments:

Name	Type	Description
store	String	The application store to which the application belongs.

urls()

Provides access to the URL fields of this mobile app. See Using upgraded URLs for more information.

Return values:

Type	Description
AdsApp.MobileAppUrls	Access to the URL fields of this mobile app.