facebookbusiness 20.0.0 → 20.0.2

data/lib/facebook_ads/ad_objects/page.rb

@@ -235,6 +235,7 @@ module FacebookAds
       "MESSAGE_TAG",
       "RESPONSE",
       "UPDATE",
+      "UTILITY",
     ]
 
     NOTIFICATION_TYPE = [
@@ -298,6 +299,7 @@ module FacebookAds
       "awards",
       "bio",
       "birthday",
+      "call_permission_reply",
       "calls",
       "category",
       "checkins",
@@ -348,6 +350,7 @@ module FacebookAds
       "messaging_game_plays",
       "messaging_handovers",
       "messaging_in_thread_lead_form_submit",
+      "messaging_integrity",
       "messaging_optins",
       "messaging_optouts",
       "messaging_payments",
@@ -782,8 +785,10 @@ module FacebookAds
     end
 
     has_edge :dataset do |edge|
-      edge.get 'AdsPixel'
-      edge.post 'AdsPixel'
+      edge.get 'Dataset'
+      edge.post 'Dataset' do |api|
+        api.has_param :dataset_name, 'string'
+      end
     end
 
     has_edge :events do |edge|
@@ -817,7 +822,6 @@ module FacebookAds
         api.has_param :actions, 'object'
         api.has_param :album_id, 'string'
         api.has_param :android_key_hash, 'string'
-        api.has_param :animated_effect_id, 'int'
         api.has_param :application_id, 'string'
         api.has_param :asked_fun_fact_prompt_id, 'int'
         api.has_param :asset3d_id, 'int'
@@ -931,13 +935,6 @@ module FacebookAds
       edge.get 'Page'
     end
 
-    has_edge :groups do |edge|
-      edge.get 'Group' do |api|
-        api.has_param :admin_only, 'bool'
-        api.has_param :parent, 'string'
-      end
-    end
-
     has_edge :image_copyrights do |edge|
       edge.get 'ImageCopyright'
       edge.post 'ImageCopyright' do |api|
@@ -1190,7 +1187,7 @@ module FacebookAds
       edge.post 'Page' do |api|
         api.has_param :metadata, 'string'
         api.has_param :recipient, 'object'
-        api.has_param :target_app_id, 'int'
+        api.has_param :target_app_id, 'string'
       end
     end
 
@@ -1523,7 +1520,6 @@ module FacebookAds
       end
       edge.post 'AdVideo' do |api|
         api.has_param :ad_breaks, { list: 'string' }
-        api.has_param :animated_effect_id, 'int'
         api.has_param :application_id, 'string'
         api.has_param :asked_fun_fact_prompt_id, 'int'
         api.has_param :audio_story_wave_animation_handle, 'string'
@@ -1634,7 +1630,7 @@ module FacebookAds
         api.has_param :flow_id, 'string'
       end
       edge.post do |api|
-        api.has_param :eligible_platforms, { list: { enum: %w{INSTAGRAM MESSENGER }} }
+        api.has_param :eligible_platforms, { list: { enum: %w{INSTAGRAM MESSENGER WHATSAPP }} }
         api.has_param :flow_id, 'string'
         api.has_param :name, 'string'
         api.has_param :welcome_message_flow, { list: 'object' }

data/lib/facebook_ads/ad_objects/page_ctx_messaging_feature_limit.rb

@@ -0,0 +1,27 @@
+# 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 PageCtxMessagingFeatureLimit < AdObject
+
+    field :messaging_feature_limit_duration, 'int'
+    field :messaging_feature_limit_type, 'string'
+    field :messaging_violation_type, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -124,7 +124,7 @@ module FacebookAds
         api.has_param :business, 'string'
         api.has_param :permitted_roles, { list: { enum: -> { ProductCatalog::PERMITTED_ROLES }} }
         api.has_param :permitted_tasks, { list: { enum: -> { ProductCatalog::PERMITTED_TASKS }} }
-        api.has_param :skip_default_utms, 'bool'
+        api.has_param :skip_defaults, 'bool'
         api.has_param :utm_settings, 'hash'
       end
     end
@@ -409,7 +409,6 @@ module FacebookAds
       end
       edge.post 'ProductItem' do |api|
         api.has_param :additional_image_urls, { list: 'string' }
-        api.has_param :additional_uploaded_image_ids, { list: 'string' }
         api.has_param :additional_variant_attributes, 'hash'
         api.has_param :android_app_name, 'string'
         api.has_param :android_class, 'string'
@@ -464,6 +463,11 @@ module FacebookAds
         api.has_param :origin_country, { enum: -> { ProductItem::ORIGIN_COUNTRY }}
         api.has_param :pattern, 'string'
         api.has_param :price, 'int'
+        api.has_param :product_priority_0, 'double'
+        api.has_param :product_priority_1, 'double'
+        api.has_param :product_priority_2, 'double'
+        api.has_param :product_priority_3, 'double'
+        api.has_param :product_priority_4, 'double'
         api.has_param :product_type, 'string'
         api.has_param :quantity_to_sell_on_facebook, 'int'
         api.has_param :retailer_id, 'string'

data/lib/facebook_ads/ad_objects/{user_set_reporting_root.rb → product_delivery_preference.rb}

@@ -13,11 +13,12 @@ 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 UserSetReportingRoot < AdObject
+  class ProductDeliveryPreference < AdObject
 
-    field :creation_time, 'datetime'
+    field :ad_object_id, 'string'
     field :id, 'string'
-    field :last_modified_time, 'datetime'
+    field :product_priority, 'string'
+    field :product_priority_category, { list: 'string' }
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/product_group.rb

@@ -73,6 +73,11 @@ module FacebookAds
         api.has_param :ordering_index, 'int'
         api.has_param :pattern, 'string'
         api.has_param :price, 'int'
+        api.has_param :product_priority_0, 'double'
+        api.has_param :product_priority_1, 'double'
+        api.has_param :product_priority_2, 'double'
+        api.has_param :product_priority_3, 'double'
+        api.has_param :product_priority_4, 'double'
         api.has_param :product_type, 'string'
         api.has_param :quantity_to_sell_on_facebook, 'int'
         api.has_param :retailer_id, 'string'

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -313,6 +313,7 @@ module FacebookAds
       "BAD_QUALITY_IMAGE",
       "BIG_CATALOG_WITH_ALL_ITEMS_IN_STOCK",
       "BIZ_MSG_AI_AGENT_DISABLED_BY_USER",
+      "BIZ_MSG_GEN_AI_POLICY_VIOLATED",
       "CANNOT_EDIT_SUBSCRIPTION_PRODUCTS",
       "CATALOG_NOT_CONNECTED_TO_EVENT_SOURCE",
       "CHECKOUT_DISABLED_BY_USER",
@@ -445,6 +446,8 @@ module FacebookAds
       "VIDEO_FETCH_FAILED_TIMED_OUT",
       "VIDEO_NOT_DOWNLOADABLE",
       "WHATSAPP_DISABLED_BY_USER",
+      "WHATSAPP_MARKETING_MESSAGE_DISABLED_BY_USER",
+      "WHATSAPP_MARKETING_MESSAGE_POLICY_VIOLATION",
       "WHATSAPP_POLICY_VIOLATION",
     ]
 
@@ -721,6 +724,8 @@ module FacebookAds
     field :applinks, 'CatalogItemAppLinks'
     field :availability, { enum: -> { AVAILABILITY }}
     field :brand, 'string'
+    field :bundle_items, { list: 'string' }
+    field :bundle_retailer_ids, { list: 'string' }
     field :capability_to_review_status, { list: 'hash' }
     field :category, 'string'
     field :category_specific_fields, 'CatalogSubVerticalList'
@@ -754,6 +759,7 @@ module FacebookAds
     field :importer_name, 'string'
     field :invalidation_errors, { list: 'ProductItemInvalidationError' }
     field :inventory, 'int'
+    field :is_bundle_hero, 'bool'
     field :manufacturer_info, 'string'
     field :manufacturer_part_number, 'string'
     field :marked_for_product_launch, 'string'
@@ -789,7 +795,6 @@ module FacebookAds
     field :video_fetch_status, { enum: -> { VIDEO_FETCH_STATUS }}
     field :visibility, { enum: -> { VISIBILITY }}
     field :wa_compliance_category, 'string'
-    field :additional_uploaded_image_ids, { list: 'string' }
     field :android_app_name, 'string'
     field :android_class, 'string'
     field :android_package, 'string'
@@ -806,6 +811,11 @@ module FacebookAds
     field :iphone_app_store_id, 'int'
     field :iphone_url, 'string'
     field :launch_date, 'string'
+    field :product_priority_0, 'double'
+    field :product_priority_1, 'double'
+    field :product_priority_2, 'double'
+    field :product_priority_3, 'double'
+    field :product_priority_4, 'double'
     field :return_policy_days, 'int'
     field :windows_phone_app_id, 'string'
     field :windows_phone_app_name, 'string'
@@ -815,6 +825,13 @@ module FacebookAds
       edge.get 'CatalogItemChannelsToIntegrityStatus'
     end
 
+    has_edge :override_details do |edge|
+      edge.get 'OverrideDetails' do |api|
+        api.has_param :keys, { list: 'string' }
+        api.has_param :type, { enum: -> { OverrideDetails::TYPE }}
+      end
+    end
+
     has_edge :product_sets do |edge|
       edge.get 'ProductSet'
     end

data/lib/facebook_ads/ad_objects/reseller_guidance.rb

@@ -21,10 +21,7 @@ module FacebookAds
     field :advertiser_name, 'string'
     field :attributed_to_reseller_l7d, 'bool'
     field :available_guidance, { list: 'string' }
-    field :benchmark_report_link, 'string'
     field :guidance_adoption_rate_l7d, 'double'
-    field :no_adsets_gte_benchmark, 'int'
-    field :no_adsets_lt_benchmark, 'int'
     field :nurtured_by_reseller_l7d, 'bool'
     field :planning_agency_name, 'string'
     field :recommendation_time, 'datetime'

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/event_request.rb

@@ -17,6 +17,7 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'json'
+require 'ostruct'
 
 require_relative './event'
 require_relative './event_response'