zernio-sdk 0.0.834 → 0.0.836

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3fd16dc3f325aa78d8c8a4fb1226dc581e6d2e5b9f9af9c790f2fce3a696506
-  data.tar.gz: 1d384392bf19efeac53f317f52b5fc9d461a71f5ada0bb93baeb5760a9e210a4
+  metadata.gz: 6cedce61d089cf837c627842e980692ddc32a52e028fbd65ff4dcd10a4f2acbe
+  data.tar.gz: 17b2a371f6e12d775445bd230f9cd40a4cf65f9e602eccbe90e1746b7c5181c0
 SHA512:
-  metadata.gz: 51c90d614a019e7cb2a1275c5626531e262d96f3f9ee35b9f44370532c5f5ee4344f7112c4fd7318f85173bd97e6cc5ab0535f666dd521d1405f4e98d8d55a84
-  data.tar.gz: 28bcc6ab0a817b8c63bdc5b8f0a4223e76b33c4ab759461dcb7e2097bae348487e5d595899aa02841cc892ddc361d9c656da690cbf4776dead9cfc6da20840c2
+  metadata.gz: a4dc60bc144675b909e72471890cf87316abeadd5005e6df4756dfe690654a91fd039265cf2a99b15b750327f259680ebd1852414ff4a78e8ec0e41eb90767ea
+  data.tar.gz: 2d0284dd2a3ef9ca3f5f10f66c34a81c3108e67b26db8ab81fb3f51837697353e38ca289c8a4124d562284157efbf64694dbbb3c3e20ef7f07be3190e166446c

data/docs/MetaAdsPlatformData.md

@@ -7,6 +7,8 @@
 | **bid_strategy** | [**BidStrategy**](BidStrategy.md) |  | [optional] |
 | **bid_amount** | **Float** | Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. May also be sent alone, WITHOUT bidStrategy, to set the cap on an ad set joining a COST_CAP / LOWEST_COST_WITH_BID_CAP campaign (the strategy is inherited from the campaign). On POST /v1/ads/create that shape requires existingCampaignId and is a 400 otherwise; on POST /v1/ads/boost it is promoted to LOWEST_COST_WITH_BID_CAP. | [optional] |
 | **roas_average_floor** | **Float** | Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400. | [optional] |
+| **daily_min_spend_target** | **Float** | Meta daily_min_spend_target on the ad set being created: the least it should spend per day, in whole currency units. It reserves a share of a CAMPAIGN budget, so it requires budgetLevel campaign or an existingCampaignId whose campaign has the budget (Advantage campaign budget / CBO); with an ad-set budget it is a 400, because Meta rejects a spend limit on an ad set that owns its budget. A target, not a guarantee. Mutually exclusive with lifetimeMinSpendTarget: the flavour must match the campaign budget type. Rejected with 400 on POST /v1/ads/boost and in adSetId attach mode: use PUT /v1/ads/ad-sets/{adSetId} for an ad set that already exists. | [optional] |
+| **lifetime_min_spend_target** | **Float** | Meta lifetime_min_spend_target: the lifetime-budget flavour of dailyMinSpendTarget, in whole currency units. Same rules and same rejections. | [optional] |
 
 ## Example
 
@@ -16,7 +18,9 @@ require 'zernio-sdk'
 instance = Zernio::MetaAdsPlatformData.new(
   bid_strategy: null,
   bid_amount: null,
-  roas_average_floor: null
+  roas_average_floor: null,
+  daily_min_spend_target: null,
+  lifetime_min_spend_target: null
 )
 ```
 

data/docs/UpdateAdSetRequestPlatformSpecificData.md

@@ -8,6 +8,8 @@
 | **billing_event** | **String** | Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY). | [optional] |
 | **start_date** | **String** | Ad set start_time (ISO 8601). | [optional] |
 | **end_date** | **String** | Ad set end_time (ISO 8601). | [optional] |
+| **daily_min_spend_target** | **Float** | Meta `daily_min_spend_target`: the least this ad set should spend per day, in whole currency units of the ad account. It reserves a share of a CAMPAIGN budget for one ad set, so it requires a campaign using Advantage campaign budget (CBO). On an ad set that owns its budget (ABO) this returns 409 — move the budget to the campaign with `PUT /v1/ads/campaigns/{campaignId}` first. Meta treats it as a target, not a guarantee, and rejects the combined minimum of a campaign's ad sets going over the campaign budget. Mutually exclusive with `lifetimeMinSpendTarget` (400): the flavour must match the campaign budget type, a daily budget takes a daily target. Read it back with `GET /v1/ads/ad-sets/{adSetId}?fields=daily_min_spend_target`.  | [optional] |
+| **lifetime_min_spend_target** | **Float** | Meta `lifetime_min_spend_target`: the lifetime-budget flavour of `dailyMinSpendTarget`, in whole currency units. Send this one when the campaign budget is a lifetime budget. Same rules and same rejections.  | [optional] |
 | **promoted_object** | [**UpdateAdSetRequestPlatformSpecificDataPromotedObject**](UpdateAdSetRequestPlatformSpecificDataPromotedObject.md) |  | [optional] |
 
 ## Example
@@ -20,6 +22,8 @@ instance = Zernio::UpdateAdSetRequestPlatformSpecificData.new(
   billing_event: null,
   start_date: null,
   end_date: null,
+  daily_min_spend_target: null,
+  lifetime_min_spend_target: null,
   promoted_object: null
 )
 ```

data/lib/zernio-sdk/models/create_standalone_ad_request_platform_specific_data.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Zernio
-  # Platform-specific options. The platform is derived from `accountId`; sending options for a different platform returns a 400. LinkedIn (campaign bidding and delivery controls) and Meta (the bid trio) have options today.  **Meta**: `bidStrategy`, `bidAmount` and `roasAverageFloor` may be sent here instead of at the root — the preferred home going forward. Sending the bid fields in BOTH places returns a 400 (`mutually_exclusive_fields`), and sending any of them in `adSetId` attach mode is a 400 too (the ad set already has its bid). 
+  # Platform-specific options. The platform is derived from `accountId`; sending options for a different platform returns a 400. LinkedIn (campaign bidding and delivery controls) and Meta (the bid trio) have options today.  **Meta**: `bidStrategy`, `bidAmount` and `roasAverageFloor` may be sent here instead of at the root — the preferred home going forward. Sending the bid fields in BOTH places returns a 400 (`mutually_exclusive_fields`), and sending any of them in `adSetId` attach mode is a 400 too (the ad set already has its bid). `dailyMinSpendTarget` / `lifetimeMinSpendTarget` set the new ad set's minimum spend and live here only; they are rejected in `adSetId` attach mode as well. 
   module CreateStandaloneAdRequestPlatformSpecificData
     class << self
       # List of class defined in oneOf (OpenAPI v3)

data/lib/zernio-sdk/models/meta_ads_platform_data.rb

@@ -24,6 +24,12 @@ module Zernio
     # Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400.
     attr_accessor :roas_average_floor
 
+    # Meta daily_min_spend_target on the ad set being created: the least it should spend per day, in whole currency units. It reserves a share of a CAMPAIGN budget, so it requires budgetLevel campaign or an existingCampaignId whose campaign has the budget (Advantage campaign budget / CBO); with an ad-set budget it is a 400, because Meta rejects a spend limit on an ad set that owns its budget. A target, not a guarantee. Mutually exclusive with lifetimeMinSpendTarget: the flavour must match the campaign budget type. Rejected with 400 on POST /v1/ads/boost and in adSetId attach mode: use PUT /v1/ads/ad-sets/{adSetId} for an ad set that already exists.
+    attr_accessor :daily_min_spend_target
+
+    # Meta lifetime_min_spend_target: the lifetime-budget flavour of dailyMinSpendTarget, in whole currency units. Same rules and same rejections.
+    attr_accessor :lifetime_min_spend_target
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -51,7 +57,9 @@ module Zernio
       {
         :'bid_strategy' => :'bidStrategy',
         :'bid_amount' => :'bidAmount',
-        :'roas_average_floor' => :'roasAverageFloor'
+        :'roas_average_floor' => :'roasAverageFloor',
+        :'daily_min_spend_target' => :'dailyMinSpendTarget',
+        :'lifetime_min_spend_target' => :'lifetimeMinSpendTarget'
       }
     end
 
@@ -70,7 +78,9 @@ module Zernio
       {
         :'bid_strategy' => :'BidStrategy',
         :'bid_amount' => :'Float',
-        :'roas_average_floor' => :'Float'
+        :'roas_average_floor' => :'Float',
+        :'daily_min_spend_target' => :'Float',
+        :'lifetime_min_spend_target' => :'Float'
       }
     end
 
@@ -107,6 +117,14 @@ module Zernio
       if attributes.key?(:'roas_average_floor')
         self.roas_average_floor = attributes[:'roas_average_floor']
       end
+
+      if attributes.key?(:'daily_min_spend_target')
+        self.daily_min_spend_target = attributes[:'daily_min_spend_target']
+      end
+
+      if attributes.key?(:'lifetime_min_spend_target')
+        self.lifetime_min_spend_target = attributes[:'lifetime_min_spend_target']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -131,7 +149,9 @@ module Zernio
       self.class == o.class &&
           bid_strategy == o.bid_strategy &&
           bid_amount == o.bid_amount &&
-          roas_average_floor == o.roas_average_floor
+          roas_average_floor == o.roas_average_floor &&
+          daily_min_spend_target == o.daily_min_spend_target &&
+          lifetime_min_spend_target == o.lifetime_min_spend_target
     end
 
     # @see the `==` method
@@ -143,7 +163,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [bid_strategy, bid_amount, roas_average_floor].hash
+      [bid_strategy, bid_amount, roas_average_floor, daily_min_spend_target, lifetime_min_spend_target].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb

@@ -28,6 +28,12 @@ module Zernio
     # Ad set end_time (ISO 8601).
     attr_accessor :end_date
 
+    # Meta `daily_min_spend_target`: the least this ad set should spend per day, in whole currency units of the ad account. It reserves a share of a CAMPAIGN budget for one ad set, so it requires a campaign using Advantage campaign budget (CBO). On an ad set that owns its budget (ABO) this returns 409 — move the budget to the campaign with `PUT /v1/ads/campaigns/{campaignId}` first. Meta treats it as a target, not a guarantee, and rejects the combined minimum of a campaign's ad sets going over the campaign budget. Mutually exclusive with `lifetimeMinSpendTarget` (400): the flavour must match the campaign budget type, a daily budget takes a daily target. Read it back with `GET /v1/ads/ad-sets/{adSetId}?fields=daily_min_spend_target`. 
+    attr_accessor :daily_min_spend_target
+
+    # Meta `lifetime_min_spend_target`: the lifetime-budget flavour of `dailyMinSpendTarget`, in whole currency units. Send this one when the campaign budget is a lifetime budget. Same rules and same rejections. 
+    attr_accessor :lifetime_min_spend_target
+
     attr_accessor :promoted_object
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -37,6 +43,8 @@ module Zernio
         :'billing_event' => :'billingEvent',
         :'start_date' => :'startDate',
         :'end_date' => :'endDate',
+        :'daily_min_spend_target' => :'dailyMinSpendTarget',
+        :'lifetime_min_spend_target' => :'lifetimeMinSpendTarget',
         :'promoted_object' => :'promotedObject'
       }
     end
@@ -58,6 +66,8 @@ module Zernio
         :'billing_event' => :'String',
         :'start_date' => :'String',
         :'end_date' => :'String',
+        :'daily_min_spend_target' => :'Float',
+        :'lifetime_min_spend_target' => :'Float',
         :'promoted_object' => :'UpdateAdSetRequestPlatformSpecificDataPromotedObject'
       }
     end
@@ -100,6 +110,14 @@ module Zernio
         self.end_date = attributes[:'end_date']
       end
 
+      if attributes.key?(:'daily_min_spend_target')
+        self.daily_min_spend_target = attributes[:'daily_min_spend_target']
+      end
+
+      if attributes.key?(:'lifetime_min_spend_target')
+        self.lifetime_min_spend_target = attributes[:'lifetime_min_spend_target']
+      end
+
       if attributes.key?(:'promoted_object')
         self.promoted_object = attributes[:'promoted_object']
       end
@@ -129,6 +147,8 @@ module Zernio
           billing_event == o.billing_event &&
           start_date == o.start_date &&
           end_date == o.end_date &&
+          daily_min_spend_target == o.daily_min_spend_target &&
+          lifetime_min_spend_target == o.lifetime_min_spend_target &&
           promoted_object == o.promoted_object
     end
 
@@ -141,7 +161,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [optimization_goal, billing_event, start_date, end_date, promoted_object].hash
+      [optimization_goal, billing_event, start_date, end_date, daily_min_spend_target, lifetime_min_spend_target, promoted_object].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 
 module Zernio
-  VERSION = '0.0.834'
+  VERSION = '0.0.836'
 end

data/openapi.yaml

@@ -5968,6 +5968,8 @@ components:
         bidStrategy: { $ref: '#/components/schemas/BidStrategy' }
         bidAmount: { type: number, description: "Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. May also be sent alone, WITHOUT bidStrategy, to set the cap on an ad set joining a COST_CAP / LOWEST_COST_WITH_BID_CAP campaign (the strategy is inherited from the campaign). On POST /v1/ads/create that shape requires existingCampaignId and is a 400 otherwise; on POST /v1/ads/boost it is promoted to LOWEST_COST_WITH_BID_CAP." }
         roasAverageFloor: { type: number, description: "Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400." }
+        dailyMinSpendTarget: { type: number, description: "Meta daily_min_spend_target on the ad set being created: the least it should spend per day, in whole currency units. It reserves a share of a CAMPAIGN budget, so it requires budgetLevel campaign or an existingCampaignId whose campaign has the budget (Advantage campaign budget / CBO); with an ad-set budget it is a 400, because Meta rejects a spend limit on an ad set that owns its budget. A target, not a guarantee. Mutually exclusive with lifetimeMinSpendTarget: the flavour must match the campaign budget type. Rejected with 400 on POST /v1/ads/boost and in adSetId attach mode: use PUT /v1/ads/ad-sets/{adSetId} for an ad set that already exists." }
+        lifetimeMinSpendTarget: { type: number, description: "Meta lifetime_min_spend_target: the lifetime-budget flavour of dailyMinSpendTarget, in whole currency units. Same rules and same rejections." }
     LinkedInAdsPlatformData:
       type: object
       additionalProperties: false
@@ -41838,6 +41840,25 @@ paths:
                     billingEvent: { type: string, description: "Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY)." }
                     startDate: { type: string, description: "Ad set start_time (ISO 8601)." }
                     endDate: { type: string, description: "Ad set end_time (ISO 8601)." }
+                    dailyMinSpendTarget:
+                      type: number
+                      description: |
+                        Meta `daily_min_spend_target`: the least this ad set should spend per day, in whole
+                        currency units of the ad account. It reserves a share of a CAMPAIGN budget for one ad
+                        set, so it requires a campaign using Advantage campaign budget (CBO). On an ad set
+                        that owns its budget (ABO) this returns 409 — move the budget to the campaign with
+                        `PUT /v1/ads/campaigns/{campaignId}` first. Meta treats it as a target, not a
+                        guarantee, and rejects the combined minimum of a campaign's ad sets going over the
+                        campaign budget.
+                        Mutually exclusive with `lifetimeMinSpendTarget` (400): the flavour must match the
+                        campaign budget type, a daily budget takes a daily target.
+                        Read it back with `GET /v1/ads/ad-sets/{adSetId}?fields=daily_min_spend_target`.
+                    lifetimeMinSpendTarget:
+                      type: number
+                      description: |
+                        Meta `lifetime_min_spend_target`: the lifetime-budget flavour of
+                        `dailyMinSpendTarget`, in whole currency units. Send this one when the campaign
+                        budget is a lifetime budget. Same rules and same rejections.
                     promotedObject:
                       type: object
                       description: "Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create). Unknown keys are rejected with 400."
@@ -45475,6 +45496,9 @@ paths:
                     Sending the bid fields in BOTH places returns a 400
                     (`mutually_exclusive_fields`), and sending any of them in
                     `adSetId` attach mode is a 400 too (the ad set already has its bid).
+                    `dailyMinSpendTarget` / `lifetimeMinSpendTarget` set the new ad set's
+                    minimum spend and live here only; they are rejected in `adSetId` attach
+                    mode as well.
                   oneOf:
                     - $ref: '#/components/schemas/LinkedInAdsPlatformData'
                     - $ref: '#/components/schemas/MetaAdsPlatformData'

data/spec/models/meta_ads_platform_data_spec.rb

@@ -45,4 +45,16 @@ describe Zernio::MetaAdsPlatformData do
     end
   end
 
+  describe 'test attribute "daily_min_spend_target"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "lifetime_min_spend_target"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/update_ad_set_request_platform_specific_data_spec.rb

@@ -51,6 +51,18 @@ describe Zernio::UpdateAdSetRequestPlatformSpecificData do
     end
   end
 
+  describe 'test attribute "daily_min_spend_target"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "lifetime_min_spend_target"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "promoted_object"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zernio-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.834
+  version: 0.0.836
 platform: ruby
 authors:
 - OpenAPI-Generator