AdWordsApp.​CampaignMobileApp

Represents a mobile app that has been added to a campaign as an ad app extension. Visit our Ad Extensions page for more information on mobile apps and other types of ad extensions.

Methods:

MemberTypeDescription
clearLinkUrl void Clears the link URL of the campaign-level mobile app.
getAppId String Returns the application store-specific ID of the campaign-level mobile app.
getCampaign AdWordsApp.Campaign Returns the campaign to which this campaign-level mobile app belongs.
getEndDate AdWordsApp.AdWordsDate Returns the end date of the campaign-level mobile app.
getEntityType String Returns the type of this entity as a String, in this case, "CampaignMobileApp".
getId long Returns the ID of the campaign-level mobile app.
getLinkText String Returns the link text of the campaign-level mobile app.
getLinkUrl String Returns the link URL of the campaign-level mobile app.
getSchedules AdWordsApp.ExtensionSchedule[] Returns the scheduling of the campaign-level mobile app.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the campaign-level mobile app.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.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 campaign-level mobile app specifies mobile device preference.
setAppId void Sets the application store-specific ID of the campaign-level mobile app.
setEndDate void Sets the campaign-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 void Sets the link text of the campaign-level mobile app.
setLinkUrl void Sets the link URL of the campaign-level mobile app.
setMobilePreferred void Sets the campaign-level mobile app's device preference.
setSchedules void Sets the campaign-level mobile app scheduling.
setStartDate void Sets the campaign-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 void Sets the application store to which the application belongs.
urls AdWordsApp.MobileAppUrls Provides access to the URL fields of this campaign-level mobile app.

clearLinkUrl()

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

Returns nothing.

getAppId()

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

Return values:

TypeDescription
String The application store-specific ID of the campaign-level mobile app.

getCampaign()

Returns the campaign to which this campaign-level mobile app belongs.

Return values:

TypeDescription
AdWordsApp.Campaign The campaign to which this campaign-level mobile app belongs.

getEndDate()

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

Return values:

TypeDescription
AdWordsApp.AdWordsDate The campaign-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, "CampaignMobileApp".

Return values:

TypeDescription
String Type of this entity: "CampaignMobileApp".

getId()

Returns the ID of the campaign-level mobile app.

Return values:

TypeDescription
long The ID of the campaign-level mobile app.

getLinkText()

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

Return values:

TypeDescription
String The link text of the campaign-level mobile app.

getLinkUrl()

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

Return values:

TypeDescription
String The link URL of the campaign-level mobile app.

getSchedules()

Returns the scheduling of the campaign-level mobile app.

Return values:

TypeDescription
AdWordsApp.ExtensionSchedule[] The scheduling of the campaign-level mobile app.

getStartDate()

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

Return values:

TypeDescription
AdWordsApp.AdWordsDate The campaign-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 = campaignMobileApp.getStatsFor("THIS_MONTH");

Arguments:

NameTypeDescription
dateRange String Date range for which the stats are requested.

Return values:

TypeDescription
AdWordsApp.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:

NameTypeDescription
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:

TypeDescription
AdWordsApp.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:

TypeDescription
String The application store to which the application belongs.

isMobilePreferred()

Returns true if the campaign-level mobile app specifies mobile device preference.

Return values:

TypeDescription
boolean true if the campaign-level mobile app specifies mobile device preference.

setAppId(appId)

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

Returns nothing.

Arguments:

NameTypeDescription
appId String The application store-specific ID of the campaign-level mobile app.

setEndDate(date)

Sets the campaign-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, campaignMobileApp.setEndDate("20130503"); is equivalent to campaignMobileApp.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:

NameTypeDescription
date Object The new campaign-level mobile app end date.

setLinkText(linkText)

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

Returns nothing.

Arguments:

NameTypeDescription
linkText String The link text of the campaign-level mobile app.

setLinkUrl(linkUrl)

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

Returns nothing.

Arguments:

NameTypeDescription
linkUrl String The link URL of the campaign-level mobile app.

setMobilePreferred(isMobilePreferred)

Sets the campaign-level mobile app's device preference.

Returns nothing.

Arguments:

NameTypeDescription
isMobilePreferred boolean true sets the device preference to mobile. false clears the device preference.

setSchedules(schedules)

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

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

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

 campaignMobileApp.setSchedules([mondayMorning, tuesdayMorning]);

Returns nothing.

Arguments:

NameTypeDescription
schedules AdWordsApp.ExtensionSchedule[] The new campaign-level mobile app schedules.

setStartDate(date)

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

Returns nothing.

Arguments:

NameTypeDescription
date Object The new campaign-level mobile app start date.

setStore(store)

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

Returns nothing.

Arguments:

NameTypeDescription
store String The application store to which the application belongs.

urls()

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

Return values:

TypeDescription
AdWordsApp.MobileAppUrls Access to the URL fields of this campaign-level mobile app.

Feedback geben zu...

AdWords Scripts
AdWords Scripts