facebookbusiness 23.0.2 → 24.0.1

data/lib/facebook_ads/ad_objects/omega_customer_trx.rb

@@ -14,11 +14,6 @@ module FacebookAds
   # pull request for this class.
 
   class OmegaCustomerTrx < AdObject
-    PRODUCT_TYPES = [
-      "FACEBOOK",
-      "WHATSAPP",
-    ]
-
     TYPE = [
       "CM",
       "DM",

data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb

@@ -14,13 +14,22 @@ module FacebookAds
   # pull request for this class.
 
   class OpenBridgeConfiguration < AdObject
+    EVENT_ENRICHMENT_STATE = [
+      "NO",
+      "NOT_INITIALIZED",
+      "YES",
+    ]
+
 
     field :active, 'bool'
+    field :blocked_event_types, { list: 'string' }
+    field :blocked_websites, { list: 'string' }
     field :browser_agent, { list: 'string' }
     field :cloud_provider, 'string'
     field :cloud_region, 'string'
     field :destination_id, 'string'
     field :endpoint, 'string'
+    field :event_enrichment_state, 'string'
     field :fallback_domain, 'string'
     field :first_party_domain, 'string'
     field :host_business_id, 'string'

data/lib/facebook_ads/ad_objects/page.rb

@@ -747,7 +747,6 @@ module FacebookAds
     has_edge :conversations do |edge|
       edge.get 'UnifiedThread' do |api|
         api.has_param :folder, 'string'
-        api.has_param :is_owner, 'bool'
         api.has_param :platform, { enum: -> { UnifiedThread::PLATFORM }}
         api.has_param :tags, { list: 'string' }
         api.has_param :user_id, 'string'
@@ -1477,7 +1476,6 @@ module FacebookAds
     has_edge :threads do |edge|
       edge.get 'UnifiedThread' do |api|
         api.has_param :folder, 'string'
-        api.has_param :is_owner, 'bool'
         api.has_param :platform, { enum: -> { UnifiedThread::PLATFORM }}
         api.has_param :tags, { list: 'string' }
         api.has_param :user_id, 'string'

data/lib/facebook_ads/ad_objects/placement_soft_opt_out.rb

@@ -0,0 +1,31 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class PlacementSoftOptOut < AdObject
+
+    field :audience_network_positions, { list: 'string' }
+    field :facebook_positions, { list: 'string' }
+    field :instagram_positions, { list: 'string' }
+    field :messenger_positions, { list: 'string' }
+    field :oculus_positions, { list: 'string' }
+    field :threads_positions, { list: 'string' }
+    field :whatsapp_positions, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -420,6 +420,7 @@ module FacebookAds
         api.has_param :schedule, 'string'
         api.has_param :selected_override_fields, { list: 'string' }
         api.has_param :update_schedule, 'string'
+        api.has_param :use_case, { enum: -> { ProductFeed::USE_CASE }}
       end
     end
 
@@ -466,6 +467,7 @@ module FacebookAds
         api.has_param :additional_image_urls, { list: 'string' }
         api.has_param :additional_variant_attributes, 'hash'
         api.has_param :age_group, { enum: -> { ProductItem::AGE_GROUP }}
+        api.has_param :allow_upsert, 'bool'
         api.has_param :android_app_name, 'string'
         api.has_param :android_class, 'string'
         api.has_param :android_package, 'string'

data/lib/facebook_ads/ad_objects/product_feed.rb

@@ -102,6 +102,10 @@ module FacebookAds
       "VERSION",
     ]
 
+    USE_CASE = [
+      "CREATOR_ASSET",
+    ]
+
 
     field :country, 'string'
     field :created_time, 'datetime'
@@ -128,6 +132,7 @@ module FacebookAds
     field :primary_feed_ids, { list: 'string' }
     field :rules, { list: 'string' }
     field :selected_override_fields, { list: 'string' }
+    field :use_case, { enum: -> { USE_CASE }}
 
     has_edge :automotive_models do |edge|
       edge.get 'AutomotiveModel' do |api|

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -472,6 +472,7 @@ module FacebookAds
       "VIDEO_FETCH_FAILED_FORBIDDEN",
       "VIDEO_FETCH_FAILED_LINK_BROKEN",
       "VIDEO_FETCH_FAILED_TIMED_OUT",
+      "VIDEO_ISSUE_GENERIC",
       "VIDEO_NOT_DOWNLOADABLE",
       "WHATSAPP_DISABLED_BY_USER",
       "WHATSAPP_MARKETING_MESSAGE_DISABLED_BY_USER",
@@ -833,6 +834,7 @@ module FacebookAds
     field :videos, { list: 'ProductItemVideoData' }
     field :visibility, { enum: -> { VISIBILITY }}
     field :wa_compliance_category, 'string'
+    field :allow_upsert, 'bool'
     field :android_app_name, 'string'
     field :android_class, 'string'
     field :android_package, 'string'

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
 
@@ -49,6 +51,30 @@ module FacebookAds
         # The share of value generated by this click-conversion pair that is attributed to Meta.
         attr_accessor :attribution_value
 
+        # The attribution source to differentiate the source of the data, e.g. whether this is from AMM or Custom Attribution or any other sources.
+        attr_accessor :attribution_source
+
+        # The engagement type that caused the original credited conversion.
+        attr_accessor :touchpoint_type
+
+        # 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
@@ -60,7 +86,15 @@ module FacebookAds
         # @param [String] attribution_model
         # @param [String] attr_window
         # @param [Float] attribution_value
-        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)
+        # @param [String] attribution_source
+        # @param [String] touchpoint_type
+        # @param [Integer] touchpoint_ts
+        # @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
@@ -88,6 +122,30 @@ module FacebookAds
           unless attribution_value.nil?
             self.attribution_value = attribution_value
           end
+          unless attribution_source.nil?
+            self.attribution_source = attribution_source
+          end
+          unless touchpoint_type.nil?
+            self.touchpoint_type = touchpoint_type
+          end
+          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
@@ -131,7 +189,39 @@ module FacebookAds
           end
 
           if attributes.has_key?(:'attribution_value')
-            self.attribution_share = attributes[:'attribution_value']
+            self.attribution_value = attributes[:'attribution_value']
+          end
+
+          if attributes.has_key?(:'attribution_source')
+            self.attribution_source = attributes[:'attribution_source']
+          end
+
+          if attributes.has_key?(:'touchpoint_type')
+            self.touchpoint_type = attributes[:'touchpoint_type']
+          end
+
+          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
 
@@ -147,7 +237,15 @@ module FacebookAds
               attribution_share == o.attribution_share &&
               attribution_model == o.attribution_model &&
               attr_window == o.attr_window &&
-              attribution_value == o.attribution_value
+              attribution_value == o.attribution_value &&
+              attribution_source == o.attribution_source &&
+              touchpoint_type == o.touchpoint_type &&
+              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
@@ -159,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
+            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
 
@@ -192,6 +290,30 @@ module FacebookAds
           unless attribution_value.nil?
             hash['attribution_value'] = attribution_value
           end
+          unless attribution_source.nil?
+            hash['attribution_source'] = attribution_source
+          end
+          unless touchpoint_type.nil?
+            hash['touchpoint_type'] = touchpoint_type
+          end
+          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
 
@@ -226,6 +348,30 @@ module FacebookAds
           unless attribution_value.nil?
             hash['attribution_value'] = attribution_value
           end
+          unless attribution_source.nil?
+            hash['attribution_source'] = attribution_source
+          end
+          unless touchpoint_type.nil?
+            hash['touchpoint_type'] = touchpoint_type
+          end
+          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/ad_objects/shadow_ig_scheduled_media.rb

@@ -0,0 +1,28 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class ShadowIgScheduledMedia < AdObject
+
+    field :caption, 'string'
+    field :id, 'string'
+    field :media_type, 'string'
+    field :media_url, 'string'
+    field :publish_timestamp, 'int'
+    field :thumbnail_url, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/shadow_ig_user_thread_owner.rb

@@ -0,0 +1,24 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class ShadowIgUserThreadOwner < AdObject
+
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/user.rb

@@ -216,7 +216,6 @@ module FacebookAds
     has_edge :conversations do |edge|
       edge.get 'UnifiedThread' do |api|
         api.has_param :folder, 'string'
-        api.has_param :is_owner, 'bool'
         api.has_param :platform, { enum: -> { UnifiedThread::PLATFORM }}
         api.has_param :tags, { list: 'string' }
         api.has_param :user_id, 'string'