TrialService manages the life cycle of campaign trials. It is used to create new trials from drafts, modify trial properties, promote changes in a trial back to its base campaign, and to archive a trial.
A trial is an experiment, running two variants (trial arms) - the base campaign and the trial - at the same time, directing a fixed share of traffic to each trial arm. A trial is created from a draft of the base campaign and will be a snapshot of changes in the draft at the time of creation.
Constraints
- A campaign cannot have running/scheduled "AdWords Campaign Experiments" (ACE) and running/scheduled trials at the same time. Trial creation will fail, if the base campaign has a running/scheduled ACE experiment.
- Trial names must be unique across all of the customer's non-deleted trial and campaign names.
- When creating a trial, [startDate, endDate] cannot be in the past or overlap with any other running/scheduled trial, must be within the base campaign's [startDate, endDate] and endDate must be later than startDate.
- A future startDate/endDate can be updated to a different future startDate/endDate as long as the constraints on [startDate, endDate] are not violated.
- There is at most one trial running and at most one trial scheduled for the future at a time, per base campaign.
- The base campaign's budget cannot be shared with any other campaign. Trial creation will fail if the base campaign's budget is shared with another campaign.
Life cycle
A trial's status reflects the state of the trial within its life cycle. Some status transitions are performed explicitly by sending a SET operation, while other status transitions occur asynchronously without a client operation.When a trial is first ADDed, its status is CREATING. The trial will be created asynchronously, and once it is fully created, its status will change to ACTIVE.
If the asynchronous creation of the trial fails, its status will change to CREATION_FAILED.
To promote changes in an ACTIVE trial back to the base campaign, set the trial status to PROMOTING. The promotion itself will occur asynchronously. If the promotion operation fails after some of the base campaign has already been updated, the status will change to PROMOTE_FAILED.
To graduate an ACTIVE trial, which will allow its associated campaign to act independently of the trial and free it of restrictions from the trial, set the status to GRADUATED and provide a new budgetId for the campaign to use (since it can no longer share the base campaign's budget).
Any trial that is not CREATING or PROMOTING can be archived by setting the status to the value of the same name.
- Production WSDL
-
https://adwords.google.com/api/adwords/cm/v201809/TrialService?wsdl
- Namespace
-
https://adwords.google.com/api/adwords/cm/v201809
- Operations
- Errors
-
- AuthenticationError
- AuthorizationError
- BiddingErrors
- BudgetError
- CampaignError
- ClientTermsError
- DatabaseError
- DateError
- DateRangeError
- DistinctError
- EntityCountLimitExceeded
- EntityNotFound
- IdError
- InternalApiError
- NotEmptyError
- NullError
- OperationAccessDenied
- OperatorError
- QuotaCheckError
- RangeError
- RateExceededError
- ReadOnlyError
- RejectedError
- RequestError
- RequiredError
- SelectorError
- SizeLimitError
- StringFormatError
- StringLengthError
- TrialError
get
Loads a TrialPage containing a list of Trial objects matching the selector.
Parameters
Field | Type | Description |
---|---|---|
selector
|
|
defines which subset of all available trials to return, the sort order, and which fields to include |
Response
Field | Type | Description |
---|---|---|
rval
|
|
Returns a page of matching trial objects. |
mutate
Creates new trials, updates properties and controls the life cycle of existing trials. See TrialService for details on the trial life cycle.
Parameters
Field | Type | Description |
---|---|---|
operations
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
Returns the list of updated Trials, in the same order as the operations list. |
query
Loads a TrialPage containing a list of Trial objects matching the query.
Parameters
Field | Type | Description |
---|---|---|
query
|
|
defines which subset of all available trials to return, the sort order, and which fields to include |
Response
Field | Type | Description |
---|---|---|
rval
|
|
Returns a page of matching trial objects. |
Errors
Error | Reasons |
---|---|
AuthenticationError
|
Errors returned when Authentication failed.
Enumerations
|
AuthorizationError
|
Errors encountered when trying to authorize a user.
Enumerations
|
BiddingErrors
|
Represents error codes for bidding strategy entities.
Enumerations
|
BudgetError
|
A list of all the error codes being used by the common budget domain package.
Enumerations
|
CampaignError
|
Base error class for Campaign Service.
Enumerations
|
ClientTermsError
|
Error due to user not accepting the AdWords terms of service.
Enumerations
|
DatabaseError
|
Errors that are thrown due to a database access problem.
Enumerations
|
DateError
|
Errors associated with invalid dates and date ranges.
Enumerations
|
DateRangeError
|
A list of all the error codes being used for date range error.
Enumerations
|
DistinctError
|
Errors related to distinct ids or content.
Enumerations
|
EntityCountLimitExceeded
|
Signals that an entity count limit was exceeded for some level.
For example, too many criteria for a campaign.
Enumerations
|
EntityNotFound
|
An id did not correspond to an entity, or it referred to an entity which does not belong to the
customer.
Enumerations
|
IdError
|
Errors associated with the ids.
Enumerations
|
InternalApiError
|
Indicates that a server-side error has occured. InternalApiError s
are generally not the result of an invalid request or message sent by the
client.
Enumerations
|
NotEmptyError
|
Errors corresponding with violation of a NOT EMPTY check.
Enumerations
|
NullError
|
Errors associated with violation of a NOT NULL check.
Enumerations
|
OperationAccessDenied
|
Operation not permitted due to the invoked service's access policy.
Enumerations
|
OperatorError
|
Errors due to the use of unsupported operations.
Enumerations
|
QuotaCheckError
|
Encapsulates the errors thrown during developer quota checks.
Enumerations
|
RangeError
|
A list of all errors associated with the Range constraint.
Enumerations
|
RateExceededError
|
Signals that a call failed because a measured rate exceeded.
Enumerations
|
ReadOnlyError
|
Errors from attempting to write to read-only fields.
Enumerations
|
RejectedError
|
Indicates that a field was rejected due to compatibility issues.
Enumerations
|
RequestError
|
Encapsulates the generic errors thrown when there's an error with user
request.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
SelectorError
|
Represents possible error codes for Selector.
Enumerations
|
SizeLimitError
|
Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors associated with the length of the given string being
out of bounds.
Enumerations
|
TrialError
|
Error class for TrialService.
Enumerations
|