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



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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 313

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

  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?(:'campaign_name')
    self.campaign_name = attributes[:'campaign_name']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'promoted_object')
    self.promoted_object = attributes[:'promoted_object']
  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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Zernio account id. Normally the connected posting account (facebook, instagram, tiktok, linkedin, pinterest, twitter) or a googleads account. TikTok: the TikTok Ads connection (platform tiktokads) is accepted too when the post brings its own authorization (sparkAuthCode or sparkPosts), so Spark ads need no organic TikTok account connected; such a call must use platformPostId, not postId.



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

def 
  @account_id
end

#ad_account_id ⇒ Object

Platform ad account ID



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

def 
  @ad_account_id
end

#ad_set_id ⇒ Object

Meta, or TikTok with smartPlus: true. Attach the boosted post to this existing ad set instead of creating a campaign. On TikTok the id is an existing Smart+ ad group: the post is added as one more Spark ad in it (up to 30 per ad group), under the identity its sparkAuthCode creates; goal and budget are inherited from the Smart+ campaign; a regular ad group is rejected with a 400. Meta: The ad set then owns budget, schedule and targeting; sending those too is a 400.



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

def ad_set_id
  @ad_set_id
end

#ad_set_name ⇒ Object

Exact name for the ad-group level this boost provisions. Omitted keeps the default <name> - Ad Group. Meta: ad set; TikTok, Pinterest, Google: ad group; X: line item; LinkedIn: the campaign under the campaign group. Ignored on the Meta attach shape.



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

def ad_set_name
  @ad_set_name
end

#attribution_spec ⇒ Object

Meta only. Ad-set attribution windows, same shape as POST /v1/ads/create. Applied on OUTCOME_SALES, OUTCOME_LEADS and OUTCOME_APP_PROMOTION campaigns (conversions, lead_conversion, lead_generation, app_promotion); other objectives keep Meta's default. Not allowed with adSetId.



153
154
155
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 153

def attribution_spec
  @attribution_spec
end

#bid_amount ⇒ Object

Deprecated: send it inside platformSpecificData instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400. 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.



96
97
98
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 96

def bid_amount
  @bid_amount
end

#bid_strategy ⇒ Object

Deprecated: send it inside platformSpecificData instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400. Meta bid strategy applied to the ad set. On TikTok, mapped to bid_type / bid_price / deep_bid_type automatically.



93
94
95
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 93

def bid_strategy
  @bid_strategy
end

#bodies ⇒ Object

Meta only. Extra primary-text options Meta rotates on the boosted post (asset_feed_spec.bodies with DEGREES_OF_FREEDOM); the post keeps its own text as one of the options. Works for Facebook posts and Instagram media. Under a conversions or traffic goal Meta also wants a website URL on the options, taken from linkUrl (send it with a callToAction); engagement boosts need none.



156
157
158
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 156

def bodies
  @bodies
end

#budget ⇒ Object

Returns the value of attribute budget.



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

def budget
  @budget
end

#budget_amount ⇒ Object

Budget in whole currency units, the same flat field as POST /v1/ads/create. Required unless adSetId is set. Minimum varies: TikTok=$20, Pinterest=$5, others=$1



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

def budget_amount
  @budget_amount
end

#budget_level ⇒ Object

Meta only, same semantics as POST /v1/ads/create: campaign = Advantage campaign budget (CBO), the budget and bid strategy sit on the campaign and the ad set inherits them. Default adset. Not allowed with adSetId.



150
151
152
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 150

def budget_level
  @budget_level
end

#budget_type ⇒ Object

Goes together with budgetAmount. lifetime requires schedule.endDate.



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

def budget_type
  @budget_type
end

#call_to_action ⇒ Object

CTA button label. Non-messaging CTAs require linkUrl. WHATSAPP_MESSAGE, MESSAGE_PAGE, and INSTAGRAM_MESSAGE do not require a URL and reject linkUrl. Meta: the CTA enum of POST /v1/ads/create plus VIEW_INSTAGRAM_PROFILE, WHATSAPP_MESSAGE, MESSAGE_PAGE, and INSTAGRAM_MESSAGE. VIEW_INSTAGRAM_PROFILE requires linkUrl; the messaging CTAs select their destination automatically. TikTok: pass-through to call_to_action on the Spark Ad creative; the platform validates the value. See TikTok's "Enumeration - Call-to-Action".



121
122
123
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 121

def call_to_action
  @call_to_action
end

#campaign_name ⇒ Object

Exact name for the campaign this boost provisions. Omitted keeps the default <name> - Campaign. Every platform: on LinkedIn it names the campaign group. Ignored on the Meta attach shape (adSetId), which creates no campaign.



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

def campaign_name
  @campaign_name
end

#creative_features ⇒ Object

Meta Advantage+ creative enhancements. Map snake_case feature names to OPT_IN or OPT_OUT; Meta validates supported keys and unspecified features default to OPT_OUT. auto_promotion_tag is an Advantage+ enhancement, not the Ads Manager Promotion setting. The deprecated standard_enhancements bundle is rejected by Meta.



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

def creative_features
  @creative_features
end

#currency ⇒ Object

ISO 4217 currency code matching the ad account's currency. Meta only. Optional: Zernio resolves it from the ad account when omitted. The value selects the minor-unit exponent Zernio converts budget/bid amounts by before calling Meta (most currencies are cents; zero-decimal currencies like JPY/KRW are sent as-is).



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

def currency
  @currency
end

#destination_type ⇒ Object

Meta only. Ad-set destination_type: where the click LANDS, as opposed to instagramAccountId which is who the ad runs as. Independent of plain link CTAs and their goal. A messaging callToAction selects its destination automatically; an explicit destinationType must then match. Lead ads use ON_AD.



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

def destination_type
  @destination_type
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.



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

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.



141
142
143
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 141

def dsa_payor
  @dsa_payor
end

#end_date ⇒ Object

Ad-set end time (ISO 8601), mapped to the ad set's end_time. Required for lifetime budgets. Same field as on POST /v1/ads/create.



80
81
82
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 80

def end_date
  @end_date
end

#existing_campaign_id ⇒ Object

TikTok only. Create the ad group and the Spark ad under this existing TikTok campaign instead of creating a new campaign. The campaign keeps its own status and objective (the objective must fit goal). Cannot be combined with adSetId or smartPlus. On Meta use POST /v1/ads/create with existingCampaignId.



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

def existing_campaign_id
  @existing_campaign_id
end

#goal ⇒ Object

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



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

def goal
  @goal
end

#identity_id ⇒ Object

TikTok only. The identity the ad runs as (the profile shown on the ad), from GET /v1/ads/tiktok-identities. Default: the connected TikTok account's own identity. Must be authorized on the advertiser or the call fails naming the available ones.



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

def identity_id
  @identity_id
end

#identity_type ⇒ Object

TikTok only. Type of identityId; resolved from the advertiser's identity list when omitted.



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

def identity_type
  @identity_type
end

#instagram_account_id ⇒ Object

Meta only. Instagram identity the ad runs AS (creative.instagram_user_id), overriding the account linked to the Page. Live-verified against a Page-post creative.



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

def 
  @instagram_account_id
end

#lead_gen_form_id ⇒ Object

Lead Gen form ID to attach to the boosted ad's creative. REQUIRED when goal is lead_generation. On Meta this is the leadgen_forms ID (create one via POST /v1/ads/lead-forms). On LinkedIn this is the adForm ID (create one via POST /v1/ads/lead-forms with a LinkedIn account); the creative's leadgenCallToAction.destination is set to urn:li:adForm:{id}. Ignored for other goals.



144
145
146
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 144

def lead_gen_form_id
  @lead_gen_form_id
end

#link_url ⇒ Object

Website URL for non-messaging CTA buttons. Send it with callToAction. Omit for messaging boosts. Meta: adds a top-level call_to_action to the post-reference creative. This is what gives a traffic boost a clickable destination without replacing the creative and losing the post's social proof. Ignored when leadGenFormId is set, which supplies its own destination. Live-verified against a Page-post creative. TikTok: maps to landing_page_url on the Spark Ad creative (AdcreateCreatives.landing_page_url); Spark Ads have no clickable destination without it. Ignored on LinkedIn / Pinterest / X / Google, which infer the destination from the boosted post.



118
119
120
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 118

def link_url
  @link_url
end

#location_targeting_type ⇒ Object

Google only (400 elsewhere). Written on the campaign the boost creates.



87
88
89
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 87

def location_targeting_type
  @location_targeting_type
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#optimization_goal ⇒ Object

Meta, or TikTok with goal: video_views. TikTok: ENGAGED_VIEW (6-second Focused View, the default) or ENGAGED_VIEW_FIFTEEN (15-second views), both billed per view (CPV); any other value is a 400. Meta: explicit ad-set optimization_goal override. When omitted, defaults to the value derived from goal. Messaging boosts always use CONVERSATIONS and reject another optimizationGoal. Otherwise the value must be compatible with the objective Meta derives from goal, not with the objective used by POST /v1/ads/create for the same goal name: boost maps goal: \"engagement\" to objective OUTCOME_AWARENESS, which accepts REACH, IMPRESSIONS, AD_RECALL_LIFT, or THRUPLAY-class values, and rejects POST_ENGAGEMENT (that value is only valid under OUTCOME_ENGAGEMENT, which create uses for the same goal name).



159
160
161
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 159

def optimization_goal
  @optimization_goal
end

#platform_post_id ⇒ Object

Platform post ID (alternative to postId). Meta: a Page post id (<pageId>_<postId> or the bare post id) or an Instagram media id. On a Meta Ads business-login connection (platform metaads) the id is resolved live: an Instagram media id is boosted as that media, running as the Instagram account that owns it.



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

def platform_post_id
  @platform_post_id
end

#platform_specific_data ⇒ Object

Returns the value of attribute platform_specific_data.



101
102
103
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 101

def platform_specific_data
  @platform_specific_data
end

#post_id ⇒ Object

Zernio post ID (provide this or platformPostId)



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

def post_id
  @post_id
end

#promo_codes ⇒ Object

TikTok Smart+ Web Conversions only (requires smartPlus: true, goal conversions). Promo codes or offers TikTok highlights on the ad (Ads Manager's "Add promo code or offer"). A promo code needs shoppers to enter it at checkout; an entry without promoCode is an offer applied automatically. Rejected with a 400 on other platforms and on Lead Generation campaigns.



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

def promo_codes
  @promo_codes
end

Returns the value of attribute promoted_object.



135
136
137
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 135

def promoted_object
  @promoted_object
end

#raw_targeting ⇒ Object

Meta only. A Meta-native targeting spec (e.g. { \"geo_locations\": { \"cities\": [{ \"key\": \"...\", \"radius\": 15, \"distance_unit\": \"kilometer\" }] } }). Sent alone it is forwarded unchanged. Use for advanced fields the structured object does not expose (flexible_spec, excluded audiences, business places, user_os, wireless_carrier). Can be combined with targeting: rawTargeting is the BASE layer and the built camelCase spec is merged on top, key by key (camelCase wins on collision). The merge goes one level deep inside geo_locations and excluded_geo_locations (built sub-keys win; raw-only sub-keys such as location_types survive). Array values (flexible_spec, ...) are replaced as a whole key, never element-merged. When rawTargeting is present the advantage_audience: 0 default that Zernio normally applies is no longer emitted, so it cannot clobber a targeting_automation sent in the raw spec. Meta requires targeting_automation on ad set creation, so include it in the raw spec, or send targeting.advantage_audience (0 or 1), which is merged over raw as targeting_automation.



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

def raw_targeting
  @raw_targeting
end

#regional_regulated_categories ⇒ Object

Meta only. Regional regulation categories required when the ad set targets certain countries (e.g. BRAZIL_REGULATION, SINGAPORE_UNIVERSAL, TAIWAN_UNIVERSAL, THAILAND_UNIVERSAL, AUSTRALIA_FINSERV, INDIA_FINSERV, TAIWAN_FINSERV). Forwarded to the ad set.



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

def regional_regulated_categories
  @regional_regulated_categories
end

#regional_regulation_identities ⇒ Object

Meta only. Beneficiary/payer entity IDs for regionalRegulatedCategories. Values are numeric IDs from Meta verification. Keys vary by category (e.g. universal_beneficiary / universal_payer for BRAZIL_REGULATION and THAILAND_UNIVERSAL). If omitted, Meta uses Ads Manager defaults when configured.



115
116
117
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 115

def regional_regulation_identities
  @regional_regulation_identities
end

#roas_average_floor ⇒ Object

Deprecated: send it inside platformSpecificData instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400. 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).



99
100
101
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 99

def roas_average_floor
  @roas_average_floor
end

#schedule ⇒ Object

Returns the value of attribute schedule.



82
83
84
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 82

def schedule
  @schedule
end

#smart_plus ⇒ Object

TikTok only. Run the Spark post in a Smart+ campaign (goal conversions = Smart+ Web Conversions, lead_generation = Smart+ Lead Generation) instead of a regular campaign. Requires sparkAuthCode (the Smart+ ad runs the post under the identity that redeeming its Spark code creates; a Business Center-owned post is not accepted there) and promotedObject.pixelId + customEventType. app_promotion is not available on a Spark post. Rejected with a 400 on other platforms. A Smart+ Spark ad uses a dynamic CTA portfolio, sent as ad_configuration.call_to_action_id (TikTok does not accept a named call to action there): Zernio creates one per ad account and reuses it, and callToAction is rejected with a 400 on this path.



127
128
129
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 127

def smart_plus
  @smart_plus
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/.



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

def spark_auth_code
  @spark_auth_code
end

#spark_posts ⇒ Object

TikTok Smart+ only (requires smartPlus: true). Several Spark posts as creatives of ONE Smart+ ad, each with its own post code (TikTok allows 1-50 per ad; posts from different creators mix). Replaces platformPostId + sparkAuthCode. Without adSetId it creates campaign + ad group + one ad carrying all of them; with adSetId it creates one new ad with all of them in that ad group. Rejected with a 400 on other platforms.



130
131
132
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 130

def spark_posts
  @spark_posts
end

#special_ad_categories ⇒ Object

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



106
107
108
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 106

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



109
110
111
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 109

def special_ad_category_country
  @special_ad_category_country
end

#start_date ⇒ Object

Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's start_time. When omitted the ad starts delivering immediately. Same field as on POST /v1/ads/create.



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

def start_date
  @start_date
end

#status ⇒ Object

Meta, TikTok, LinkedIn, and Google. Publish state of the created entities. Omitted or ACTIVE publishes live (default); PAUSED creates them paused so you can review before they spend. On Meta a new campaign stays paused until explicitly activated; an attached ad is itself paused. On Google the pause is held on the campaign the boost creates (ad group and ad switched on), so PUT /v1/ads/campaigns/campaignId/status with active brings it live. On LinkedIn the whole campaign group, campaign, and creative hierarchy stays PAUSED (intendedStatus PAUSED on each).



147
148
149
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 147

def status
  @status
end

#targeting ⇒ Object

Returns the value of attribute targeting.



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

def targeting
  @targeting
end

#tracking ⇒ Object

Returns the value of attribute tracking.



103
104
105
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 103

def tracking
  @tracking
end

#whatsapp_phone_number ⇒ Object

Meta WhatsApp only. E.164 number already paired with the Page. Omit to use the default pairing. Requires WHATSAPP_MESSAGE callToAction. Stored as creative.whatsappPhoneNumber on the ad.



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

def whatsapp_phone_number
  @whatsapp_phone_number
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



240
241
242
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 240

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



245
246
247
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 245

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'creative_features' => :'creativeFeatures',
    :'post_id' => :'postId',
    :'platform_post_id' => :'platformPostId',
    :'account_id' => :'accountId',
    :'ad_account_id' => :'adAccountId',
    :'name' => :'name',
    :'campaign_name' => :'campaignName',
    :'ad_set_name' => :'adSetName',
    :'goal' => :'goal',
    :'ad_set_id' => :'adSetId',
    :'existing_campaign_id' => :'existingCampaignId',
    :'identity_id' => :'identityId',
    :'identity_type' => :'identityType',
    :'budget_amount' => :'budgetAmount',
    :'budget_type' => :'budgetType',
    :'budget' => :'budget',
    :'instagram_account_id' => :'instagramAccountId',
    :'destination_type' => :'destinationType',
    :'whatsapp_phone_number' => :'whatsappPhoneNumber',
    :'currency' => :'currency',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'schedule' => :'schedule',
    :'targeting' => :'targeting',
    :'location_targeting_type' => :'locationTargetingType',
    :'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',
    :'regional_regulated_categories' => :'regionalRegulatedCategories',
    :'regional_regulation_identities' => :'regionalRegulationIdentities',
    :'link_url' => :'linkUrl',
    :'call_to_action' => :'callToAction',
    :'spark_auth_code' => :'sparkAuthCode',
    :'smart_plus' => :'smartPlus',
    :'spark_posts' => :'sparkPosts',
    :'promo_codes' => :'promoCodes',
    :'promoted_object' => :'promotedObject',
    :'dsa_beneficiary' => :'dsaBeneficiary',
    :'dsa_payor' => :'dsaPayor',
    :'lead_gen_form_id' => :'leadGenFormId',
    :'status' => :'status',
    :'budget_level' => :'budgetLevel',
    :'attribution_spec' => :'attributionSpec',
    :'bodies' => :'bodies',
    :'optimization_goal' => :'optimizationGoal'
  }
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



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 1011

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



306
307
308
309
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 306

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

.openapi_types ⇒ Object

Attribute type mapping.



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
300
301
302
303
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 250

def self.openapi_types
  {
    :'creative_features' => :'Hash<String, String>',
    :'post_id' => :'String',
    :'platform_post_id' => :'String',
    :'account_id' => :'String',
    :'ad_account_id' => :'String',
    :'name' => :'String',
    :'campaign_name' => :'String',
    :'ad_set_name' => :'String',
    :'goal' => :'String',
    :'ad_set_id' => :'String',
    :'existing_campaign_id' => :'String',
    :'identity_id' => :'String',
    :'identity_type' => :'String',
    :'budget_amount' => :'Float',
    :'budget_type' => :'String',
    :'budget' => :'BoostPostRequestBudget',
    :'instagram_account_id' => :'String',
    :'destination_type' => :'String',
    :'whatsapp_phone_number' => :'String',
    :'currency' => :'String',
    :'start_date' => :'Time',
    :'end_date' => :'Time',
    :'schedule' => :'BoostPostRequestSchedule',
    :'targeting' => :'BoostPostRequestTargeting',
    :'location_targeting_type' => :'GoogleLocationTargetingType',
    :'raw_targeting' => :'Hash<String, Object>',
    :'bid_strategy' => :'BidStrategy',
    :'bid_amount' => :'Float',
    :'roas_average_floor' => :'Float',
    :'platform_specific_data' => :'BoostPostRequestPlatformSpecificData',
    :'tracking' => :'BoostPostRequestTracking',
    :'special_ad_categories' => :'Array<String>',
    :'special_ad_category_country' => :'Array<String>',
    :'regional_regulated_categories' => :'Array<String>',
    :'regional_regulation_identities' => :'Hash<String, Integer>',
    :'link_url' => :'String',
    :'call_to_action' => :'String',
    :'spark_auth_code' => :'String',
    :'smart_plus' => :'Boolean',
    :'spark_posts' => :'Array<BoostPostRequestSparkPostsInner>',
    :'promo_codes' => :'Array<BoostPostRequestPromoCodesInner>',
    :'promoted_object' => :'BoostPostRequestPromotedObject',
    :'dsa_beneficiary' => :'String',
    :'dsa_payor' => :'String',
    :'lead_gen_form_id' => :'String',
    :'status' => :'String',
    :'budget_level' => :'String',
    :'attribution_spec' => :'Array<BoostPostRequestAttributionSpecInner>',
    :'bodies' => :'Array<String>',
    :'optimization_goal' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 941

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      creative_features == o.creative_features &&
      post_id == o.post_id &&
      platform_post_id == o.platform_post_id &&
       == o. &&
       == o. &&
      name == o.name &&
      campaign_name == o.campaign_name &&
      ad_set_name == o.ad_set_name &&
      goal == o.goal &&
      ad_set_id == o.ad_set_id &&
      existing_campaign_id == o.existing_campaign_id &&
      identity_id == o.identity_id &&
      identity_type == o.identity_type &&
      budget_amount == o.budget_amount &&
      budget_type == o.budget_type &&
      budget == o.budget &&
       == o. &&
      destination_type == o.destination_type &&
      whatsapp_phone_number == o.whatsapp_phone_number &&
      currency == o.currency &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      schedule == o.schedule &&
      targeting == o.targeting &&
      location_targeting_type == o.location_targeting_type &&
      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 &&
      regional_regulated_categories == o.regional_regulated_categories &&
      regional_regulation_identities == o.regional_regulation_identities &&
      link_url == o.link_url &&
      call_to_action == o.call_to_action &&
      spark_auth_code == o.spark_auth_code &&
      smart_plus == o.smart_plus &&
      spark_posts == o.spark_posts &&
      promo_codes == o.promo_codes &&
      promoted_object == o.promoted_object &&
      dsa_beneficiary == o.dsa_beneficiary &&
      dsa_payor == o.dsa_payor &&
      lead_gen_form_id == o.lead_gen_form_id &&
      status == o.status &&
      budget_level == o.budget_level &&
      attribution_spec == o.attribution_spec &&
      bodies == o.bodies &&
      optimization_goal == o.optimization_goal
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


998
999
1000
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 998

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



1004
1005
1006
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 1004

def hash
  [creative_features, post_id, platform_post_id, , , name, campaign_name, ad_set_name, goal, ad_set_id, existing_campaign_id, identity_id, identity_type, budget_amount, budget_type, budget, , destination_type, whatsapp_phone_number, currency, start_date, end_date, schedule, targeting, location_targeting_type, raw_targeting, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, tracking, special_ad_categories, special_ad_category_country, regional_regulated_categories, regional_regulation_identities, link_url, call_to_action, spark_auth_code, smart_plus, spark_posts, promo_codes, promoted_object, dsa_beneficiary, dsa_payor, lead_gen_form_id, status, budget_level, attribution_spec, bodies, optimization_goal].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



558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 558

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

  if !@ad_set_name.nil? && @ad_set_name.to_s.length > 255
    invalid_properties.push('invalid value for "ad_set_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

  pattern = Regexp.new(/^\+[1-9]\d{6,14}$/)
  if !@whatsapp_phone_number.nil? && @whatsapp_phone_number !~ pattern
    invalid_properties.push("invalid value for \"whatsapp_phone_number\", must conform to the pattern #{pattern}.")
  end

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

  if !@currency.nil? && @currency.to_s.length < 3
    invalid_properties.push('invalid value for "currency", the character length must be greater than or equal to 3.')
  end

  if !@spark_posts.nil? && @spark_posts.length > 50
    invalid_properties.push('invalid value for "spark_posts", number of items must be less than or equal to 50.')
  end

  if !@spark_posts.nil? && @spark_posts.length < 1
    invalid_properties.push('invalid value for "spark_posts", number of items must be greater than or equal to 1.')
  end

  if !@promo_codes.nil? && @promo_codes.length > 10
    invalid_properties.push('invalid value for "promo_codes", number of items must be less than or equal to 10.')
  end

  if !@promo_codes.nil? && @promo_codes.length < 1
    invalid_properties.push('invalid value for "promo_codes", number of items must be greater than or equal to 1.')
  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

  if !@attribution_spec.nil? && @attribution_spec.length > 3
    invalid_properties.push('invalid value for "attribution_spec", number of items must be less than or equal to 3.')
  end

  if !@attribution_spec.nil? && @attribution_spec.length < 1
    invalid_properties.push('invalid value for "attribution_spec", number of items must be greater than or equal to 1.')
  end

  if !@bodies.nil? && @bodies.length > 5
    invalid_properties.push('invalid value for "bodies", number of items must be less than or equal to 5.')
  end

  if !@bodies.nil? && @bodies.length < 1
    invalid_properties.push('invalid value for "bodies", number of items must be greater than or equal to 1.')
  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



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 1033

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



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/zernio-sdk/models/boost_post_request.rb', line 647

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 !@campaign_name.nil? && @campaign_name.to_s.length > 255
  return false if !@ad_set_name.nil? && @ad_set_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)
  identity_type_validator = EnumAttributeValidator.new('String', ["TT_USER", "CUSTOMIZED_USER", "BC_AUTH_TT"])
  return false unless identity_type_validator.valid?(@identity_type)
  budget_type_validator = EnumAttributeValidator.new('String', ["daily", "lifetime"])
  return false unless budget_type_validator.valid?(@budget_type)
  destination_type_validator = EnumAttributeValidator.new('String', ["INSTAGRAM_PROFILE", "WEBSITE", "ON_AD", "MESSENGER", "WHATSAPP", "INSTAGRAM_DIRECT"])
  return false unless destination_type_validator.valid?(@destination_type)
  return false if !@whatsapp_phone_number.nil? && @whatsapp_phone_number !~ Regexp.new(/^\+[1-9]\d{6,14}$/)
  return false if !@currency.nil? && @currency.to_s.length > 3
  return false if !@currency.nil? && @currency.to_s.length < 3
  return false if !@spark_posts.nil? && @spark_posts.length > 50
  return false if !@spark_posts.nil? && @spark_posts.length < 1
  return false if !@promo_codes.nil? && @promo_codes.length > 10
  return false if !@promo_codes.nil? && @promo_codes.length < 1
  return false if !@dsa_beneficiary.nil? && @dsa_beneficiary.to_s.length > 100
  return false if !@dsa_payor.nil? && @dsa_payor.to_s.length > 100
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "PAUSED"])
  return false unless status_validator.valid?(@status)
  budget_level_validator = EnumAttributeValidator.new('String', ["adset", "campaign"])
  return false unless budget_level_validator.valid?(@budget_level)
  return false if !@attribution_spec.nil? && @attribution_spec.length > 3
  return false if !@attribution_spec.nil? && @attribution_spec.length < 1
  return false if !@bodies.nil? && @bodies.length > 5
  return false if !@bodies.nil? && @bodies.length < 1
  true
end