TrafficEstimatorService (v201809)

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 2500.

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.

---

Production WSDL

https://adwords.google.com/api/adwords/o/v201809/TrafficEstimatorService?wsdl

Namespace

https://adwords.google.com/api/adwords/o/v201809

Operations

• get

Errors

• AdxError
• AuthenticationError
• AuthorizationError
• ClientTermsError
• CollectionSizeError
• CurrencyCodeError
• DatabaseError
• DateError
• DistinctError
• EntityAccessDenied
• EntityNotFound
• IdError
• InternalApiError
• NotEmptyError
• NullError
• OperationAccessDenied
• OperatorError
• QuotaCheckError
• RangeError
• RateExceededError
• ReadOnlyError
• RegionCodeError
• RejectedError
• RequestError
• RequiredError
• SizeLimitError
• StringFormatError
• StringLengthError
• TrafficEstimatorError

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. Starting version V201409 ClientCustomerId will be required for all requests except for CustomerService.get 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. CUSTOMER_NOT_ACTIVE Access denied since the customer is not active. 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. TWO_STEP_VERIFICATION_NOT_ENROLLED The customer has a policy to enforce 2-Step Verification, but the user is not enrolled. ADVANCED_PROTECTION_NOT_ENROLLED The customer has a policy to enforce enrollment in the Advanced Protection Program, but the user is not enrolled.
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. Enumerations TOO_FEW TOO_MANY
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. ACCESS_PROHIBITED The user's access to an object has been prohibited. 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. TRANSIENT_ERROR A temporary error occurred during the request. Please retry. 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. ERROR_GENERATING_RESPONSE Mutate succeeded but server was unable to build response. Client should not retry mutate.
NotEmptyError	Errors corresponding with violation of a NOT EMPTY check. Enumerations EMPTY_LIST
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. OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE This operation is not permitted on this campaign type ADD_AS_REMOVED_NOT_PERMITTED An ADD operation may not set status to REMOVED. OPERATION_NOT_PERMITTED_FOR_REMOVED_ENTITY This operation is not allowed because the campaign or adgroup is removed. OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE This operation is not permitted on this ad group type. 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 DEVELOPER_TOKEN_NOT_APPROVED Developer token is not approved for production access, and the customer is attempting to access a production account. TERMS_AND_CONDITIONS_NOT_SIGNED Terms and conditions are not signed. 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. UNSUPPORTED_VERSION The api version in the request has been discontinued. Please update to the new AdWords API version.
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. INTERNAL_STORAGE_ERROR The account is too large to load. UNKNOWN
StringFormatError	A list of error code for reporting invalid content of input strings. Enumerations UNKNOWN ILLEGAL_CHARS The input string value contains disallowed characters. INVALID_FORMAT The input string value is invalid for the associated field.
StringLengthError	Errors associated with the length of the given string being out of bounds. Enumerations TOO_SHORT TOO_LONG
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.