Experiment

resource_name

string

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

customers/{customer_id}/experiments/{experiment_id}

name

string

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

description

string

The description of the experiment. It must have a minimum length of 1 and maximum length of 2048.

suffix

string

For system managed experiments, the advertiser must provide a suffix during construction, in the setup stage before moving to initiated. The suffix will be appended to the in-design and experiment campaign names so that the name is base campaign name + suffix.

type

ExperimentType

Required. The product/feature that uses this experiment.

status

ExperimentStatus

The Advertiser-chosen status of this experiment.

goals[]

MetricGoal

The goals of this experiment.

promote_status

AsyncActionStatus

Output only. The status of the experiment promotion process.

experiment_id

int64

Output only. The ID of the experiment. Read only.

start_date

string

Date when the experiment starts. By default, the experiment starts now or on the campaign's start date, whichever is later. If this field is set, then the experiment starts at the beginning of the specified date in the customer's time zone.

Format: YYYY-MM-DD Example: 2019-03-14

end_date

string

Date when the experiment ends. By default, the experiment ends on the campaign's end date. If this field is set, then the experiment ends at the end of the specified date in the customer's time zone.

Format: YYYY-MM-DD Example: 2019-04-18

long_running_operation

string

Output only. The resource name of the long-running operation that can be used to poll for completion of experiment schedule or promote. The most recent long running operation is returned.

sync_enabled

bool

Immutable. Set to true if changes to base campaigns should be synced to the trial campaigns. Any changes made directly to trial campaigns will be preserved. This field can only be set when the experiment is being created.