Share your feedback about the AdWords API! Take our annual survey.

type Trial (v201802)

Interface for campaign trial entities. A trial is an experiment created by an advertiser from changes in a draft.


Namespace
https://adwords.google.com/api/adwords/cm/v201802

Field

id

xsd:long

The id of this trial.

This field can be selected using the value "Id".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: ADD.
This field is required and should not be null when it is contained within Operators : SET.

baseCampaignId

xsd:long

Id of the base campaign, which will be the control arm of this trial.

This field can be selected using the value "BaseCampaignId".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: SET.
This field is required and should not be null when it is contained within Operators : ADD.

draftId

xsd:long

Valid id of the draft this trial is based on.

This field can be selected using the value "DraftId".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: SET.
This field is required and should not be null when it is contained within Operators : ADD.

budgetId

xsd:long

Id of the new budget to assign to the trial campaign when graduating a trial.

Required for SET operations, when changing the status to GRADUATED, and read-only otherwise.

When graduating a trial, the same constraints apply to this field as for a budget id passed to CampaignService when creating a new campaign.

GET operations always return a null budget id.

This field is read only and will be ignored when sent to the API for the following Operators: ADD.

name

xsd:string

The name of this trial. Must not conflict with the name of another trial or campaign.

This field can be selected using the value "Name".
This field can be filtered on.
This field is required and should not be null when it is contained within Operators : ADD.
The length of this string should be between 1 and 1024, inclusive, in UTF-8 bytes, (trimmed).

startDate

xsd:string

Date the trial begins. On add, defaults to the the base campaign's start date or the current day in the parent account's local timezone (whichever is later).

This field can be selected using the value "StartDate".
This field can be filtered on.

endDate

xsd:string

Date the campaign ends. On add, defaults to the base campaign's end date.

This field can be selected using the value "EndDate".
This field can be filtered on.

trafficSplitPercent

xsd:int

Traffic share to be directed to the trial arm of this trial, i.e. the arm containing the trial changes (in percent). The remainder of the traffic (100 - trafficSplitPercent) will be directed to the base campaign.

This field can be selected using the value "TrafficSplitPercent".
This field can be filtered on.
This field must be between 1 and 99, inclusive.
This field is read only and will be ignored when sent to the API for the following Operators: SET.
This field is required and should not be null when it is contained within Operators : ADD.

status

TrialStatus

Status of this trial. Note that a running trial will always be ACTIVE, but not all ACTIVE trials are currently running: they may have ended or been scheduled for the future.


Enumerations
UNKNOWN
Invalid status. Should not be used except for detecting values that are incorrect, or values that are not yet known to the user.
CREATING
The trial campaign is being created.
ACTIVE
The trial campaign is fully created. The trial is currently running, scheduled to run in the future or has ended based on its end date.The advertiser cannot set this status directly. A trial with the status CREATING will be updated to ACTIVE when it is fully created.
PROMOTING
The advertiser requested to merge changes in the trial back into the original campaigns. The update to the original campaign will be kicked off asynchronously and the status will be updated to PROMOTED or PROMOTE_FAILED upon completion.
PROMOTED
The process to merge changes in the trial back to the original campaign has completedly successfully. The advertiser cannot set this status directly. To move the trial to this status, set the trial to status PROMOTING and the status will be updated to PROMOTED when the changes are applied to the original campaign.
ARCHIVED
The advertiser archived the campaign trial.
CREATION_FAILED
The trial campaign failed to create. More details about the errors are available through getErrors in the TrialService API.The advertiser cannot set this status directly.
PROMOTE_FAILED
The promotion failed after it was partially applied. Promote cannot be attempted again safely, so the issue must be corrected in the original campaign. More details about the errors are available through getErrors in the TrialService API.The advertiser cannot set this status directly. To promote the trial, set the trial in state PROMOTING and the status will be updated to PROMOTE_FAILED if errors are encountered while applying changes to the original campaign.
GRADUATED
The advertiser has graduated the trial campaign to a standalone campaign, existing independently of the trial.
HALTED
The advertiser has halted the trial.

This field can be selected using the value "Status".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: ADD.

trialCampaignId

xsd:long

Id of the trial campaign. This will be null if the Trial has status CREATING.

This field can be selected using the value "TrialCampaignId".
This field can be filtered on.
This field is read only and will be ignored when sent to the API.

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.