Class: Google::Apis::DisplayvideoV3::CustomBiddingScript

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 script.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CustomBiddingScript

Returns a new instance of CustomBiddingScript.



4963
4964
4965
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4963

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

Instance Attribute Details

#active ⇒ Boolean Also known as: active?

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

Returns:

  • (Boolean) 


4923
4924
4925
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4923

def active
  @active
end

#create_time ⇒ String

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

Returns:

  • (String) 


4929
4930
4931
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4929

def create_time
  @create_time
end

#custom_bidding_algorithm_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


4935
4936
4937
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4935

def custom_bidding_algorithm_id
  @custom_bidding_algorithm_id
end

#custom_bidding_script_id ⇒ Fixnum

Output only. The unique ID of the custom bidding script. Corresponds to the JSON property customBiddingScriptId

Returns:

  • (Fixnum) 


4940
4941
4942
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4940

def custom_bidding_script_id
  @custom_bidding_script_id
end

#errors ⇒ Array<Google::Apis::DisplayvideoV3::ScriptError>

Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED. Corresponds to the JSON property errors

Returns:



4946
4947
4948
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4946

def errors
  @errors
end

#name ⇒ String

Output only. The resource name of the custom bidding script. Corresponds to the JSON property name

Returns:

  • (String) 


4951
4952
4953
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4951

def name
  @name
end

#script ⇒ Google::Apis::DisplayvideoV3::CustomBiddingScriptRef

The reference to the uploaded custom bidding script file. Corresponds to the JSON property script

Returns:



4956
4957
4958
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4956

def script
  @script
end

#state ⇒ String

Output only. The state of the custom bidding script. Corresponds to the JSON property state

Returns:

  • (String) 


4961
4962
4963
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4961

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4968

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_script_id = args[:custom_bidding_script_id] if args.key?(:custom_bidding_script_id)
  @errors = args[:errors] if args.key?(:errors)
  @name = args[:name] if args.key?(:name)
  @script = args[:script] if args.key?(:script)
  @state = args[:state] if args.key?(:state)
end