Class: Google::Apis::AnalyticsV3::Experiment::Variation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/analytics_v3/classes.rb,
generated/google/apis/analytics_v3/representations.rb,
generated/google/apis/analytics_v3/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Variation

Returns a new instance of Variation



1936
1937
1938
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1936

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#name ⇒ String

The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED. Corresponds to the JSON property name

Returns:

  • (String) 


1908
1909
1910
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1908

def name
  @name
end

#status ⇒ String

Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED. Corresponds to the JSON property status

Returns:

  • (String) 


1915
1916
1917
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1915

def status
  @status
end

#url ⇒ String

The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED. Corresponds to the JSON property url

Returns:

  • (String) 


1921
1922
1923
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1921

def url
  @url
end

#weight ⇒ Float

Weight that this variation should receive. Only present if the experiment is running. This field is read-only. Corresponds to the JSON property weight

Returns:

  • (Float) 


1927
1928
1929
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1927

def weight
  @weight
end

#won ⇒ Boolean Also known as: won?

True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only. Corresponds to the JSON property won

Returns:

  • (Boolean) 


1933
1934
1935
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1933

def won
  @won
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1941
1942
1943
1944
1945
1946
1947
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1941

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @status = args[:status] if args.key?(:status)
  @url = args[:url] if args.key?(:url)
  @weight = args[:weight] if args.key?(:weight)
  @won = args[:won] if args.key?(:won)
end