Class: Zernio::UpdateAdCampaignRequest

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
167
168
169
170
171
172
173
174
175
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 118

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

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

  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

  if attributes.key?(:'allow_shared_budget_update')
    self.allow_shared_budget_update = attributes[:'allow_shared_budget_update']
  else
    self.allow_shared_budget_update = false
  end

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Meta only. Zernio SocialAccount id owning the ad account. Needed only for an EMPTY campaign (zero ads); ignored otherwise.



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

def 
  @account_id
end

#allow_shared_budget_update ⇒ Object

Google only. Explicitly allow changing a shared campaign budget, affecting every campaign that uses it. Does not bypass an unknown sharing state.



37
38
39
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 37

def allow_shared_budget_update
  @allow_shared_budget_update
end

#bid_amount ⇒ Object

Google only. Whole currency units (USD: 12 = $12.00). Max CPC for LOWEST_COST_WITH_BID_CAP, CPA target for COST_CAP; required for both.



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

def bid_amount
  @bid_amount
end

#bid_strategy ⇒ Object

Meta + Google. On Meta, the campaign default that ad sets inherit unless they override it. On Google, the campaign's own bidding strategy. On Google: LOWEST_COST_WITHOUT_CAP = Maximize Conversions, COST_CAP + bidAmount = Target CPA, LOWEST_COST_WITH_MIN_ROAS + roasAverageFloor = Target ROAS, LOWEST_COST_WITH_BID_CAP + bidAmount = Maximize Clicks with a CPC ceiling; portfolioBidStrategyId attaches a portfolio strategy instead.



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

def bid_strategy
  @bid_strategy
end

#budget ⇒ Object

Returns the value of attribute budget.



39
40
41
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 39

def budget
  @budget
end

#name ⇒ Object

Meta only. Rename the campaign.



42
43
44
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 42

def name
  @name
end

#platform ⇒ Object

Required: platform campaign IDs are not globally unique.



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

def platform
  @platform
end

#platform_specific_data ⇒ Object

Returns the value of attribute platform_specific_data.



44
45
46
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 44

def platform_specific_data
  @platform_specific_data
end

#portfolio_bid_strategy_id ⇒ Object

Google only. Attach an existing portfolio bid strategy (numeric id from GET /v1/ads/bid-strategies) instead of setting bidStrategy. Exclusive with bidStrategy.



34
35
36
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 34

def portfolio_bid_strategy_id
  @portfolio_bid_strategy_id
end

#roas_average_floor ⇒ Object

Google only. Decimal ROAS multiplier (2.0 = 2.0x), required for LOWEST_COST_WITH_MIN_ROAS.



31
32
33
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 31

def roas_average_floor
  @roas_average_floor
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



85
86
87
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 85

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 90

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 69

def self.attribute_map
  {
    :'platform' => :'platform',
    :'account_id' => :'accountId',
    :'bid_strategy' => :'bidStrategy',
    :'bid_amount' => :'bidAmount',
    :'roas_average_floor' => :'roasAverageFloor',
    :'portfolio_bid_strategy_id' => :'portfolioBidStrategyId',
    :'allow_shared_budget_update' => :'allowSharedBudgetUpdate',
    :'budget' => :'budget',
    :'name' => :'name',
    :'platform_specific_data' => :'platformSpecificData'
  }
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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 281

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



111
112
113
114
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 95

def self.openapi_types
  {
    :'platform' => :'String',
    :'account_id' => :'String',
    :'bid_strategy' => :'BidStrategy',
    :'bid_amount' => :'Float',
    :'roas_average_floor' => :'Float',
    :'portfolio_bid_strategy_id' => :'String',
    :'allow_shared_budget_update' => :'Boolean',
    :'budget' => :'UpdateAdCampaignRequestBudget',
    :'name' => :'String',
    :'platform_specific_data' => :'UpdateAdCampaignRequestPlatformSpecificData'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 251

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      platform == o.platform &&
       == o. &&
      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 &&
      allow_shared_budget_update == o.allow_shared_budget_update &&
      budget == o.budget &&
      name == o.name &&
      platform_specific_data == o.platform_specific_data
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


268
269
270
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



274
275
276
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 274

def hash
  [platform, , bid_strategy, bid_amount, roas_average_floor, portfolio_bid_strategy_id, allow_shared_budget_update, budget, name, platform_specific_data].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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 179

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

  pattern = Regexp.new(/^\d+$/)
  if !@portfolio_bid_strategy_id.nil? && @portfolio_bid_strategy_id !~ pattern
    invalid_properties.push("invalid value for \"portfolio_bid_strategy_id\", must conform to the pattern #{pattern}.")
  end

  if !@name.nil? && @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 303

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



200
201
202
203
204
205
206
207
208
 
# File 'lib/zernio-sdk/models/update_ad_campaign_request.rb', line 200

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @platform.nil?
  platform_validator = EnumAttributeValidator.new('String', ["facebook", "instagram", "google"])
  return false unless platform_validator.valid?(@platform)
  return false if !@portfolio_bid_strategy_id.nil? && @portfolio_bid_strategy_id !~ Regexp.new(/^\d+$/)
  return false if !@name.nil? && @name.to_s.length > 255
  true
end