Class: Google::Apis::DisplayvideoV1::CustomBiddingAlgorithm

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

Overview

A single custom bidding algorithm.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CustomBiddingAlgorithm

Returns a new instance of CustomBiddingAlgorithm.



3817
3818
3819
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3817

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

Instance Attribute Details

#advertiser_id ⇒ Fixnum

Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


3754
3755
3756
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3754

def advertiser_id
  @advertiser_id
end

#custom_bidding_algorithm_id ⇒ Fixnum

Output only. The unique ID of the custom bidding algorithm. Assigned by the system. Corresponds to the JSON property customBiddingAlgorithmId

Returns:

  • (Fixnum) 


3760
3761
3762
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3760

def custom_bidding_algorithm_id
  @custom_bidding_algorithm_id
end

#custom_bidding_algorithm_state ⇒ String

Output only. The status of custom bidding algorithm. Corresponds to the JSON property customBiddingAlgorithmState

Returns:

  • (String) 


3765
3766
3767
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3765

def custom_bidding_algorithm_state
  @custom_bidding_algorithm_state
end

#custom_bidding_algorithm_type ⇒ String

Required. Immutable. The type of custom bidding algorithm. Corresponds to the JSON property customBiddingAlgorithmType

Returns:

  • (String) 


3770
3771
3772
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3770

def custom_bidding_algorithm_type
  @custom_bidding_algorithm_type
end

#display_name ⇒ String

Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. Corresponds to the JSON property displayName

Returns:

  • (String) 


3776
3777
3778
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3776

def display_name
  @display_name
end

#entity_status ⇒ String

Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * ENTITY_STATUS_ACTIVE * ENTITY_STATUS_ARCHIVED Corresponds to the JSON property entityStatus

Returns:

  • (String) 


3783
3784
3785
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3783

def entity_status
  @entity_status
end

#model_readiness ⇒ Array<Google::Apis::DisplayvideoV1::CustomBiddingModelReadinessState>

Output only. The state of custom bidding model readiness for each advertiser who has access. This field may only include the state of the queried advertiser if the algorithm owner is a partner and is being retrieved using an advertiser accessor. Corresponds to the JSON property modelReadiness

Returns:



3794
3795
3796
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3794

def model_readiness
  @model_readiness
end

#name ⇒ String

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

Returns:

  • (String) 


3799
3800
3801
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3799

def name
  @name
end

#partner_id ⇒ Fixnum

Immutable. The unique ID of the partner that owns the custom bidding algorithm. Corresponds to the JSON property partnerId

Returns:

  • (Fixnum) 


3804
3805
3806
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3804

def partner_id
  @partner_id
end

#shared_advertiser_ids ⇒ Array<Fixnum>

The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm owner is a partner and is being retrieved using an advertiser accessor. Corresponds to the JSON property sharedAdvertiserIds

Returns:

  • (Array<Fixnum>) 


3815
3816
3817
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3815

def shared_advertiser_ids
  @shared_advertiser_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3822

def update!(**args)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @custom_bidding_algorithm_id = args[:custom_bidding_algorithm_id] if args.key?(:custom_bidding_algorithm_id)
  @custom_bidding_algorithm_state = args[:custom_bidding_algorithm_state] if args.key?(:custom_bidding_algorithm_state)
  @custom_bidding_algorithm_type = args[:custom_bidding_algorithm_type] if args.key?(:custom_bidding_algorithm_type)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_status = args[:entity_status] if args.key?(:entity_status)
  @model_readiness = args[:model_readiness] if args.key?(:model_readiness)
  @name = args[:name] if args.key?(:name)
  @partner_id = args[:partner_id] if args.key?(:partner_id)
  @shared_advertiser_ids = args[:shared_advertiser_ids] if args.key?(:shared_advertiser_ids)
end