AdWords API

AdWords API
Feedback on this document

TrafficEstimatorService (v201302)

Use this service to request traffic estimates for proposed or existing campaigns, ad groups, and keywords.

To simply retrieve estimates for a list of proposed keywords, create a campaign estimate request and a child ad group estimate request with null IDs, and then set the keywordEstimateRequests to contain the keywords.

You can refine the traffic estimates by setting campaign targeting options in the request. If an ad group ID is provided, all creatives from that ad group will be loaded and used to improve estimates.

The maximum number of keyword estimate requests across all campaign estimate requests and ad group estimate requests is 500.

The maximum number of adgroup estimate requests across all campaign estimate requests is 50.

Note that the API returns intervals whereas the Traffic Estimator UI displays averages. Estimates are account specific since they are based on creatives already in the account. When comparing numbers, use the same account for the API and UI.

This is disabled for AdX.
Production WSDL
https://adwords.google.com/api/adwords/o/v201302/TrafficEstimatorService?wsdl
Namespace
https://adwords.google.com/api/adwords/o/v201302
Operations
Errors

get

Returns traffic estimates for specified criteria.

Parameters

Field Type Description
selector TrafficEstimatorSelector Campaigns, ad groups and keywords for which traffic should be estimated.

Response

Field Type Description
rval TrafficEstimatorResult Traffic estimation results.

Errors

Error Reasons
AdxError Errors that are thrown when a non-AdX feature is accessed by an AdX customer.
Enumerations
UNSUPPORTED_FEATURE
Attempt to use non-AdX feature by AdX customer.
AuthenticationError Errors returned when Authentication failed.
Enumerations
AUTHENTICATION_FAILED
Authentication of the request failed.
CLIENT_CUSTOMER_ID_IS_REQUIRED
Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID.
CLIENT_EMAIL_REQUIRED
Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD.
CLIENT_CUSTOMER_ID_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_FAILED_TO_AUTHENTICATE
Client email is not a valid customer email.
CUSTOMER_NOT_FOUND
No customer found for the customer id provided in the header.
GOOGLE_ACCOUNT_DELETED
Client's Google Account is deleted.
GOOGLE_ACCOUNT_COOKIE_INVALID
Google account login token in the cookie is invalid.
FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT
problem occurred during Google account authentication.
GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH
The user in the google account login token does not match the UserId in the cookie.
LOGIN_COOKIE_REQUIRED
Login cookie is required for authentication.
NOT_ADS_USER
User in the cookie is not a valid Ads user.
OAUTH_TOKEN_INVALID
Oauth token in the header is not valid.
OAUTH_TOKEN_EXPIRED
Oauth token in the header has expired.
OAUTH_TOKEN_DISABLED
Oauth token in the header has been disabled.
OAUTH_TOKEN_REVOKED
Oauth token in the header has been revoked.
OAUTH_TOKEN_HEADER_INVALID
Oauth token HTTP header is malformed.
LOGIN_COOKIE_INVALID
Login cookie is not valid.
FAILED_TO_RETRIEVE_LOGIN_COOKIE
Failed to decrypt the login cookie.
USER_ID_INVALID
User Id in the header is not a valid id.
AuthorizationError Errors encountered when trying to authorize a user.
Enumerations
UNABLE_TO_AUTHORIZE
Could not complete authorization due to an internal problem.
NO_ADWORDS_ACCOUNT_FOR_CUSTOMER
Customer has no AdWords account.
USER_PERMISSION_DENIED
User doesn't have permission to access customer.
EFFECTIVE_USER_PERMISSION_DENIED
Effective user doesn't have permission to access this customer.
USER_HAS_READONLY_PERMISSION
User has read-only permission cannot mutate.
NO_CUSTOMER_FOUND
No customer found.
SERVICE_ACCESS_DENIED
Developer doesn't have permission to access service.
ClientTermsError Error due to user not accepting the AdWords terms of service.
Enumerations
INCOMPLETE_SIGNUP_CURRENT_ADWORDS_TNC_NOT_AGREED
Customer has not agreed to the latest AdWords Terms & Conditions
CollectionSizeError Errors associated with the size of the given collection being out of bounds.
CurrencyCodeError Errors for currency codes.
Enumerations
UNSUPPORTED_CURRENCY_CODE
DatabaseError Errors that are thrown due to a database access problem.
Enumerations
CONCURRENT_MODIFICATION
A concurrency problem occurred as two threads were attempting to modify same object.
PERMISSION_DENIED
The permission was denied to access an object.
CAMPAIGN_PRODUCT_NOT_SUPPORTED
Requested campaign belongs to a product that is not supported by the api.
DUPLICATE_KEY
a duplicate key was detected upon insertion
DATABASE_ERROR
a database error has occurred
UNKNOWN
an unknown error has occurred
DateError Errors associated with invalid dates and date ranges.
Enumerations
INVALID_FIELD_VALUES_IN_DATE
Given field values do not correspond to a valid date.
INVALID_FIELD_VALUES_IN_DATE_TIME
Given field values do not correspond to a valid date time.
INVALID_STRING_DATE
The string date's format should be yyyymmdd.
INVALID_STRING_DATE_RANGE
The string date range's format should be yyyymmdd yyyymmdd.
INVALID_STRING_DATE_TIME
The string date time's format should be yyyymmdd hhmmss [tz].
EARLIER_THAN_MINIMUM_DATE
Date is before allowed minimum.
LATER_THAN_MAXIMUM_DATE
Date is after allowed maximum.
DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE
Date range bounds are not in order.
DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL
Both dates in range are null.
DistinctError Errors related to distinct ids or content.
Enumerations
DUPLICATE_ELEMENT
DUPLICATE_TYPE
EntityAccessDenied Reports permission problems trying to access an entity.
Enumerations
READ_ACCESS_DENIED
User did not have read access.
WRITE_ACCESS_DENIED
User did not have write access.
EntityNotFound An id did not correspond to an entity, or it referred to an entity which does not belong to the customer.
Enumerations
INVALID_ID
The specified id refered to an entity which either doesn't exist or is not accessible to the customer. e.g. campaign belongs to another customer.
IdError Errors associated with the ids.
Enumerations
NOT_FOUND
Id not found
InternalApiError Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client.
Enumerations
UNEXPECTED_INTERNAL_API_ERROR
API encountered an unexpected internal error.
UNKNOWN
The cause of the error is not known or only defined in newer versions.
DOWNTIME
The API is currently unavailable for a planned downtime.
MatchesRegexError Errors associated with a given string not matching the provided regular expression.
Enumerations
UNKNOWN
DOES_NOT_MATCH
NotEmptyError Errors corresponding with violation of a NOT EMPTY check.
Enumerations
EMPTY_LIST
NotWhitelistedError Indicates that the customer is not whitelisted for accessing the API.
Enumerations
CUSTOMER_NOT_WHITELISTED_FOR_API
Customer is not whitelisted for accessing the API.
NullError Errors associated with violation of a NOT NULL check.
Enumerations
NULL_CONTENT
Specified list/container must not contain any null elements
OperationAccessDenied Operation not permitted due to the invoked service's access policy.
Enumerations
ACTION_NOT_PERMITTED
Unauthorized invocation of a service's method (get, mutate, etc.)
ADD_OPERATION_NOT_PERMITTED
Unauthorized ADD operation in invoking a service's mutate method.
REMOVE_OPERATION_NOT_PERMITTED
Unauthorized REMOVE operation in invoking a service's mutate method.
SET_OPERATION_NOT_PERMITTED
Unauthorized SET operation in invoking a service's mutate method.
MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT
A mutate action is not allowed on this campaign, from this client.
UNKNOWN
The reason the invoked method or operation is prohibited is not known (the client may be of an older version than the server).
OperatorError Errors due to the use of unsupported operations.
Enumerations
OPERATOR_NOT_SUPPORTED
QuotaCheckError Encapsulates the errors thrown during developer quota checks.
Enumerations
INVALID_TOKEN_HEADER
Customer passed in an invalid token in the header.
ACCOUNT_DELINQUENT
Customer is marked delinquent.
ACCOUNT_INACCESSIBLE
Customer is a fraudulent.
ACCOUNT_INACTIVE
Inactive Account.
INCOMPLETE_SIGNUP
Signup not complete
INCOMPLETE_SIGNUP_LATEST_ADWORDS_API_TNC_NOT_AGREED
Latest AdWords API T&C not agreed.
INCOMPLETE_SIGNUP_NO_BILLING_INFO
No Billing Info.
INCOMPLETE_SIGNUP_USER_INFO_MISSING
User Info missing.
INCOMPLETE_SIGNUP_USER_INFO_PENDING
User Info pending.
INCOMPLETE_SIGNUP_USER_INFO_REJECTED
User Info rejected.
MONTHLY_BUDGET_REACHED
Monthly budget quota reached.
QUOTA_EXCEEDED
Monthly budget quota exceeded.
RangeError A list of all errors associated with the Range constraint.
Enumerations
TOO_LOW
TOO_HIGH
RateExceededError Signals that a call failed because a measured rate exceeded.
Enumerations
RATE_EXCEEDED
Rate exceeded.
ReadOnlyError Errors from attempting to write to read-only fields.
Enumerations
READ_ONLY
RegionCodeError A list of all errors associated with the @RegionCode constraints.
Enumerations
INVALID_REGION_CODE
RejectedError Indicates that a field was rejected due to compatibility issues.
Enumerations
UNKNOWN_VALUE
Unknown value encountered
RequestError Encapsulates the generic errors thrown when there's an error with user request.
Enumerations
UNKNOWN
Error reason is unknown.
INVALID_INPUT
Invalid input.
RequiredError Errors due to missing required field.
Enumerations
REQUIRED
Missing required field.
SizeLimitError Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
REQUEST_SIZE_LIMIT_EXCEEDED
The number of entries in the request exceeds the system limit.
RESPONSE_SIZE_LIMIT_EXCEEDED
The number of entries in the response exceeds the system limit.
UNKNOWN
Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.
StringLengthError Errors associated with the length of the given string being out of bounds.
Enumerations
TOO_SHORT
TOO_LONG
TargetError A list of all the error codes being used by the common targeting package.
Enumerations
AD_SCHEDULE_ADVANCED_INCOMPATIBLE_WITH_CONVERSION_OPTIMIZER
Cannot enable advanced ad scheduling for a conversion optimizer campaign.
AD_SCHEDULE_BID_MULTIPLIER_MALFORMED
Bid multiplier could not be parsed as a number; it was malformed.
AD_SCHEDULE_BID_MULTIPLIER_TOO_BIG
Bid multiplier was too big.
AD_SCHEDULE_BID_MULTIPLIER_TOO_SMALL
Bid multiplier was too small.
AD_SCHEDULE_BID_MULTIPLIER_TOO_MANY_FRACTION_DIGITS
Bid multiplier has too many decimal digits.
AD_SCHEDULE_EXCEEDED_INTERVALS_PER_DAY_LIMIT
The number of intervals per day limit was exceeded.
AD_SCHEDULE_EXCEEDS_PAST_END_OF_WEEK
The required times must be on or before the end of the week (Sunday at 11:45pm).
AD_SCHEDULE_INCOMPATIBILITY
Cannot enable ad scheduling for the campaign.
AD_SCHEDULE_INCOMPATIBLE_WITH_BUDGET_OPTIMIZER
Cannot enable ad scheduling for a budget optimizer campaign.
AD_SCHEDULE_INTERVAL_CANNOT_SPAN_MULTIPLE_DAYS
The start and end times are not on the same day.
AD_SCHEDULE_INVALID_DAY_OF_THE_WEEK
Integer representation day of the week is not within proper range
AD_SCHEDULE_INVALID_TIME_INTERVAL
The start time is not less than the end time.
AD_SCHEDULE_NO_INTERVALS_WHILE_ENABLED
Enabled ad schedule does not have at least one interval.
AD_SCHEDULE_NOT_MULTIPLE_OF_15_MINUTES
The required times must be a multiple of 15 minutes.
AD_SCHEDULE_TIME_INTERVALS_OVERLAP
Two time intervals overlap each other.
CANNOT_EXCLUDE_CITY
Cannot exclude city.
CANNOT_EXCLUDE_IF_NOT_TARGETED
Cannot exclude a location that is not being targeted by an enclosing location.
CANNOT_EXCLUDE_METRO
Cannot exclude metro.
CANNOT_EXCLUDE_PROVINCE
Cannot exclude province.
CANNOT_OPT_OUT_GOOGLE_SEARCH_WHILE_BID_TO_POSITION_ENABLE
Cannot opt out from Google Search while position preference enabled.
CANNOT_TARGET_AGE_WITHOUT_GENDER
Cannot target an age segment without targeting at least one gender segment.
CANNOT_TARGET_CITY
Cannot target city.
CANNOT_TARGET_CONTENT_CONTEXTUAL_WITHOUT_CONTENT_NETWORK
Cannot cover content contextual without content network.
CANNOT_MODIFY_CONTENT_CONTEXTUAL
Cannot modify content contextual on campaigns setup to use AdGroup level targeting settings. This is specified using TargetRestrictSetting. Note that TargetRestrictSetting is set automatically for all campaigns created after version v201206.
CANNOT_TARGET_COUNTRY
Cannot target country.
CANNOT_TARGET_COVERAGE
The requested network coverage modification is prohibited.
CANNOT_TARGET_GENDER_WITHOUT_AGE
Cannot target a gender segment without targeting at least one age segment.
CANNOT_TARGET_GOOGLE_SEARCH_FOR_CPM_CAMPAIGN
Cannot target Google Search network for a CPM campaign.
CANNOT_TARGET_LANGUAGE
Specified language cannot be targeted.
CANNOT_TARGET_METRO
Cannot target metro.
CANNOT_TARGET_MOBILE_CARRIER
Specified Mobile carrier cannot be targeted
CANNOT_TARGET_PROVINCE
Cannot target province.
CANNOT_TARGET_SEARCH_SYNDICATION_WITHOUT_GOOGLE_SEARCH
Cannot cover search syndication network without google search network.
CANNOT_TARGET_SYNDICATABLE_TYPES
Cannot target any syndicatable types.
CANNOT_TARGET_THE_SAME_TARGET_LIST_TYPE_MULTIPLE_TIMES
Cannot target the same target list type twice.
DEMOGRAPHIC_BID_MODIFIER_SHOULD_BE_IN_BETWEEN_0_AND_500
The bid modifier of a demographic target should be in the [0, 500] range.
INVALID_CITY_CODE
A city could not be matched with the provided input.
INVALID_CITYNAME_LENGTH
CityName is too long.
INVALID_EXCLUDED_POLYGON_TARGET
Polygon targets cannot be excluded.
INVALID_EXCLUDED_PROXIMITY_TARGET
Proximity targets cannot be excluded
INVALID_LANGUAGE_CODE
Language code specified is invalid.
INVALID_LATITUDE
Latitude supplied with the target is invalid.
INVALID_LONGITUDE
Longitude supplied with the target is invalid.
INVALID_METRO_CODE
Metro code specified is invalid.
INVALID_MOBILE_CARRIER
Mobile Carrier specified is invalid.
INVALID_MOBILE_PLATFORM
Mobile Platform is invalid.
INVALID_POSTALCODE_LENGTH
PostalCode is too long.
INVALID_PROVINCE_CODE
Province code specified is invalid.
INVALID_PROXIMITY_RADIUS
Radius supplied with the proximity target is invalid.
INVALID_REGIONCODE_LENGTH
RegionCode is too long.
INVALID_REGIONNAME_LENGTH
RegionName is too long.
INVALID_STREETADDRESS_LENGTH
StreetAddress is too long.
MULTIPLE_OCCURRENCES_OF_SAME_TARGET
Multiple occurrences of the same target were encountered.
POLYGON_DUPLICATE_VERTICES
A PolygonTarget point is duplicated.
POLYGON_EDGES_INTERSECT
A PolygonTarget has edges that intersect.
POLYGON_TOO_FEW_VERTICES
A PolygonTarget has too few vertices.
POLYGON_TOO_MANY_VERTICES
A polygonTarget has too many vertices. (more than 100)
POLYGON_TOO_LARGE
A PolygonTarget is too large.
TARGETING_VALIDATION_FAILED
A validation error was encountered; however, a more detailed TargetingValidationError usually has already been provided.
TARGETING_CROSS_COUNTRY_REGIONAL
Region spanning multiple countries.
TARGETING_EXCLUSION_NOT_SUPPORTED
The given exclusion is not supported.
TARGETING_INCOMPATIBLE_LOCATION_TYPES
The location types are incompatible for targeting.
TARGETING_NOT_SUPPORTED
The targeting is not supported.
TARGETING_TOO_MANY_REGIONS
There are too many regions.
TOO_MANY_EXCLUDED_LOCATIONS
There are too many excluded locations.
TOO_MANY_TARGETED_LOCATIONS
There are too many targeted locations.
WARNING_MAY_NOW_REQUIRE_CHINESE_APPROVAL
This is for warnings which is currently not being passed back to the client.
WARNING_NOW_REQUIRES_CHINESE_APPROVAL
This is for warnings which is currently not being passed back to the client.
WARNING_NOW_TARGETS_CHINA
This is for warnings which is currently not being passed back to the client.
WARNING_NOW_TARGETS_CHINESE
This is for warnings which is currently not being passed back to the client.
TARGET_ERROR
The target error is unknown.
TrafficEstimatorError Base error class for TrafficEstimatorService.
Enumerations
NO_CAMPAIGN_FOR_AD_GROUP_ESTIMATE_REQUEST
When the request with null campaign ID in CampaignEstimateRequest contains an AdGroupEstimateRequest with an ID.
NO_AD_GROUP_FOR_KEYWORD_ESTIMATE_REQUEST
When the request with null adgroup ID in AdGroupEstimateRequest contains a KeywordEstimateRequest with an ID.
NO_MAX_CPC_FOR_KEYWORD_ESTIMATE_REQUEST
All KeywordEstimateRequest items should have maxCpc associated with them.
TOO_MANY_KEYWORD_ESTIMATE_REQUESTS
When there are more KeywordEstimateRequests in the request than TrafficEstimatorService allows.
TOO_MANY_CAMPAIGN_ESTIMATE_REQUESTS
When there are more CampaignEstimateRequests in the request than TrafficEstimatorService allows.
TOO_MANY_ADGROUP_ESTIMATE_REQUESTS
When there are more AdGroupEstimateRequests in the request than TrafficEstimatorService allows.
TOO_MANY_TARGETS
When there are more targets in the request than TrafficEstimatorService allows. See documentation on CampaignEstimateRequest for more information about this error.
KEYWORD_TOO_LONG
Request contains a keyword that is too long for backends to handle.
KEYWORD_CONTAINS_BROAD_MATCH_MODIFIERS
Request contains a keyword that contains broad match modifiers.
INVALID_INPUT
When an unexpected error occurs.
SERVICE_UNAVAILABLE
When backend service calls fail.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Authentication required

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

Signing you in...

Google Developers needs your permission to do that.