com.google.api.ads.adwords.jaxws.v201809.cm

Interface TrialServiceInterface

public interface TrialServiceInterface

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. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
TrialPage	get(Selector selector) Loads a TrialPage containing a list of Trial objects matching the selector.
TrialReturnValue	mutate(List<TrialOperation> operations) Creates new trials, updates properties and controls the life cycle of existing trials.
TrialPage	query(String query) Loads a TrialPage containing a list of Trial objects matching the query.

Method Detail

get

@RequestWrapper(localName="get",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.TrialServiceInterfaceget")
 @ResponseWrapper(localName="getResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.TrialServiceInterfacegetResponse")
TrialPage get(Selector selector)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                           throws ApiException_Exception

Loads a TrialPage containing a list of Trial objects matching the selector.

Parameters:

selector - defines which subset of all available trials to return, the sort order, and which fields to include

selector -

Returns:

Returns a page of matching trial objects.

Throws:

com.google.ads.api.services.common.error.ApiException - if errors occurred while retrieving the results.

ApiException_Exception

mutate

@RequestWrapper(localName="mutate",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.TrialServiceInterfacemutate")
 @ResponseWrapper(localName="mutateResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.TrialServiceInterfacemutateResponse")
TrialReturnValue mutate(List<TrialOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

Creates new trials, updates properties and controls the life cycle of existing trials. See TrialService for details on the trial life cycle.

Parameters:

operations -

Returns:

Returns the list of updated Trials, in the same order as the operations list.

Throws:

com.google.ads.api.services.common.error.ApiException - if errors occurred while processing the request.

ApiException_Exception

query

@RequestWrapper(localName="query",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.TrialServiceInterfacequery")
 @ResponseWrapper(localName="queryResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.TrialServiceInterfacequeryResponse")
TrialPage query(String query)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     throws ApiException_Exception

Loads a TrialPage containing a list of Trial objects matching the query.

Parameters:

query - defines which subset of all available trials to return, the sort order, and which fields to include

query -

Returns:

Returns a page of matching trial objects.

Throws:

com.google.ads.api.services.common.error.ApiException - if errors occurred while retrieving the results.

ApiException_Exception