#include <experiment.h>

Inheritance diagram for google_analytics_api::Experiment:

Classes
class	ExperimentParentLink

class	ExperimentVariations

Public Member Functions
	Experiment (const Json::Value &storage)

	Experiment (Json::Value *storage)

virtual	~Experiment ()

const StringPiece	GetTypeName () const

bool	has_account_id () const

void	clear_account_id ()

const StringPiece	get_account_id () const

void	set_account_id (const StringPiece &value)

bool	has_created () const

void	clear_created ()

client::DateTime	get_created () const

void	set_created (client::DateTime value)

bool	has_description () const

void	clear_description ()

const StringPiece	get_description () const

void	set_description (const StringPiece &value)

bool	has_editable_in_ga_ui () const

void	clear_editable_in_ga_ui ()

bool	get_editable_in_ga_ui () const

void	set_editable_in_ga_ui (bool value)

bool	has_end_time () const

void	clear_end_time ()

client::DateTime	get_end_time () const

void	set_end_time (client::DateTime value)

bool	has_equal_weighting () const

void	clear_equal_weighting ()

bool	get_equal_weighting () const

void	set_equal_weighting (bool value)

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_internal_web_property_id () const

void	clear_internal_web_property_id ()

const StringPiece	get_internal_web_property_id () const

void	set_internal_web_property_id (const StringPiece &value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_minimum_experiment_length_in_days () const

void	clear_minimum_experiment_length_in_days ()

int32	get_minimum_experiment_length_in_days () const

void	set_minimum_experiment_length_in_days (int32 value)

bool	has_name () const

void	clear_name ()

const StringPiece	get_name () const

void	set_name (const StringPiece &value)

bool	has_objective_metric () const

void	clear_objective_metric ()

const StringPiece	get_objective_metric () const

void	set_objective_metric (const StringPiece &value)

bool	has_optimization_type () const

void	clear_optimization_type ()

const StringPiece	get_optimization_type () const

void	set_optimization_type (const StringPiece &value)

bool	has_parent_link () const

void	clear_parent_link ()

const ExperimentParentLink	get_parent_link () const

ExperimentParentLink	mutable_parentLink ()

bool	has_profile_id () const

void	clear_profile_id ()

const StringPiece	get_profile_id () const

void	set_profile_id (const StringPiece &value)

bool	has_reason_experiment_ended () const

void	clear_reason_experiment_ended ()

const StringPiece	get_reason_experiment_ended () const

void	set_reason_experiment_ended (const StringPiece &value)

bool	has_rewrite_variation_urls_as_original () const

void	clear_rewrite_variation_urls_as_original ()

bool	get_rewrite_variation_urls_as_original () const

void	set_rewrite_variation_urls_as_original (bool value)

bool	has_self_link () const

void	clear_self_link ()

const StringPiece	get_self_link () const

void	set_self_link (const StringPiece &value)

bool	has_serving_framework () const

void	clear_serving_framework ()

const StringPiece	get_serving_framework () const

void	set_serving_framework (const StringPiece &value)

bool	has_snippet () const

void	clear_snippet ()

const StringPiece	get_snippet () const

void	set_snippet (const StringPiece &value)

bool	has_start_time () const

void	clear_start_time ()

client::DateTime	get_start_time () const

void	set_start_time (client::DateTime value)

bool	has_status () const

void	clear_status ()

const StringPiece	get_status () const

void	set_status (const StringPiece &value)

bool	has_traffic_coverage () const

void	clear_traffic_coverage ()

double	get_traffic_coverage () const

void	set_traffic_coverage (double value)

bool	has_updated () const

void	clear_updated ()

client::DateTime	get_updated () const

void	set_updated (client::DateTime value)

bool	has_variations () const

void	clear_variations ()

const client::JsonCppArray< ExperimentVariations >	get_variations () const

client::JsonCppArray< ExperimentVariations >	mutable_variations ()

bool	has_web_property_id () const

void	clear_web_property_id ()

const StringPiece	get_web_property_id () const

void	set_web_property_id (const StringPiece &value)

bool	has_winner_confidence_level () const

void	clear_winner_confidence_level ()

double	get_winner_confidence_level () const

void	set_winner_confidence_level (double value)

bool	has_winner_found () const

void	clear_winner_found ()

bool	get_winner_found () const

void	set_winner_found (bool value)

Static Public Member Functions
static Experiment *	New ()

Detailed Description

JSON template for Analytics experiment resource.

Constructor & Destructor Documentation

◆ Experiment() [1/2]

google_analytics_api::Experiment::Experiment ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ Experiment() [2/2]

google_analytics_api::Experiment::Experiment ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~Experiment()

google_analytics_api::Experiment::~Experiment ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_account_id()

void google_analytics_api::Experiment::clear_account_id ( )

inline

Clears the 'accountId' attribute.

◆ clear_created()

void google_analytics_api::Experiment::clear_created ( )

inline

Clears the 'created' attribute.

◆ clear_description()

void google_analytics_api::Experiment::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_editable_in_ga_ui()

void google_analytics_api::Experiment::clear_editable_in_ga_ui ( )

inline

Clears the 'editableInGaUi' attribute.

◆ clear_end_time()

void google_analytics_api::Experiment::clear_end_time ( )

inline

Clears the 'endTime' attribute.

◆ clear_equal_weighting()

void google_analytics_api::Experiment::clear_equal_weighting ( )

inline

Clears the 'equalWeighting' attribute.

◆ clear_id()

void google_analytics_api::Experiment::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_internal_web_property_id()

void google_analytics_api::Experiment::clear_internal_web_property_id ( )

inline

Clears the 'internalWebPropertyId' attribute.

◆ clear_kind()

void google_analytics_api::Experiment::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_minimum_experiment_length_in_days()

void google_analytics_api::Experiment::clear_minimum_experiment_length_in_days ( )

inline

Clears the 'minimumExperimentLengthInDays' attribute.

◆ clear_name()

void google_analytics_api::Experiment::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_objective_metric()

void google_analytics_api::Experiment::clear_objective_metric ( )

inline

Clears the 'objectiveMetric' attribute.

◆ clear_optimization_type()

void google_analytics_api::Experiment::clear_optimization_type ( )

inline

Clears the 'optimizationType' attribute.

◆ clear_parent_link()

void google_analytics_api::Experiment::clear_parent_link ( )

inline

Clears the 'parentLink' attribute.

◆ clear_profile_id()

void google_analytics_api::Experiment::clear_profile_id ( )

inline

Clears the 'profileId' attribute.

◆ clear_reason_experiment_ended()

void google_analytics_api::Experiment::clear_reason_experiment_ended ( )

inline

Clears the 'reasonExperimentEnded' attribute.

◆ clear_rewrite_variation_urls_as_original()

void google_analytics_api::Experiment::clear_rewrite_variation_urls_as_original ( )

inline

Clears the 'rewriteVariationUrlsAsOriginal' attribute.

◆ clear_self_link()

void google_analytics_api::Experiment::clear_self_link ( )

inline

Clears the 'selfLink' attribute.

◆ clear_serving_framework()

void google_analytics_api::Experiment::clear_serving_framework ( )

inline

Clears the 'servingFramework' attribute.

◆ clear_snippet()

void google_analytics_api::Experiment::clear_snippet ( )

inline

Clears the 'snippet' attribute.

◆ clear_start_time()

void google_analytics_api::Experiment::clear_start_time ( )

inline

Clears the 'startTime' attribute.

◆ clear_status()

void google_analytics_api::Experiment::clear_status ( )

inline

Clears the 'status' attribute.

◆ clear_traffic_coverage()

void google_analytics_api::Experiment::clear_traffic_coverage ( )

inline

Clears the 'trafficCoverage' attribute.

◆ clear_updated()

void google_analytics_api::Experiment::clear_updated ( )

inline

Clears the 'updated' attribute.

◆ clear_variations()

void google_analytics_api::Experiment::clear_variations ( )

inline

Clears the 'variations' attribute.

◆ clear_web_property_id()

void google_analytics_api::Experiment::clear_web_property_id ( )

inline

Clears the 'webPropertyId' attribute.

◆ clear_winner_confidence_level()

void google_analytics_api::Experiment::clear_winner_confidence_level ( )

inline

Clears the 'winnerConfidenceLevel' attribute.

◆ clear_winner_found()

void google_analytics_api::Experiment::clear_winner_found ( )

inline

Clears the 'winnerFound' attribute.

◆ get_account_id()

const StringPiece google_analytics_api::Experiment::get_account_id ( ) const

inline

Get the value of the 'accountId' attribute.

◆ get_created()

client::DateTime google_analytics_api::Experiment::get_created ( ) const

inline

Get the value of the 'created' attribute.

◆ get_description()

const StringPiece google_analytics_api::Experiment::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_editable_in_ga_ui()

bool google_analytics_api::Experiment::get_editable_in_ga_ui ( ) const

inline

Get the value of the 'editableInGaUi' attribute.

◆ get_end_time()

client::DateTime google_analytics_api::Experiment::get_end_time ( ) const

inline

Get the value of the 'endTime' attribute.

◆ get_equal_weighting()

bool google_analytics_api::Experiment::get_equal_weighting ( ) const

inline

Get the value of the 'equalWeighting' attribute.

◆ get_id()

const StringPiece google_analytics_api::Experiment::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_internal_web_property_id()

const StringPiece google_analytics_api::Experiment::get_internal_web_property_id ( ) const

inline

Get the value of the 'internalWebPropertyId' attribute.

◆ get_kind()

const StringPiece google_analytics_api::Experiment::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_minimum_experiment_length_in_days()

int32 google_analytics_api::Experiment::get_minimum_experiment_length_in_days ( ) const

inline

Get the value of the 'minimumExperimentLengthInDays' attribute.

◆ get_name()

const StringPiece google_analytics_api::Experiment::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_objective_metric()

const StringPiece google_analytics_api::Experiment::get_objective_metric ( ) const

inline

Get the value of the 'objectiveMetric' attribute.

◆ get_optimization_type()

const StringPiece google_analytics_api::Experiment::get_optimization_type ( ) const

inline

Get the value of the 'optimizationType' attribute.

◆ get_parent_link()

const ExperimentParentLink google_analytics_api::Experiment::get_parent_link ( ) const

inline

Get a reference to the value of the 'parentLink' attribute.

◆ get_profile_id()

const StringPiece google_analytics_api::Experiment::get_profile_id ( ) const

inline

Get the value of the 'profileId' attribute.

◆ get_reason_experiment_ended()

const StringPiece google_analytics_api::Experiment::get_reason_experiment_ended ( ) const

inline

Get the value of the 'reasonExperimentEnded' attribute.

◆ get_rewrite_variation_urls_as_original()

bool google_analytics_api::Experiment::get_rewrite_variation_urls_as_original ( ) const

inline

Get the value of the 'rewriteVariationUrlsAsOriginal' attribute.

◆ get_self_link()

const StringPiece google_analytics_api::Experiment::get_self_link ( ) const

inline

Get the value of the 'selfLink' attribute.

◆ get_serving_framework()

const StringPiece google_analytics_api::Experiment::get_serving_framework ( ) const

inline

Get the value of the 'servingFramework' attribute.

◆ get_snippet()

const StringPiece google_analytics_api::Experiment::get_snippet ( ) const

inline

Get the value of the 'snippet' attribute.

◆ get_start_time()

client::DateTime google_analytics_api::Experiment::get_start_time ( ) const

inline

Get the value of the 'startTime' attribute.

◆ get_status()

const StringPiece google_analytics_api::Experiment::get_status ( ) const

inline

Get the value of the 'status' attribute.

◆ get_traffic_coverage()

double google_analytics_api::Experiment::get_traffic_coverage ( ) const

inline

Get the value of the 'trafficCoverage' attribute.

◆ get_updated()

client::DateTime google_analytics_api::Experiment::get_updated ( ) const

inline

Get the value of the 'updated' attribute.

◆ get_variations()

const client::JsonCppArray<ExperimentVariations > google_analytics_api::Experiment::get_variations ( ) const

inline

Get a reference to the value of the 'variations' attribute.

◆ get_web_property_id()

const StringPiece google_analytics_api::Experiment::get_web_property_id ( ) const

inline

Get the value of the 'webPropertyId' attribute.

◆ get_winner_confidence_level()

double google_analytics_api::Experiment::get_winner_confidence_level ( ) const

inline

Get the value of the 'winnerConfidenceLevel' attribute.

◆ get_winner_found()

bool google_analytics_api::Experiment::get_winner_found ( ) const

inline

Get the value of the 'winnerFound' attribute.

◆ GetTypeName()

const StringPiece google_analytics_api::Experiment::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_analytics_api::Experiment

◆ has_account_id()

bool google_analytics_api::Experiment::has_account_id ( ) const

inline

Determine if the 'accountId' attribute was set.

Returns: true if the 'accountId' attribute was set.

◆ has_created()

bool google_analytics_api::Experiment::has_created ( ) const

inline

Determine if the 'created' attribute was set.

Returns: true if the 'created' attribute was set.

◆ has_description()

bool google_analytics_api::Experiment::has_description ( ) const

inline

Determine if the 'description' attribute was set.

Returns: true if the 'description' attribute was set.

◆ has_editable_in_ga_ui()

bool google_analytics_api::Experiment::has_editable_in_ga_ui ( ) const

inline

Determine if the 'editableInGaUi' attribute was set.

Returns: true if the 'editableInGaUi' attribute was set.

◆ has_end_time()

bool google_analytics_api::Experiment::has_end_time ( ) const

inline

Determine if the 'endTime' attribute was set.

Returns: true if the 'endTime' attribute was set.

◆ has_equal_weighting()

bool google_analytics_api::Experiment::has_equal_weighting ( ) const

inline

Determine if the 'equalWeighting' attribute was set.

Returns: true if the 'equalWeighting' attribute was set.

◆ has_id()

bool google_analytics_api::Experiment::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_internal_web_property_id()

bool google_analytics_api::Experiment::has_internal_web_property_id ( ) const

inline

Determine if the 'internalWebPropertyId' attribute was set.

Returns: true if the 'internalWebPropertyId' attribute was set.

◆ has_kind()

bool google_analytics_api::Experiment::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_minimum_experiment_length_in_days()

bool google_analytics_api::Experiment::has_minimum_experiment_length_in_days ( ) const

inline

Determine if the 'minimumExperimentLengthInDays' attribute was set.

Returns: true if the 'minimumExperimentLengthInDays' attribute was set.

◆ has_name()

bool google_analytics_api::Experiment::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns: true if the 'name' attribute was set.

◆ has_objective_metric()

bool google_analytics_api::Experiment::has_objective_metric ( ) const

inline

Determine if the 'objectiveMetric' attribute was set.

Returns: true if the 'objectiveMetric' attribute was set.

◆ has_optimization_type()

bool google_analytics_api::Experiment::has_optimization_type ( ) const

inline

Determine if the 'optimizationType' attribute was set.

Returns: true if the 'optimizationType' attribute was set.

◆ has_parent_link()

bool google_analytics_api::Experiment::has_parent_link ( ) const

inline

Determine if the 'parentLink' attribute was set.

Returns: true if the 'parentLink' attribute was set.

◆ has_profile_id()

bool google_analytics_api::Experiment::has_profile_id ( ) const

inline

Determine if the 'profileId' attribute was set.

Returns: true if the 'profileId' attribute was set.

◆ has_reason_experiment_ended()

bool google_analytics_api::Experiment::has_reason_experiment_ended ( ) const

inline

Determine if the 'reasonExperimentEnded' attribute was set.

Returns: true if the 'reasonExperimentEnded' attribute was set.

◆ has_rewrite_variation_urls_as_original()

bool google_analytics_api::Experiment::has_rewrite_variation_urls_as_original ( ) const

inline

Determine if the 'rewriteVariationUrlsAsOriginal' attribute was set.

Returns: true if the 'rewriteVariationUrlsAsOriginal' attribute was set.

◆ has_self_link()

bool google_analytics_api::Experiment::has_self_link ( ) const

inline

Determine if the 'selfLink' attribute was set.

Returns: true if the 'selfLink' attribute was set.

◆ has_serving_framework()

bool google_analytics_api::Experiment::has_serving_framework ( ) const

inline

Determine if the 'servingFramework' attribute was set.

Returns: true if the 'servingFramework' attribute was set.

◆ has_snippet()

bool google_analytics_api::Experiment::has_snippet ( ) const

inline

Determine if the 'snippet' attribute was set.

Returns: true if the 'snippet' attribute was set.

◆ has_start_time()

bool google_analytics_api::Experiment::has_start_time ( ) const

inline

Determine if the 'startTime' attribute was set.

Returns: true if the 'startTime' attribute was set.

◆ has_status()

bool google_analytics_api::Experiment::has_status ( ) const

inline

Determine if the 'status' attribute was set.

Returns: true if the 'status' attribute was set.

◆ has_traffic_coverage()

bool google_analytics_api::Experiment::has_traffic_coverage ( ) const

inline

Determine if the 'trafficCoverage' attribute was set.

Returns: true if the 'trafficCoverage' attribute was set.

◆ has_updated()

bool google_analytics_api::Experiment::has_updated ( ) const

inline

Determine if the 'updated' attribute was set.

Returns: true if the 'updated' attribute was set.

◆ has_variations()

bool google_analytics_api::Experiment::has_variations ( ) const

inline

Determine if the 'variations' attribute was set.

Returns: true if the 'variations' attribute was set.

◆ has_web_property_id()

bool google_analytics_api::Experiment::has_web_property_id ( ) const

inline

Determine if the 'webPropertyId' attribute was set.

Returns: true if the 'webPropertyId' attribute was set.

◆ has_winner_confidence_level()

bool google_analytics_api::Experiment::has_winner_confidence_level ( ) const

inline

Determine if the 'winnerConfidenceLevel' attribute was set.

Returns: true if the 'winnerConfidenceLevel' attribute was set.

◆ has_winner_found()

bool google_analytics_api::Experiment::has_winner_found ( ) const

inline

Determine if the 'winnerFound' attribute was set.

Returns: true if the 'winnerFound' attribute was set.

◆ mutable_parentLink()

ExperimentParentLink google_analytics_api::Experiment::mutable_parentLink ( )

inline

Gets a reference to a mutable value of the 'parentLink' property.

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

Returns: The result can be modified to change the attribute value.

◆ mutable_variations()

client::JsonCppArray<ExperimentVariations > google_analytics_api::Experiment::mutable_variations ( )

inline

Gets a reference to a mutable value of the 'variations' property.

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.

Returns: The result can be modified to change the attribute value.

◆ New()

Experiment * google_analytics_api::Experiment::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_account_id()

void google_analytics_api::Experiment::set_account_id ( const StringPiece & value )

inline

Change the 'accountId' attribute.

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

Parameters

[in] value The new value.

◆ set_created()

void google_analytics_api::Experiment::set_created ( client::DateTime value )

inline

Change the 'created' attribute.

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

Parameters

[in] value The new value.

◆ set_description()

void google_analytics_api::Experiment::set_description ( const StringPiece & value )

inline

Change the 'description' attribute.

Notes about this experiment.

Parameters

[in] value The new value.

◆ set_editable_in_ga_ui()

void google_analytics_api::Experiment::set_editable_in_ga_ui ( bool value )

inline

Change the 'editableInGaUi' attribute.

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

Parameters

[in] value The new value.

◆ set_end_time()

void google_analytics_api::Experiment::set_end_time ( client::DateTime value )

inline

Change the 'endTime' attribute.

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.

Parameters

[in] value The new value.

◆ set_equal_weighting()

void google_analytics_api::Experiment::set_equal_weighting ( bool value )

inline

Change the 'equalWeighting' attribute.

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.

Parameters

[in] value The new value.

◆ set_id()

void google_analytics_api::Experiment::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

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

Parameters

[in] value The new value.

◆ set_internal_web_property_id()

void google_analytics_api::Experiment::set_internal_web_property_id ( const StringPiece & value )

inline

Change the 'internalWebPropertyId' attribute.

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

Parameters

[in] value The new value.

◆ set_kind()

void google_analytics_api::Experiment::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

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

Parameters

[in] value The new value.

◆ set_minimum_experiment_length_in_days()

void google_analytics_api::Experiment::set_minimum_experiment_length_in_days ( int32 value )

inline

Change the 'minimumExperimentLengthInDays' attribute.

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.

Parameters

[in] value The new value.

◆ set_name()

void google_analytics_api::Experiment::set_name ( const StringPiece & value )

inline

Change the 'name' attribute.

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

Parameters

[in] value The new value.

◆ set_objective_metric()

void google_analytics_api::Experiment::set_objective_metric ( const StringPiece & value )

inline

Change the 'objectiveMetric' attribute.

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

Parameters

[in] value The new value.

◆ set_optimization_type()

void google_analytics_api::Experiment::set_optimization_type ( const StringPiece & value )

inline

Change the 'optimizationType' attribute.

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

Parameters

[in] value The new value.

◆ set_profile_id()

void google_analytics_api::Experiment::set_profile_id ( const StringPiece & value )

inline

Change the 'profileId' attribute.

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

Parameters

[in] value The new value.

◆ set_reason_experiment_ended()

void google_analytics_api::Experiment::set_reason_experiment_ended ( const StringPiece & value )

inline

Change the 'reasonExperimentEnded' attribute.

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.

Parameters

[in] value The new value.

◆ set_rewrite_variation_urls_as_original()

void google_analytics_api::Experiment::set_rewrite_variation_urls_as_original ( bool value )

inline

Change the 'rewriteVariationUrlsAsOriginal' attribute.

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.

Parameters

[in] value The new value.

◆ set_self_link()

void google_analytics_api::Experiment::set_self_link ( const StringPiece & value )

inline

Change the 'selfLink' attribute.

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

Parameters

[in] value The new value.

◆ set_serving_framework()

void google_analytics_api::Experiment::set_serving_framework ( const StringPiece & value )

inline

Change the 'servingFramework' attribute.

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.

Parameters

[in] value The new value.

◆ set_snippet()

void google_analytics_api::Experiment::set_snippet ( const StringPiece & value )

inline

Change the 'snippet' attribute.

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

Parameters

[in] value The new value.

◆ set_start_time()

void google_analytics_api::Experiment::set_start_time ( client::DateTime value )

inline

Change the 'startTime' attribute.

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.

Parameters

[in] value The new value.

◆ set_status()

void google_analytics_api::Experiment::set_status ( const StringPiece & value )

inline

Change the 'status' attribute.

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.

Parameters

[in] value The new value.

◆ set_traffic_coverage()

void google_analytics_api::Experiment::set_traffic_coverage ( double value )

inline

Change the 'trafficCoverage' attribute.

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.

Parameters

[in] value The new value.

◆ set_updated()

void google_analytics_api::Experiment::set_updated ( client::DateTime value )

inline

Change the 'updated' attribute.

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

Parameters

[in] value The new value.

◆ set_web_property_id()

void google_analytics_api::Experiment::set_web_property_id ( const StringPiece & value )

inline

Change the 'webPropertyId' attribute.

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

Parameters

[in] value The new value.

◆ set_winner_confidence_level()

void google_analytics_api::Experiment::set_winner_confidence_level ( double value )

inline

Change the 'winnerConfidenceLevel' attribute.

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.

Parameters

[in] value The new value.

◆ set_winner_found()

void google_analytics_api::Experiment::set_winner_found ( bool value )

inline

Change the 'winnerFound' attribute.

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

Parameters

[in] value The new value.

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

google/analytics_api/experiment.h
google/analytics_api/experiment.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Experiment() [1/2]

◆ Experiment() [2/2]

◆ ~Experiment()

Member Function Documentation

◆ clear_account_id()

◆ clear_created()

◆ clear_description()

◆ clear_editable_in_ga_ui()

◆ clear_end_time()

◆ clear_equal_weighting()

◆ clear_id()

◆ clear_internal_web_property_id()

◆ clear_kind()

◆ clear_minimum_experiment_length_in_days()

◆ clear_name()

◆ clear_objective_metric()

◆ clear_optimization_type()

◆ clear_parent_link()

◆ clear_profile_id()

◆ clear_reason_experiment_ended()

◆ clear_rewrite_variation_urls_as_original()

◆ clear_self_link()

◆ clear_serving_framework()

◆ clear_snippet()

◆ clear_start_time()

◆ clear_status()

◆ clear_traffic_coverage()

◆ clear_updated()

◆ clear_variations()

◆ clear_web_property_id()

◆ clear_winner_confidence_level()

◆ clear_winner_found()

◆ get_account_id()

◆ get_created()

◆ get_description()

◆ get_editable_in_ga_ui()

◆ get_end_time()

◆ get_equal_weighting()

◆ get_id()

◆ get_internal_web_property_id()

◆ get_kind()

◆ get_minimum_experiment_length_in_days()

◆ get_name()

◆ get_objective_metric()

◆ get_optimization_type()

◆ get_parent_link()

◆ get_profile_id()

◆ get_reason_experiment_ended()

◆ get_rewrite_variation_urls_as_original()

◆ get_self_link()

◆ get_serving_framework()

◆ get_snippet()

◆ get_start_time()

◆ get_status()

◆ get_traffic_coverage()

◆ get_updated()

◆ get_variations()

◆ get_web_property_id()

◆ get_winner_confidence_level()

◆ get_winner_found()

◆ GetTypeName()

◆ has_account_id()

◆ has_created()

◆ has_description()

◆ has_editable_in_ga_ui()

◆ has_end_time()

◆ has_equal_weighting()

◆ has_id()

◆ has_internal_web_property_id()

◆ has_kind()

◆ has_minimum_experiment_length_in_days()

◆ has_name()

◆ has_objective_metric()

◆ has_optimization_type()

◆ has_parent_link()