CampaignExperiment

An A/B experiment that compares the performance of the base campaign (the control) and a variation of that campaign (the experiment).

Fields

resource_name

string

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

customers/{customer_id}/campaignExperiments/{campaign_experiment_id}

id

Int64Value

Output only. The ID of the campaign experiment.

This field is read-only.

campaign_draft

StringValue

Immutable. The campaign draft with staged changes to the base campaign.

name

StringValue

The name of the campaign experiment.

This field is required when creating new campaign experiments and must not conflict with the name of another non-removed campaign experiment or campaign.

It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

description

StringValue

The description of the experiment.

traffic_split_percent

Int64Value

Immutable. Share of traffic directed to experiment as a percent (must be between 1 and 99 inclusive. Base campaign receives the remainder of the traffic (100 - traffic_split_percent). Required for create.

traffic_split_type

CampaignExperimentTrafficSplitType

Immutable. Determines the behavior of the traffic split.

experiment_campaign

StringValue

Output only. The experiment campaign, as opposed to the base campaign.

status

CampaignExperimentStatus

Output only. The status of the campaign experiment. This field is read-only.

long_running_operation

StringValue

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

start_date

StringValue

Date when the campaign 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. Cannot be changed once the experiment starts.

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

end_date

StringValue

Date when the campaign 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