ScheduleExperiment

  • The ScheduleExperiment RPC schedules an experiment by converting an in-design campaign into an active experiment campaign that will serve ads.

  • This method returns a long-running operation to track the process, and its metadata includes the resource name of the created experiment.

  • If the forking of the campaign fails, errors can be retrieved using the ListExperimentAsyncErrors method.

  • Scheduling an experiment requires the https://www.googleapis.com/auth/adwords OAuth scope for authorization.

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.