Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.experiments.scheduleExperiment

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 experiments.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

HTTP request

POST https://googleads.googleapis.com/v10/{resourceName=customers/*/experiments/*}:scheduleExperiment

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resourceName

string

Required. The scheduled experiment.

Request body

The request body contains data with the following structure:

JSON representation
{
  "validateOnly": boolean
}
Fields
validateOnly

boolean

If true, the request is validated but not executed. Only errors are returned, not results.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.