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

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 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 HeaderError InternalError QuotaError RequestError

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The resource name of the experiment to promote.

Request body

The request body contains data with the following structure:

JSON representation
  "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:


For more information, see the OAuth 2.0 Overview.