facebookbusiness 0.7.0.3 → 0.10.0.0

data/lib/facebook_ads/ad_objects/product_feed.rb

@@ -68,6 +68,35 @@ module FacebookAds
       "VEHICLE_OFFER",
     ]
 
+    ITEM_SUB_TYPE = [
+      "APPLIANCES",
+      "BABY_FEEDING",
+      "BABY_TRANSPORT",
+      "BEAUTY",
+      "BEDDING",
+      "CAMERAS",
+      "CELL_PHONES_AND_SMART_WATCHES",
+      "CLEANING_SUPPLIES",
+      "CLOTHING",
+      "CLOTHING_ACCESSORIES",
+      "COMPUTERS_AND_TABLETS",
+      "DIAPERING_AND_POTTY_TRAINING",
+      "ELECTRONICS_ACCESSORIES",
+      "FURNITURE",
+      "HEALTH",
+      "HOME_GOODS",
+      "JEWELRY",
+      "NURSERY",
+      "PRINTERS_AND_SCANNERS",
+      "PROJECTORS",
+      "SHOES_AND_FOOTWEAR",
+      "SOFTWARE",
+      "TOYS",
+      "TVS_AND_MONITORS",
+      "VIDEO_GAME_CONSOLES_AND_VIDEO_GAMES",
+      "WATCHES",
+    ]
+
     OVERRIDE_TYPE = [
       "CATALOG_SEGMENT_CUSTOMIZE_DEFAULT",
       "COUNTRY",
@@ -85,7 +114,9 @@ module FacebookAds
     field :encoding, 'string'
     field :file_name, 'string'
     field :id, 'string'
+    field :item_sub_type, 'string'
     field :latest_upload, 'ProductFeedUpload'
+    field :migrated_from_feed_id, 'string'
     field :name, 'string'
     field :override_type, 'string'
     field :product_count, 'int'
@@ -95,7 +126,7 @@ module FacebookAds
     field :feed_type, { enum: -> { FEED_TYPE }}
     field :override_value, 'string'
     field :rules, { list: 'string' }
-    field :whitelisted_properties, { list: 'string' }
+    field :selected_override_fields, { list: 'string' }
 
     has_edge :automotive_models do |edge|
       edge.get 'AutomotiveModel' do |api|

data/lib/facebook_ads/ad_objects/product_feed_schedule.rb

@@ -54,6 +54,8 @@ module FacebookAds
     field :timezone, 'string'
     field :url, 'string'
     field :username, 'string'
+    has_no_post
+    has_no_delete
 
   end
 end

data/lib/facebook_ads/ad_objects/product_group.rb

@@ -57,6 +57,7 @@ module FacebookAds
         api.has_param :custom_label_4, 'string'
         api.has_param :description, 'string'
         api.has_param :expiration_date, 'string'
+        api.has_param :fb_product_category, 'string'
         api.has_param :gender, { enum: -> { ProductItem::GENDER }}
         api.has_param :gtin, 'string'
         api.has_param :image_url, 'string'

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -92,6 +92,7 @@ module FacebookAds
       "FB_APRL_CLOTHING",
       "FB_APRL_COSTUME",
       "FB_APRL_CSTM",
+      "FB_APRL_FORMAL",
       "FB_APRL_HANDBAG",
       "FB_APRL_JEWELRY",
       "FB_APRL_SHOE",
@@ -293,10 +294,12 @@ module FacebookAds
     field :additional_variant_attributes, 'hash'
     field :age_group, { enum: -> { AGE_GROUP }}
     field :applinks, 'CatalogItemAppLinks'
+    field :ar_data, 'ProductItemArData'
     field :availability, { enum: -> { AVAILABILITY }}
     field :brand, 'string'
     field :capability_to_review_status, 'hash'
     field :category, 'string'
+    field :category_specific_fields, 'CatalogSubVerticalList'
     field :color, 'string'
     field :commerce_insights, 'ProductItemCommerceInsights'
     field :condition, { enum: -> { CONDITION }}
@@ -309,17 +312,20 @@ module FacebookAds
     field :custom_label_4, 'string'
     field :description, 'string'
     field :expiration_date, 'string'
+    field :fb_product_category, 'string'
     field :gender, { enum: -> { GENDER }}
     field :gtin, 'string'
     field :id, 'string'
     field :image_cdn_urls, 'hash'
     field :image_url, 'string'
+    field :images, { list: 'string' }
     field :inventory, 'int'
     field :manufacturer_part_number, 'string'
     field :material, 'string'
     field :mobile_link, 'string'
     field :name, 'string'
     field :ordering_index, 'int'
+    field :parent_product_id, 'string'
     field :pattern, 'string'
     field :price, 'string'
     field :product_catalog, 'ProductCatalog'
@@ -340,7 +346,7 @@ module FacebookAds
     field :start_date, 'string'
     field :url, 'string'
     field :visibility, { enum: -> { VISIBILITY }}
-    field :additional_image_files, { list: 'file' }
+    field :additional_uploaded_image_ids, { list: 'string' }
     field :android_app_name, 'string'
     field :android_class, 'string'
     field :android_package, 'string'
@@ -365,6 +371,10 @@ module FacebookAds
     field :windows_phone_app_name, 'string'
     field :windows_phone_url, 'string'
 
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
     has_edge :product_sets do |edge|
       edge.get 'ProductSet'
     end

data/lib/facebook_ads/ad_objects/{user_payment_methods_info.rb → product_item_ar_data.rb}

@@ -25,15 +25,30 @@ 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 UserPaymentMethodsInfo < AdObject
+  class ProductItemArData < AdObject
+    SURFACES = [
+      "B2C_MARKETPLACE",
+      "C2C_MARKETPLACE",
+      "DA",
+      "DAILY_DEALS",
+      "DAILY_DEALS_LEGACY",
+      "IG_PRODUCT_TAGGING",
+      "MARKETPLACE",
+      "MARKETPLACE_ADS_DEPRECATED",
+      "MARKETPLACE_SHOPS",
+      "OFFLINE_CONVERSIONS",
+      "SHOPS",
+      "UNIVERSAL_CHECKOUT",
+    ]
 
-    field :account_id, 'string'
-    field :available_card_types, { list: 'string' }
-    field :available_payment_methods, { list: 'string' }
-    field :available_payment_methods_details, { list: 'object' }
-    field :country, 'string'
-    field :currency, 'string'
-    field :existing_payment_methods, { list: 'object' }
+
+    field :container_effect, 'string'
+    field :effect_icon, 'string'
+    field :effect_parameters, 'object'
+    field :picker_icon, 'string'
+    field :product_ar_link, 'object'
+    field :state, 'string'
+    field :surfaces, { list: { enum: -> { SURFACES }} }
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/product_set.rb

@@ -35,6 +35,7 @@ module FacebookAds
     field :name, 'string'
     field :product_catalog, 'ProductCatalog'
     field :product_count, 'int'
+    field :retailer_id, 'string'
     field :metadata, 'hash'
 
     has_edge :automotive_models do |edge|

data/lib/facebook_ads/ad_objects/product_set_metadata.rb

@@ -29,6 +29,7 @@ module FacebookAds
 
     field :cover_image_url, 'string'
     field :description, 'string'
+    field :external_url, 'string'
     field :integrity_review_status, 'string'
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/publisher_block_list.rb

@@ -38,6 +38,12 @@ module FacebookAds
     field :owner_ad_account_id, 'string'
     field :web_publishers, { list: 'object' }
 
+    has_edge :append_publisher_urls do |edge|
+      edge.post do |api|
+        api.has_param :publisher_urls, { list: 'string' }
+      end
+    end
+
     has_edge :paged_web_publishers do |edge|
       edge.get do |api|
         api.has_param :draft_id, 'string'

data/lib/facebook_ads/ad_objects/referral.rb

@@ -34,10 +34,12 @@ module FacebookAds
     field :namespace, 'string'
     field :need_promo_code, 'bool'
     field :offer_origin, 'string'
+    field :privacy_policy_link, 'string'
     field :promotion_text, 'string'
     field :receiver_benefits_text, 'string'
     field :referral_link_uri, 'string'
     field :sender_benefits_text, 'string'
+    field :terms_and_condition_link, 'string'
 
   end
 end

data/lib/facebook_ads/ad_objects/security_settings.rb

@@ -27,7 +27,6 @@ module FacebookAds
 
   class SecuritySettings < AdObject
 
-    field :secure_browsing, 'object'
     has_no_id
     has_no_get
     has_no_post

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

@@ -0,0 +1,48 @@
+# 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
+		ActionSource = Set[
+
+			# Conversion happened over email.
+			'email',
+
+			# Conversion was made on your website.
+			'website',
+
+			# Conversion was made using your app.
+			'app',
+
+			# Conversion was made over the phone.
+			'phone_call',
+
+			# Conversion was made via a messaging app, SMS, or online messaging feature.
+			'chat',
+
+			# Conversion was made in person at your physical store.
+			'physical_store',
+
+			# Conversion happened automatically, for example, a subscription renewal that's set on auto-pay each month.
+			'system_generated',
+
+			# Conversion happened in a way that is not listed.
+			'other'
+		]
+	end
+end

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

@@ -0,0 +1,73 @@
+# 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::ServerSide
+  class BatchProcessor
+    attr_accessor :batch_size
+    attr_accessor :concurrent_requests
+
+    # Initializes the object
+    # @param [Integer] batch_size  The number of events to send in each request
+    # @param [Integer] concurrent_requests  The number of threads to use when making requests concurrently
+    def initialize(batch_size=50, concurrent_requests=4)
+      self.batch_size = batch_size
+      self.concurrent_requests = concurrent_requests
+    end
+
+    def process_event_requests(event_requests_async)
+      generator = self.process_event_requests_generator(event_requests_async)
+      generator.each do |batch|
+        Concurrent::Promise.zip(*batch).execute.value!
+      end
+    end
+
+    def process_events(event_request_async_to_clone, events)
+      generator = self.process_events_generator(event_request_async_to_clone, events)
+      generator.each do |batch|
+        Concurrent::Promise.zip(*batch).execute.value!
+      end
+    end
+
+    def process_event_requests_generator(event_requests_async)
+      index = 0
+      Enumerator.new do |generator|
+        while index < event_requests_async.size do
+          batch = event_requests_async[index, concurrent_requests].map(&:execute)
+          generator.yield *[batch]
+          index += concurrent_requests
+        end
+      end
+    end
+
+    def process_events_generator(event_request_async_to_clone, events)
+      index = 0
+      Enumerator.new do |generator|
+        while index < events.size do
+          batch = []
+          while index < events.size && batch.size < concurrent_requests do
+            event_request_async = event_request_async_to_clone.clone_without_events
+            event_request_async.events = events[index, batch_size]
+            batch << event_request_async
+            index += batch_size
+          end
+          generator.yield *[batch.map(&:execute)]
+        end
+      end
+    end
+  end
+end

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

@@ -28,7 +28,8 @@ module FacebookAds
                     :title,
                     :description,
                     :brand,
-                    :category
+                    :category,
+                    :delivery_category
 
       # Initializes the object
       # @param [String] product_id
@@ -38,7 +39,8 @@ module FacebookAds
       # @param [String] description
       # @param [String] brand
       # @param [String] category
-      def initialize(product_id: nil, quantity: nil, item_price: nil, title: nil, description: nil, brand: nil, category: nil)
+      # @param [String] delivery_category
+      def initialize(product_id: nil, quantity: nil, item_price: nil, title: nil, description: nil, brand: nil, category: nil, delivery_category: nil)
         unless product_id.nil?
           self.product_id = String(product_id)
         end
@@ -60,6 +62,9 @@ module FacebookAds
         unless category.nil?
           self.category = String(category)
         end
+        unless delivery_category.nil?
+          self.delivery_category = String(delivery_category)
+        end
       end
 
       # build the object using the input hash
@@ -97,6 +102,10 @@ module FacebookAds
         if attributes.has_key?(:'category')
           self.category = attributes[:'category']
         end
+
+        if attributes.has_key?(:'delivery_category')
+          self.delivery_category = attributes[:'delivery_category']
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -108,7 +117,8 @@ module FacebookAds
             title == o.title &&
             description == o.description &&
             brand == o.brand &&
-            category == o.category
+            category == o.category &&
+            delivery_category == o.delivery_category
       end
 
       # @see the `==` method
@@ -126,7 +136,8 @@ module FacebookAds
             title,
             description,
             brand,
-            category
+            category,
+            delivery_category
         ].hash
       end
 
@@ -156,6 +167,9 @@ module FacebookAds
         unless category.nil?
           hash['category'] = category
         end
+        unless delivery_category.nil?
+          hash['delivery_category'] = delivery_category
+        end
         hash.to_s
       end
 
@@ -183,6 +197,11 @@ module FacebookAds
         unless category.nil?
           hash['category'] = category
         end
+        unless delivery_category.nil?
+          hash['delivery_category'] = FacebookAds::ServerSide::Util.normalize_delivery_category(
+            delivery_category
+          )
+        end
         hash
       end
     end

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

@@ -70,6 +70,10 @@ module FacebookAds
       # Example: 'lettuce'.
       attr_accessor :search_string
 
+      # Type of delivery for a purchase event
+      # Example: 'home_delivery'.
+      attr_accessor :delivery_category
+
       # The item number.
       # Example: 'item1234'.
       attr_accessor :item_number
@@ -90,6 +94,7 @@ module FacebookAds
       # @param [Integer] num_items
       # @param [String] status
       # @param [String] search_string
+      # @param [String] delivery_category
       # @param [String] item_number
       # @param [String] custom_properties
       def initialize(value: nil,
@@ -104,6 +109,7 @@ module FacebookAds
                      num_items: nil,
                      status: nil,
                      search_string: nil,
+                     delivery_category: nil,
                      item_number: nil,
                      custom_properties: {})
 
@@ -143,6 +149,9 @@ module FacebookAds
         unless search_string.nil?
           self.search_string = search_string
         end
+        unless delivery_category.nil?
+          self.delivery_category = delivery_category
+        end
         unless item_number.nil?
           self.item_number = item_number
         end
@@ -212,6 +221,10 @@ module FacebookAds
           self.search_string = attributes[:'search_string']
         end
 
+        if attributes.has_key?(:'delivery_category')
+          self.delivery_category = attributes[:'delivery_category']
+        end
+
         if attributes.has_key?(:'item_number')
           self.item_number = attributes[:'item_number']
         end
@@ -237,6 +250,7 @@ module FacebookAds
             num_items == o.num_items &&
             status == o.status &&
             search_string == o.search_string &&
+            delivery_category == o.delivery_category &&
             item_number == o.item_number &&
             custom_properties == o.custom_properties
       end
@@ -262,6 +276,7 @@ module FacebookAds
             num_items,
             status,
             search_string,
+            delivery_category,
             item_number,
             custom_properties
         ].hash
@@ -307,6 +322,9 @@ module FacebookAds
         unless search_string.nil?
           hash['search_string'] = search_string
         end
+        unless delivery_category.nil?
+          hash['delivery_category'] = delivery_category
+        end
         unless custom_properties.nil?
           hash['custom_properties'] = custom_properties
         end
@@ -354,6 +372,9 @@ module FacebookAds
         unless search_string.nil?
           hash['search_string'] = search_string
         end
+        unless delivery_category.nil?
+          hash['delivery_category'] = FacebookAds::ServerSide::Util.normalize(delivery_category, 'delivery_category')
+        end
         unless item_number.nil?
           hash['item_number'] = item_number
         end