My favorites | English | Sign in

More personalization in Google Friend Connect New!

Documentation for the requested version is not available.Documentation for the requested diff is not available.

API Reference

Link to this version

AccountService

AccountService provides operations for modifying AdWords accounts.

Requests Summary
getAccountInfo Return the AdWords account specified by the client account header.
getClientAccountInfos Gets the client account information for managed clients of effective user.
getClientAccounts Gets the primary email address for each account managed by the effective user.
getMccAlerts Retrieves the MCC alerts associated with any of the accounts beneath the current account.
updateAccountInfo Updates the database to reflect the changes in the account object.
Data Objects Summary
AccountInfo Account contains information about a particular account.
Address Address contains the address information for a particular account.
EmailPromotionsPreferences EmailPromotionsPreferences indicates the type of email promotions an account user is interested in receiving from Google.
ClientAccountInfo Contains client account information.
MccAlert An alert from My Client Center, returned using AccountService#getMccAlerts.

AdGroupService

AdGroupService provides operations for accessing, modifying, and creating ad groups.

Requests Summary
addAdGroup Creates a new ad group.
addAdGroupList Adds multiple ad groups to a campaign.
getActiveAdGroups Returns all information about active ad groups associated with a campaign.
getAdGroup Returns information about the specified ad group
getAdGroupList Returns information about multiple ad groups.
getAdGroupStats Get statistics for a list of ad groups in a campaign.
getAllAdGroups Returns all information about the ad groups associated with a campaign.
updateAdGroup Updates an existing ad group.
updateAdGroupList Updates multiple existing ad groups.
Data Objects Summary
AdGroup Data associated with an ad group.

AdService

AdService provides operations for accessing, creating and modifying Ads in an AdGroup.

Requests Summary
addAds Make a batch of new Ads.
checkAds Check a batch of Ads for policy errors.
findBusinesses Searches for businesses with similar attributes.
getActiveAds Return all active Ads associated with the list of AdGroup ids specified.
getAd Return information about one Ad.
getAdStats Get statistics for a list of ads in an ad group.
getAllAds Return all Ads (enabled, disabled, or paused) associated with the list of AdGroup ids specified.
getMyBusinesses Returns the list of businesses registered to the user in the Local Business Center.
getMyVideos Returns a list of all videos stored under the users account.
updateAds Update a batch of ads.
Data Objects Summary
Business Information about a business from local business center or local search.
CommerceAd Data associated with a commerce ad.
ImageAd Data associated with an image ad.
Image Data associated with an image for an image ad.
LocalBusinessAd Represents a local business ad, which is associated with a specific business location.
MobileAd Data associated with a mobile ad.
MobileImageAd Data associated with a mobile image ad.
TextAd Data associated with a text ad.
VideoAd Data associated with a video ad.
Video Data associated with a video for a video ad.

CampaignService

CampaignService provides operations for accessing, modifying, and creating AdWords Campaigns.

Requests Summary
addCampaign Creates a new campaign.
addCampaignList Creates multiple new campaigns.
getActiveAdWordsCampaigns Returns all information about active campaigns belonging to the customer issuing the request.
getAllAdWordsCampaigns Returns all information about all campaigns belonging to the customer issuing the request.
getCampaign Returns all information about a specified campaign.
getCampaignList Returns all information about multiple campaigns.
getCampaignStats Returns statistics for a list of campaigns.
getConversionOptimizerEligibility Checks if the specified campaigns are eligible to use conversion optimizer.
getOptimizeAdServing Returns true if optimized ad serving is enabled for the specified campaign.
getRecommendedBudgetList Returns the recommended budgets for the specified campaigns.
setOptimizeAdServing Enables or disables optimized ad serving for the specified campaign.
updateCampaign Updates the settings for an existing campaign.
updateCampaignList Updates the settings for multiple existing campaigns.
Data Objects Summary
Campaign Data structure that represents an AdWords campaign.
AdSchedule An ad schedule specified by an array of SchedulingIntervals that dictates when to show ads.
SchedulingInterval A time interval on a given day during which to show ads, along with a multiplier to apply to bids.
BudgetOptimizerSettings Settings for budget optimizer.
ConversionOptimizerSettings Settings for conversion optimizer.
GeoTarget Geographical targeting options for a campaign.
CityTargets Represents city targeting options.
CountryTargets Represents targeting options for countries.
MetroTargets Represents targeting options for US metropolitan regions.
RegionTargets Represents regional targeting options.
ProximityTargets Represents proximity targeting options.
Circle Represents a circular area on Earth.
LanguageTarget Language targeting options for a Campaign.
NetworkTarget Defines which advertising networks to target.
ConversionOptimizerEligibility Conversion optimizer eligibility for a given campaign.

CriterionService

Use CriterionService to create and manage criteria in an ad group.

Requests Summary
addCriteria Adds new criteria to an ad group.
checkCriteria Checks a batch of criteria for policy errors.
getAllCriteria Returns the criteria associated with the specified ad group.
getCampaignNegativeCriteria Gets a list of the negative criteria associated with a campaign.
getCriteria Returns the criteria with the specified IDs associated with a given ad group.
getCriterionStats Gets statistics for a list of criteria in an ad group.
removeCriteria Removes a list of criteria from an ad group.
setCampaignNegativeCriteria Removes all existing negative criteria from a campaign and sets new negative criteria for the specified campaign.
updateCriteria Updates the fields associated with the specified criteria.
Data Objects Summary
Keyword Data associated with a keyword criterion.
Website Data associated with a Website criterion.

InfoService

The Info Service allows you to obtain some basic information about your API usage.

Requests Summary
getFreeUsageQuotaThisMonth Retrieves the number of free API units for this entire month that can be used by the developer token being used to make this call.
getMethodCost Retrieves the cost, in API units per operation, of the given method on a specific date for the developer token being used to make this call.
getOperationCount Retrieves the number of operations recorded for the developer token being used to make this call over the given date range.
getOperationsQuotaThisMonth Retrieves this month's usage quota for the developer token being used to make this call.
getUnitCount Retrieves the number of API units recorded for the developer token being used to make this call over the given date range.
getUnitCountForClients Retrieves the number of API units recorded for a subset of clients over the given date range for the developer token being used to make this call.
getUnitCountForMethod Retrieves the number of API units recorded for the developer token being used to make this call over the given date range for a specific method.
getUsageQuotaThisMonth Retrieves the total number of API units for this entire month that can be used by the developer token being used to make this call.
Data Objects Summary
ClientUsageRecord Data record for per client API units.

KeywordToolService

KeywordToolService provides operations for getting new keywords based on seed keywords you provide or on the words found on a web site from a URL that you provide.

Requests Summary
getKeywordsFromSite Given a URL, returns keywords based on words found on that web page or site, which can be used as keyword criteria for a campaign.
getKeywordVariations Given a list of SeedKeywords, returns their variations in multiple lists within KeywordVariations.
Data Objects Summary
KeywordVariations Variations of a seed keyword.
KeywordVariation A single variation of a seed keyword.
SeedKeyword A source keyword to generate keyword variations from.
SiteKeywordGroups Encapsulates the different groups of keywords related to a site.
SiteKeyword A single keyword based on words found on a website.

ReportService

Use ReportService to schedule and retrieve reports about your AdWords account.

Requests Summary
deleteReport Deletes a report job along with the report it produced, if any.
getAllJobs Returns an array consisting of all jobs the user has scheduled.
getGzipReportDownloadUrl Returns a URL from which a compressed report with the given job ID can be downloaded (in Gzip format).
getReportDownloadUrl Returns a URL from which the report with the given job ID can be downloaded.
getReportJobStatus Returns the status of the report job with the given reportJobId.
scheduleReportJob Schedules a report job for execution.
validateReportJob Runs validation against a report job.
Data Objects Summary
DefinedReportJob Data representing a report job.

SiteSuggestionService

SiteSuggestionService provides operations for getting web site suggestions by category, topics, URLs or demographics.

Requests Summary
getSitesByCategoryName Returns site suggestions based on the specified category name.
getSitesByDemographics Returns site suggestions based on the specified demographics criteria, including gender, age, income, ethnicity and whether there are children in the household.
getSitesByTopics Returns site suggestions based on the specified topics.
getSitesByUrls Returns site suggestions based on the specified URLs.
Data Objects Summary
DemographicsTarget Groups demographics information of the target audience.
LanguageGeoTargeting Holds language and geographical information used in targeting site suggestions.
SiteSuggestion SiteSuggestion contains information returned from each operation in SiteSuggestionService.

TrafficEstimatorService

Provides keyword traffic estimates (such as clicks per day and cost per click) for new or existing keywords.

Requests Summary
checkKeywordTraffic Check a batch of keywords to see whether they will get any traffic.
estimateAdGroupList Returns traffic estimates for the requested set of new or existing ad groups.
estimateCampaignList Returns traffic estimates for the requested set of campaigns.
estimateKeywordList Returns traffic estimates for the requested set of new keywords.
Data Objects Summary
CampaignEstimate Represents traffic estimates for keywords in a campaign.
AdGroupEstimate Represents traffic estimates for keywords in an ad group.
KeywordEstimate Represents the traffic estimates (such as the number of clicks per day) for ads triggered by a keyword.
CampaignRequest Represents a campaign whose keywords are to be estimated.
AdGroupRequest Represents an ad group whose keywords are to be estimated.
KeywordRequest Represents a keyword whose traffic is to be estimated.