facebookbusiness 24.0.0 → 24.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d288f124a10cb9ca7a0f7d7b212bd1c4254edab43dd3ad429e8572c1304aa76
-  data.tar.gz: e4df55422c3c5d4493ebe660600ee00732da844bad1ccce1bd03890f1a3993fb
+  metadata.gz: 8266c6de7b60110a6b278518eb923d5829356f42594bc597d87ab891ad817025
+  data.tar.gz: baa7bb60d36ea0ad26bab19e0da2fd850eeabd2bc7e95723705dc35f1a62b178
 SHA512:
-  metadata.gz: 8f4138df50f2f995172932b9204cdf0c812acfc07bb35dd91ee33fdd11ba11e1d34cd57adb4727e04fae0cbfa680cf2ba2f46a526eb38461b1808a31cadb5029
-  data.tar.gz: dd12ff024d8d3e09784ce4d41d3298579e0c60101e3f2b407a9721f58f7028b77f804ec89aef71168e28dbb73dda502ff37cc9f5446a1bec0ebd290510526186
+  metadata.gz: 346fc60212279d1e247f7fc73ef7cf70981b00f467bfcbbe93d021e55ac3bdf0ae10a63801672d82fcf6dde48fb206a736d336121c6a8199615de2d1c83361b7
+  data.tar.gz: 885b20b24884ff42591ccf5a264e99390ce3a2a79d1e0032f6e1af95785da39cb903101a2d0d5008165567d7e2ed778b15701d50397ecdd2fe6d966071cbe33a

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

@@ -16,6 +16,8 @@
 # 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.
 
+require_relative './attribution_setting'
+
 module FacebookAds
     module ServerSide
 
@@ -58,6 +60,21 @@ module FacebookAds
         # The time when the touchpoint event occurred with the ad that the install was credited to.
         attr_accessor :touchpoint_ts
 
+        # The attribution method used to attribute the event.
+        attr_accessor :attribution_method
+
+        # The decline reason for the attribution.
+        attr_accessor :decline_reason
+
+        # The auditing token for the attribution.
+        attr_accessor :auditing_token
+
+        # The linkage key for the attribution.
+        attr_accessor :linkage_key
+
+        # The attribution setting for the attribution.
+        attr_accessor :attribution_setting
+
 
 
         # @param [String] scope
@@ -72,7 +89,12 @@ module FacebookAds
         # @param [String] attribution_source
         # @param [String] touchpoint_type
         # @param [Integer] touchpoint_ts
-        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, attribution_value: nil, attribution_source: nil, touchpoint_type: nil, touchpoint_ts: nil)
+        # @param [String] attribution_method
+        # @param [String] decline_reason
+        # @param [String] auditing_token
+        # @param [String] linkage_key
+        # @param [FacebookAds::ServerSide::AttributionSetting] attribution_setting
+        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, attribution_value: nil, attribution_source: nil, touchpoint_type: nil, touchpoint_ts: nil, attribution_method: nil, decline_reason: nil, auditing_token: nil, linkage_key: nil, attribution_setting: nil)
           unless scope.nil?
             self.scope = scope
           end
@@ -109,6 +131,21 @@ module FacebookAds
           unless touchpoint_ts.nil?
             self.touchpoint_ts = touchpoint_ts
           end
+          unless attribution_method.nil?
+            self.attribution_method = attribution_method
+          end
+          unless decline_reason.nil?
+            self.decline_reason = decline_reason
+          end
+          unless auditing_token.nil?
+            self.auditing_token = auditing_token
+          end
+          unless linkage_key.nil?
+            self.linkage_key = linkage_key
+          end
+          unless attribution_setting.nil?
+            self.attribution_setting = attribution_setting
+          end
         end
 
         # build the object using the input hash
@@ -166,6 +203,26 @@ module FacebookAds
           if attributes.has_key?(:'touchpoint_ts')
             self.touchpoint_ts = attributes[:'touchpoint_ts']
           end
+
+          if attributes.has_key?(:'attribution_method')
+            self.attribution_method = attributes[:'attribution_method']
+          end
+
+          if attributes.has_key?(:'decline_reason')
+            self.decline_reason = attributes[:'decline_reason']
+          end
+
+          if attributes.has_key?(:'auditing_token')
+            self.auditing_token = attributes[:'auditing_token']
+          end
+
+          if attributes.has_key?(:'linkage_key')
+            self.linkage_key = attributes[:'linkage_key']
+          end
+
+          if attributes.has_key?(:'attribution_setting')
+            self.attribution_setting = attributes[:'attribution_setting']
+          end
         end
 
         # Checks equality by comparing each attribute.
@@ -183,7 +240,12 @@ module FacebookAds
               attribution_value == o.attribution_value &&
               attribution_source == o.attribution_source &&
               touchpoint_type == o.touchpoint_type &&
-              touchpoint_ts == o.touchpoint_ts
+              touchpoint_ts == o.touchpoint_ts &&
+              attribution_method == o.attribution_method &&
+              decline_reason == o.decline_reason &&
+              auditing_token == o.auditing_token &&
+              linkage_key == o.linkage_key &&
+              attribution_setting == o.attribution_setting
         end
 
         # @see the `==` method
@@ -195,7 +257,7 @@ module FacebookAds
         # @return [Fixnum] Hash code
         def hash
           [
-            scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window, attribution_value, attribution_source, touchpoint_type, touchpoint_ts
+            scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window, attribution_value, attribution_source, touchpoint_type, touchpoint_ts, attribution_method, decline_reason, auditing_token, linkage_key, attribution_setting
           ].hash
         end
 
@@ -237,6 +299,21 @@ module FacebookAds
           unless touchpoint_ts.nil?
             hash['touchpoint_ts'] = touchpoint_ts
           end
+          unless attribution_method.nil?
+            hash['attribution_method'] = attribution_method
+          end
+          unless decline_reason.nil?
+            hash['decline_reason'] = decline_reason
+          end
+          unless auditing_token.nil?
+            hash['auditing_token'] = auditing_token
+          end
+          unless linkage_key.nil?
+            hash['linkage_key'] = linkage_key
+          end
+          unless attribution_setting.nil?
+            hash['attribution_setting'] = attribution_setting
+          end
           hash.to_s
         end
 
@@ -280,6 +357,21 @@ module FacebookAds
           unless touchpoint_ts.nil?
             hash['touchpoint_ts'] = touchpoint_ts
           end
+          unless attribution_method.nil?
+            hash['attribution_method'] = FacebookAds::ServerSide::Util.normalize_attribution_method(attribution_method)
+          end
+          unless decline_reason.nil?
+            hash['decline_reason'] = FacebookAds::ServerSide::Util.normalize_decline_reason(decline_reason)
+          end
+          unless auditing_token.nil?
+            hash['auditing_token'] = auditing_token
+          end
+          unless linkage_key.nil?
+            hash['linkage_key'] = linkage_key
+          end
+          unless attribution_setting.nil?
+            hash['attribution_setting'] = attribution_setting.normalize
+          end
           hash
         end
 

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

@@ -0,0 +1,30 @@
+# 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
+		AttributionMethod = Set[
+			'ard',
+			'deeplink',
+			'gpir',
+			'invalid_response',
+			'mir',
+			'srn'
+		]
+	end
+end

data/lib/facebook_ads/ad_objects/server_side/attribution_setting.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
+
+    # AttributionSetting contains attribution window settings used for attribution.
+    class AttributionSetting
+
+      # Inactivity window in hours.
+      attr_accessor :inactivity_window_hours
+
+      # Reattribution window in hours.
+      attr_accessor :reattribution_window_hours
+
+
+      # @param [Integer] inactivity_window_hours
+      # @param [Integer] reattribution_window_hours
+      def initialize(inactivity_window_hours: nil, reattribution_window_hours: nil)
+        unless inactivity_window_hours.nil?
+          self.inactivity_window_hours = inactivity_window_hours
+        end
+        unless reattribution_window_hours.nil?
+          self.reattribution_window_hours = reattribution_window_hours
+        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?(:'inactivity_window_hours')
+          self.inactivity_window_hours = attributes[:'inactivity_window_hours']
+        end
+
+        if attributes.has_key?(:'reattribution_window_hours')
+          self.reattribution_window_hours = attributes[:'reattribution_window_hours']
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      def ==(o)
+        return true if self.equal?(o)
+        self.class == o.class &&
+            inactivity_window_hours == o.inactivity_window_hours &&
+            reattribution_window_hours == o.reattribution_window_hours
+      end
+
+      # @see the `==` method
+      def eql?(o)
+        self == o
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Fixnum] Hash code
+      def hash
+        [
+          inactivity_window_hours, reattribution_window_hours
+        ].hash
+      end
+
+      def to_s
+        hash = {}
+        unless inactivity_window_hours.nil?
+          hash['inactivity_window_hours'] = inactivity_window_hours
+        end
+        unless reattribution_window_hours.nil?
+          hash['reattribution_window_hours'] = reattribution_window_hours
+        end
+        hash.to_s
+      end
+
+
+      # Normalize input fields to server request format.
+      def normalize
+        hash = {}
+        unless inactivity_window_hours.nil?
+          hash['inactivity_window_hours'] = inactivity_window_hours
+        end
+        unless reattribution_window_hours.nil?
+          hash['reattribution_window_hours'] = reattribution_window_hours
+        end
+        hash
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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
+		DeclineReason = Set[
+			'attribute_to_other_source',
+			'out_of_lookback_window',
+			'view_through_disabled',
+			'within_inactive_window',
+			'inactive',
+			'fraud_detected',
+			'unknown',
+			'reinstall_attribution_disabled',
+			'lookback',
+			'not_pmod_match',
+			'validation_rule_detected',
+			'preload_install',
+			'min_time_between_re_engagements',
+			'duplicated',
+			'pmod_disabled'
+		]
+	end
+end

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

@@ -318,6 +318,30 @@ module FacebookAds
 
 				action_source
 			end
+
+			# Normalizes the input attribution_method and returns valid value (or throw exception if invalid).
+			def self.normalize_attribution_method(attribution_method)
+				unless FacebookAds::ServerSide::AttributionMethod.include?(attribution_method)
+					values = FacebookAds::ServerSide::AttributionMethod.to_a.join(',')
+					raise ArgumentError.new(
+						"Invalid attribution_method passed: #{attribution_method}. Please use one of the defined values: #{values}"
+					)
+				end
+
+				attribution_method
+			end
+
+			# Normalizes the input decline_reason and returns valid value (or throw exception if invalid).
+			def self.normalize_decline_reason(decline_reason)
+				unless FacebookAds::ServerSide::DeclineReason.include?(decline_reason)
+					values = FacebookAds::ServerSide::DeclineReason.to_a.join(',')
+					raise ArgumentError.new(
+						"Invalid decline_reason passed: #{decline_reason}. Please use one of the defined values: #{values}"
+					)
+				end
+
+				decline_reason
+			end
 		end
 	end
 end

data/lib/facebook_ads/version.rb

@@ -7,6 +7,6 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  VERSION = '24.0.0'
+  VERSION = '24.0.1'
   API_VERSION = '24.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebookbusiness
 version: !ruby/object:Gem::Version
-  version: 24.0.0
+  version: 24.0.1
 platform: ruby
 authors:
 - Facebook
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-24 00:00:00.000000000 Z
+date: 2025-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -1079,9 +1079,12 @@ files:
 - 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/attribution_method.rb
+- lib/facebook_ads/ad_objects/server_side/attribution_setting.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
+- lib/facebook_ads/ad_objects/server_side/decline_reason.rb
 - lib/facebook_ads/ad_objects/server_side/delivery_category.rb
 - lib/facebook_ads/ad_objects/server_side/event.rb
 - lib/facebook_ads/ad_objects/server_side/event_request.rb