facebookbusiness 19.0.3 → 20.0.1

data/lib/facebook_ads/ad_objects/research_poll_study.rb

@@ -0,0 +1,25 @@
+# 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 ResearchPollStudy < AdObject
+
+    field :account, 'AdAccount'
+    field :id, 'string'
+    field :name, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/reseller_guidance.rb

@@ -0,0 +1,41 @@
+# 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 ResellerGuidance < AdObject
+
+    field :ad_account_first_spend_date, 'string'
+    field :ad_account_id, 'string'
+    field :adopted_guidance_l7d, { list: 'string' }
+    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'
+    field :reporting_ds, 'string'
+    field :reseller, 'Business'
+    field :revenue_l30d, 'double'
+    field :ultimate_advertiser_name, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/rights_manager_data_export.rb

@@ -0,0 +1,29 @@
+# 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 RightsManagerDataExport < AdObject
+
+    field :download_uri, 'string'
+    field :export_scope, 'string'
+    field :id, 'string'
+    field :name, 'string'
+    field :record_type, 'string'
+    field :time_range_end, 'datetime'
+    field :time_range_start, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/rights_manager_insights.rb

@@ -0,0 +1,29 @@
+# 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 RightsManagerInsights < AdObject
+
+    field :error, 'string'
+    field :error_message, 'string'
+    field :metadata, { list: 'hash' }
+    field :totals, { list: 'hash' }
+    field :x_axis_breakdown, { list: { list: 'hash' } }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/robot.rb

@@ -0,0 +1,34 @@
+# 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 Robot < AdObject
+
+    field :bringup_vars, { list: 'hash' }
+    field :configurations, { list: 'hash' }
+    field :data_center, 'string'
+    field :id, 'string'
+    field :init_pos, { list: 'hash' }
+    field :last_pos, { list: 'hash' }
+    field :meetup_link_hash, 'string'
+    field :suite, 'string'
+    field :target_map_image_uri, 'string'
+    field :target_os_image_uri, 'string'
+    field :target_sw_image_uri, 'string'
+    field :user, 'User'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/sales_rights_inventory_management.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 SalesRightsInventoryManagement < AdObject
+
+    field :available_impressions, 'int'
+    field :booked_impressions, 'int'
+    field :overbooked_impressions, 'int'
+    field :supported_countries, { list: 'string' }
+    field :total_impressions, 'int'
+    field :unavailable_impressions, 'int'
+    field :warning_messages, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/scheduled_post.rb

@@ -0,0 +1,40 @@
+# 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 ScheduledPost < AdObject
+
+    field :admin_creator, 'User'
+    field :creation_time, 'datetime'
+    field :feed_audience_description, 'string'
+    field :feed_targeting, 'Targeting'
+    field :id, 'string'
+    field :is_post_in_good_state, 'bool'
+    field :message, 'string'
+    field :modified_time, 'datetime'
+    field :og_action_summary, 'string'
+    field :permalink_url, 'string'
+    field :place, 'Place'
+    field :privacy_description, 'string'
+    field :scheduled_failure_notice, 'string'
+    field :scheduled_publish_time, 'datetime'
+    field :story_token, 'string'
+    field :thumbnail, 'string'
+    field :video_id, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/scim_company_user_phone_number.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 ScimCompanyUserPhoneNumber < AdObject
+
+    field :number, 'string'
+    field :primary, 'bool'
+    field :type, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

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