ExperimentService

Service to manage experiments.

EndExperiment

rpc EndExperiment(EndExperimentRequest) returns (Empty)

Immediately ends an experiment, changing the experiment's scheduled end date and without waiting for end of day. End date is updated to be the time of the request.

List of thrown errors: AuthenticationError AuthorizationError ExperimentError HeaderError InternalError QuotaError RequestError

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GraduateExperiment

rpc GraduateExperiment(GraduateExperimentRequest) returns (Empty)

Graduates an experiment to a full campaign.

List of thrown errors: AuthenticationError AuthorizationError ExperimentError HeaderError InternalError MutateError QuotaError RequestError

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ListExperimentAsyncErrors

rpc ListExperimentAsyncErrors(ListExperimentAsyncErrorsRequest) returns (ListExperimentAsyncErrorsResponse)

Returns all errors that occurred during the last Experiment update (either scheduling or promotion). Supports standard list paging.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateExperiments

rpc MutateExperiments(MutateExperimentsRequest) returns (MutateExperimentsResponse)

Creates, updates, or removes experiments. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError ExperimentError HeaderError InternalError QuotaError RequestError

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

PromoteExperiment

rpc PromoteExperiment(PromoteExperimentRequest) returns (Operation)

Promotes the trial campaign thus applying changes in the trial campaign to the base campaign. This method returns a long running operation that tracks the promotion of the experiment campaign. If it fails, a list of errors can be retrieved using the ListExperimentAsyncErrors method. The operation's metadata will be a string containing the resource name of the created experiment.

List of thrown errors: AuthenticationError AuthorizationError ExperimentError HeaderError InternalError QuotaError RequestError

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ScheduleExperiment

rpc ScheduleExperiment(ScheduleExperimentRequest) returns (Operation)

Schedule an experiment. The in design campaign will be converted into a real campaign (called the experiment campaign) that will begin serving ads if successfully created.

The experiment is scheduled immediately with status INITIALIZING. This method returns a long running operation that tracks the forking of the in design campaign. If the forking fails, a list of errors can be retrieved using the ListExperimentAsyncErrors method. The operation's metadata will be a string containing the resource name of the created experiment.

List of thrown errors: AuthenticationError AuthorizationError ExperimentError DatabaseError DateError DateRangeError FieldError HeaderError InternalError QuotaError RangeError RequestError

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.