Class: Zernio::BoostPostRequest

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/boost_post_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 = {}) ⇒ BoostPostRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 178

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

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

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

  if attributes.key?(:'ad_account_id')
    self. = attributes[:'ad_account_id']
  else
    self. = nil
  end

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

  if attributes.key?(:'goal')
    self.goal = attributes[:'goal']
  else
    self.goal = nil
  end

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

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

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

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

  if attributes.key?(:'raw_targeting')
    if (value = attributes[:'raw_targeting']).is_a?(Hash)
      self.raw_targeting = value
    end
  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?(:'platform_specific_data')
    self.platform_specific_data = attributes[:'platform_specific_data']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Social account ID



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

def 
  @account_id
end

#ad_account_id ⇒ Object

Platform ad account ID



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

def 
  @ad_account_id
end

#bid_amount ⇒ Object

Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Backward-compat: providing bidAmount without bidStrategy is treated as LOWEST_COST_WITH_BID_CAP.



50
51
52
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 50

def bid_amount
  @bid_amount
end

#bid_strategy ⇒ Object

Meta bid strategy applied to the ad set. On TikTok, mapped to bid_type / bid_price / deep_bid_type automatically.



47
48
49
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 47

def bid_strategy
  @bid_strategy
end

#budget ⇒ Object

Returns the value of attribute budget.



35
36
37
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 35

def budget
  @budget
end

#call_to_action ⇒ Object

TikTok-only. Call-to-action button label on the Spark Ad creative (e.g. LEARN_MORE, SHOP_NOW, DOWNLOAD_NOW, SIGN_UP, WATCH_NOW). Maps to call_to_action on the creative entry of /v2/ad/create/. Pass-through — the platform validates the value. See TikTok's "Enumeration - Call-to-Action" reference for the full list.



69
70
71
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 69

def call_to_action
  @call_to_action
end

#currency ⇒ Object

Returns the value of attribute currency.



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

def currency
  @currency
end

#dsa_beneficiary ⇒ Object

Legal entity that benefits from the ad. Required when targeting EU users (EU DSA, Article 26). Optional if the ad account has a default beneficiary: set it once via PATCH /v1/ads/accounts or in Meta Ads Manager, and Meta fills it in whenever the field is omitted.



75
76
77
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 75

def dsa_beneficiary
  @dsa_beneficiary
end

#dsa_payor ⇒ Object

Legal entity that pays for the ad. Can differ from dsaBeneficiary (for example, an agency paying for a client's ads). Same rules as dsaBeneficiary: required for EU targeting unless the ad account has a default payor.



78
79
80
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 78

def dsa_payor
  @dsa_payor
end

#goal ⇒ Object

Available goals vary by platform. Meta (Facebook/Instagram) and TikTok support all 7. LinkedIn supports all except app_promotion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.



33
34
35
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 33

def goal
  @goal
end

#link_url ⇒ Object

TikTok-only. Custom destination URL for the Spark Ad. Without this, TikTok Spark Ads have no clickable destination — required for traffic / conversion objectives. Maps to landing_page_url on the creative entry of /v2/ad/create/ (TikTok SDK AdcreateCreatives.landing_page_url). Ignored on Meta / LinkedIn / Pinterest / X / Google (those infer the destination from the boosted post).



66
67
68
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 66

def link_url
  @link_url
end

#name ⇒ Object

Returns the value of attribute name.



30
31
32
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 30

def name
  @name
end

#platform_post_id ⇒ Object

Platform post ID (alternative to postId)



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

def platform_post_id
  @platform_post_id
end

#platform_specific_data ⇒ Object

Returns the value of attribute platform_specific_data.



55
56
57
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 55

def platform_specific_data
  @platform_specific_data
end

#post_id ⇒ Object

Zernio post ID (provide this or platformPostId)



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

def post_id
  @post_id
end

#raw_targeting ⇒ Object

Meta only. A verbatim Meta-native targeting spec (e.g. { \"geo_locations\": { \"cities\": [{ \"key\": \"...\", \"radius\": 15, \"distance_unit\": \"kilometer\" }] } }), forwarded unchanged. Mutually exclusive with targeting (sending both is a 400). Use for advanced fields the structured object does not expose (flexible_spec, excluded audiences, business places).



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

def raw_targeting
  @raw_targeting
end

#roas_average_floor ⇒ Object

Minimum ROAS as a decimal multiplier (e.g. 2.0 = 2.0x ROAS). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS. Sent to Meta as bid_constraints.roas_average_floor × 10000 (Meta uses fixed-point integers).



53
54
55
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 53

def roas_average_floor
  @roas_average_floor
end

#schedule ⇒ Object

Returns the value of attribute schedule.



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

def schedule
  @schedule
end

#spark_auth_code ⇒ Object

TikTok-only. Spark Code (creator's auth_code) authorizing cross-creator Spark Ads — the advertiser can boost a video owned by a DIFFERENT TikTok account. Without this, boosts are limited to videos owned by the same account running the ads (same-BC creators only). The creator generates the code in their TikTok app's Promote settings and shares it with the advertiser. Maps to auth_code on the creative entry of /v2/ad/create/.



72
73
74
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 72

def spark_auth_code
  @spark_auth_code
end

#special_ad_categories ⇒ Object

Meta only. Required for housing, employment, credit, or political ads.



60
61
62
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 60

def special_ad_categories
  @special_ad_categories
end

#special_ad_category_country ⇒ Object

Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires specialAdCategories to be set (400 otherwise).



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

def special_ad_category_country
  @special_ad_category_country
end

#targeting ⇒ Object

Returns the value of attribute targeting.



41
42
43
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 41

def targeting
  @targeting
end

#tracking ⇒ Object

Returns the value of attribute tracking.



57
58
59
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 57

def tracking
  @tracking
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



137
138
139
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 137

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 103

def self.attribute_map
  {
    :'post_id' => :'postId',
    :'platform_post_id' => :'platformPostId',
    :'account_id' => :'accountId',
    :'ad_account_id' => :'adAccountId',
    :'name' => :'name',
    :'goal' => :'goal',
    :'budget' => :'budget',
    :'currency' => :'currency',
    :'schedule' => :'schedule',
    :'targeting' => :'targeting',
    :'raw_targeting' => :'rawTargeting',
    :'bid_strategy' => :'bidStrategy',
    :'bid_amount' => :'bidAmount',
    :'roas_average_floor' => :'roasAverageFloor',
    :'platform_specific_data' => :'platformSpecificData',
    :'tracking' => :'tracking',
    :'special_ad_categories' => :'specialAdCategories',
    :'special_ad_category_country' => :'specialAdCategoryCountry',
    :'link_url' => :'linkUrl',
    :'call_to_action' => :'callToAction',
    :'spark_auth_code' => :'sparkAuthCode',
    :'dsa_beneficiary' => :'dsaBeneficiary',
    :'dsa_payor' => :'dsaPayor'
  }
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



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 485

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



171
172
173
174
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 171

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 142

def self.openapi_types
  {
    :'post_id' => :'String',
    :'platform_post_id' => :'String',
    :'account_id' => :'String',
    :'ad_account_id' => :'String',
    :'name' => :'String',
    :'goal' => :'String',
    :'budget' => :'BoostPostRequestBudget',
    :'currency' => :'String',
    :'schedule' => :'BoostPostRequestSchedule',
    :'targeting' => :'BoostPostRequestTargeting',
    :'raw_targeting' => :'Hash<String, Object>',
    :'bid_strategy' => :'BidStrategy',
    :'bid_amount' => :'Float',
    :'roas_average_floor' => :'Float',
    :'platform_specific_data' => :'LinkedInAdsPlatformData',
    :'tracking' => :'BoostPostRequestTracking',
    :'special_ad_categories' => :'Array<String>',
    :'special_ad_category_country' => :'Array<String>',
    :'link_url' => :'String',
    :'call_to_action' => :'String',
    :'spark_auth_code' => :'String',
    :'dsa_beneficiary' => :'String',
    :'dsa_payor' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 442

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      post_id == o.post_id &&
      platform_post_id == o.platform_post_id &&
       == o. &&
       == o. &&
      name == o.name &&
      goal == o.goal &&
      budget == o.budget &&
      currency == o.currency &&
      schedule == o.schedule &&
      targeting == o.targeting &&
      raw_targeting == o.raw_targeting &&
      bid_strategy == o.bid_strategy &&
      bid_amount == o.bid_amount &&
      roas_average_floor == o.roas_average_floor &&
      platform_specific_data == o.platform_specific_data &&
      tracking == o.tracking &&
      special_ad_categories == o.special_ad_categories &&
      special_ad_category_country == o.special_ad_category_country &&
      link_url == o.link_url &&
      call_to_action == o.call_to_action &&
      spark_auth_code == o.spark_auth_code &&
      dsa_beneficiary == o.dsa_beneficiary &&
      dsa_payor == o.dsa_payor
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


472
473
474
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 472

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



478
479
480
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 478

def hash
  [post_id, platform_post_id, , , name, goal, budget, currency, schedule, targeting, raw_targeting, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, tracking, special_ad_categories, special_ad_category_country, link_url, call_to_action, spark_auth_code, dsa_beneficiary, dsa_payor].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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 303

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

  if @ad_account_id.nil?
    invalid_properties.push('invalid value for "ad_account_id", ad_account_id cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if @goal.nil?
    invalid_properties.push('invalid value for "goal", goal cannot be nil.')
  end

  if @budget.nil?
    invalid_properties.push('invalid value for "budget", budget cannot be nil.')
  end

  if !@dsa_beneficiary.nil? && @dsa_beneficiary.to_s.length > 100
    invalid_properties.push('invalid value for "dsa_beneficiary", the character length must be smaller than or equal to 100.')
  end

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



507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 507

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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 343

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  return false if @ad_account_id.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @goal.nil?
  goal_validator = EnumAttributeValidator.new('String', ["engagement", "traffic", "awareness", "video_views", "lead_generation", "conversions", "app_promotion"])
  return false unless goal_validator.valid?(@goal)
  return false if @budget.nil?
  return false if !@dsa_beneficiary.nil? && @dsa_beneficiary.to_s.length > 100
  return false if !@dsa_payor.nil? && @dsa_payor.to_s.length > 100
  true
end