Class Experiment

JSON template for Analytics experiment resource.

Inheritance

object

Experiment

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Analytics.v3.Data

Assembly: Google.Apis.Analytics.v3.dll

Syntax

public class Experiment : IDirectResponseSchema

Properties

AccountId

Account ID to which this experiment belongs. This field is read-only.

Declaration

[JsonProperty("accountId")]
public virtual string AccountId { get; set; }

Property Value

Type	Description
string

Created

DateTime representation of CreatedRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreatedDateTimeOffset instead.")]
public virtual DateTime? Created { get; set; }

Property Value

Type	Description
DateTime?

CreatedDateTimeOffset

DateTimeOffset representation of CreatedRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreatedDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreatedRaw

Time the experiment was created. This field is read-only.

Declaration

[JsonProperty("created")]
public virtual string CreatedRaw { get; set; }

Property Value

Type	Description
string

Description

Notes about this experiment.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EditableInGaUi

If true, the end user will be able to edit the experiment via the Google Analytics user interface.

Declaration

[JsonProperty("editableInGaUi")]
public virtual bool? EditableInGaUi { get; set; }

Property Value

Type	Description
bool?

EndTime

DateTime representation of EndTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual DateTime? EndTime { get; set; }

Property Value

Type	Description
DateTime?

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

EndTimeRaw

The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.

Declaration

[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }

Property Value

Type	Description
string

EqualWeighting

Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.

Declaration

[JsonProperty("equalWeighting")]
public virtual bool? EqualWeighting { get; set; }

Property Value

Type	Description
bool?

Id

Experiment ID. Required for patch and update. Disallowed for create.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

InternalWebPropertyId

Internal ID for the web property to which this experiment belongs. This field is read-only.

Declaration

[JsonProperty("internalWebPropertyId")]
public virtual string InternalWebPropertyId { get; set; }

Property Value

Type	Description
string

Kind

Resource type for an Analytics experiment. This field is read-only.

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
string

MinimumExperimentLengthInDays

An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.

Declaration

[JsonProperty("minimumExperimentLengthInDays")]
public virtual int? MinimumExperimentLengthInDays { get; set; }

Property Value

Type	Description
int?

Name

Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

ObjectiveMetric

The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".

Declaration

[JsonProperty("objectiveMetric")]
public virtual string ObjectiveMetric { get; set; }

Property Value

Type	Description
string

OptimizationType

Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".

Declaration

[JsonProperty("optimizationType")]
public virtual string OptimizationType { get; set; }

Property Value

Type	Description
string

ParentLink

Parent link for an experiment. Points to the view (profile) to which this experiment belongs.

Declaration

[JsonProperty("parentLink")]
public virtual Experiment.ParentLinkData ParentLink { get; set; }

Property Value

Type	Description
Experiment.ParentLinkData

ProfileId

View (Profile) ID to which this experiment belongs. This field is read-only.

Declaration

[JsonProperty("profileId")]
public virtual string ProfileId { get; set; }

Property Value

Type	Description
string

ReasonExperimentEnded

Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.

Declaration

[JsonProperty("reasonExperimentEnded")]
public virtual string ReasonExperimentEnded { get; set; }

Property Value

Type	Description
string

RewriteVariationUrlsAsOriginal

Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.

Declaration

[JsonProperty("rewriteVariationUrlsAsOriginal")]
public virtual bool? RewriteVariationUrlsAsOriginal { get; set; }

Property Value

Type	Description
bool?

SelfLink

Link for this experiment. This field is read-only.

Declaration

[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }

Property Value

Type	Description
string

ServingFramework

The framework used to serve the experiment variations and evaluate the results. One of: - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.

Declaration

[JsonProperty("servingFramework")]
public virtual string ServingFramework { get; set; }

Property Value

Type	Description
string

Snippet

The snippet of code to include on the control page(s). This field is read-only.

Declaration

[JsonProperty("snippet")]
public virtual string Snippet { get; set; }

Property Value

Type	Description
string

StartTime

DateTime representation of StartTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual DateTime? StartTime { get; set; }

Property Value

Type	Description
DateTime?

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

StartTimeRaw

The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.

Declaration

[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }

Property Value

Type	Description
string

Status

Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.

Declaration

[JsonProperty("status")]
public virtual string Status { get; set; }

Property Value

Type	Description
string

TrafficCoverage

A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.

Declaration

[JsonProperty("trafficCoverage")]
public virtual double? TrafficCoverage { get; set; }

Property Value

Type	Description
double?

Updated

DateTime representation of UpdatedRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdatedDateTimeOffset instead.")]
public virtual DateTime? Updated { get; set; }

Property Value

Type	Description
DateTime?

UpdatedDateTimeOffset

DateTimeOffset representation of UpdatedRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdatedDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdatedRaw

Time the experiment was last modified. This field is read-only.

Declaration

[JsonProperty("updated")]
public virtual string UpdatedRaw { get; set; }

Property Value

Type	Description
string

Variations

Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.

Declaration

[JsonProperty("variations")]
public virtual IList<Experiment.VariationsData> Variations { get; set; }

Property Value

Type	Description
IList<Experiment.VariationsData>

WebPropertyId

Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.

Declaration

[JsonProperty("webPropertyId")]
public virtual string WebPropertyId { get; set; }

Property Value

Type	Description
string

WinnerConfidenceLevel

A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.

Declaration

[JsonProperty("winnerConfidenceLevel")]
public virtual double? WinnerConfidenceLevel { get; set; }

Property Value

Type	Description
double?

WinnerFound

Boolean specifying whether a winner has been found for this experiment. This field is read-only.

Declaration

[JsonProperty("winnerFound")]
public virtual bool? WinnerFound { get; set; }

Property Value

Type	Description
bool?

Implements

IDirectResponseSchema