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.


1842
1843
1844
# File 'generated/google/apis/analytics_v3/classes.rb', line 1842

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

Instance Attribute Details

#nameString

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)

1814
1815
1816
# File 'generated/google/apis/analytics_v3/classes.rb', line 1814

def name
  @name
end

#statusString

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)

1821
1822
1823
# File 'generated/google/apis/analytics_v3/classes.rb', line 1821

def status
  @status
end

#urlString

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)

1827
1828
1829
# File 'generated/google/apis/analytics_v3/classes.rb', line 1827

def url
  @url
end

#weightFloat

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)

1833
1834
1835
# File 'generated/google/apis/analytics_v3/classes.rb', line 1833

def weight
  @weight
end

#wonBoolean 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)

1839
1840
1841
# File 'generated/google/apis/analytics_v3/classes.rb', line 1839

def won
  @won
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1847
1848
1849
1850
1851
1852
1853
# File 'generated/google/apis/analytics_v3/classes.rb', line 1847

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