Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesExperimentArm

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

Overview

A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ResourcesExperimentArm

Returns a new instance of GoogleAdsSearchads360V23ResourcesExperimentArm.



29219
29220
29221
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 29219

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

Instance Attribute Details

#asset_groups ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesExperimentArmAssetGroupInfo>

List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. Corresponds to the JSON property assetGroups

Returns:



29176
29177
29178
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 29176

def asset_groups
  @asset_groups
end

#campaigns ⇒ Array<String>

List of campaigns in the trial arm. The max length is one. Corresponds to the JSON property campaigns

Returns:

  • (Array<String>) 


29181
29182
29183
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 29181

def campaigns
  @campaigns
end

#control ⇒ Boolean Also known as: control?

Whether this arm is a control arm. A control arm is the arm against which the other arms are compared. Corresponds to the JSON property control

Returns:

  • (Boolean) 


29187
29188
29189
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 29187

def control
  @control
end

#experiment ⇒ String

Immutable. The experiment to which the ExperimentArm belongs. Corresponds to the JSON property experiment

Returns:

  • (String) 


29193
29194
29195
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 29193

def experiment
  @experiment
end

#in_design_campaigns ⇒ Array<String>

Output only. The in design campaigns in the treatment experiment arm. Corresponds to the JSON property inDesignCampaigns

Returns:

  • (Array<String>) 


29198
29199
29200
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 29198

def in_design_campaigns
  @in_design_campaigns
end

#name ⇒ String

Required. The name of the experiment arm. It must have a minimum length of 1 and maximum length of 1024. It must be unique under an experiment. Corresponds to the JSON property name

Returns:

  • (String) 


29204
29205
29206
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 29204

def name
  @name
end

#resource_name ⇒ String

Immutable. The resource name of the experiment arm. Experiment arm resource names have the form: customers/customer_id/experimentArms/TrialArm. trial_id~TrialArm.trial_arm_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


29211
29212
29213
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 29211

def resource_name
  @resource_name
end

#traffic_split ⇒ Fixnum

Traffic split of the trial arm. The value should be between 1 and 100 and must total 100 between the two trial arms. Corresponds to the JSON property trafficSplit

Returns:

  • (Fixnum) 


29217
29218
29219
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 29217

def traffic_split
  @traffic_split
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



29224
29225
29226
29227
29228
29229
29230
29231
29232
29233
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 29224

def update!(**args)
  @asset_groups = args[:asset_groups] if args.key?(:asset_groups)
  @campaigns = args[:campaigns] if args.key?(:campaigns)
  @control = args[:control] if args.key?(:control)
  @experiment = args[:experiment] if args.key?(:experiment)
  @in_design_campaigns = args[:in_design_campaigns] if args.key?(:in_design_campaigns)
  @name = args[:name] if args.key?(:name)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @traffic_split = args[:traffic_split] if args.key?(:traffic_split)
end