AdWords API

AdWords API
Feedback on this document

ExperimentService (v201306)

Use this service to set up campaign experiments which let you accurately test and measure changes to your keywords, bids, ad groups and placements. Creating and running a campaign experiment involves the following steps:

  1. Creating an Experiment object that describes the experiment itself, including the experiment ID, date range, and the percentage of traffic that will be directed to the experiment.
  2. Setting up control and experimental campaign entities by setting the experimentData field on AdGroup and BiddableAdGroupCriterion objects. Use the experimentDataStatus field to choose if the entity should be part of a control group, part of the experiment group, or if the entity should handle both control and experimental traffic.

For more information on campaign experiments, including tracking the performance of an experiment, see the AdWords Help Center.

This is disabled for AdX.
Production WSDL
https://adwords.google.com/api/adwords/cm/v201306/ExperimentService?wsdl
Namespace
https://adwords.google.com/api/adwords/cm/v201306
Operations
Errors

get

Returns a list of experiments specified by the experiment selector from the customer's account.

Parameters

Field Type Description
serviceSelector Selector The selector specifying the Experiments to return. If selector is empty, all experiments are returned.

Response

Field Type Description
rval ExperimentPage List of experiments meeting all the criteria of each selector.

mutate

Mutates (add, update or remove) experiments. Note: To REMOVE use SET and mark status to DELETED.

Parameters

Field Type Description
operations ExperimentOperation[] A list of unique operations. The same experiment cannot be specified in more than one operation.

Response

Field Type Description
rval ExperimentReturnValue The updated experiments. The list of experiments is returned in the same order in which it came in as input.

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.
BudgetError A list of all the error codes being used by the common budget domain package.
Enumerations
BUDGET_DELETED
The requested budget no longer exists.
BUDGET_ERROR
Default budget error.
BUDGET_IN_USE
The budget is associated with at least one campaign, and so the budget cannot be removed.
BUDGET_PERIOD_NOT_AVAILABLE
Customer is not whitelisted for this budget period.
CANNOT_EDIT_SHARED_BUDGET
Customer cannot use CampaignService to edit a shared budget.
DUPLICATE_NAME
A budget with this name already exists.
MONEY_AMOUNT_IN_WRONG_CURRENCY
A money amount was not in the expected currency.
MONEY_AMOUNT_LESS_THAN_CURRENCY_MINIMUM_CPC
A money amount was less than the minimum CPC for currency.
MONEY_AMOUNT_TOO_LARGE
A money amount was greater than the maximum allowed.
NEGATIVE_MONEY_AMOUNT
A money amount was negative.
NON_MULTIPLE_OF_MINIMUM_CURRENCY_UNIT
A money amount was not a multiple of a minimum unit.
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
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
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.
ExperimentServiceError Base error class for Experiment Service.
Enumerations
AFTER_MAXIMUM_ALLOWABLE_DATE
Start/end date is too far in the future
AOL_PARTNER_CAMPAIGNS_CANT_RUN_EXPERIMENTS
AOL partners are not permitted to run experiments
CANNOT_CREATE_EXPERIMENT_FOR_BIDDING_STRATEGY
Cannot create experiment for bidding strategy
CANNOT_CREATE_EXPERIMENT_FOR_BIDDING_STRATEGY_FEATURE
Cannot create experiment for a bidding strategy feature used in the campaign.
CANNOT_SET_DATE_TO_PAST
Specified start/end date for experiment is in the past
CANNOT_SET_END_DATE_WITHOUT_SETTING_START_DATE
Cannot set an end date for an experiment if a start date is not set.
CANNOT_USE_EXPERIMENT_WITH_SHARED_BUDGET
Cannot use experiment with a campaign that is using a shared budget.
DATE_OUTSIDE_CAMPAIGN_DATE_RANGE
Start date before campaign start or end date after campaign end
EXPERIMENT_ALREADY_STARTED
Can't change start date of experiment once started
EXPERIMENT_ENDED
Can't edit ended experiments
EXPERIMENT_LIMIT_EXCEEDED
Adding experiment would exceed maximum allowed experiments in campaign.
INVALID_EXPERIMENT_NAME
Experiment name cannot be used.
INVALID_QUERY_PERCENTAGE
The query percentage is not valid
CANNOT_CHANGE_QUERY_PERCENTAGE_AFTER_EXPERIMENT_HAS_STARTED
Cannot change query percentage after experiment has started
INVALID_STATUS_UPDATE
Invalid initial experiment status or transition.
START_DATE_AFTER_END_DATE
The experiment start date was after the experiment end date.
NO_VALID_BUDGET
No budget in this campaign
EXPERIMENT_NOT_ACTIVE
An inactive experiment cannot be changed
EXPERIMENT_SERVICE_ERROR
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.
NewEntityCreationError Error associated with creation of new entities using TempIds.
Enumerations
CANNOT_SET_ID_FOR_ADD
Do not set the id field while creating new entities.
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.
OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE
This operation is not permitted on this campaign 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
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.
QuotaError Errors that are thrown if a quota limit is exceeded.
Enumerations
TOO_MANY_ADGROUPS_PER_CAMPAIGN
Too many ad groups per campaign.
TOO_MANY_CAMPAIGNS_PER_ACCOUNT
Too many campaigns per account.
TOO_MANY_CONVERSION_TYPES_PER_ACCOUNT
Too many conversion types per account.
TOO_MANY_KEYWORDS_PER_ADGROUP
Too many keywords per ad group.
TOO_MANY_KEYWORDS_PER_CAMPAIGN
Too many keywords per campaign.
TOO_MANY_KEYWORDS_PER_CUSTOMER
Too many keywords per customer.
TOO_MANY_SITES_PER_ADGROUP
Too many sites per ad group.
TOO_MANY_SITES_PER_CAMPAIGN
Too many sites per campaign.
TOO_MANY_CRITERIA_PER_ACCOUNT
Too many campaign level negative keywords + negative sites + geo targets for the account.
UNKNOWN
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
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.
SelectorError Represents possible error codes for Selector.
Enumerations
INVALID_FIELD_NAME
The field name is not valid.
MISSING_FIELDS
The list of fields is null or empty.
MISSING_PREDICATES
The list of predicates is null or empty.
OPERATOR_DOES_NOT_SUPPORT_MULTIPLE_VALUES
Predicate operator does not support multiple values. Multiple values are supported only for Predicate.Operator.IN and Predicate.Operator.NOT_IN.
INVALID_PREDICATE_ENUM_VALUE
The predicate enum value is not valid.
MISSING_PREDICATE_OPERATOR
The predicate operator is empty.
MISSING_PREDICATE_VALUES
The predicate values are empty.
INVALID_PREDICATE_FIELD_NAME
The predicate field name is not valid.
INVALID_PREDICATE_OPERATOR
The predicate operator is not valid.
INVALID_FIELD_SELECTION
Invalid selection of fields.
INVALID_PREDICATE_VALUE
The predicate value is not valid.
INVALID_SORT_FIELD_NAME
The sort field name is not valid or the field is not sortable.
SELECTOR_ERROR
Standard error.
FILTER_BY_DATE_RANGE_NOT_SUPPORTED
Filtering by date range is not supported.
START_INDEX_IS_TOO_HIGH
Selector paging start index is too high.
UNKNOWN_ERROR
Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.
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

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.