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.



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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

def entity_status
  @entity_status
end

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

Output only. The custom bidding model readiness state for each advertiser who have 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:



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

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) 


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

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) 


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

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>) 


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

def shared_advertiser_ids
  @shared_advertiser_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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