facebookbusiness 0.8.0.0 → 0.8.0.2

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -64,6 +64,35 @@ module FacebookAds
       "google",
     ]
 
+    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",
+    ]
+
 
     field :business, 'Business'
     field :commerce_merchant_settings, 'CommerceMerchantSettings'
@@ -77,9 +106,12 @@ module FacebookAds
     field :product_count, 'int'
     field :store_catalog_settings, 'StoreCatalogSettings'
     field :vertical, 'string'
+    field :catalog_segment_filter, 'object'
+    field :catalog_segment_product_set_id, 'string'
     field :destination_catalog_settings, 'hash'
     field :flight_catalog_settings, 'hash'
     field :onsite_commerce_merchant, 'object'
+    field :parent_catalog_id, 'string'
 
     has_edge :agencies do |edge|
       edge.delete do |api|
@@ -90,6 +122,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 :utm_settings, 'hash'
       end
     end
 
@@ -235,6 +268,7 @@ module FacebookAds
     has_edge :items_batch do |edge|
       edge.post 'ProductCatalog' do |api|
         api.has_param :allow_upsert, 'bool'
+        api.has_param :item_sub_type, { enum: -> { ProductCatalog::ITEM_SUB_TYPE }}
         api.has_param :item_type, 'string'
         api.has_param :requests, 'hash'
       end
@@ -270,6 +304,7 @@ module FacebookAds
         api.has_param :encoding, { enum: -> { ProductFeed::ENCODING }}
         api.has_param :feed_type, { enum: -> { ProductFeed::FEED_TYPE }}
         api.has_param :file_name, 'string'
+        api.has_param :item_sub_type, { enum: -> { ProductFeed::ITEM_SUB_TYPE }}
         api.has_param :name, 'string'
         api.has_param :override_type, { enum: -> { ProductFeed::OVERRIDE_TYPE }}
         api.has_param :override_value, 'string'
@@ -300,6 +335,7 @@ module FacebookAds
         api.has_param :filter, 'object'
         api.has_param :metadata, 'hash'
         api.has_param :name, 'string'
+        api.has_param :retailer_id, 'string'
       end
     end
 
@@ -326,6 +362,7 @@ module FacebookAds
         api.has_param :availability, { enum: -> { ProductItem::AVAILABILITY }}
         api.has_param :brand, 'string'
         api.has_param :category, 'string'
+        api.has_param :category_specific_fields, 'hash'
         api.has_param :checkout_url, 'string'
         api.has_param :color, 'string'
         api.has_param :commerce_tax_category, { enum: -> { ProductItem::COMMERCE_TAX_CATEGORY }}
@@ -339,6 +376,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_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,6 +114,7 @@ module FacebookAds
     field :encoding, 'string'
     field :file_name, 'string'
     field :id, 'string'
+    field :item_sub_type, 'string'
     field :latest_upload, 'ProductFeedUpload'
     field :name, 'string'
     field :override_type, 'string'

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

@@ -297,6 +297,7 @@ module FacebookAds
     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,6 +310,7 @@ 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'

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

@@ -137,17 +137,17 @@ module FacebookAds
         end
         normalized_events = normalize
         ads_pixel = FacebookAds::AdsPixel.get(pixel_id)
-        response = ads_pixel.events.create(
-            {
-                data: normalized_events,
-                test_event_code: test_event_code,
-                partner_agent: partner_agent,
-                namespace_id: namespace_id,
-                upload_id: upload_id,
-                upload_tag: upload_tag,
-                upload_source: upload_source,
-            }
-        )
+        params = {
+          data: normalized_events
+        }
+        params[:test_event_code] = test_event_code unless test_event_code.nil?
+        params[:partner_agent] = partner_agent unless partner_agent.nil?
+        params[:namespace_id] = namespace_id unless namespace_id.nil?
+        params[:upload_id] = upload_id unless upload_id.nil?
+        params[:upload_tag] = upload_tag unless upload_tag.nil?
+        params[:upload_source] = upload_source unless upload_source.nil?
+
+        response = ads_pixel.events.create(params)
         json_response_object = JSON.parse(JSON.generate(response), object_class: OpenStruct)
         FacebookAds::ServerSide::EventResponse.new(
             events_received: json_response_object.events_received,

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

@@ -0,0 +1,31 @@
+# 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.
+
+require 'concurrent'
+
+module FacebookAds
+  module ServerSide
+    class EventRequestAsync < EventRequest
+      def execute
+        Concurrent::Promise.execute do
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -91,6 +91,9 @@ module FacebookAds
       # The subscription ID for the user in this transaction. This is similar to the order ID for an individual product.
       attr_accessor :subscription_id
 
+      # The lead ID for the user in this transaction. This ID is associated with a lead generated by Facebook's Lead Ads.
+      attr_accessor :lead_id
+
       # The first 5 letters of the first name.
       attr_accessor :f5first
 
@@ -126,6 +129,7 @@ module FacebookAds
       # @param [String] fbc
       # @param [String] fbp
       # @param [String] subscription_id
+      # @param [String] lead_id
       # @param [String] f5first
       # @param [String] f5last
       # @param [String] fi
@@ -135,7 +139,7 @@ module FacebookAds
       def initialize(email: nil, phone: nil, gender: nil, date_of_birth: nil,
                      last_name: nil, first_name: nil, city: nil, state: nil,
                      country_code: nil, zip_code: nil, external_id: nil, client_ip_address: nil,
-                     client_user_agent: nil, fbc: nil, fbp: nil, subscription_id: 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)
         unless email.nil?
           self.email = email
@@ -185,6 +189,9 @@ module FacebookAds
         unless subscription_id.nil?
           self.subscription_id = subscription_id
         end
+        unless lead_id.nil?
+          self.lead_id = lead_id
+        end
         unless f5first.nil?
           self.f5first = f5first
         end
@@ -273,6 +280,10 @@ module FacebookAds
           self.fbp = attributes[:'fbp']
         end
 
+        if attributes.has_key?(:'lead_id')
+          self.lead_id = attributes[:'lead_id']
+        end
+
         if attributes.has_key?(:'f5first')
           self.f5first = attributes[:'f5first']
         end
@@ -318,6 +329,7 @@ module FacebookAds
             fbc == o.fbc &&
             fbp == o.fbp &&
             subscription_id == o.subscription_id &&
+            lead_id == o.lead_id &&
             f5first == o.f5first &&
             f5last == o.f5last &&
             fi == o.fi &&
@@ -351,6 +363,7 @@ module FacebookAds
             fbc,
             fbp,
             subscription_id,
+            lead_id,
             f5first,
             f5last,
             fi,
@@ -413,6 +426,9 @@ module FacebookAds
         unless subscription_id.nil?
           hash['subscription_id'] = subscription_id
         end
+        unless lead_id.nil?
+          hash['lead_id'] = lead_id
+        end
         unless f5first.nil?
           hash['f5first'] = f5first
         end
@@ -486,6 +502,9 @@ module FacebookAds
         unless subscription_id.nil?
           hash['subscription_id'] = subscription_id
         end
+        unless lead_id.nil?
+          hash['lead_id'] = lead_id
+        end
         unless f5first.nil?
           hash['f5first'] = FacebookAds::ServerSide::Util.normalize(f5first, 'f5first')
         end

data/lib/facebook_ads/ad_objects/system_user.rb

@@ -33,6 +33,10 @@ module FacebookAds
       "EMPLOYEE",
       "FINANCE_ANALYST",
       "FINANCE_EDITOR",
+      "FINANCE_EDIT_TASK",
+      "FINANCE_VIEW_TASK",
+      "MODERATE_TASK",
+      "OPERATE_TASK",
       "PARTNER_CENTER_ADMIN",
       "PARTNER_CENTER_ANALYST",
       "PARTNER_CENTER_EDUCATION",

data/lib/facebook_ads/ad_objects/targeting.rb

@@ -50,7 +50,7 @@ module FacebookAds
     field :catalog_based_targeting, 'CatalogBasedTargeting'
     field :cities, { list: 'IdName' }
     field :college_years, { list: 'int' }
-    field :connections, { list: 'IdName' }
+    field :connections, { list: 'ConnectionsTargeting' }
     field :contextual_targeting_categories, { list: 'IdName' }
     field :countries, { list: 'string' }
     field :country, { list: 'string' }
@@ -72,7 +72,7 @@ module FacebookAds
     field :ethnic_affinity, { list: 'IdName' }
     field :exclude_reached_since, { list: 'string' }
     field :excluded_brand_safety_content_types, { list: 'string' }
-    field :excluded_connections, { list: 'IdName' }
+    field :excluded_connections, { list: 'ConnectionsTargeting' }
     field :excluded_custom_audiences, { list: 'RawCustomAudience' }
     field :excluded_dynamic_audience_ids, { list: 'string' }
     field :excluded_engagement_specs, { list: 'TargetingDynamicRule' }
@@ -87,7 +87,7 @@ module FacebookAds
     field :family_statuses, { list: 'IdName' }
     field :fb_deal_id, 'string'
     field :flexible_spec, { list: 'FlexibleTargeting' }
-    field :friends_of_connections, { list: 'IdName' }
+    field :friends_of_connections, { list: 'ConnectionsTargeting' }
     field :genders, { list: 'int' }
     field :generation, { list: 'IdName' }
     field :geo_locations, 'TargetingGeoLocation'

data/lib/facebook_ads/ad_objects/unified_thread.rb

@@ -32,6 +32,7 @@ module FacebookAds
     field :id, 'string'
     field :is_subscribed, 'bool'
     field :link, 'string'
+    field :linked_group, 'Group'
     field :message_count, 'int'
     field :name, 'string'
     field :participants, 'object'

data/lib/facebook_ads/ad_objects/user.rb

@@ -54,7 +54,6 @@ module FacebookAds
     field :age_range, 'AgeRange'
     field :auth_method, 'string'
     field :birthday, 'string'
-    field :can_review_measurement_request, 'bool'
     field :cover, 'UserCoverPhoto'
     field :currency, 'Currency'
     field :devices, { list: 'UserDevice' }
@@ -70,9 +69,7 @@ module FacebookAds
     field :install_type, 'string'
     field :installed, 'bool'
     field :interested_in, { list: 'string' }
-    field :is_famedeeplinkinguser, 'bool'
     field :is_guest_user, 'bool'
-    field :is_shared_login, 'bool'
     field :is_verified, 'bool'
     field :languages, { list: 'Experience' }
     field :last_name, 'string'
@@ -92,20 +89,17 @@ module FacebookAds
     field :quotes, 'string'
     field :relationship_status, 'string'
     field :religion, 'string'
-    field :security_settings, 'SecuritySettings'
     field :shared_login_upgrade_required_by, 'datetime'
     field :short_name, 'string'
     field :significant_other, 'User'
     field :sports, { list: 'Experience' }
     field :supports_donate_button_in_live_video, 'bool'
-    field :test_group, 'int'
     field :third_party_id, 'string'
     field :timezone, 'double'
     field :token_for_business, 'string'
     field :updated_time, 'datetime'
     field :verified, 'bool'
     field :video_upload_limits, 'VideoUploadLimits'
-    field :viewer_can_send_gift, 'bool'
     field :website, 'string'
     field :work, { list: 'object' }
 
@@ -211,6 +205,7 @@ module FacebookAds
       end
       edge.get 'Business'
       edge.post 'Business' do |api|
+        api.has_param :child_business_external_id, 'string'
         api.has_param :email, 'string'
         api.has_param :name, 'string'
         api.has_param :primary_page, 'string'
@@ -468,6 +463,7 @@ module FacebookAds
       edge.post 'LiveVideo' do |api|
         api.has_param :content_tags, { list: 'string' }
         api.has_param :description, 'string'
+        api.has_param :enable_backup_ingest, 'bool'
         api.has_param :encoding_settings, 'string'
         api.has_param :fisheye_video_cropped, 'bool'
         api.has_param :front_z_rotation, 'double'
@@ -489,11 +485,6 @@ module FacebookAds
       end
     end
 
-    has_edge :meeting_link do |edge|
-      edge.get 'WorkMeetingLink'
-      edge.post 'WorkMeetingLink'
-    end
-
     has_edge :music do |edge|
       edge.get 'Page' do |api|
         api.has_param :target_id, 'string'
@@ -513,6 +504,10 @@ module FacebookAds
       end
     end
 
+    has_edge :owned_product_catalogs do |edge|
+      edge.get 'ProductCatalog'
+    end
+
     has_edge :permissions do |edge|
       edge.delete do |api|
         api.has_param :permission, 'string'