facebookbusiness 0.8.0.0 → 0.9.0.1

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

@@ -31,6 +31,7 @@ module FacebookAds
     field :name, 'string'
     field :owner, 'Profile'
     field :app_id, 'string'
+    field :session_id, 'string'
     field :source, 'file'
     field :source_url, 'string'
     field :source_zip, 'file'

data/lib/facebook_ads/ad_objects/post.rb

@@ -46,6 +46,51 @@ module FacebookAds
       "normal",
     ]
 
+    CHECKIN_ENTRY_POINT = [
+      "BRANDING_CHECKIN",
+      "BRANDING_OTHER",
+      "BRANDING_PHOTO",
+      "BRANDING_STATUS",
+    ]
+
+    FORMATTING = [
+      "MARKDOWN",
+      "PLAINTEXT",
+    ]
+
+    PLACE_ATTACHMENT_SETTING = [
+      "1",
+      "2",
+    ]
+
+    POST_SURFACES_BLACKLIST = [
+      "1",
+      "2",
+      "3",
+      "4",
+      "5",
+    ]
+
+    POSTING_TO_REDSPACE = [
+      "disabled",
+      "enabled",
+    ]
+
+    TARGET_SURFACE = [
+      "STORY",
+      "TIMELINE",
+    ]
+
+    UNPUBLISHED_CONTENT_TYPE = [
+      "ADS_POST",
+      "DRAFT",
+      "INLINE_CREATED",
+      "PUBLISHED",
+      "REVIEWABLE_BRANDED_CONTENT",
+      "SCHEDULED",
+      "SCHEDULED_RECURRING",
+    ]
+
 
     field :actions, { list: 'string' }
     field :admin_creator, 'object'
@@ -74,6 +119,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 +141,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 +221,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 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 :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 REFER_FRIENDS REQUEST_TIME SAY_THANKS SEE_MORE SELL_NOW SEND_A_GIFT SHARE SHOP_NOW SIGN_UP SOTTO_SUBSCRIBE START_ORDER SUBSCRIBE SWIPE_UP_PRODUCT SWIPE_UP_SHOP 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

@@ -35,6 +35,7 @@ module FacebookAds
       "home_listings",
       "hotels",
       "jobs",
+      "local_delivery_shipping_profiles",
       "local_service_businesses",
       "offer_items",
       "offline_commerce",
@@ -64,6 +65,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 +107,11 @@ 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,17 +268,12 @@ 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
     end
 
-    has_edge :onsite_commerce_merchant do |edge|
-      edge.post 'ProductCatalog' do |api|
-        api.has_param :onsite_commerce_merchant, 'object'
-      end
-    end
-
     has_edge :pricing_variables_batch do |edge|
       edge.get 'ProductCatalogPricingVariablesBatch' do |api|
         api.has_param :handle, 'string'
@@ -270,6 +298,8 @@ 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 :migrated_from_feed_id, 'string'
         api.has_param :name, 'string'
         api.has_param :override_type, { enum: -> { ProductFeed::OVERRIDE_TYPE }}
         api.has_param :override_value, 'string'
@@ -300,6 +330,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
 
@@ -318,6 +349,7 @@ module FacebookAds
       edge.post 'ProductItem' do |api|
         api.has_param :additional_image_files, { list: 'file' }
         api.has_param :additional_image_urls, { list: 'string' }
+        api.has_param :additional_uploaded_image_ids, { list: 'string' }
         api.has_param :additional_variant_attributes, 'hash'
         api.has_param :android_app_name, 'string'
         api.has_param :android_class, 'string'
@@ -326,6 +358,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 +372,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,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'

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,11 +310,13 @@ 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'
@@ -341,6 +344,7 @@ module FacebookAds
     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'

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