Class: Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRules

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

Overview

A single custom bidding algorithm rules.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CustomBiddingAlgorithmRules

Returns a new instance of CustomBiddingAlgorithmRules.



4722
4723
4724
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4722

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

Instance Attribute Details

#active ⇒ Boolean Also known as: active?

Output only. Whether the rules resource is currently being used for scoring by the parent algorithm. Corresponds to the JSON property active

Returns:

  • (Boolean) 


4682
4683
4684
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4682

def active
  @active
end

#create_time ⇒ String

Output only. The time when the rules resource was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


4688
4689
4690
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4688

def create_time
  @create_time
end

#custom_bidding_algorithm_id ⇒ Fixnum

Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to. Corresponds to the JSON property customBiddingAlgorithmId

Returns:

  • (Fixnum) 


4694
4695
4696
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4694

def custom_bidding_algorithm_id
  @custom_bidding_algorithm_id
end

#custom_bidding_algorithm_rules_id ⇒ Fixnum

Output only. The unique ID of the rules resource. Corresponds to the JSON property customBiddingAlgorithmRulesId

Returns:

  • (Fixnum) 


4699
4700
4701
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4699

def custom_bidding_algorithm_rules_id
  @custom_bidding_algorithm_rules_id
end

#error ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRulesError

An error message for a CustomBiddingAlgorithmRules resource. Corresponds to the JSON property error

Returns:



4704
4705
4706
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4704

def error
  @error
end

#name ⇒ String

Output only. The resource name of the rules resource. Corresponds to the JSON property name

Returns:

  • (String) 


4709
4710
4711
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4709

def name
  @name
end

#rules ⇒ Google::Apis::DisplayvideoV3::CustomBiddingAlgorithmRulesRef

The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. Corresponds to the JSON property rules

Returns:



4715
4716
4717
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4715

def rules
  @rules
end

#state ⇒ String

Output only. The state of the rules resource. Corresponds to the JSON property state

Returns:

  • (String) 


4720
4721
4722
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4720

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4727

def update!(**args)
  @active = args[:active] if args.key?(:active)
  @create_time = args[:create_time] if args.key?(:create_time)
  @custom_bidding_algorithm_id = args[:custom_bidding_algorithm_id] if args.key?(:custom_bidding_algorithm_id)
  @custom_bidding_algorithm_rules_id = args[:custom_bidding_algorithm_rules_id] if args.key?(:custom_bidding_algorithm_rules_id)
  @error = args[:error] if args.key?(:error)
  @name = args[:name] if args.key?(:name)
  @rules = args[:rules] if args.key?(:rules)
  @state = args[:state] if args.key?(:state)
end