Class: PinterestSdkClient::CampaignBidOptionsUpdate

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/campaign_bid_options_update.rb

Overview

Object describing an update to the campaign level bid multipliers.

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 = {}) ⇒ CampaignBidOptionsUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 117

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::CampaignBidOptionsUpdate` 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 `PinterestSdkClient::CampaignBidOptionsUpdate`. 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?(:'age_bucket_multipliers')
    self.age_bucket_multipliers = attributes[:'age_bucket_multipliers']
  end

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

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

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

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

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

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

  if attributes.key?(:'update_mask')
    if (value = attributes[:'update_mask']).is_a?(Array)
      self.update_mask = value
    end
  else
    self.update_mask = nil
  end
end

Instance Attribute Details

#age_bucket_multipliers ⇒ Object

Age bucket multipliers for bid adjustments.



20
21
22
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 20

def age_bucket_multipliers
  @age_bucket_multipliers
end

#app_type_multipliers ⇒ Object

App type multipliers for bid adjustments.



23
24
25
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 23

def app_type_multipliers
  @app_type_multipliers
end

#audience_multipliers ⇒ Object

Audience multipliers for bid adjustments.



26
27
28
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 26

def audience_multipliers
  @audience_multipliers
end

#freq_bid_multiplier_time_window ⇒ Object

The time window for frequency bid multipliers.



29
30
31
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 29

def freq_bid_multiplier_time_window
  @freq_bid_multiplier_time_window
end

#frequency_multipliers ⇒ Object

Frequency multipliers for bid adjustments.



32
33
34
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 32

def frequency_multipliers
  @frequency_multipliers
end

#gender_multipliers ⇒ Object

Gender multipliers for bid adjustments.



35
36
37
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 35

def gender_multipliers
  @gender_multipliers
end

#placement_multipliers ⇒ Object

Placement multipliers for bid adjustments.



38
39
40
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 38

def placement_multipliers
  @placement_multipliers
end

#update_mask ⇒ Object

List of fields to update. Only the fields in the list will be updated.



41
42
43
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 41

def update_mask
  @update_mask
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



80
81
82
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 80

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 85

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 66

def self.attribute_map
  {
    :'age_bucket_multipliers' => :'age_bucket_multipliers',
    :'app_type_multipliers' => :'app_type_multipliers',
    :'audience_multipliers' => :'audience_multipliers',
    :'freq_bid_multiplier_time_window' => :'freq_bid_multiplier_time_window',
    :'frequency_multipliers' => :'frequency_multipliers',
    :'gender_multipliers' => :'gender_multipliers',
    :'placement_multipliers' => :'placement_multipliers',
    :'update_mask' => :'update_mask'
  }
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 228

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



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 104

def self.openapi_nullable
  Set.new([
    :'age_bucket_multipliers',
    :'app_type_multipliers',
    :'freq_bid_multiplier_time_window',
    :'frequency_multipliers',
    :'gender_multipliers',
    :'placement_multipliers',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 90

def self.openapi_types
  {
    :'age_bucket_multipliers' => :'AgeBucketMultipliers',
    :'app_type_multipliers' => :'AppTypeMultipliers',
    :'audience_multipliers' => :'CampaignAudienceMultipliers',
    :'freq_bid_multiplier_time_window' => :'FreqBidMultiplierTimeWindow',
    :'frequency_multipliers' => :'FrequencyMultipliers',
    :'gender_multipliers' => :'GenderMultipliers',
    :'placement_multipliers' => :'PlacementMultipliers',
    :'update_mask' => :'Array<CampaignBidOptionsUpdateMaskItems>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      age_bucket_multipliers == o.age_bucket_multipliers &&
      app_type_multipliers == o.app_type_multipliers &&
      audience_multipliers == o.audience_multipliers &&
      freq_bid_multiplier_time_window == o.freq_bid_multiplier_time_window &&
      frequency_multipliers == o.frequency_multipliers &&
      gender_multipliers == o.gender_multipliers &&
      placement_multipliers == o.placement_multipliers &&
      update_mask == o.update_mask
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


215
216
217
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



221
222
223
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 221

def hash
  [age_bucket_multipliers, app_type_multipliers, audience_multipliers, freq_bid_multiplier_time_window, frequency_multipliers, gender_multipliers, placement_multipliers, update_mask].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



170
171
172
173
174
175
176
177
178
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 170

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @update_mask.nil?
    invalid_properties.push('invalid value for "update_mask", update_mask cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 250

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



182
183
184
185
186
 
# File 'lib/pinterest_sdk/models/campaign_bid_options_update.rb', line 182

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @update_mask.nil?
  true
end