Struct google_analytics3::api::Experiment [−][src]
JSON template for Analytics experiment resource.
Activities
This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).
- experiments get management (response)
- experiments insert management (request|response)
- experiments patch management (request|response)
- experiments update management (request|response)
Fields
account_id: Option<String>
Account ID to which this experiment belongs. This field is read-only.
created: Option<String>
Time the experiment was created. This field is read-only.
description: Option<String>
Notes about this experiment.
editable_in_ga_ui: Option<bool>
If true, the end user will be able to edit the experiment via the Google Analytics user interface.
end_time: Option<String>
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.
equal_weighting: Option<bool>
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.
id: Option<String>
Experiment ID. Required for patch and update. Disallowed for create.
internal_web_property_id: Option<String>
Internal ID for the web property to which this experiment belongs. This field is read-only.
kind: Option<String>
Resource type for an Analytics experiment. This field is read-only.
minimum_experiment_length_in_days: Option<i32>
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: Option<String>
Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
objective_metric: Option<String>
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”.
optimization_type: Option<String>
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”.
parent_link: Option<ExperimentParentLink>
Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
profile_id: Option<String>
View (Profile) ID to which this experiment belongs. This field is read-only.
reason_experiment_ended: Option<String>
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.
rewrite_variation_urls_as_original: Option<bool>
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.
self_link: Option<String>
Link for this experiment. This field is read-only.
serving_framework: Option<String>
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: Option<String>
The snippet of code to include on the control page(s). This field is read-only.
start_time: Option<String>
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: Option<String>
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.
traffic_coverage: Option<f64>
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: Option<String>
Time the experiment was last modified. This field is read-only.
variations: Option<Vec<ExperimentVariations>>
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.
web_property_id: Option<String>
Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
winner_confidence_level: Option<f64>
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.
winner_found: Option<bool>
Boolean specifying whether a winner has been found for this experiment. This field is read-only.
Trait Implementations
impl Clone for Experiment
[src]
fn clone(&self) -> Experiment
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for Experiment
[src]
impl Default for Experiment
[src]
fn default() -> Experiment
[src]
impl<'de> Deserialize<'de> for Experiment
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl RequestValue for Experiment
[src]
impl ResponseResult for Experiment
[src]
impl Serialize for Experiment
[src]
Auto Trait Implementations
impl RefUnwindSafe for Experiment
impl Send for Experiment
impl Sync for Experiment
impl Unpin for Experiment
impl UnwindSafe for Experiment
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,