AdsApp.​AccountMobileApp

    • AccountMobileApp represents a mobile app added as an ad app extension at the account level.

    • You can retrieve various properties of the AccountMobileApp such as its ID, app ID, link text, and store.

    • Methods are available to clear or set the start and end dates of the account-level mobile app.

    • The getStatsFor method allows you to retrieve performance statistics for specific date ranges.

    • Access to URL fields for the account-level mobile app is provided through the urls() method.

     Represents a mobile app that has been added to an account as 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 account-level mobile app's end date.
    clearLinkUrl()
    		void Clears the link URL of the account-level mobile app.
    clearStartDate()
    		void Clears the account-level mobile app's start date.
    getAppId()
    		String Returns the application store-specific ID of the account-level mobile app.
    getEndDate()
    		AdsApp.GoogleAdsDate Returns the end date of the account-level mobile app, or null if no end date is set.
    getEntityType()
    		String Returns the type of this entity as a String , in this case, "AccountMobileApp" .
    getId()
    		String Returns the ID of the account-level mobile app.
    getLinkText()
    		String Returns the link text of the account-level mobile app.
    getLinkUrl()
    		String Returns the link URL of the account-level mobile app.
    getResourceName()
    		String Returns the resource name of the account-level mobile app.
    getSchedules()
    		AdsApp.ExtensionSchedule[] Returns the scheduling of the account-level mobile app.
    getStartDate()
    		AdsApp.GoogleAdsDate Returns the start date of the account-level mobile app, or null if no start date is set.
    getStatsFor(dateRange)
    		AdsApp.Stats Returns stats for the specified date range.
    getStatsFor(dateFrom, dateTo)
    		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 account-level mobile app specifies mobile device preference.
    setAppId(appId)
    		void Sets the application store-specific ID of the account-level mobile app.
    setEndDate(date)
    		void Sets the account-level mobile app's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
    setLinkText(linkText)
    		void Sets the link text of the account-level mobile app.
    setLinkUrl(linkUrl)
    		void Sets the link URL of the account-level mobile app.
    setMobilePreferred(isMobilePreferred)
    		void Sets the account-level mobile app's device preference.
    setSchedules(schedules)
    		void Sets the account-level mobile app scheduling.
    setStartDate(date)
    		void Sets the account-level mobile app's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
    setStore(store)
    		void Sets the application store to which the application belongs.
    urls()
    		AdsApp.MobileAppUrls Provides access to the URL fields of this account-level mobile app.

    clearEndDate()

    Clears the account-level mobile app's end date.

    Returns nothing.

    clearLinkUrl()

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

    Returns nothing.

    clearStartDate()

    Clears the account-level mobile app's start date.

    Returns nothing.

    getAppId()

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

    Return values:

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

    getEndDate()

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

    For instance, if the end date of the account-level 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 account-level 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, "AccountMobileApp" .

    Return values:

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

    getId()

    Returns the ID of the account-level mobile app.

    Return values:

    Type Description
    String The ID of the account-level mobile app.

    getLinkText()

    Returns the link text of the account-level mobile app.

    Return values:

    Type Description
    String The link text of the account-level mobile app.

    getLinkUrl()

    Returns the link URL of the account-level mobile app.

    Return values:

    Type Description
    String The link URL of the account-level mobile app.

    getResourceName()

    Returns the resource name of the account-level mobile app.

    Return values:

    Type Description
    String The resource name of the account-level mobile app.

    getSchedules()

    Returns the scheduling of the account-level mobile app.

    Return values:

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

    getStartDate()

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

    For instance, if the start date of the account-level 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 account-level 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 
  
 = 
  
 accountMobileApp 
 . 
 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 account-level mobile app specifies mobile device preference.

    Return values:

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

    setAppId(appId)

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

    Returns nothing.

    Arguments:

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

    setEndDate(date)

    Sets the account-level 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, accountMobileApp.setEndDate("20130503"); is equivalent to accountMobileApp.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 account-level mobile app end date.

    setLinkText(linkText)

    Sets the link text of the account-level mobile app.

    Returns nothing.

    Arguments:

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

    setLinkUrl(linkUrl)

    Sets the link URL of the account-level mobile app.

    Returns nothing.

    Arguments:

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

    setMobilePreferred(isMobilePreferred)

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

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

    The following example sets the account-level 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 
 }; 
 accountMobileApp 
 . 
 setSchedules 
 ([ 
 mondayMorning 
 , 
  
 tuesdayMorning 
 ]);

    Returns nothing.

    Arguments:

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

    setStartDate(date)

    Sets the account-level 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, accountMobileApp.setStartDate("20130503"); is equivalent to accountMobileApp.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 account-level mobile app's end date.

    Returns nothing.

    Arguments:

    Name Type Description
    date
    		 Object The new account-level 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 account-level mobile app. See Using upgraded URLs for more information.

    Return values:

    Type Description
    AdsApp.MobileAppUrls Access to the URL fields of this account-level mobile app.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: