AdsApp.​VideoMobileApplication

AI-generated Key Takeaways

• A Video Mobile Application criterion in a Video Campaign provides methods to access its bidding fields, retrieve its ID, name, and resource name, and determine its entity type.

• You can get statistics for the video mobile application using predefined date ranges or by specifying a custom date range.

• The video mobile application can return the video ad group and the video campaign it belongs to.

• You can check the status of the video mobile application (enabled, managed, paused) and remove it if needed.

Represents a Google Ads Mobile Application criterion in a Video Campaign.

Methods:

Member	Type	Description
bidding()	AdsApp.VideoCriterionBidding	Provides access to bidding fields of this video mobile application.
getAppId()	String	Returns the ID of the mobile application.
getEntityType()	String	Returns the type of this entity as a String, in this case, "VideoMobileApplication".
getId()	String	Returns the ID of the video mobile application.
getName()	String	Returns the mobile application name.
getResourceName()	String	Returns the resource name of the video mobile application.
getStatsFor(dateRange)	AdsApp.Stats	Returns stats for the specified date range.
getStatsFor(dateFrom, dateTo)	AdsApp.Stats	Returns stats for the specified custom date range.
getVideoAdGroup()	AdsApp.VideoAdGroup	Returns the ad group to which this video mobile application belongs.
getVideoCampaign()	AdsApp.VideoCampaign	Returns the campaign to which this video mobile application belongs.
isEnabled()	boolean	Returns true if the video mobile application is enabled.
isManaged()	boolean	Returns true if the mobile application is managed.
isPaused()	boolean	Returns true if the video mobile application is paused.
remove()	void	Removes the video mobile application.

bidding()

Provides access to bidding fields of this video mobile application.

Return values:

Type	Description
AdsApp.VideoCriterionBidding	Access to bidding fields of this video mobile application.

getAppId()

Returns the ID of the mobile application. The ID is a string that uniquely identifies a mobile application to Google Ads API. The format of this string is "{platform}-{platform_native_id}", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "1091700242" for "Gboard" whose App Store link is https://itunes.apple.com/us/app/gboard-new-keyboard-from-google/id1091700242). For Android, this native identifier is the application's package name (e.g., "com.google.android.vr.home" for "Daydream" from the Google Play link https://play.google.com/store/apps/details?id=com.google.android.vr.home). A well formed app ID for Google Ads API would thus be "1-1091700242" for iOS and "2-com.google.android.vr.home" for Android.

Return values:

Type	Description
String	The ID of the mobile application.

getEntityType()

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

Return values:

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

getId()

Returns the ID of the video mobile application.

Return values:

Type	Description
String	The ID of the video mobile application.

getName()

Returns the mobile application name.

Return values:

Type	Description
String	The mobile application name.

getResourceName()

Returns the resource name of the video mobile application.

Return values:

Type	Description
String	The resource name of the video mobile application.

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

getVideoAdGroup()

Returns the ad group to which this video mobile application belongs.

Return values:

Type	Description
AdsApp.VideoAdGroup	The ad group to which this video mobile application belongs.

getVideoCampaign()

Returns the campaign to which this video mobile application belongs.

Return values:

Type	Description
AdsApp.VideoCampaign	The campaign to which this video mobile application belongs.

isEnabled()

Returns true if the video mobile application is enabled.

Return values:

Type	Description
boolean	true if the video mobile application is enabled.

isManaged()

Returns true if the mobile application is managed. Returns false if the placement is automatic.

Return values:

Type	Description
boolean	true if the mobile application is managed.

isPaused()

Returns true if the video mobile application is paused.

Return values:

Type	Description
boolean	true if the video mobile application is paused.

remove()

Removes the video mobile application.

Returns nothing.