facebookbusiness 20.0.0 → 20.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45f902ba41cb7537b8b1b9cbe01d2574dc00686947bab8c19cf6bccf5d79d080
-  data.tar.gz: e4ed46ba34a9f14fe20aa09c5b9895e9d06cc00d2fd4c066192f45ebc8ddf3c8
+  metadata.gz: cedc6a1b168ca4a27b28a71c55b602e341780e151c8b0b9ea8a18bec46e8e17f
+  data.tar.gz: 2c65fb40cf0f8d6421c86207575dd9cfd2e94a0b86779bcafcdd9845ac8cc290
 SHA512:
-  metadata.gz: 15caf3b07ad6e846222697615789c4580f1ea1936631068d37529dfacc5b1753798f363ffaa48cce3ce62daf98e9006c368541b2ab03562865ffe69e05b34c09
-  data.tar.gz: f4a053226f78ba7d684f30757bf98e3be67efc69458b32a174c0a0fc5d58f4349c53e80768b1c7d05dd6c1958a2fc67752c6699bad42f5aa7c0dd2bdac611e68
+  metadata.gz: f49be4f9cfc8209d3172fcd066523b459e5cdc6577ed144d6039b7ca1525cbd33c6a48277a2e40f9f94fe5cd978ca44b8e539fc29dbe8b5c99dd739f71cfc2f5
+  data.tar.gz: 98909554bb031c566077fa95b0fbe4e8e05bdc873464dc60c9caa355790e6bd5a00332d8e94924699b6854fb40cfbbb719f04b84798f0a78c2417c713004f602

data/lib/facebook_ads/ad_objects/{ad_account_optimization_goals_ae_mv2_eligibility.rb → ad_account_optimization_goals_aemv2_eligibility.rb}

@@ -13,7 +13,7 @@ module FacebookAds
   # on github and we'll fix in our codegen framework. We'll not be able to accept
   # pull request for this class.
 
-  class AdAccountOptimizationGoalsAeMv2Eligibility < AdObject
+  class AdAccountOptimizationGoalsAemv2Eligibility < AdObject
     OPTIMIZATION_GOAL = [
       "AD_RECALL_LIFT",
       "APP_INSTALLS",

data/lib/facebook_ads/ad_objects/{p2_m_invoice_payments.rb → p2m_invoice_payments.rb}

@@ -13,7 +13,7 @@ module FacebookAds
   # on github and we'll fix in our codegen framework. We'll not be able to accept
   # pull request for this class.
 
-  class P2MInvoicePayments < AdObject
+  class P2mInvoicePayments < AdObject
 
     field :page_id, 'string'
     field :payments, { list: 'object' }

data/lib/facebook_ads/ad_objects/server_side/attribution_data.rb

@@ -0,0 +1,216 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module FacebookAds
+    module ServerSide
+
+      # AttributionData indicated the attribution data used for attribution passback event to optimize the performance.
+      class AttributionData
+
+        # Touchpoint type.
+        attr_accessor :scope
+
+        # A Unix timestamp in seconds indicating when the campaign_id or fbc was first received.
+        attr_accessor :visit_time
+
+        # Meta-provided ad id from URL/deeplink.
+        attr_accessor :ad_id
+
+        # Meta-provided adset id from URL/deeplink.
+        attr_accessor :adset_id
+
+        # Meta-provided campaign id from URL/deeplink.
+        attr_accessor :campaign_id
+
+        # [0-1] weight of credit assigned to the visit.
+        attr_accessor :attribution_share
+
+        # Attribution model used to attribute the event.
+        attr_accessor :attribution_model
+
+        # Attribution woindow in days.
+        attr_accessor :attr_window
+
+
+
+        # @param [String] scope
+        # @param [Integer] visit_time
+        # @param [String] ad_id
+        # @param [String] adset_id
+        # @param [String] campaign_id
+        # @param [Float] attribution_share
+        # @param [String] attribution_model
+        # @param [String] attr_window
+        def initialize(scope: nil, visit_time: nil, ad_id: nil, adset_id: nil, campaign_id: nil, attribution_share: nil, attribution_model: nil, attr_window: nil)
+          unless scope.nil?
+            self.scope = scope
+          end
+          unless visit_time.nil?
+            self.visit_time = visit_time
+          end
+          unless ad_id.nil?
+            self.ad_id = ad_id
+          end
+          unless adset_id.nil?
+            self.adset_id = adset_id
+          end
+          unless campaign_id.nil?
+            self.campaign_id = campaign_id
+          end
+          unless attribution_share.nil?
+            self.attribution_share = attribution_share
+          end
+          unless attribution_model.nil?
+            self.attribution_model = attribution_model
+          end
+          unless attr_window.nil?
+            self.attr_window = attr_window
+          end
+        end
+
+        # build the object using the input hash
+        # @param [Hash] attributes  attributes in the form of hash
+        def build(attributes = {})
+          return unless attributes.is_a?(Hash)
+
+          # convert string to symbol for hash key
+          attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+          if attributes.has_key?(:'scope')
+            self.scope = attributes[:'scope']
+          end
+
+          if attributes.has_key?(:'visit_time')
+            self.visit_time = attributes[:'visit_time']
+          end
+
+          if attributes.has_key?(:'ad_id')
+            self.ad_id = attributes[:'ad_id']
+          end
+
+          if attributes.has_key?(:'adset_id')
+            self.adset_id = attributes[:'adset_id']
+          end
+
+          if attributes.has_key?(:'campaign_id')
+            self.campaign_id = attributes[:'campaign_id']
+          end
+
+          if attributes.has_key?(:'attribution_share')
+            self.attribution_share = attributes[:'attribution_share']
+          end
+
+          if attributes.has_key?(:'attribution_model')
+            self.attribution_model = attributes[:'attribution_model']
+          end
+
+          if attributes.has_key?(:'attr_window')
+            self.attr_window = attributes[:'attr_window']
+          end
+        end
+
+        # Checks equality by comparing each attribute.
+        def ==(o)
+          return true if self.equal?(o)
+          self.class == o.class &&
+              scope == o.scope &&
+              visit_time == o.visit_time &&
+              ad_id == o.ad_id &&
+              adset_id == o.adset_id &&
+              campaign_id == o.campaign_id &&
+              attribution_share == o.attribution_share &&
+              attribution_model == o.attribution_model &&
+              attr_window == o.attr_window
+        end
+
+        # @see the `==` method
+        def eql?(o)
+          self == o
+        end
+
+        # Calculates hash code according to all attributes.
+        # @return [Fixnum] Hash code
+        def hash
+          [
+            scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window
+          ].hash
+        end
+
+        def to_s
+          hash = {}
+          unless scope.nil?
+            hash['scope'] = scope
+          end
+          unless visit_time.nil?
+            hash['visit_time'] = visit_time
+          end
+          unless ad_id.nil?
+            hash['ad_id'] = ad_id
+          end
+          unless adset_id.nil?
+            hash['adset_id'] = adset_id
+          end
+          unless campaign_id.nil?
+            hash['campaign_id'] = campaign_id
+          end
+          unless attribution_share.nil?
+            hash['attribution_share'] = attribution_share
+          end
+          unless attribution_model.nil?
+            hash['attribution_model'] = attribution_model
+          end
+          unless attr_window.nil?
+            hash['attr_window'] = attr_window
+          end
+          hash.to_s
+        end
+
+
+        # Normalize input fields to server request format.
+        def normalize
+          hash = {}
+          unless scope.nil?
+            hash['scope'] = scope
+          end
+          unless visit_time.nil?
+            hash['visit_time'] = visit_time
+          end
+          unless ad_id.nil?
+            hash['ad_id'] = ad_id
+          end
+          unless adset_id.nil?
+            hash['adset_id'] = adset_id
+          end
+          unless campaign_id.nil?
+            hash['campaign_id'] = campaign_id
+          end
+          unless attribution_share.nil?
+            hash['attribution_share'] = attribution_share
+          end
+          unless attribution_model.nil?
+            hash['attribution_model'] = attribution_model
+          end
+          unless attr_window.nil?
+            hash['attr_window'] = attr_window
+          end
+          hash
+        end
+
+      end
+    end
+  end

data/lib/facebook_ads/ad_objects/server_side/event.rb

@@ -19,6 +19,8 @@
 require_relative './user_data'
 require_relative './custom_data'
 require_relative './app_data'
+require_relative './original_event_data'
+require_relative './attribution_data'
 
 module FacebookAds
   module ServerSide
@@ -78,6 +80,12 @@ module FacebookAds
       # Messaging channel for the event
       attr_accessor :messaging_channel
 
+      # Original event info
+      attr_accessor :original_event_data
+
+      # Attribution data info
+      attr_accessor :attribution_data
+
       # @param [String] event_name
       # @param [int] event_time
       # @param [String] event_source_url
@@ -92,6 +100,8 @@ module FacebookAds
       # @param String action_source
       # @param [String] advanced_measurement_table
       # @param [String] messaging_channel
+      # @param [FacebookAds::ServerSide::OriginalEventData] original_event_data
+      # @param [FacebookAds::ServerSide::AttributionData] attribution_data
       def initialize(event_name: nil,
                      event_time: nil,
                      event_source_url: nil,
@@ -105,7 +115,9 @@ module FacebookAds
                      data_processing_options_state: nil,
                      action_source: nil,
                      advanced_measurement_table: nil,
-                     messaging_channel: nil
+                     messaging_channel: nil,
+                     original_event_data: nil,
+                     attribution_data: nil
                      )
 
         unless event_name.nil?
@@ -150,6 +162,12 @@ module FacebookAds
         unless messaging_channel.nil?
           self.messaging_channel = messaging_channel
         end
+        unless original_event_data.nil?
+          self.original_event_data = original_event_data
+        end
+        unless attribution_data.nil?
+          self.attribution_data = attribution_data
+        end
       end
 
       # build the object using the input hash
@@ -215,6 +233,14 @@ module FacebookAds
         if attributes.has_key?(:'messaging_channel')
           self.messaging_channel = attributes[:'messaging_channel']
         end
+
+        if attributes.has_key?(:'original_event_data')
+          self.original_event_data = attributes[:'original_event_data']
+        end
+
+        if attributes.has_key?(:'attribution_data')
+          self.attribution_data = attributes[:'attribution_data']
+        end
       end
 
       # Show invalid properties with the reasons. Usually used together with valid?
@@ -261,8 +287,10 @@ module FacebookAds
             data_processing_options_country == o.data_processing_options_country &&
             data_processing_options_state == o.data_processing_options_state &&
             action_source == o.action_source &&
-            advanced_measurement_table == o.advanced_measurement_table
-            messaging_channel == o.messaging_channel
+            advanced_measurement_table == o.advanced_measurement_table &&
+            messaging_channel == o.messaging_channel &&
+            original_event_data == o.original_event_data &&
+            attribution_data == o.attribution_data
       end
 
       # @see the `==` method
@@ -276,7 +304,7 @@ module FacebookAds
         [
           event_name, event_time, event_source_url, opt_out, event_id, user_data, custom_data, app_data,
           data_processing_options, data_processing_options_country, data_processing_options_state,
-          action_source, advanced_measurement_table, messaging_channel,
+          action_source, advanced_measurement_table, messaging_channel, original_event_data, attribution_data
         ].hash
       end
 
@@ -324,6 +352,12 @@ module FacebookAds
         unless messaging_channel.nil?
           hash['messaging_channel'] = messaging_channel
         end
+        unless original_event_data.nil?
+          hash['original_event_data'] = original_event_data
+        end
+        unless attribution_data.nil?
+          hash['attribution_data'] = attribution_data
+        end
         hash.to_s
       end
 
@@ -376,6 +410,12 @@ module FacebookAds
         unless messaging_channel.nil?
           hash['messaging_channel'] = messaging_channel
         end
+        unless original_event_data.nil?
+          hash['original_event_data'] = original_event_data
+        end
+        unless attribution_data.nil?
+          hash['attribution_data'] = attribution_data
+        end
         hash
       end
 

data/lib/facebook_ads/ad_objects/server_side/original_event_data.rb

@@ -0,0 +1,107 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module FacebookAds
+    module ServerSide
+
+      # OriginalEventData contains original event info used for attribution passback event or generalized value optimization(GVO).
+      class OriginalEventData
+
+        # A Facebook pixel Standard Event or Custom Event name.
+        # This is used with event_id to determine if events are identical.
+        attr_accessor :event_name
+
+        # A Unix timestamp in seconds indicating when the original event occurred.
+        attr_accessor :event_time
+
+        # @param [String] event_name
+        # @param [int] event_time
+        def initialize(event_name: nil, event_time: nil)
+          unless event_name.nil?
+            self.event_name = event_name
+          end
+          unless event_time.nil?
+            self.event_time = event_time
+          end
+        end
+
+        # build the object using the input hash
+        # @param [Hash] attributes  attributes in the form of hash
+        def build(attributes = {})
+          return unless attributes.is_a?(Hash)
+
+          # convert string to symbol for hash key
+          attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+          if attributes.has_key?(:'event_name')
+            self.event_name = attributes[:'event_name']
+          end
+
+          if attributes.has_key?(:'event_time')
+            self.event_time = attributes[:'event_time']
+          end
+        end
+
+        # Checks equality by comparing each attribute.
+        def ==(o)
+          return true if self.equal?(o)
+          self.class == o.class &&
+              event_name == o.event_name &&
+              event_time == o.event_time
+        end
+
+        # @see the `==` method
+        def eql?(o)
+          self == o
+        end
+
+        # Calculates hash code according to all attributes.
+        # @return [Fixnum] Hash code
+        def hash
+          [
+            event_name, event_time,
+          ].hash
+        end
+
+        def to_s
+          hash = {}
+          unless event_name.nil?
+            hash['event_name'] = event_name
+          end
+          unless event_time.nil?
+            hash['event_time'] = event_time
+          end
+          hash.to_s
+        end
+
+
+        # Normalize input fields to server request format.
+        def normalize
+          hash = {}
+          unless event_name.nil?
+            hash['event_name'] = event_name
+          end
+          unless event_time.nil?
+            hash['event_time'] = event_time
+          end
+          hash
+        end
+
+      end
+    end
+  end

data/lib/facebook_ads/ad_objects/{with_asset3_d.rb → with_asset_3d.rb}

@@ -13,7 +13,7 @@ module FacebookAds
   # on github and we'll fix in our codegen framework. We'll not be able to accept
   # pull request for this class.
 
-  class WithAsset3D < AdObject
+  class WithAsset3d < AdObject
 
     field :id, 'string'
     has_no_post

data/lib/facebook_ads/version.rb

@@ -7,6 +7,6 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  VERSION = '20.0.0'
+  VERSION = '20.0.1'
   API_VERSION = '20.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebookbusiness
 version: !ruby/object:Gem::Version
-  version: 20.0.0
+  version: 20.0.1
 platform: ruby
 authors:
 - Facebook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -276,7 +276,7 @@ files:
 - lib/facebook_ads/ad_objects/ad_account_ios_fourteen_campaign_limits.rb
 - lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb
 - lib/facebook_ads/ad_objects/ad_account_max_bid.rb
-- lib/facebook_ads/ad_objects/ad_account_optimization_goals_ae_mv2_eligibility.rb
+- lib/facebook_ads/ad_objects/ad_account_optimization_goals_aemv2_eligibility.rb
 - lib/facebook_ads/ad_objects/ad_account_payment_details.rb
 - lib/facebook_ads/ad_objects/ad_account_payment_options.rb
 - lib/facebook_ads/ad_objects/ad_account_prepay_details.rb
@@ -895,7 +895,7 @@ files:
 - lib/facebook_ads/ad_objects/organization.rb
 - lib/facebook_ads/ad_objects/outcome_prediction_point.rb
 - lib/facebook_ads/ad_objects/owned_domain.rb
-- lib/facebook_ads/ad_objects/p2_m_invoice_payments.rb
+- lib/facebook_ads/ad_objects/p2m_invoice_payments.rb
 - lib/facebook_ads/ad_objects/page.rb
 - lib/facebook_ads/ad_objects/page_about_story_composed_block.rb
 - lib/facebook_ads/ad_objects/page_about_story_composed_block_entity_ranges.rb
@@ -1049,6 +1049,7 @@ files:
 - lib/facebook_ads/ad_objects/security_settings.rb
 - lib/facebook_ads/ad_objects/server_side/action_source.rb
 - lib/facebook_ads/ad_objects/server_side/app_data.rb
+- lib/facebook_ads/ad_objects/server_side/attribution_data.rb
 - lib/facebook_ads/ad_objects/server_side/batch_processor.rb
 - lib/facebook_ads/ad_objects/server_side/content.rb
 - lib/facebook_ads/ad_objects/server_side/custom_data.rb
@@ -1062,6 +1063,7 @@ files:
 - lib/facebook_ads/ad_objects/server_side/http_service_interface.rb
 - lib/facebook_ads/ad_objects/server_side/http_util.rb
 - lib/facebook_ads/ad_objects/server_side/messaging_channel.rb
+- lib/facebook_ads/ad_objects/server_side/original_event_data.rb
 - lib/facebook_ads/ad_objects/server_side/user_data.rb
 - lib/facebook_ads/ad_objects/server_side/util.rb
 - lib/facebook_ads/ad_objects/shadow_ig_hashtag.rb
@@ -1182,7 +1184,7 @@ files:
 - lib/facebook_ads/ad_objects/windows_app_link.rb
 - lib/facebook_ads/ad_objects/windows_phone_app_link.rb
 - lib/facebook_ads/ad_objects/wit_user.rb
-- lib/facebook_ads/ad_objects/with_asset3_d.rb
+- lib/facebook_ads/ad_objects/with_asset_3d.rb
 - lib/facebook_ads/ad_objects/woodhenge_purchased_payg_receipt.rb
 - lib/facebook_ads/ad_objects/woodhenge_supporter.rb
 - lib/facebook_ads/ad_objects/work_access_code.rb