facebookbusiness 0.13.0.0 → 18.0.3

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

@@ -0,0 +1,344 @@
+# 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
+    # ExtendedDeviceInfo, such as screen width and height. This parameter is an array and values are separated by commas.
+    class ExtendedDeviceInfo
+
+        attr_accessor :ext_info_version,
+                      :app_package_name,
+                      :short_version,
+                      :long_version,
+                      :os_version,
+                      :device_model_name,
+                      :locale,
+                      :timezone_abbreviation,
+                      :carrier,
+                      :screen_width,
+                      :screen_height,
+                      :screen_density,
+                      :cpu_core_count,
+                      :total_disk_space_gb,
+                      :free_disk_space_gb,
+                      :device_time_zone
+
+        # Initializes the object
+        # @param [String] ext_info_version
+        # @param [String] app_package_name
+        # @param [String] short_version
+        # @param [String] long_version
+        # @param [String] os_version
+        # @param [String] device_model_name
+        # @param [String] locale
+        # @param [String] timezone_abbreviation
+        # @param [String] carrier
+        # @param [String] screen_width
+        # @param [String] screen_height
+        # @param [String] screen_density
+        # @param [String] cpu_core_count
+        # @param [String] total_disk_space_gb
+        # @param [String] free_disk_space_gb
+        # @param [String] device_time_zone
+        def initialize(ext_info_version: nil, app_package_name: nil, short_version: nil, long_version: nil, os_version: nil, device_model_name: nil, locale: nil, timezone_abbreviation: nil,
+            carrier: nil, screen_width: nil, screen_height: nil, screen_density: nil, cpu_core_count: nil, total_disk_space_gb: nil, free_disk_space_gb: nil, device_time_zone: nil)
+            unless ext_info_version.nil?
+              self.ext_info_version = String(ext_info_version)
+            end
+            unless app_package_name.nil?
+              self.app_package_name = String(app_package_name)
+            end
+            unless short_version.nil?
+              self.short_version = String(short_version)
+            end
+            unless long_version.nil?
+              self.long_version = String(long_version)
+            end
+            unless os_version.nil?
+              self.os_version = String(os_version)
+            end
+            unless device_model_name.nil?
+              self.device_model_name = String(device_model_name)
+            end
+            unless locale.nil?
+              self.locale = String(locale)
+            end
+            unless timezone_abbreviation.nil?
+              self.timezone_abbreviation = String(timezone_abbreviation)
+            end
+            unless carrier.nil?
+                self.carrier = String(carrier)
+            end
+            unless screen_width.nil?
+                self.screen_width = String(screen_width)
+            end
+            unless screen_height.nil?
+                self.screen_height = String(screen_height)
+            end
+            unless screen_density.nil?
+                self.screen_density = String(screen_density)
+            end
+            unless cpu_core_count.nil?
+                self.cpu_core_count = String(cpu_core_count)
+            end
+            unless total_disk_space_gb.nil?
+                self.total_disk_space_gb = String(total_disk_space_gb)
+            end
+            unless free_disk_space_gb.nil?
+                self.free_disk_space_gb = String(free_disk_space_gb)
+            end
+            unless device_time_zone.nil?
+                self.device_time_zone = String(device_time_zone)
+            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?(:'ext_info_version')
+                self.ext_info_version = attributes[:'ext_info_version']
+            end
+
+              if attributes.has_key?(:'app_package_name')
+                self.app_package_name = attributes[:'app_package_name']
+              end
+
+              if attributes.has_key?(:'short_version')
+                self.short_version = attributes[:'short_version']
+              end
+
+              if attributes.has_key?(:'long_version')
+                self.long_version = attributes[:'long_version']
+              end
+
+              if attributes.has_key?(:'os_version')
+                self.os_version = attributes[:'os_version']
+              end
+
+              if attributes.has_key?(:'device_model_name')
+                self.device_model_name = attributes[:'device_model_name']
+              end
+
+              if attributes.has_key?(:'locale')
+                self.locale = attributes[:'locale']
+              end
+
+              if attributes.has_key?(:'timezone_abbreviation')
+                self.timezone_abbreviation = attributes[:'timezone_abbreviation']
+              end
+
+              if attributes.has_key?(:'carrier')
+                self.carrier = attributes[:'carrier']
+              end
+
+              if attributes.has_key?(:'screen_width')
+                self.screen_width = attributes[:'screen_width']
+              end
+
+              if attributes.has_key?(:'screen_height')
+                self.screen_height = attributes[:'screen_height']
+              end
+
+              if attributes.has_key?(:'screen_density')
+                self.screen_density = attributes[:'screen_density']
+              end
+
+              if attributes.has_key?(:'cpu_core_count')
+                self.cpu_core_count = attributes[:'cpu_core_count']
+              end
+
+              if attributes.has_key?(:'total_disk_space_gb')
+                self.total_disk_space_gb = attributes[:'total_disk_space_gb']
+              end
+
+              if attributes.has_key?(:'free_disk_space_gb')
+                self.free_disk_space_gb = attributes[:'free_disk_space_gb']
+              end
+
+              if attributes.has_key?(:'device_time_zone')
+                self.device_time_zone = attributes[:'device_time_zone']
+              end
+        end
+
+
+        # Checks equality by comparing each attribute.
+        def ==(o)
+            return self.class == o.class &&
+                ext_info_version == o.ext_info_version &&
+                app_package_name == o.app_package_name &&
+                short_version == o.short_version &&
+                long_version == o.long_version &&
+                os_version == o.os_version &&
+                device_model_name == o.device_model_name &&
+                locale == o.locale &&
+                timezone_abbreviation == o.timezone_abbreviation &&
+                carrier == o.carrier &&
+                screen_width == o.screen_width &&
+                screen_height == o.screen_height &&
+                screen_density == o.screen_density &&
+                cpu_core_count == o.cpu_core_count &&
+                total_disk_space_gb == o.total_disk_space_gb &&
+                free_disk_space_gb == o.free_disk_space_gb &&
+                device_time_zone == o.device_time_zone
+        end
+
+        # @see the `==` method
+        def eql?(o)
+            self == o
+        end
+
+        # Calculates hash code according to all attributes.
+        # @return [Fixnum] Hash code
+        def hash
+            [
+                ext_info_version,
+                app_package_name,
+                short_version,
+                long_version,
+                os_version,
+                device_model_name,
+                locale,
+                timezone_abbreviation,
+                carrier,
+                screen_width,
+                screen_height,
+                screen_density,
+                cpu_core_count,
+                total_disk_space_gb,
+                free_disk_space_gb,
+                device_time_zone
+            ].hash
+        end
+
+        # Returns the string representation of the object
+        # @return [String] String presentation of the object
+        def to_s
+          hash = {}
+          unless ext_info_version.nil?
+            hash['ext_info_version'] = ext_info_version
+          end
+          unless app_package_name.nil?
+            hash['app_package_name'] = app_package_name
+          end
+          unless short_version.nil?
+            hash['short_version'] = short_version
+          end
+          unless long_version.nil?
+            hash['long_version'] = long_version
+          end
+          unless os_version.nil?
+            hash['os_version'] = os_version
+          end
+          unless device_model_name.nil?
+            hash['device_model_name'] = device_model_name
+          end
+          unless locale.nil?
+            hash['locale'] = locale
+          end
+          unless timezone_abbreviation.nil?
+            hash['timezone_abbreviation'] = timezone_abbreviation
+          end
+          unless carrier.nil?
+            hash['carrier'] = carrier
+          end
+          unless screen_width.nil?
+            hash['screen_width'] = screen_width
+          end
+          unless screen_height.nil?
+            hash['screen_height'] = screen_height
+          end
+          unless screen_density.nil?
+            hash['screen_density'] = screen_density
+          end
+          unless cpu_core_count.nil?
+            hash['cpu_core_count'] = cpu_core_count
+          end
+          unless total_disk_space_gb.nil?
+            hash['total_disk_space_gb'] = total_disk_space_gb
+          end
+          unless free_disk_space_gb.nil?
+            hash['free_disk_space_gb'] = free_disk_space_gb
+          end
+          unless device_time_zone.nil?
+            hash['device_time_zone'] = device_time_zone
+          end
+          hash.to_s
+        end
+
+        # Normalize input fields to server request format.
+        def normalize
+          ext_info_array = []
+          unless ext_info_version.nil?
+            ext_info_array.push(ext_info_version)
+          end
+          unless app_package_name.nil?
+            ext_info_array.push(app_package_name)
+          end
+          unless short_version.nil?
+            ext_info_array.push(short_version)
+          end
+          unless long_version.nil?
+            ext_info_array.push(long_version)
+          end
+          unless os_version.nil?
+            ext_info_array.push(os_version)
+          end
+          unless device_model_name.nil?
+            ext_info_array.push(device_model_name)
+          end
+          unless locale.nil?
+            ext_info_array.push(locale)
+          end
+          unless timezone_abbreviation.nil?
+            ext_info_array.push(timezone_abbreviation)
+          end
+          unless carrier.nil?
+            ext_info_array.push(carrier)
+          end
+          unless screen_width.nil?
+            ext_info_array.push(screen_width)
+          end
+          unless screen_height.nil?
+            ext_info_array.push(screen_height)
+          end
+          unless screen_density.nil?
+            ext_info_array.push(screen_density)
+          end
+          unless cpu_core_count.nil?
+            ext_info_array.push(cpu_core_count)
+          end
+          unless total_disk_space_gb.nil?
+            ext_info_array.push(total_disk_space_gb)
+          end
+          unless free_disk_space_gb.nil?
+            ext_info_array.push(free_disk_space_gb)
+          end
+          unless device_time_zone.nil?
+            ext_info_array.push(device_time_zone)
+          end
+          ext_info_array
+        end
+    end
+  end
+end

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

@@ -216,6 +216,27 @@ module FacebookAds
       # The date of birth year.
       attr_accessor :doby
 
+      # Your Install ID. This field represents unique application installation instances.
+      attr_accessor :anon_ids
+
+      def anon_id
+        @anon_ids ? @anon_ids[0] : nil
+      end
+      def anon_id=(anon_id)
+        @anon_ids = [anon_id]
+      end
+
+      # Your mobile advertiser ID, the advertising ID from an Android device or the Advertising Identifier (IDFA) from an Apple device.
+      attr_accessor :madids
+
+      def madid
+        @madids ? @madids[0] : nil
+      end
+      def madid=(madid)
+        @madids = [madid]
+      end
+
+
       #UserData is a set of identifiers Facebook can use for targeted attribution
       # @param [String] email
       # @param [Array<String>] emails
@@ -251,13 +272,17 @@ module FacebookAds
       # @param [String] dobd
       # @param [String] dobm
       # @param [String] doby
+      # @param [String] anon_id
+      # @param [Array<String>] anon_ids
+      # @param [String] madid
+      # @param [Array<String>] madids
       def initialize(email: nil, emails: nil, phone: nil, phones: nil, gender: nil, genders: nil,
                      date_of_birth: nil, dates_of_birth: nil, last_name: nil, last_names: nil,
                      first_name: nil, first_names: nil, city: nil, cities: nil, state: nil, states: nil,
                      country_code: nil, country_codes: nil, zip_code: nil, zip_codes: nil,
                      external_id: nil, external_ids: nil, client_ip_address: nil,
                      client_user_agent: nil, fbc: nil, fbp: nil, subscription_id: nil, lead_id: nil,
-                     f5first: nil, f5last: nil, fi: nil, dobd: nil, dobm: nil, doby: nil)
+                     f5first: nil, f5last: nil, fi: nil, dobd: nil, dobm: nil, doby: nil, anon_id: nil, anon_ids: nil, madid:nil, madids: nil)
         validate_constructor_values(emails, email, 'emails', 'email')
         validate_constructor_values(phones, phone, 'phones', 'phone')
         validate_constructor_values(genders, gender, 'genders', 'gender')
@@ -372,6 +397,18 @@ module FacebookAds
         unless doby.nil?
           self.doby = doby
         end
+        unless anon_id.nil?
+          self.anon_id = anon_id
+        end
+        unless anon_ids.nil?
+          self.anon_ids = anon_ids
+        end
+        unless madid.nil?
+          self.madid = madid
+        end
+        unless madids.nil?
+          self.madids = madids
+        end
       end
 
       # build the object using the input hash
@@ -491,6 +528,18 @@ module FacebookAds
         if attributes.has_key?(:'doby')
           self.doby = attributes[:'doby']
         end
+
+        if attributes.has_key?(:'anon_ids')
+          self.anon_ids = attributes[:'anon_ids']
+        elsif attributes.has_key?(:'anon_id')
+          self.anon_ids = [attributes[:'anon_id']]
+        end
+
+        if attributes.has_key?(:'madids')
+          self.madids = attributes[:'madids']
+        elsif attributes.has_key?(:'madid')
+          self.madids = [attributes[:'madid']]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -519,7 +568,9 @@ module FacebookAds
             fi == o.fi &&
             dobd == o.dobd &&
             dobm == o.dobm &&
-            doby == o.doby
+            doby == o.doby &&
+            anon_ids == o.anon_ids &&
+            madids == o.madids
       end
 
       # @see the `==` method
@@ -554,6 +605,8 @@ module FacebookAds
             dobd,
             dobm,
             doby,
+            anon_ids,
+            madids
         ].hash
 
       end
@@ -631,6 +684,12 @@ module FacebookAds
         unless doby.nil?
           hash['doby'] = doby
         end
+        unless anon_ids.nil?
+          hash['anon_ids'] = anon_ids
+        end
+        unless madids.nil?
+          hash['madids'] = madids
+        end
         hash.to_s
       end
 
@@ -707,6 +766,12 @@ module FacebookAds
         unless doby.nil?
           hash['doby'] = FacebookAds::ServerSide::Util.normalize(doby, 'doby')
         end
+        unless anon_id.nil?
+          hash['anon_id'] = anon_ids
+        end
+        unless madid.nil?
+          hash['madid'] = madids
+        end
         hash.select{|k, v| !v.nil?}
       end
 

data/lib/facebook_ads/ad_objects/shadow_ig_hashtag.rb

@@ -0,0 +1,36 @@
+# 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 ShadowIgHashtag < AdObject
+
+    field :id, 'string'
+    field :name, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :recent_media do |edge|
+      edge.get 'IgMedia' do |api|
+        api.has_param :user_id, 'string'
+      end
+    end
+
+    has_edge :top_media do |edge|
+      edge.get 'IgMedia' do |api|
+        api.has_param :user_id, 'string'
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/shadow_ig_media_builder.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 ShadowIgMediaBuilder < AdObject
+
+    field :copyright_check_status, 'IgVideoCopyrightCheckStatus'
+    field :id, 'string'
+    field :status, 'string'
+    field :status_code, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

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

data/lib/facebook_ads/ad_objects/shadow_ig_media_product_tags.rb

@@ -0,0 +1,35 @@
+# 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 ShadowIgMediaProductTags < AdObject
+
+    field :image_url, 'string'
+    field :is_checkout, 'bool'
+    field :merchant_id, 'int'
+    field :name, 'string'
+    field :price_string, 'string'
+    field :product_id, 'int'
+    field :review_status, 'string'
+    field :stripped_price_string, 'string'
+    field :stripped_sale_price_string, 'string'
+    field :x, 'double'
+    field :y, 'double'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/shadow_ig_user_catalog_product_search.rb

@@ -0,0 +1,32 @@
+# 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 ShadowIgUserCatalogProductSearch < AdObject
+
+    field :image_url, 'string'
+    field :is_checkout_flow, 'bool'
+    field :merchant_id, 'int'
+    field :product_id, 'int'
+    field :product_name, 'string'
+    field :product_variants, { list: 'ShadowIgUserCatalogProductVariant' }
+    field :retailer_id, 'string'
+    field :review_status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/shadow_ig_user_catalog_product_variant.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 ShadowIgUserCatalogProductVariant < AdObject
+
+    field :product_id, 'int'
+    field :variant_name, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/shop.rb

@@ -1,20 +1,8 @@
-# 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.
+# 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
 
@@ -30,6 +18,9 @@ module FacebookAds
     field :fb_sales_channel, 'object'
     field :id, 'string'
     field :ig_sales_channel, 'object'
+    field :is_onsite_enabled, 'bool'
+    field :shop_status, 'string'
+    field :workspace, 'object'
     has_no_post
     has_no_delete