Class: Zernio::CampaignBiddingBidSpec

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/campaign_bidding_bid_spec.rb

Overview

Null when the campaign is on a strategy PUT does not model (Manual CPC, Target Impression Share, ...); show biddingStrategyType instead in that case.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CampaignBiddingBidSpec

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::CampaignBiddingBidSpec` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::CampaignBiddingBidSpec`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'bid_strategy')
    self.bid_strategy = attributes[:'bid_strategy']
  end

  if attributes.key?(:'bid_amount')
    self.bid_amount = attributes[:'bid_amount']
  end

  if attributes.key?(:'roas_average_floor')
    self.roas_average_floor = attributes[:'roas_average_floor']
  end

  if attributes.key?(:'portfolio_bid_strategy_id')
    self.portfolio_bid_strategy_id = attributes[:'portfolio_bid_strategy_id']
  end
end

Instance Attribute Details

#bid_amount ⇒ Object

Whole currency units. Present for COST_CAP and LOWEST_COST_WITH_BID_CAP, and omitted when the campaign is on a bare TARGET_SPEND with no CPC ceiling set.



22
23
24
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 22

def bid_amount
  @bid_amount
end

#bid_strategy ⇒ Object

Returns the value of attribute bid_strategy.



19
20
21
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 19

def bid_strategy
  @bid_strategy
end

#portfolio_bid_strategy_id ⇒ Object

Present alone (bidStrategy omitted) when the campaign is on a portfolio strategy; see portfolio.



28
29
30
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 28

def portfolio_bid_strategy_id
  @portfolio_bid_strategy_id
end

#roas_average_floor ⇒ Object

Decimal ROAS multiplier (2.0 = 2.0x). Present for LOWEST_COST_WITH_MIN_ROAS.



25
26
27
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 25

def roas_average_floor
  @roas_average_floor
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



63
64
65
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 63

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 68

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



53
54
55
56
57
58
59
60
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 53

def self.attribute_map
  {
    :'bid_strategy' => :'bidStrategy',
    :'bid_amount' => :'bidAmount',
    :'roas_average_floor' => :'roasAverageFloor',
    :'portfolio_bid_strategy_id' => :'portfolioBidStrategyId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 162

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 83

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 73

def self.openapi_types
  {
    :'bid_strategy' => :'BidStrategy',
    :'bid_amount' => :'Float',
    :'roas_average_floor' => :'Float',
    :'portfolio_bid_strategy_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bid_strategy == o.bid_strategy &&
      bid_amount == o.bid_amount &&
      roas_average_floor == o.roas_average_floor &&
      portfolio_bid_strategy_id == o.portfolio_bid_strategy_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 155

def hash
  [bid_strategy, bid_amount, roas_average_floor, portfolio_bid_strategy_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



123
124
125
126
127
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 123

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 184

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



131
132
133
134
 
# File 'lib/zernio-sdk/models/campaign_bidding_bid_spec.rb', line 131

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end