facebookbusiness 0.7.0.1 → 0.8.0.3

data/lib/facebook_ads/ad_objects/page_admin_note.rb

@@ -30,6 +30,7 @@ module FacebookAds
     field :body, 'string'
     field :from, 'Page'
     field :id, 'string'
+    field :note_label, 'string'
     field :user, 'User'
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/page_call_to_action.rb

@@ -32,6 +32,7 @@ module FacebookAds
       "EMAIL",
       "FACEBOOK_APP",
       "FOLLOW",
+      "MARKETPLACE_INVENTORY_PAGE",
       "MESSENGER",
       "MINI_SHOP",
       "NONE",
@@ -46,6 +47,7 @@ module FacebookAds
       "EMAIL",
       "FACEBOOK_APP",
       "FOLLOW",
+      "MARKETPLACE_INVENTORY_PAGE",
       "MESSENGER",
       "MINI_SHOP",
       "NONE",
@@ -83,6 +85,7 @@ module FacebookAds
       "SHOP_NOW",
       "SHOP_ON_FACEBOOK",
       "SIGN_UP",
+      "VIEW_INVENTORY",
       "VIEW_SHOP",
       "VISIT_GROUP",
       "WATCH_NOW",

data/lib/facebook_ads/ad_objects/page_change_proposal.rb

@@ -33,6 +33,8 @@ module FacebookAds
     field :id, 'string'
     field :proposed_value, 'string'
     field :upcoming_change_info, 'PageUpcomingChange'
+    has_no_get
+    has_no_post
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/page_post.rb

@@ -76,6 +76,7 @@ module FacebookAds
     field :id, 'string'
     field :implicit_place, 'Place'
     field :instagram_eligibility, 'string'
+    field :instream_eligibility, 'string'
     field :is_app_share, 'bool'
     field :is_eligible_for_promotion, 'bool'
     field :is_expired, 'bool'
@@ -94,6 +95,7 @@ module FacebookAds
     field :permalink_url, 'object'
     field :picture, 'string'
     field :place, 'Place'
+    field :poll, 'object'
     field :privacy, 'Privacy'
     field :promotable_id, 'string'
     field :promotion_status, 'string'

data/lib/facebook_ads/ad_objects/{business_creative.rb → payment_subscription.rb}

@@ -25,26 +25,34 @@ 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 BusinessCreative < AdObject
+  class PaymentSubscription < AdObject
 
-    field :creation_time, 'datetime'
-    field :duration, 'int'
-    field :hash, 'string'
-    field :height, 'int'
+    field :amount, 'string'
+    field :app_param_data, 'string'
+    field :application, 'Profile'
+    field :billing_period, 'string'
+    field :canceled_reason, 'string'
+    field :created_time, 'datetime'
+    field :currency, 'string'
     field :id, 'string'
-    field :name, 'string'
-    field :thumbnail, 'string'
-    field :type, 'string'
-    field :url, 'string'
-    field :video_id, 'string'
-    field :width, 'int'
-    has_no_get
+    field :last_payment, 'string'
+    field :next_bill_time, 'datetime'
+    field :next_period_amount, 'string'
+    field :next_period_currency, 'string'
+    field :next_period_product, 'string'
+    field :payment_status, 'string'
+    field :pending_cancel, 'bool'
+    field :period_start_time, 'datetime'
+    field :product, 'string'
+    field :status, 'string'
+    field :test, 'int'
+    field :trial_amount, 'string'
+    field :trial_currency, 'string'
+    field :trial_expiry_time, 'datetime'
+    field :updated_time, 'datetime'
+    field :user, 'Profile'
     has_no_post
     has_no_delete
 
-    has_edge :ad_placement_validation_results do |edge|
-      edge.get
-    end
-
   end
 end

data/lib/facebook_ads/ad_objects/photo.rb

@@ -125,6 +125,12 @@ module FacebookAds
       end
     end
 
+    has_edge :reactions do |edge|
+      edge.get 'Profile' do |api|
+        api.has_param :type, { enum: -> { Profile::TYPE }}
+      end
+    end
+
     has_edge :sharedposts do |edge|
       edge.get 'Post'
     end

data/lib/facebook_ads/ad_objects/post.rb

@@ -74,6 +74,7 @@ module FacebookAds
     field :id, 'string'
     field :implicit_place, 'Place'
     field :instagram_eligibility, 'string'
+    field :instream_eligibility, 'string'
     field :is_app_share, 'bool'
     field :is_eligible_for_promotion, 'bool'
     field :is_expired, 'bool'
@@ -95,6 +96,7 @@ module FacebookAds
     field :permalink_url, 'object'
     field :picture, 'string'
     field :place, 'Place'
+    field :poll, 'object'
     field :privacy, 'Privacy'
     field :promotable_id, 'string'
     field :promotion_status, 'string'
@@ -174,11 +176,11 @@ module FacebookAds
       edge.post do |api|
         api.has_param :ad_account_id, 'string'
         api.has_param :ad_conversion_pixel_id, 'int'
-        api.has_param :audience, { enum: %w{AUTO_LOOKALIKE AUTO_PAGE_LOOKALIKE AUTO_TARGETING COUNTRY_AND_INTEREST CREATE_NEW CUSTOM_AUDIENCE DISTRICT EVENT_CUSTOM_AUDIENCES EVENT_ENGAGEMENT FANS GROUPER HEC_AUDIENCE IG_PROMOTED_POST_AUTO LOCAL LOOKALIKE MARKETPLACE_DEFAULT MULT_CUSTOM_AUDIENCES NCPP SAVED_AUDIENCE SMART_AUDIENCE }}
+        api.has_param :audience, { enum: %w{AUTO_LOOKALIKE AUTO_PAGE_LOOKALIKE AUTO_TARGETING COUNTRY_AND_INTEREST CREATE_NEW CUSTOM_AUDIENCE DISTRICT EVENT_CUSTOM_AUDIENCES EVENT_ENGAGEMENT FANS GROUPER HEC_AUDIENCE IG_PROMOTED_POST_AUTO LOCAL LOOKALIKE MARKETPLACE_DEFAULT MARKETPLACE_NATIONWIDE_AUDIENCE MARKETPLACE_SAVED_AUDIENCE MULT_CUSTOM_AUDIENCES NCPP SAVED_AUDIENCE SMART_AUDIENCE }}
         api.has_param :audience_id, 'string'
         api.has_param :bid_amount, 'int'
         api.has_param :budget, 'int'
-        api.has_param :cta_type, { enum: %w{ADD_TO_CART APPLY_NOW BOOK_TRAVEL BUY BUY_NOW BUY_TICKETS CALL CALL_ME CONTACT CONTACT_US DONATE DONATE_NOW DOWNLOAD EVENT_RSVP FIND_A_GROUP FIND_YOUR_GROUPS FOLLOW_NEWS_STORYLINE FOLLOW_PAGE FOLLOW_USER GET_DIRECTIONS GET_OFFER GET_OFFER_VIEW GET_QUOTE GET_SHOWTIMES INSTALL_APP INSTALL_MOBILE_APP LEARN_MORE LIKE_PAGE LISTEN_MUSIC LISTEN_NOW MESSAGE_PAGE MOBILE_DOWNLOAD MOMENTS NO_BUTTON OPEN_LINK ORDER_NOW PAY_TO_ACCESS PLAY_GAME PURCHASE_GIFT_CARDS RECORD_NOW REQUEST_TIME SAY_THANKS SEE_MORE SELL_NOW SHARE SHOP_NOW SIGN_UP SOTTO_SUBSCRIBE SUBSCRIBE UPDATE_APP USE_APP USE_MOBILE_APP VIDEO_ANNOTATION VISIT_PAGES_FEED WATCH_MORE WATCH_VIDEO WHATSAPP_MESSAGE WOODHENGE_SUPPORT }}
+        api.has_param :cta_type, { enum: %w{ADD_TO_CART APPLY_NOW BOOK_TRAVEL BUY BUY_NOW BUY_TICKETS CALL CALL_ME CONTACT CONTACT_US DONATE DONATE_NOW DOWNLOAD EVENT_RSVP FIND_A_GROUP FIND_YOUR_GROUPS FOLLOW_NEWS_STORYLINE FOLLOW_PAGE FOLLOW_USER GET_DIRECTIONS GET_OFFER GET_OFFER_VIEW GET_QUOTE GET_SHOWTIMES INSTALL_APP INSTALL_MOBILE_APP LEARN_MORE LIKE_PAGE LISTEN_MUSIC LISTEN_NOW MESSAGE_PAGE MOBILE_DOWNLOAD MOMENTS NO_BUTTON OPEN_LINK ORDER_NOW PAY_TO_ACCESS PLAY_GAME PURCHASE_GIFT_CARDS RECORD_NOW REQUEST_TIME SAY_THANKS SEE_MORE SELL_NOW SEND_A_GIFT SHARE SHOP_NOW SIGN_UP SOTTO_SUBSCRIBE SUBSCRIBE UPDATE_APP USE_APP USE_MOBILE_APP VIDEO_ANNOTATION VISIT_PAGES_FEED WATCH_MORE WATCH_VIDEO WHATSAPP_MESSAGE WOODHENGE_SUPPORT }}
         api.has_param :currency, 'string'
         api.has_param :flow_id, 'string'
         api.has_param :placement, 'string'

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class ProductCatalog < AdObject
     VERTICAL = [
+      "adoptable_pets",
       "bookable",
       "commerce",
       "destinations",
@@ -50,17 +51,48 @@ module FacebookAds
     PERMITTED_TASKS = [
       "ADVERTISE",
       "MANAGE",
+      "MANAGE_AR",
     ]
 
     TASKS = [
       "ADVERTISE",
       "MANAGE",
+      "MANAGE_AR",
     ]
 
     STANDARD = [
       "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'
@@ -74,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|
@@ -87,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
 
@@ -232,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
@@ -267,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'
@@ -295,7 +333,9 @@ module FacebookAds
       end
       edge.post 'ProductSet' do |api|
         api.has_param :filter, 'object'
+        api.has_param :metadata, 'hash'
         api.has_param :name, 'string'
+        api.has_param :retailer_id, 'string'
       end
     end
 
@@ -322,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 }}
@@ -335,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

@@ -63,10 +63,40 @@ module FacebookAds
       "MEDIA_TITLE",
       "OFFER",
       "PRODUCTS",
+      "TRANSACTABLE_ITEMS",
       "VEHICLES",
       "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",
@@ -84,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

@@ -30,9 +30,13 @@ module FacebookAds
     field :auto_creation_url, 'string'
     field :filter, 'string'
     field :id, 'string'
+    field :latest_metadata, 'ProductSetMetadata'
+    field :live_metadata, 'ProductSetMetadata'
     field :name, 'string'
     field :product_catalog, 'ProductCatalog'
     field :product_count, 'int'
+    field :retailer_id, 'string'
+    field :metadata, 'hash'
 
     has_edge :automotive_models do |edge|
       edge.get 'AutomotiveModel' do |api|

data/lib/facebook_ads/ad_objects/{client_transparency_status.rb → product_set_metadata.rb}

@@ -25,12 +25,12 @@ 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 ClientTransparencyStatus < AdObject
+  class ProductSetMetadata < AdObject
 
-    field :grace_period_expiration_date, 'datetime'
-    field :has_owning_business, 'bool'
-    field :is_satisfied, 'bool'
-    field :owning_business_requirements, 'object'
+    field :cover_image_url, 'string'
+    field :description, 'string'
+    field :external_url, 'string'
+    field :integrity_review_status, 'string'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/profile.rb

@@ -64,6 +64,7 @@ module FacebookAds
 
     has_edge :picture do |edge|
       edge.get 'ProfilePictureSource' do |api|
+        api.has_param :breaking_change, { enum: -> { ProfilePictureSource::BREAKING_CHANGE }}
         api.has_param :height, 'int'
         api.has_param :redirect, 'bool'
         api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}

data/lib/facebook_ads/ad_objects/profile_picture_source.rb

@@ -32,6 +32,10 @@ module FacebookAds
       "thumbnail",
     ]
 
+    BREAKING_CHANGE = [
+      "PROFILE_PICTURE",
+    ]
+
 
     field :bottom, 'int'
     field :cache_key, 'string'

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

@@ -40,6 +40,7 @@ module FacebookAds
     field :time_created, 'datetime'
     field :time_updated, 'datetime'
     has_no_post
+    has_no_delete
 
   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/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