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.

ExperimentArm

A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.

JSON representation
{
  "resourceName": string,
  "trial": string,
  "name": string,
  "control": boolean,
  "trafficSplit": string,
  "campaigns": [
    string
  ],
  "inDesignCampaigns": [
    string
  ]
}
Fields
resourceName

string

Immutable. The resource name of the experiment arm. Experiment arm resource names have the form:

customers/{customerId}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}

trial

string

Immutable. The experiment to which the ExperimentArm belongs.

name

string

Required. The name of the experiment arm. It must have a minimum length of 1 and maximum length of 1024. It must be unique under an experiment.

control

boolean

Whether this arm is a control arm. A control arm is the arm against which the other arms are compared.

trafficSplit

string (int64 format)

Traffic split of the trial arm. The value should be between 1 and 100 and must total 100 between the two trial arms.

campaigns[]

string

List of campaigns in the trial arm. The max length is one.

inDesignCampaigns[]

string

Output only. The in design campaigns in the treatment experiment arm.