AdWords scripts

AdWords Services

Provides access to an AdWords account.

Users can access, modify, and create new AdWords entities.

Base Classes:

ClassDescription
AdWordsApp The root object of the API.
AdWordsApp.Account Miscellaneous information about AdWords Accounts.
AdWordsApp.Ad Represents an AdWords ad.
AdWordsApp.AdGroup Represents an AdWords ad group.
AdWordsApp.AdGroupBuilder Builder for an ad group under construction.
AdWordsApp.AdGroupExtensions Access to ad group-level extensions.
AdWordsApp.AdGroupIterator An iterator of ad groups.
AdWordsApp.AdGroupMobileApp Represents a mobile app that has been added to an ad group as an ad app extension.
AdWordsApp.AdGroupMobileAppIterator An iterator of ad group-level mobile apps.
AdWordsApp.AdGroupMobileAppSelector Fetches ad group-level mobile apps.
AdWordsApp.AdGroupPhoneNumber Represents a phone number that has been added to an ad group as an ad call extension.
AdWordsApp.AdGroupPhoneNumberIterator An iterator of ad group-level phone numbers.
AdWordsApp.AdGroupPhoneNumberSelector Fetches ad group-level phone numbers.
AdWordsApp.AdGroupSelector Fetches ad groups.
AdWordsApp.AdGroupSitelink Represents a sitelink that has been added to an ad group as an ad sitelink extension.
AdWordsApp.AdGroupSitelinkIterator An iterator of ad group-level sitelinks.
AdWordsApp.AdGroupSitelinkSelector Fetches ad group-level sitelinks.
AdWordsApp.AdIterator An iterator of ads.
AdWordsApp.AdParam Represents an AdWords ad param.
AdWordsApp.AdParamIterator An iterator of ad params.
AdWordsApp.AdParamSelector Fetches ad params.
AdWordsApp.AdSchedule Represents one period of an AdWords ad schedule.
AdWordsApp.AdScheduleIterator An iterator of ad schedules.
AdWordsApp.AdScheduleSelector Fetches ad schedules.
AdWordsApp.AdSelector Fetches ads.
AdWordsApp.AdWordsDate A calendar date broken down into year, month, and day.
AdWordsApp.Address Represents the address of a geographical point.
AdWordsApp.Budget Represents an AdWords budget.
AdWordsApp.BudgetIterator An iterator of budgets.
AdWordsApp.BudgetSelector Fetches budgets.
AdWordsApp.Campaign Represents an AdWords campaign.
AdWordsApp.CampaignExtensions Access to campaign-level extensions.
AdWordsApp.CampaignIterator An iterator of campaigns.
AdWordsApp.CampaignMobileApp Represents a mobile app that has been added to a campaign as an ad app extension.
AdWordsApp.CampaignMobileAppIterator An iterator of campaign-level mobile apps.
AdWordsApp.CampaignMobileAppSelector Fetches campaign-level mobile apps.
AdWordsApp.CampaignPhoneNumber Represents a phone number that has been added to a campaign as an ad call extension.
AdWordsApp.CampaignPhoneNumberIterator An iterator of campaign-level phone numbers.
AdWordsApp.CampaignPhoneNumberSelector Fetches campaign-level phone numbers.
AdWordsApp.CampaignSelector Fetches campaigns.
AdWordsApp.CampaignSitelink Represents a sitelink that has been added to a campaign as an ad sitelink extension.
AdWordsApp.CampaignSitelinkIterator An iterator of campaign-level sitelinks.
AdWordsApp.CampaignSitelinkSelector Fetches campaign-level sitelinks.
AdWordsApp.ExcludedLocation Represents an AdWords excluded location.
AdWordsApp.ExcludedLocationIterator An iterator of locations.
AdWordsApp.ExcludedLocationSelector Fetches excluded locations.
AdWordsApp.ExecutionInfo Miscellaneous information about the current script execution.
AdWordsApp.ExtensionSchedule Represents one period of an AdWords ad extension schedule.
AdWordsApp.Extensions Access to ad extensions that have been added to this account: Sitelink, PhoneNumber, MobileApp.
AdWordsApp.Keyword Represents an AdWords keyword.
AdWordsApp.KeywordIterator An iterator of keywords.
AdWordsApp.KeywordSelector Fetches keywords.
AdWordsApp.Label Represents an AdWords label.
AdWordsApp.LabelIterator An iterator of labels.
AdWordsApp.LabelSelector Fetches labels.
AdWordsApp.MobileApp Represents a mobile app that can be part of an ad app extension.
AdWordsApp.MobileAppBuilder Builder for MobileApp objects.
AdWordsApp.MobileAppIterator An iterator of mobile apps.
AdWordsApp.MobileAppSelector Fetches mobile apps.
AdWordsApp.NegativeKeyword Represents an AdWords negative keyword.
AdWordsApp.NegativeKeywordIterator An iterator of negative keywords.
AdWordsApp.NegativeKeywordSelector Fetches negative keywords.
AdWordsApp.PhoneNumber Represents a phone number that can be part of an ad call extension.
AdWordsApp.PhoneNumberBuilder Builder for PhoneNumber objects.
AdWordsApp.PhoneNumberIterator An iterator of phone numbers.
AdWordsApp.PhoneNumberSelector Fetches phone numbers.
AdWordsApp.Platform Represents an AdWords device target (either desktop, mobile, or tablet).
AdWordsApp.PlatformIterator An iterator of platforms.
AdWordsApp.PlatformSelector Fetches platforms.
AdWordsApp.Report Represents an AdWords report.
AdWordsApp.ReportRowIterator Represents an iterator of report rows.
AdWordsApp.Sitelink Represents a sitelink that can be part of an ad sitelink extension.
AdWordsApp.SitelinkBuilder Builder for Sitelink objects.
AdWordsApp.SitelinkIterator An iterator of sitelinks.
AdWordsApp.SitelinkSelector Fetches sitelinks.
AdWordsApp.Stats Statistics common to various entity types.
AdWordsApp.TargetedLocation Represents an AdWords targeted location.
AdWordsApp.TargetedLocationIterator An iterator of locations.
AdWordsApp.TargetedLocationSelector Fetches targeted locations.
AdWordsApp.TargetedProximity Represents an AdWords targeted proximity — some radius around a geographical point.
AdWordsApp.TargetedProximityIterator An iterator of proximities.
AdWordsApp.TargetedProximitySelector Fetches targeted proximities.
AdWordsApp.Targeting Access to campaign-level targeting criteria.

class AdWordsApp

Methods:

MemberTypeDescription
adGroups AdWordsApp.AdGroupSelector Returns the selector of all ad groups in the account.
adParams AdWordsApp.AdParamSelector Returns the selector of all ad params in the account.
ads AdWordsApp.AdSelector Returns the selector of all ads in the account.
budgets AdWordsApp.BudgetSelector Returns the selector of all budgets in the account.
campaigns AdWordsApp.CampaignSelector Returns the selector of all campaigns in the account.
createLabel void Creates a new Label.
currentAccount AdWordsApp.Account Returns miscellaneous information about the AdWords account in which the script is currently running.
extensions AdWordsApp.Extensions Provides access to ad extensions that have been added to this account: Sitelink, PhoneNumber, MobileApp.
getExecutionInfo AdWordsApp.ExecutionInfo Returns miscellaneous information about the current script execution.
keywords AdWordsApp.KeywordSelector Returns the selector of all keywords in the account.
labels AdWordsApp.LabelSelector Returns the selector of all labels in the account.
report AdWordsApp.Report Fetches an AdWords report.
targeting AdWordsApp.Targeting Provides access to campaign-level targeting criteria: device targeting, ad scheduling, and location targeting.

class AdWordsApp.Account

Methods:

MemberTypeDescription
getCurrencyCode String Returns the currency code of the account.
getCustomerId String Returns the customer ID of the account.
getLoginEmail String Returns the email address of the account's first login user.
getName String Returns the name of the account.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
getTimeZone String Returns the POSIX time zone of the account.

class AdWordsApp.Ad

Methods:

MemberTypeDescription
applyLabel void Applies a label to the ad.
enable void Enables the ad.
getAdGroup AdWordsApp.AdGroup Returns the ad group to which this ad belongs.
getApprovalStatus String Returns the approval status of the ad.
getCampaign AdWordsApp.Campaign Returns the campaign to which this ad belongs.
getDescription1 String Returns the first line of the ad description.
getDescription2 String Returns the second line of the ad description.
getDestinationUrl String Returns the destination URL of the ad.
getDisplayUrl String Returns the display URL of the ad.
getEntityType String Returns the type of this entity as a String.
getHeadline String Returns the headline of the ad.
getId long Returns the ID of the ad.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
getType String Returns the type of the ad.
isEnabled boolean Returns true if the ad is enabled.
isMobilePreferred boolean Returns true if the ad specifies mobile device preference or false otherwise.
isPaused boolean Returns true if the ad is paused.
labels AdWordsApp.LabelSelector Creates a selector of all labels applied to the ad.
pause void Pauses the ad.
remove void Deletes the ad from the account.
removeLabel void Removes a label from the ad.

class AdWordsApp.AdGroup

Methods:

MemberTypeDescription
adParams AdWordsApp.AdParamSelector Creates a selector of all ad params in the ad group.
addMobileApp void Adds a mobile app to this ad group.
addPhoneNumber void Adds a phone number to this ad group.
addSitelink void Adds a sitelink to this ad group.
ads AdWordsApp.AdSelector Returns the selector of all ads in the ad group.
applyLabel void Applies a label to the ad group.
createKeyword void Creates a new keyword in the ad group with a default bid.
createKeyword void Creates a new keyword in the ad group with the specified bid.
createKeyword void Creates a new keyword in the ad group with the specified bid and destination URL.
createNegativeKeyword void Creates a new negative keyword with the specified text.
createTextAd void Creates a new text ad in the ad group.
createTextAd void Creates a new text ad in the ad group, with some additional parameters.
enable void Enables the ad group.
extensions AdWordsApp.AdGroupExtensions Provides access to this ad group's extensions: AdGroupSitelink, AdGroupPhoneNumber, AdGroupMobileApp.
getCampaign AdWordsApp.Campaign Returns the campaign to which this ad group belongs.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the ad group.
getKeywordMaxCpc double Returns the default keyword max cpc bid of the ad group, in the currency of the account.
getName String Returns the name of the ad group.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isDeleted boolean Returns true if the ad group is deleted.
isEnabled boolean Returns true if the ad group is enabled.
isPaused boolean Returns true if the ad group is paused.
keywords AdWordsApp.KeywordSelector Returns the selector of all keywords in the ad group.
labels AdWordsApp.LabelSelector Creates a selector of all labels applied to the ad group.
negativeKeywords AdWordsApp.NegativeKeywordSelector Returns a selector of all negative keywords in the ad group.
pause void Pauses the ad group.
removeLabel void Removes a label from the ad group.
removeMobileApp void Removes a mobile app extension from this ad group.
removePhoneNumber void Removes a phone number extension from this ad group.
removeSitelink void Removes a sitelink extension from this ad group.
setKeywordMaxCpc void Sets the default keyword max cpc bid of the ad group to the specified value.
setName void Sets the name of the ad group.

class AdWordsApp.AdGroupBuilder

Methods:

MemberTypeDescription
create AdWordsApp.AdGroup Returns the newly created ad group.
withKeywordMaxCpc AdWordsApp.AdGroupBuilder Sets the default keyword max cpc bid of the new ad group to the specified value.
withName AdWordsApp.AdGroupBuilder Sets the name of the new ad group to the specified value.
withStatus AdWordsApp.AdGroupBuilder Sets the status of the new ad group to the specified value.

class AdWordsApp.AdGroupExtensions

Methods:

MemberTypeDescription
mobileApps AdWordsApp.AdGroupMobileAppSelector Returns the selector of all mobile apps in the ad group.
phoneNumbers AdWordsApp.AdGroupPhoneNumberSelector Returns the selector of all phone numbers in the ad group.
sitelinks AdWordsApp.AdGroupSitelinkSelector Returns the selector of all sitelinks in the ad group.

class AdWordsApp.AdGroupIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.AdGroup Returns the next AdGroup in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.AdGroupMobileApp

Methods:

MemberTypeDescription
getAdGroup AdWordsApp.AdGroup Returns the ad group to which this ad group-level mobile app belongs.
getAppId String Returns the application store-specific ID of the ad group-level mobile app.
getEndDate AdWordsApp.AdWordsDate Returns the end date of the ad group-level mobile app.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the ad group-level mobile app.
getLinkText String Returns the link text of the ad group-level mobile app.
getLinkUrl String Returns the link URL of the ad group-level mobile app.
getSchedules AdWordsApp.ExtensionSchedule[] Returns the scheduling of the ad group-level mobile app.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the ad group-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 ad group-level mobile app specifies mobile device preference.
setAppId void Sets the application store-specific ID of the ad group-level mobile app.
setEndDate void Sets the ad group-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 ad group-level mobile app.
setLinkUrl void Sets the link URL of the ad group-level mobile app.
setMobilePreferred void Sets the ad group-level mobile app's device preference to mobile or clears it.
setSchedules void Sets the ad group-level mobile app scheduling.
setStartDate void Sets the ad group-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.

class AdWordsApp.AdGroupMobileAppIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.AdGroupMobileApp Returns the next AdGroupMobileApp in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.AdGroupMobileAppSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.AdGroupMobileAppSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.AdGroupMobileAppSelector Sets a custom date range onto the selector.
get AdWordsApp.AdGroupMobileAppIterator Fetches the requested ad group-level mobile apps and returns an iterator.
orderBy AdWordsApp.AdGroupMobileAppSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.AdGroupMobileAppSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.AdGroupMobileAppSelector Restricts this selector to return only ad group-level mobile apps with the given ad group-level mobile app IDs.
withLimit AdWordsApp.AdGroupMobileAppSelector Specifies limit for the selector to use.

class AdWordsApp.AdGroupPhoneNumber

Methods:

MemberTypeDescription
getAdGroup AdWordsApp.AdGroup Returns the ad group to which this ad group-level phone number belongs.
getCountry String Returns the two character country code of the advertiser's phone number.
getEndDate AdWordsApp.AdWordsDate Returns the end date of the ad group-level phone number.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the ad group-level phone number.
getPhoneNumber String Returns the advertiser's phone number that gets appended to the ad.
getSchedules AdWordsApp.ExtensionSchedule[] Returns the scheduling of the ad group-level phone number.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the ad group-level phone number.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isCallOnly boolean Returns true if this ad group-level phone number is call only.
isMobilePreferred boolean Returns true if the ad group-level phone number specifies mobile device preference.
setCallOnly void If set to true, only the advertiser's phone number will get displayed.
setCountry void Sets the two character country code of the advertiser's phone number.
setEndDate void Sets the ad group-level phone number's end date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.
setMobilePreferred void Sets the ad group-level phone number's device preference to mobile or clears it.
setPhoneNumber void Sets the advertiser's phone number that gets appended to the ad.
setSchedules void Sets the ad group-level phone number scheduling.
setStartDate void Sets the ad group-level phone number's start date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.

class AdWordsApp.AdGroupPhoneNumberIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.AdGroupPhoneNumber Returns the next AdGroupPhoneNumber in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.AdGroupPhoneNumberSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.AdGroupPhoneNumberSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.AdGroupPhoneNumberSelector Sets a custom date range onto the selector.
get AdWordsApp.AdGroupPhoneNumberIterator Fetches the requested ad group-level phone numbers and returns an iterator.
orderBy AdWordsApp.AdGroupPhoneNumberSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.AdGroupPhoneNumberSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.AdGroupPhoneNumberSelector Restricts this selector to return only ad group-level phone numbers with the given ad group-level phone number IDs.
withLimit AdWordsApp.AdGroupPhoneNumberSelector Specifies limit for the selector to use.

class AdWordsApp.AdGroupSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.AdGroupSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.AdGroupSelector Sets a custom date range onto the selector.
get AdWordsApp.AdGroupIterator Fetches the requested ad groups and returns an iterator.
orderBy AdWordsApp.AdGroupSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.AdGroupSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.AdGroupSelector Restricts this selector to return only ad groups with the given ad group IDs.
withLimit AdWordsApp.AdGroupSelector Specifies limit for the selector to use.

class AdWordsApp.AdGroupSitelink

Methods:

MemberTypeDescription
getAdGroup AdWordsApp.AdGroup Returns the ad group to which this ad group-level sitelink belongs.
getEndDate AdWordsApp.AdWordsDate Returns the end date of the ad group-level sitelink.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the ad group-level sitelink.
getLinkText String Returns the link text of the ad group-level sitelink.
getLinkUrl String Returns the link URL of the ad group-level sitelink.
getSchedules AdWordsApp.ExtensionSchedule[] Returns the scheduling of the ad group-level sitelink.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the ad group-level sitelink.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isMobilePreferred boolean Returns true if the ad group-level sitelink specifies mobile device preference.
setEndDate void Sets the ad group-level sitelink'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 ad group-level sitelink.
setLinkUrl void Sets the link URL of the ad group-level sitelink.
setMobilePreferred void Sets the ad group-level sitelink's device preference to mobile or clears it.
setSchedules void Sets the ad group-level sitelink scheduling.
setStartDate void Sets the ad group-level sitelink's start date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.

class AdWordsApp.AdGroupSitelinkIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.AdGroupSitelink Returns the next AdGroupSitelink in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.AdGroupSitelinkSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.AdGroupSitelinkSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.AdGroupSitelinkSelector Sets a custom date range onto the selector.
get AdWordsApp.AdGroupSitelinkIterator Fetches the requested ad group-level sitelinks and returns an iterator.
orderBy AdWordsApp.AdGroupSitelinkSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.AdGroupSitelinkSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.AdGroupSitelinkSelector Restricts this selector to return only ad group-level sitelinks with the given ad group-level sitelink IDs.
withLimit AdWordsApp.AdGroupSitelinkSelector Specifies limit for the selector to use.

class AdWordsApp.AdIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.Ad Returns the next Ad in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.AdParam

Methods:

MemberTypeDescription
getAdGroup AdWordsApp.AdGroup Returns the ad group to which this ad param belongs.
getEntityType String Returns the type of this entity as a String.
getIndex int Returns the index of the ad param.
getInsertionText String Returns the insertion text of the ad param.
getKeyword AdWordsApp.Keyword Returns the Keyword the ad param belongs to.
remove void Deletes the ad param from the account.
setInsertionText void Sets the insertion text of the ad param to the specified value.

class AdWordsApp.AdParamIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.AdParam Returns the next AdParam in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.AdParamSelector

Methods:

MemberTypeDescription
get AdWordsApp.AdParamIterator Fetches the requested ad params and returns an iterator.

class AdWordsApp.AdSchedule

Methods:

MemberTypeDescription
getBidModifier double Returns the bid modifier for this ad schedule.
getCampaign AdWordsApp.Campaign Returns the campaign to which this ad schedule belongs.
getDayOfWeek String Returns the day of week this ad schedule applies to.
getEndHour int Returns the ending hour of this ad schedule.
getEndMinute int Returns the ending minute of this ad schedule.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the ad schedule.
getStartHour int Returns the starting hour of this ad schedule.
getStartMinute int Returns the starting minute of this ad schedule.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
remove void Deletes the ad schedule from the account.
setBidModifier void Sets the bid modifier for this ad schedule.

class AdWordsApp.AdScheduleIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.AdSchedule Returns the next AdSchedule in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.AdScheduleSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.AdScheduleSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.AdScheduleSelector Sets a custom date range onto the selector.
get AdWordsApp.AdScheduleIterator Fetches the requested ad schedules and returns an iterator.
orderBy AdWordsApp.AdScheduleSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.AdScheduleSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.AdScheduleSelector Restricts this selector to return only ad schedules with the given ad schedule IDs.
withLimit AdWordsApp.AdScheduleSelector Specifies limit for the selector to use.

class AdWordsApp.AdSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.AdSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.AdSelector Sets a custom date range onto the selector.
get AdWordsApp.AdIterator Fetches the requested ads and returns an iterator.
orderBy AdWordsApp.AdSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.AdSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.AdSelector Restricts this selector to return only ads with the given ad IDs.
withLimit AdWordsApp.AdSelector Specifies limit for the selector to use.

class AdWordsApp.AdWordsDate

Properties:

MemberTypeDescription
day int The day of month (1 to 31) for this date.
month int The month index for this date, where 1 corresponds to January, 2 to February, and so on.
year int The year for this date.

class AdWordsApp.Address

Methods:

MemberTypeDescription
getCityName String Returns the city name, or null if not known.
getCountryCode String Returns the country code, or null if not known.
getPostalCode String Returns the postal code, or null if not known.
getProvinceCode String Returns the province / state code, or null if not known.
getProvinceName String Returns the province / state name, or null if not known.
getStreetAddress String Returns the street address, or null if not known.
getStreetAddress2 String Returns the second line of the street address, or null if not known.

class AdWordsApp.Budget

Methods:

MemberTypeDescription
campaigns AdWordsApp.CampaignSelector Returns the selector of all campaigns that share this budget.
getAmount double Returns the amount of the budget, in the currency of the account.
getDeliveryMethod String Returns the delivery method of the budget.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the budget.
getName String Returns the name of the budget.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isExplicitlyShared boolean Returns true if the budget is explicitly shared, and false otherwise.
setAmount void Sets the budget's amount to the specified value, in the currency of the account.

class AdWordsApp.BudgetIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.Budget Returns the next Budget in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.BudgetSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.BudgetSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.BudgetSelector Sets a custom date range onto the selector.
get AdWordsApp.BudgetIterator Fetches the requested budgets and returns an iterator.
orderBy AdWordsApp.BudgetSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.BudgetSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.BudgetSelector Restricts this selector to return only budgets with the given budget IDs.
withLimit AdWordsApp.BudgetSelector Specifies limit for the selector to use.

class AdWordsApp.Campaign

Methods:

MemberTypeDescription
adGroups AdWordsApp.AdGroupSelector Returns the selector of all ad groups in the campaign.
addAdSchedule void Creates an ad schedule criterion from an ad schedule object.
addAdSchedule void Creates an ad schedule criterion.
addLocation void Creates a location target in this campaign from a location object.
addLocation void Creates a location target in this campaign from a location ID and bid modifier.
addMobileApp void Adds a mobile app extension to this campaign.
addPhoneNumber void Adds a phone number extension to this campaign.
addProximity void Creates a proximity target in this campaign from a proximity object.
addProximity void Creates a proximity target in this campaign.
addSitelink void Adds a sitelink extension to this campaign.
ads AdWordsApp.AdSelector Returns the selector of all ads in the campaign.
applyLabel void Applies a label to the campaign.
createNegativeKeyword void Creates a new campaign-level negative keyword with the specified text.
enable void Enables the campaign.
excludeLocation void Creates a location exclusion in this campaign.
extensions AdWordsApp.CampaignExtensions Provides access to this campaign's extensions: CampaignSitelink, CampaignPhoneNumber, CampaignMobileApp.
getAdRotationType String Returns the ad rotation type of the campaign.
getBiddingStrategyType String Returns the bidding strategy type of the campaign.
getBudget AdWordsApp.Budget Returns the budget of the campaign.
getEndDate AdWordsApp.AdWordsDate Returns the campaign's end date, or null if there is no end date.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the campaign.
getName String Returns the name of the campaign.
getStartDate AdWordsApp.AdWordsDate Returns the campaign's start date.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isDeleted boolean Returns true if the campaign is deleted.
isEnabled boolean Returns true if the campaign is enabled.
isPaused boolean Returns true if the campaign is paused.
keywords AdWordsApp.KeywordSelector Returns the selector of all keywords in the campaign.
labels AdWordsApp.LabelSelector Creates a selector of all labels applied to the campaign.
negativeKeywords AdWordsApp.NegativeKeywordSelector Returns a selector of the campaign-level negative keywords belonging to this campaign.
newAdGroupBuilder AdWordsApp.AdGroupBuilder Returns a new ad group builder for this campaign.
pause void Pauses the campaign.
removeLabel void Removes a label from the campaign.
removeMobileApp void Removes a mobile app extension from this campaign.
removePhoneNumber void Removes a phone number extension from this campaign.
removeSitelink void Removes a sitelink extension from this campaign.
setAdRotationType void Sets the ad rotation type of the campaign.
setBudget void

Sets the budget of the campaign to the specified value.

setEndDate void Sets the campaign's end date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.
setName void Sets the name of the campaign.
setStartDate void Sets the campaign's start date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.
targeting AdWordsApp.Targeting Provides access to campaign-level targeting criteria: device targeting, ad scheduling, and location targeting.

class AdWordsApp.CampaignExtensions

Methods:

MemberTypeDescription
mobileApps AdWordsApp.CampaignMobileAppSelector Returns the selector of all mobile apps in the campaign.
phoneNumbers AdWordsApp.CampaignPhoneNumberSelector Returns the selector of all phone numbers in the campaign.
sitelinks AdWordsApp.CampaignSitelinkSelector Returns the selector of all sitelinks in the campaign.

class AdWordsApp.CampaignIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.Campaign Returns the next Campaign in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.CampaignMobileApp

Methods:

MemberTypeDescription
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.
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 to mobile or clears it.
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.

class AdWordsApp.CampaignMobileAppIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.CampaignMobileApp Returns the next CampaignMobileApp in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.CampaignMobileAppSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.CampaignMobileAppSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.CampaignMobileAppSelector Sets a custom date range onto the selector.
get AdWordsApp.CampaignMobileAppIterator Fetches the requested campaign-level mobile apps and returns an iterator.
orderBy AdWordsApp.CampaignMobileAppSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.CampaignMobileAppSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.CampaignMobileAppSelector Restricts this selector to return only campaign-level mobile apps with the given campaign-level mobile app IDs.
withLimit AdWordsApp.CampaignMobileAppSelector Specifies limit for the selector to use.

class AdWordsApp.CampaignPhoneNumber

Methods:

MemberTypeDescription
getCampaign AdWordsApp.Campaign Returns the campaign to which this campaign-level phone number belongs.
getCountry String Returns the two character country code of the advertiser's phone number.
getEndDate AdWordsApp.AdWordsDate Returns the end date of the campaign-level phone number.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the campaign-level phone number.
getPhoneNumber String Returns the advertiser's phone number that gets appended to the ad.
getSchedules AdWordsApp.ExtensionSchedule[] Returns the scheduling of the campaign-level phone number.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the campaign-level phone number.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isCallOnly boolean Returns true if this campaign-level phone number is call only.
isMobilePreferred boolean Returns true if the campaign-level phone number specifies mobile device preference.
setCallOnly void If set to true, only the advertiser's phone number will get displayed.
setCountry void Sets the two character country code of the advertiser's phone number.
setEndDate void Sets the campaign-level phone number's end date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.
setMobilePreferred void Sets the campaign-level phone number's device preference to mobile or clears it.
setPhoneNumber void Sets the advertiser's phone number that gets appended to the ad.
setSchedules void Sets the campaign-level phone number scheduling.
setStartDate void Sets the campaign-level phone number's start date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.

class AdWordsApp.CampaignPhoneNumberIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.CampaignPhoneNumber Returns the next CampaignPhoneNumber in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.CampaignPhoneNumberSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.CampaignPhoneNumberSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.CampaignPhoneNumberSelector Sets a custom date range onto the selector.
get AdWordsApp.CampaignPhoneNumberIterator Fetches the requested campaign-level phone numbers and returns an iterator.
orderBy AdWordsApp.CampaignPhoneNumberSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.CampaignPhoneNumberSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.CampaignPhoneNumberSelector Restricts this selector to return only campaign-level phone numbers with the given campaign-level phone number IDs.
withLimit AdWordsApp.CampaignPhoneNumberSelector Specifies limit for the selector to use.

class AdWordsApp.CampaignSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.CampaignSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.CampaignSelector Sets a custom date range onto the selector.
get AdWordsApp.CampaignIterator Fetches the requested campaigns and returns an iterator.
orderBy AdWordsApp.CampaignSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.CampaignSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.CampaignSelector Restricts this selector to return only campaigns with the given campaign IDs.
withLimit AdWordsApp.CampaignSelector Specifies limit for the selector to use.

class AdWordsApp.CampaignSitelink

Methods:

MemberTypeDescription
getCampaign AdWordsApp.Campaign Returns the campaign to which this campaign-level sitelink belongs.
getEndDate AdWordsApp.AdWordsDate Returns the end date of the campaign-level sitelink.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the campaign-level sitelink.
getLinkText String Returns the link text of the campaign-level sitelink.
getLinkUrl String Returns the link URL of the campaign-level sitelink.
getSchedules AdWordsApp.ExtensionSchedule[] Returns the scheduling of the campaign-level sitelink.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the campaign-level sitelink.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isMobilePreferred boolean Returns true if the campaign-level sitelink specifies mobile device preference.
setEndDate void Sets the campaign-level sitelink'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 sitelink.
setLinkUrl void Sets the link URL of the campaign-level sitelink.
setMobilePreferred void Sets the campaign-level sitelink's device preference to mobile or clears it.
setSchedules void Sets the campaign-level sitelink scheduling.
setStartDate void Sets the campaign-level sitelink's start date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.

class AdWordsApp.CampaignSitelinkIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.CampaignSitelink Returns the next CampaignSitelink in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.CampaignSitelinkSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.CampaignSitelinkSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.CampaignSitelinkSelector Sets a custom date range onto the selector.
get AdWordsApp.CampaignSitelinkIterator Fetches the requested campaign-level sitelinks and returns an iterator.
orderBy AdWordsApp.CampaignSitelinkSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.CampaignSitelinkSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.CampaignSitelinkSelector Restricts this selector to return only campaign-level sitelinks with the given campaign-level sitelink IDs.
withLimit AdWordsApp.CampaignSitelinkSelector Specifies limit for the selector to use.

class AdWordsApp.ExcludedLocation

Methods:

MemberTypeDescription
getCampaign AdWordsApp.Campaign Returns the campaign to which this location belongs.
getCountryCode String Returns the country code of this location.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the location.
getName String Returns the name of this location.
getTargetType String Returns the target type of this location.
getTargetingStatus String Returns the targeting status of this location.
remove void Deletes the location from the account.

class AdWordsApp.ExcludedLocationIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.ExcludedLocation Returns the next ExcludedLocation in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.ExcludedLocationSelector

Methods:

MemberTypeDescription
get AdWordsApp.ExcludedLocationIterator Fetches the requested excluded locations and returns an iterator.
withLimit AdWordsApp.ExcludedLocationSelector Specifies limit for the selector to use.

class AdWordsApp.ExecutionInfo

Methods:

MemberTypeDescription
getRemainingCreateQuota int Returns the remaining number of AdWords entities the script is allowed to create in this execution.
getRemainingGetQuota int Returns the remaining number of AdWords entities the script is allowed to fetch in this execution.
getRemainingTime int Returns the remaining time in seconds the script is allowed to execute.
isPreview boolean Returns true if the script is currently being previewed, or false if it is a live execution.

class AdWordsApp.ExtensionSchedule

Methods:

MemberTypeDescription
getDayOfWeek String Returns the day of week this schedule applies to.
getEndHour int Returns the ending hour of this schedule.
getEndMinute int Returns the ending minute of this schedule.
getStartHour int Returns the starting hour of this schedule.
getStartMinute int Returns the starting minute of this schedule.

class AdWordsApp.Extensions

Methods:

MemberTypeDescription
mobileApps AdWordsApp.MobileAppSelector Returns the selector of all mobile apps in the account.
newMobileAppBuilder AdWordsApp.MobileAppBuilder Returns a new mobile app builder for this account.
newPhoneNumberBuilder AdWordsApp.PhoneNumberBuilder Returns a new phone number builder for this account.
newSitelinkBuilder AdWordsApp.SitelinkBuilder Returns a new sitelink builder for this account.
phoneNumbers AdWordsApp.PhoneNumberSelector Returns the selector of all phone numbers in the account.
sitelinks AdWordsApp.SitelinkSelector Returns the selector of all sitelinks in the account.

class AdWordsApp.Keyword

Methods:

MemberTypeDescription
adParams AdWordsApp.AdParamSelector Creates a selector of all ad params belonging to this keyword.
applyLabel void Applies a label to the keyword.
enable void Enables the keyword.
getAdGroup AdWordsApp.AdGroup Returns the ad group to which this keyword belongs.
getApprovalStatus String Returns the approval status of the keyword.
getCampaign AdWordsApp.Campaign Returns the campaign to which this keyword belongs.
getDestinationUrl String Returns the destination URL of the keyword.
getEntityType String Returns the type of this entity as a String.
getFirstPageCpc double Returns the first page cpc for the keyword.
getId long Returns the ID of the keyword.
getMatchType String Returns the match type of the keyword.
getMaxCpc double Returns the max cpc bid of the keyword, in the currency of the account.
getQualityScore int Returns the quality score of the keyword, in 1..10 range.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
getText String Returns the text of the keyword.
getTopOfPageCpc double Returns the top of page cpc for the keyword.
isEnabled boolean Returns true if the keyword is enabled.
isPaused boolean Returns true if the keyword is paused.
labels AdWordsApp.LabelSelector Creates a selector of all labels applied to the keyword.
pause void Pauses the keyword.
remove void Deletes the keyword from the account.
removeLabel void Removes a label from the keyword.
setAdParam void Creates an ad param for this keyword with the specified index and insertion text.
setDestinationUrl void Sets destination url of the keyword to the specified value.
setMaxCpc void Sets the max cpc bid of the keyword to the specified value.

class AdWordsApp.KeywordIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.Keyword Returns the next Keyword in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.KeywordSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.KeywordSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.KeywordSelector Sets a custom date range onto the selector.
get AdWordsApp.KeywordIterator Fetches the requested keywords and returns an iterator.
orderBy AdWordsApp.KeywordSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.KeywordSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.KeywordSelector Restricts this selector to return only keywords with the given keyword IDs.
withLimit AdWordsApp.KeywordSelector Specifies limit for the selector to use.

class AdWordsApp.Label

Methods:

MemberTypeDescription
adGroups AdWordsApp.AdGroupSelector Returns the selector of all ad groups to which the label is applied.
ads AdWordsApp.AdSelector Returns the selector of all ads to which the label is applied.
campaigns AdWordsApp.CampaignSelector Returns the selector of all campaigns to which the label is applied.
getColor String Returns the color code of the label.
getDescription String Returns the description of the label.
getEntityType String Returns the type of this entity as a String.
getName String Returns the name of the label.
keywords AdWordsApp.KeywordSelector Returns the selector of all keywords to which the label is applied.
remove void Deletes the label from the account.
setColor void Sets the background color of the label.
setDescription void Sets the description for this label.
setName void Changes the name of the Label.

class AdWordsApp.LabelIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.Label Returns the next Label in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.LabelSelector

Methods:

MemberTypeDescription
get AdWordsApp.LabelIterator Fetches the requested labels and returns an iterator.
orderBy AdWordsApp.LabelSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.LabelSelector Adds the specified condition to the selector in order to narrow down the results.
withLimit AdWordsApp.LabelSelector Specifies limit for the selector to use.

class AdWordsApp.MobileApp

Methods:

MemberTypeDescription
getAppId String Returns the application store-specific ID of the mobile app.
getEndDate AdWordsApp.AdWordsDate Returns the end date of the mobile app.
getEntityType String Returns the type of this entity as a String.
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 AdWordsApp.ExtensionSchedule[] Returns the scheduling of the mobile app.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the 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 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 to mobile or clears it.
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.

class AdWordsApp.MobileAppBuilder

Methods:

MemberTypeDescription
create AdWordsApp.MobileApp Returns the newly created mobile app.
withAppId AdWordsApp.MobileAppBuilder Sets the mobile app's app ID.
withEndDate AdWordsApp.MobileAppBuilder 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.
withLinkText AdWordsApp.MobileAppBuilder Sets the link text of the mobile app.
withLinkUrl AdWordsApp.MobileAppBuilder Sets the link URL of the mobile app.
withMobilePreferred AdWordsApp.MobileAppBuilder Sets the mobile app's device preference to mobile or clears it.
withSchedules AdWordsApp.MobileAppBuilder Sets the mobile app scheduling.
withStartDate AdWordsApp.MobileAppBuilder 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.
withStore AdWordsApp.MobileAppBuilder Sets the application store that this application belongs to.

class AdWordsApp.MobileAppIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.MobileApp Returns the next MobileApp in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.MobileAppSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.MobileAppSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.MobileAppSelector Sets a custom date range onto the selector.
get AdWordsApp.MobileAppIterator Fetches the requested mobile apps and returns an iterator.
orderBy AdWordsApp.MobileAppSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.MobileAppSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.MobileAppSelector Restricts this selector to return only mobile apps with the given mobile app IDs.
withLimit AdWordsApp.MobileAppSelector Specifies limit for the selector to use.

class AdWordsApp.NegativeKeyword

Methods:

MemberTypeDescription
getAdGroup AdWordsApp.AdGroup Returns the AdGroup to which the negative keyword belongs.
getCampaign AdWordsApp.Campaign Returns the Campaign to which the negative keyword belongs.
getEntityType String Returns the type of this entity as a String.
getMatchType String Returns the match type of the negative keyword.
getText String Returns the text of the negative keyword.
remove void Deletes the negative keyword from the account.

class AdWordsApp.NegativeKeywordIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.NegativeKeyword Returns the next NegativeKeyword in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.NegativeKeywordSelector

Methods:

MemberTypeDescription
get AdWordsApp.NegativeKeywordIterator Fetches the requested negative keywords and returns an iterator.
orderBy AdWordsApp.NegativeKeywordSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.NegativeKeywordSelector Adds the specified condition to the selector in order to narrow down the results.
withLimit AdWordsApp.NegativeKeywordSelector Specifies limit for the selector to use.

class AdWordsApp.PhoneNumber

Methods:

MemberTypeDescription
getCountry String Returns the two character country code of the advertiser's phone number.
getEndDate AdWordsApp.AdWordsDate Returns the end date of the phone number.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the phone number.
getPhoneNumber String Returns the advertiser's phone number that gets appended to the ad.
getSchedules AdWordsApp.ExtensionSchedule[] Returns the scheduling of the phone number.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the phone number.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isCallOnly boolean Returns true if this phone number is call only.
isMobilePreferred boolean Returns true if the phone number specifies mobile device preference.
setCallOnly void If set to true, only the advertiser's phone number will get displayed.
setCountry void Sets the two character country code of the advertiser's phone number.
setEndDate void Sets the phone number's end date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.
setMobilePreferred void Sets the phone number's device preference to mobile or clears it.
setPhoneNumber void Sets the advertiser's phone number that gets appended to the ad.
setSchedules void Sets the phone number scheduling.
setStartDate void Sets the phone number's start date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.

class AdWordsApp.PhoneNumberBuilder

Methods:

MemberTypeDescription
create AdWordsApp.PhoneNumber Returns the newly created phone number.
withCallOnly AdWordsApp.PhoneNumberBuilder If set to true, only the advertiser's phone number will get displayed.
withCountry AdWordsApp.PhoneNumberBuilder Sets the two character country code of the advertiser's phone number.
withEndDate AdWordsApp.PhoneNumberBuilder Sets the phone number's end date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.
withMobilePreferred AdWordsApp.PhoneNumberBuilder Sets the phone number's device preference to mobile or clears it.
withPhoneNumber AdWordsApp.PhoneNumberBuilder Sets the advertiser's phone number that gets appended to the ad.
withSchedules AdWordsApp.PhoneNumberBuilder Sets the phone number scheduling.
withStartDate AdWordsApp.PhoneNumberBuilder Sets the phone number's start date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.

class AdWordsApp.PhoneNumberIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.PhoneNumber Returns the next PhoneNumber in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.PhoneNumberSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.PhoneNumberSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.PhoneNumberSelector Sets a custom date range onto the selector.
get AdWordsApp.PhoneNumberIterator Fetches the requested phone numbers and returns an iterator.
orderBy AdWordsApp.PhoneNumberSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.PhoneNumberSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.PhoneNumberSelector Restricts this selector to return only phone numbers with the given phone number IDs.
withLimit AdWordsApp.PhoneNumberSelector Specifies limit for the selector to use.

class AdWordsApp.Platform

Methods:

MemberTypeDescription
getBidModifier double Returns the bid modifier for this platform.
getCampaign AdWordsApp.Campaign Returns the campaign to which this platform belongs.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the platform.
getName String Returns the name of this platform.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
setBidModifier void Sets the bid modifier for this platform.

class AdWordsApp.PlatformIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.Platform Returns the next Platform in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.PlatformSelector

Methods:

MemberTypeDescription
desktop AdWordsApp.PlatformSelector Restricts this selector to only select desktop targets.
forDateRange AdWordsApp.PlatformSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.PlatformSelector Sets a custom date range onto the selector.
get AdWordsApp.PlatformIterator Fetches the requested platforms and returns an iterator.
mobile AdWordsApp.PlatformSelector Restricts this selector to only select mobile targets.
orderBy AdWordsApp.PlatformSelector Specifies the ordering of the resulting entities.
tablet AdWordsApp.PlatformSelector Restricts this selector to only select tablet targets.
withCondition AdWordsApp.PlatformSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.PlatformSelector Restricts this selector to return only platforms with the given platform IDs.
withLimit AdWordsApp.PlatformSelector Specifies limit for the selector to use.

class AdWordsApp.Report

Methods:

MemberTypeDescription
exportToSheet void Exports the content of the report into a Google spreadsheet.
rows AdWordsApp.ReportRowIterator Returns an iterator over the rows of the report.

class AdWordsApp.ReportRowIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the report has more rows.
next Object Returns the next row in the report.

class AdWordsApp.Sitelink

Methods:

MemberTypeDescription
getEndDate AdWordsApp.AdWordsDate Returns the end date of the sitelink.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the sitelink.
getLinkText String Returns the link text of the sitelink.
getLinkUrl String Returns the link URL of the sitelink.
getSchedules AdWordsApp.ExtensionSchedule[] Returns the scheduling of the sitelink.
getStartDate AdWordsApp.AdWordsDate Returns the start date of the sitelink.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isMobilePreferred boolean Returns true if the sitelink specifies mobile device preference.
setEndDate void Sets the sitelink'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 sitelink.
setLinkUrl void Sets the link URL of the sitelink.
setMobilePreferred void Sets the sitelink's device preference to mobile or clears it.
setSchedules void Sets the sitelink scheduling.
setStartDate void Sets the sitelink's start date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.

class AdWordsApp.SitelinkBuilder

Methods:

MemberTypeDescription
create AdWordsApp.Sitelink Returns the newly created sitelink.
withEndDate AdWordsApp.SitelinkBuilder Sets the sitelink's end date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.
withLinkText AdWordsApp.SitelinkBuilder Sets the link text of the sitelink.
withLinkUrl AdWordsApp.SitelinkBuilder Sets the link URL of the sitelink.
withMobilePreferred AdWordsApp.SitelinkBuilder Sets the sitelink's device preference to mobile or clears it.
withSchedules AdWordsApp.SitelinkBuilder Sets the sitelink scheduling.
withStartDate AdWordsApp.SitelinkBuilder Sets the sitelink's start date from either an object containing year, month, and day fields, or an 8-digit string in "yyyymmdd" format.

class AdWordsApp.SitelinkIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.Sitelink Returns the next Sitelink in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.SitelinkSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.SitelinkSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.SitelinkSelector Sets a custom date range onto the selector.
get AdWordsApp.SitelinkIterator Fetches the requested sitelinks and returns an iterator.
orderBy AdWordsApp.SitelinkSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.SitelinkSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.SitelinkSelector Restricts this selector to return only sitelinks with the given sitelink IDs.
withLimit AdWordsApp.SitelinkSelector Specifies limit for the selector to use.

class AdWordsApp.Stats

Methods:

MemberTypeDescription
getAverageCpc double Returns the average cost per click.
getAverageCpm double Returns the average cost per thousand impressions.
getAveragePageviews double Returns the average number of pages viewed per visit.
getAveragePosition double Returns the average position.
getAverageTimeOnSite double Returns the average time a visitor spent on site, in seconds.
getBounceRate double Returns the bounce rate of the entity, in 0..1 range.
getClickConversionRate double Returns the conversion rate for clicks, in 0..1 range.
getClicks long Returns the number of clicks.
getConversionRate double Returns the conversion rate, in 0..1 range.
getConversions long Returns the number of conversions.
getConvertedClicks long Returns the number of clicks that converted.
getCost double Returns the cost in the default currency of the account.
getCtr double Returns the click through rate of the entity, in 0..1 range.
getImpressions long Returns the number of impressions.

class AdWordsApp.TargetedLocation

Methods:

MemberTypeDescription
getBidModifier double Returns the bid modifier for this location.
getCampaign AdWordsApp.Campaign Returns the campaign to which this location belongs.
getCountryCode String Returns the country code of this location.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the location.
getName String Returns the name of this location.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
getTargetType String Returns the target type of this location.
getTargetingStatus String Returns the targeting status of this location.
remove void Deletes the location from the account.
setBidModifier void Sets the bid modifier for this location.

class AdWordsApp.TargetedLocationIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.TargetedLocation Returns the next TargetedLocation in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.TargetedLocationSelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.TargetedLocationSelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.TargetedLocationSelector Sets a custom date range onto the selector.
get AdWordsApp.TargetedLocationIterator Fetches the requested targeted locations and returns an iterator.
orderBy AdWordsApp.TargetedLocationSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.TargetedLocationSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.TargetedLocationSelector Restricts this selector to return only targeted locations with the given targeted location IDs.
withLimit AdWordsApp.TargetedLocationSelector Specifies limit for the selector to use.

class AdWordsApp.TargetedProximity

Methods:

MemberTypeDescription
getAddress AdWordsApp.Address Returns the address of the central point, or null if unknown.
getBidModifier double Returns the bid modifier for this proximity.
getCampaign AdWordsApp.Campaign Returns the campaign to which this proximity belongs.
getEntityType String Returns the type of this entity as a String.
getId long Returns the ID of the proximity.
getLatitude double Returns the latitide in degrees of the central point of this proximity.
getLongitude double Returns the longitude in degrees of the central point of this proximity.
getRadius double Returns the radius around the central point to target.
getRadiusUnits String Returns the units of TargetedProximity.getRadius().
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
remove void Deletes the proximity from the account.
setBidModifier void Sets the bid modifier for this proximity.

class AdWordsApp.TargetedProximityIterator

Methods:

MemberTypeDescription
hasNext boolean Returns true if the iterator has more elements.
next AdWordsApp.TargetedProximity Returns the next TargetedProximity in the iterator.
totalNumEntities int Returns the total number of entities matched by the selector which generated this iterator.

class AdWordsApp.TargetedProximitySelector

Methods:

MemberTypeDescription
forDateRange AdWordsApp.TargetedProximitySelector Sets a pre-defined date range onto the selector.
forDateRange AdWordsApp.TargetedProximitySelector Sets a custom date range onto the selector.
get AdWordsApp.TargetedProximityIterator Fetches the requested targeted proximities and returns an iterator.
orderBy AdWordsApp.TargetedProximitySelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.TargetedProximitySelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.TargetedProximitySelector Restricts this selector to return only targeted proximities with the given targeted proximity IDs.
withLimit AdWordsApp.TargetedProximitySelector Specifies limit for the selector to use.

class AdWordsApp.Targeting

Methods:

MemberTypeDescription
adSchedules AdWordsApp.AdScheduleSelector Specializes this selector to return AdSchedule criteria.
excludedLocations AdWordsApp.ExcludedLocationSelector Specializes this selector to return ExcludedLocation criteria.
platforms AdWordsApp.PlatformSelector Specializes this selector to return Platform criteria.
targetedLocations AdWordsApp.TargetedLocationSelector Specializes this selector to return TargetedLocation criteria.
targetedProximities AdWordsApp.TargetedProximitySelector Specializes this selector to return TargetedProximity criteria.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.