facebookbusiness 19.0.3 → 20.0.1

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

@@ -0,0 +1,30 @@
+# 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 ShadowIgMediaBoostedInsightsResult < AdObject
+
+    field :description, 'string'
+    field :name, 'string'
+    field :organic_media_id, 'string'
+    field :source_type, 'string'
+    field :title, 'string'
+    field :values, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/shadow_ig_media_builder.rb

@@ -19,6 +19,7 @@ module FacebookAds
     field :id, 'string'
     field :status, 'string'
     field :status_code, 'string'
+    field :video_status, 'IgResumableVideoUploadStatus'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/signals_iwl_extractor.rb

@@ -0,0 +1,26 @@
+# 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 SignalsIwlExtractor < AdObject
+
+    field :domain_uri, 'string'
+    field :event_type, 'string'
+    field :extractor_type, 'string'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/single_owner_additional_profile.rb

@@ -0,0 +1,26 @@
+# 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 SingleOwnerAdditionalProfile < AdObject
+
+    field :id, 'string'
+    field :name, 'string'
+    field :user_name, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/site_link.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 SiteLink < AdObject
+
+    field :id, 'string'
+    field :link_image_hash, 'string'
+    field :link_title, 'string'
+    field :link_type, 'string'
+    field :link_url, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/sliced_event_source_group.rb

@@ -0,0 +1,26 @@
+# 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 SlicedEventSourceGroup < AdObject
+
+    field :event_source_group, 'EventSourceGroup'
+    field :filter, 'string'
+    field :id, 'string'
+    field :name, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/smart_pixel_insights.rb

@@ -0,0 +1,26 @@
+# 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 SmartPixelInsights < AdObject
+
+    field :source, 'string'
+    field :stats, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/social_wifi_site.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 SocialWifiSite < AdObject
+
+    field :id, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/split_test_config.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 SplitTestConfig < AdObject
+
+    field :budget, 'int'
+    field :early_winner_declaration_enabled, 'bool'
+    field :end_time, 'datetime'
+    field :splits, { list: 'int' }
+    field :start_time, 'datetime'
+    field :test_variable, 'string'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/status.rb

@@ -0,0 +1,37 @@
+# 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 Status < AdObject
+
+    field :event, 'Event'
+    field :from, 'object'
+    field :id, 'string'
+    field :message, 'string'
+    field :place, 'Place'
+    field :updated_time, 'datetime'
+    has_no_post
+    has_no_delete
+
+    has_edge :likes do |edge|
+      edge.post 'Status' do |api|
+        api.has_param :feedback_source, 'string'
+        api.has_param :nectar_module, 'string'
+        api.has_param :notify, 'bool'
+        api.has_param :tracking, 'string'
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/stream_filter.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 StreamFilter < AdObject
+
+    field :filter_key, 'string'
+    field :name, 'string'
+    field :type, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/taggable_subject.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 TaggableSubject < AdObject
+
+    field :id, 'string'
+    field :name, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/targeting_automation.rb

@@ -16,6 +16,7 @@ module FacebookAds
   class TargetingAutomation < AdObject
 
     field :advantage_audience, 'int'
+    field :individual_setting, 'object'
     field :shared_audiences, 'int'
     field :value_expression, 'int'
     has_no_id

data/lib/facebook_ads/ad_objects/targeting_geo_location_location_expansion.rb

@@ -0,0 +1,26 @@
+# 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 TargetingGeoLocationLocationExpansion < AdObject
+
+    field :allowed, 'bool'
+    field :intent, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/targeting_marketing_message_channels.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 TargetingMarketingMessageChannels < AdObject
+
+    field :whatsapp, 'IdName'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/third_party_measurement_report_dataset.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 ThirdPartyMeasurementReportDataset < AdObject
+
+    field :category, 'string'
+    field :id, 'string'
+    field :partner, 'Business'
+    field :product, 'string'
+    field :schema, { list: 'object' }
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/third_party_partner_lift_request.rb

@@ -0,0 +1,43 @@
+# 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 ThirdPartyPartnerLiftRequest < AdObject
+    STATUS = [
+      "CREATED",
+      "FAILURE",
+      "IN_PROGRESS",
+      "SCHEDULED",
+      "SUCCESS",
+    ]
+
+
+    field :ad_entities, { list: 'string' }
+    field :country, 'string'
+    field :created_time, 'datetime'
+    field :description, 'string'
+    field :holdout_size, 'double'
+    field :id, 'string'
+    field :modified_time, 'datetime'
+    field :owner_instance_id, 'string'
+    field :region, 'string'
+    field :status, { enum: -> { STATUS }}
+    field :study_cells, { list: 'string' }
+    field :study_end_time, 'datetime'
+    field :study_start_time, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/third_party_partner_panel_request.rb

@@ -0,0 +1,49 @@
+# 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 ThirdPartyPartnerPanelRequest < AdObject
+    STATUS = [
+      "CREATED",
+      "FAILURE",
+      "IN_PROGRESS",
+      "SCHEDULED",
+      "SUCCESS",
+    ]
+
+    STUDY_TYPE = [
+      "BRAND_LIFT",
+      "PANEL_SALES_ATTRIBUTION",
+      "REACH",
+    ]
+
+
+    field :adentities_ids, { list: 'string' }
+    field :country, 'string'
+    field :created_time, 'datetime'
+    field :description, 'string'
+    field :id, 'string'
+    field :modified_time, 'datetime'
+    field :owner_instance_id, 'string'
+    field :owner_panel_id, 'string'
+    field :owner_panel_name, 'string'
+    field :status, { enum: -> { STATUS }}
+    field :study_end_time, 'datetime'
+    field :study_start_time, 'datetime'
+    field :study_type, { enum: -> { STUDY_TYPE }}
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/third_party_partner_panel_scheduled.rb

@@ -0,0 +1,49 @@
+# 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 ThirdPartyPartnerPanelScheduled < AdObject
+    STATUS = [
+      "CANCELLED",
+      "CREATED",
+      "FINISHED",
+      "ONGOING",
+    ]
+
+    STUDY_TYPE = [
+      "BRAND_LIFT",
+      "PANEL_SALES_ATTRIBUTION",
+      "REACH",
+    ]
+
+
+    field :adentities_ids, { list: 'string' }
+    field :cadence, 'string'
+    field :country, 'string'
+    field :created_time, 'datetime'
+    field :description, 'string'
+    field :end_time, 'datetime'
+    field :id, 'string'
+    field :modified_time, 'datetime'
+    field :owner_instance_id, 'string'
+    field :owner_panel_id, 'string'
+    field :owner_panel_name, 'string'
+    field :start_time, 'datetime'
+    field :status, { enum: -> { STATUS }}
+    field :study_type, { enum: -> { STUDY_TYPE }}
+    has_no_post
+    has_no_delete
+
+  end
+end