analytics  v3
Classes | Properties | List of all members
Google.Apis.Analytics.v3.Data.Experiment Class Reference

JSON template for Analytics experiment resource. More...

Inheritance diagram for Google.Apis.Analytics.v3.Data.Experiment:
Google::Apis::Requests::IDirectResponseSchema

Classes

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

Properties

virtual string AccountId [get, set]
 Account ID to which this experiment belongs. This field is read-only. More...
 
virtual string CreatedRaw [get, set]
 Time the experiment was created. This field is read-only. More...
 
virtual System.Nullable< System.DateTime > Created [get, set]
 
See also
System.DateTime

representation of CreatedRaw. More...

 
virtual string Description [get, set]
 Notes about this experiment. More...
 
virtual System.Nullable< bool > EditableInGaUi [get, set]
 If true, the end user will be able to edit the experiment via the Google Analytics user interface. More...
 
virtual string EndTimeRaw [get, set]
 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. More...
 
virtual System.Nullable< System.DateTime > EndTime [get, set]
 
See also
System.DateTime

representation of EndTimeRaw. More...

 
virtual System.Nullable< bool > EqualWeighting [get, set]
 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. More...
 
virtual string Id [get, set]
 Experiment ID. Required for patch and update. Disallowed for create. More...
 
virtual string InternalWebPropertyId [get, set]
 Internal ID for the web property to which this experiment belongs. This field is read- only. More...
 
virtual string Kind [get, set]
 Resource type for an Analytics experiment. This field is read-only. More...
 
virtual System.Nullable< int > MinimumExperimentLengthInDays [get, set]
 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. More...
 
virtual string Name [get, set]
 Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment. More...
 
virtual string ObjectiveMetric [get, set]
 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". More...
 
virtual string OptimizationType [get, set]
 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". More...
 
virtual Experiment.ParentLinkData ParentLink [get, set]
 Parent link for an experiment. Points to the view (profile) to which this experiment belongs. More...
 
virtual string ProfileId [get, set]
 View (Profile) ID to which this experiment belongs. This field is read-only. More...
 
virtual string ReasonExperimentEnded [get, set]
 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. More...
 
virtual System.Nullable< bool > RewriteVariationUrlsAsOriginal [get, set]
 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. More...
 
virtual string SelfLink [get, set]
 Link for this experiment. This field is read-only. More...
 
virtual string ServingFramework [get, set]
 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. More...
 
virtual string Snippet [get, set]
 The snippet of code to include on the control page(s). This field is read-only. More...
 
virtual string StartTimeRaw [get, set]
 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. More...
 
virtual System.Nullable< System.DateTime > StartTime [get, set]
 
See also
System.DateTime

representation of StartTimeRaw. More...

 
virtual string Status [get, set]
 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. More...
 
virtual System.Nullable< double > TrafficCoverage [get, set]
 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. More...
 
virtual string UpdatedRaw [get, set]
 Time the experiment was last modified. This field is read-only. More...
 
virtual System.Nullable< System.DateTime > Updated [get, set]
 
See also
System.DateTime

representation of UpdatedRaw. More...

 
virtual System.Collections.Generic.IList< Experiment.VariationsDataVariations [get, set]
 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. More...
 
virtual string WebPropertyId [get, set]
 Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only. More...
 
virtual System.Nullable< double > WinnerConfidenceLevel [get, set]
 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. More...
 
virtual System.Nullable< bool > WinnerFound [get, set]
 Boolean specifying whether a winner has been found for this experiment. This field is read- only. More...
 
virtual string ETag [get, set]
 The ETag of the item. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

JSON template for Analytics experiment resource.

Property Documentation

◆ AccountId

virtual string Google.Apis.Analytics.v3.Data.Experiment.AccountId
getset

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

◆ Created

virtual System.Nullable<System.DateTime> Google.Apis.Analytics.v3.Data.Experiment.Created
getset

See also
System.DateTime

representation of CreatedRaw.

◆ CreatedRaw

virtual string Google.Apis.Analytics.v3.Data.Experiment.CreatedRaw
getset

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

◆ Description

virtual string Google.Apis.Analytics.v3.Data.Experiment.Description
getset

Notes about this experiment.

◆ EditableInGaUi

virtual System.Nullable<bool> Google.Apis.Analytics.v3.Data.Experiment.EditableInGaUi
getset

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

◆ EndTime

virtual System.Nullable<System.DateTime> Google.Apis.Analytics.v3.Data.Experiment.EndTime
getset

See also
System.DateTime

representation of EndTimeRaw.

◆ EndTimeRaw

virtual string Google.Apis.Analytics.v3.Data.Experiment.EndTimeRaw
getset

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.

◆ EqualWeighting

virtual System.Nullable<bool> Google.Apis.Analytics.v3.Data.Experiment.EqualWeighting
getset

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.

◆ ETag

virtual string Google.Apis.Analytics.v3.Data.Experiment.ETag
getset

The ETag of the item.

◆ Id

virtual string Google.Apis.Analytics.v3.Data.Experiment.Id
getset

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

◆ InternalWebPropertyId

virtual string Google.Apis.Analytics.v3.Data.Experiment.InternalWebPropertyId
getset

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

◆ Kind

virtual string Google.Apis.Analytics.v3.Data.Experiment.Kind
getset

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

◆ MinimumExperimentLengthInDays

virtual System.Nullable<int> Google.Apis.Analytics.v3.Data.Experiment.MinimumExperimentLengthInDays
getset

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.

◆ Name

virtual string Google.Apis.Analytics.v3.Data.Experiment.Name
getset

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

◆ ObjectiveMetric

virtual string Google.Apis.Analytics.v3.Data.Experiment.ObjectiveMetric
getset

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

◆ OptimizationType

virtual string Google.Apis.Analytics.v3.Data.Experiment.OptimizationType
getset

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

◆ ParentLink

virtual Experiment.ParentLinkData Google.Apis.Analytics.v3.Data.Experiment.ParentLink
getset

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

◆ ProfileId

virtual string Google.Apis.Analytics.v3.Data.Experiment.ProfileId
getset

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

◆ ReasonExperimentEnded

virtual string Google.Apis.Analytics.v3.Data.Experiment.ReasonExperimentEnded
getset

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.

◆ RewriteVariationUrlsAsOriginal

virtual System.Nullable<bool> Google.Apis.Analytics.v3.Data.Experiment.RewriteVariationUrlsAsOriginal
getset

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.

◆ SelfLink

virtual string Google.Apis.Analytics.v3.Data.Experiment.SelfLink
getset

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

◆ ServingFramework

virtual string Google.Apis.Analytics.v3.Data.Experiment.ServingFramework
getset

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.

◆ Snippet

virtual string Google.Apis.Analytics.v3.Data.Experiment.Snippet
getset

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

◆ StartTime

virtual System.Nullable<System.DateTime> Google.Apis.Analytics.v3.Data.Experiment.StartTime
getset

See also
System.DateTime

representation of StartTimeRaw.

◆ StartTimeRaw

virtual string Google.Apis.Analytics.v3.Data.Experiment.StartTimeRaw
getset

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.

◆ Status

virtual string Google.Apis.Analytics.v3.Data.Experiment.Status
getset

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.

◆ TrafficCoverage

virtual System.Nullable<double> Google.Apis.Analytics.v3.Data.Experiment.TrafficCoverage
getset

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.

◆ Updated

virtual System.Nullable<System.DateTime> Google.Apis.Analytics.v3.Data.Experiment.Updated
getset

See also
System.DateTime

representation of UpdatedRaw.

◆ UpdatedRaw

virtual string Google.Apis.Analytics.v3.Data.Experiment.UpdatedRaw
getset

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

◆ Variations

virtual System.Collections.Generic.IList<Experiment.VariationsData> Google.Apis.Analytics.v3.Data.Experiment.Variations
getset

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.

◆ WebPropertyId

virtual string Google.Apis.Analytics.v3.Data.Experiment.WebPropertyId
getset

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

◆ WinnerConfidenceLevel

virtual System.Nullable<double> Google.Apis.Analytics.v3.Data.Experiment.WinnerConfidenceLevel
getset

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.

◆ WinnerFound

virtual System.Nullable<bool> Google.Apis.Analytics.v3.Data.Experiment.WinnerFound
getset

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


The documentation for this class was generated from the following file: