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.



4724
4725
4726
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4724

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) 


4684
4685
4686
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4684

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) 


4690
4691
4692
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4690

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) 


4696
4697
4698
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4696

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) 


4701
4702
4703
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4701

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:



4706
4707
4708
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4706

def error
  @error
end

#name ⇒ String

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

Returns:

  • (String) 


4711
4712
4713
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4711

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:



4717
4718
4719
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4717

def rules
  @rules
end

#state ⇒ String

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

Returns:

  • (String) 


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

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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