facebookbusiness 0.3.1.0 → 0.14.0.0

data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb

@@ -26,31 +26,61 @@ module FacebookAds
   # pull request for this class.
 
   class ReachFrequencyPrediction < AdObject
+    ACTION = [
+      "cancel",
+      "quote",
+      "reserve",
+    ]
+
+    BUYING_TYPE = [
+      "AUCTION",
+      "DEPRECATED_REACH_BLOCK",
+      "FIXED_CPM",
+      "MIXED",
+      "REACHBLOCK",
+      "RESEARCH_POLL",
+      "RESERVED",
+    ]
+
     INSTREAM_PACKAGES = [
+      "BEAUTY",
+      "ENTERTAINMENT",
+      "FOOD",
       "NORMAL",
       "PREMIUM",
+      "REGULAR_ANIMALS_PETS",
+      "REGULAR_FOOD",
+      "REGULAR_GAMES",
+      "REGULAR_POLITICS",
+      "REGULAR_SPORTS",
+      "REGULAR_STYLE",
+      "REGULAR_TV_MOVIES",
+      "SPANISH",
       "SPORTS",
-      "ENTERTAINMENT",
-      "BEAUTY",
-    ]
-
-    STATUS = [
-      "EXPIRED",
-      "DRAFT",
-      "PENDING",
-      "ACTIVE",
-      "COMPLETED",
     ]
 
 
     field :account_id, 'int'
+    field :activity_status, 'ReachFrequencyActivity'
+    field :ad_formats, { list: 'ReachFrequencyAdFormat' }
+    field :auction_entry_option_index, 'int'
+    field :audience_size_lower_bound, 'int'
+    field :audience_size_upper_bound, 'int'
+    field :business_id, 'int'
+    field :buying_type, 'string'
     field :campaign_group_id, 'int'
     field :campaign_id, 'string'
     field :campaign_time_start, 'datetime'
     field :campaign_time_stop, 'datetime'
-    field :curve_budget_reach, 'object'
+    field :currency, 'string'
+    field :curve_budget_reach, 'ReachFrequencyEstimatesCurve'
+    field :curve_reach, { list: 'int' }
+    field :daily_grp_curve, { list: 'double' }
     field :daily_impression_curve, { list: 'double' }
+    field :daily_impression_curve_map, 'map<unsigned int, list<float>>'
+    field :day_parting_schedule, { list: 'ReachFrequencyDayPart' }
     field :destination_id, 'string'
+    field :end_time, 'datetime'
     field :expiration_time, 'datetime'
     field :external_budget, 'int'
     field :external_impression, 'int'
@@ -61,38 +91,76 @@ module FacebookAds
     field :external_minimum_impression, 'int'
     field :external_minimum_reach, 'int'
     field :external_reach, 'int'
+    field :feed_ratio_0000, 'int'
     field :frequency_cap, 'int'
-    field :frequency_distribution, { list: 'double' }
-    field :frequency_distribution_map, { list: 'object' }
-    field :frequency_distribution_map_agg, { list: 'object' }
+    field :frequency_distribution_map, 'map<unsigned int, list<float>>'
+    field :frequency_distribution_map_agg, 'map<unsigned int, list<unsigned int>>'
+    field :grp_audience_size, 'double'
+    field :grp_avg_probability_map, 'string'
+    field :grp_country_audience_size, 'double'
+    field :grp_curve, { list: 'double' }
     field :grp_dmas_audience_size, 'double'
+    field :grp_filtering_threshold_00, 'int'
+    field :grp_points, 'double'
+    field :grp_ratio, 'double'
+    field :grp_reach_ratio, 'double'
+    field :grp_status, 'string'
     field :holdout_percentage, 'int'
     field :id, 'string'
+    field :impression_curve, { list: 'int' }
     field :instagram_destination_id, 'string'
+    field :instream_packages, { list: 'string' }
     field :interval_frequency_cap, 'int'
     field :interval_frequency_cap_reset_period, 'int'
+    field :is_bonus_media, 'int'
+    field :is_conversion_goal, 'int'
+    field :is_higher_average_frequency, 'bool'
+    field :is_io, 'bool'
+    field :is_reserved_buying, 'int'
+    field :is_trp, 'bool'
     field :name, 'string'
+    field :objective, 'int'
+    field :objective_name, 'string'
+    field :odax_objective, 'int'
+    field :odax_objective_name, 'string'
+    field :optimization_goal, 'int'
+    field :optimization_goal_name, 'string'
     field :pause_periods, { list: 'object' }
-    field :placement_breakdown, 'object'
+    field :placement_breakdown, 'ReachFrequencyEstimatesPlacementBreakdown'
+    field :placement_breakdown_map, 'map<unsigned int, ReachFrequencyEstimatesPlacementBreakdown>'
+    field :plan_name, 'string'
+    field :plan_type, 'string'
     field :prediction_mode, 'int'
     field :prediction_progress, 'int'
+    field :reference_id, 'string'
     field :reservation_status, 'int'
+    field :start_time, 'datetime'
     field :status, 'int'
     field :story_event_type, 'int'
-    field :target_audience_size, 'int'
+    field :target_cpm, 'int'
     field :target_spec, 'Targeting'
     field :time_created, 'datetime'
     field :time_updated, 'datetime'
+    field :timezone_id, 'int'
+    field :timezone_name, 'string'
+    field :topline_id, 'int'
+    field :video_view_length_constraint, 'int'
+    field :viewtag, 'string'
+    field :action, { enum: -> { ACTION }}
     field :budget, 'int'
-    field :day_parting_schedule, { list: 'object' }
+    field :deal_id, 'string'
     field :destination_ids, { list: 'string' }
-    field :end_time, 'int'
-    field :instream_packages, { list: { enum: -> { INSTREAM_PACKAGES }} }
+    field :exceptions, 'bool'
+    field :existing_campaign_id, 'string'
+    field :grp_buying, 'bool'
+    field :impression, 'int'
+    field :is_full_view, 'bool'
+    field :is_reach_and_frequency_io_buying, 'bool'
     field :num_curve_points, 'int'
-    field :objective, 'string'
     field :reach, 'int'
+    field :rf_prediction_id, 'string'
+    field :rf_prediction_id_to_release, 'string'
     field :rf_prediction_id_to_share, 'string'
-    field :start_time, 'int'
     field :stop_time, 'int'
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/reach_frequency_spec.rb

@@ -29,6 +29,7 @@ module FacebookAds
 
     field :countries, { list: 'string' }
     field :default_creation_data, 'object'
+    field :global_io_max_campaign_duration, 'int'
     field :max_campaign_duration, 'object'
     field :max_days_to_finish, 'object'
     field :max_pause_without_prediction_rerun, 'object'

data/lib/facebook_ads/ad_objects/{open_graph_rating.rb → recommendation.rb}

@@ -25,13 +25,14 @@ 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 OpenGraphRating < AdObject
+  class Recommendation < AdObject
 
     field :created_time, 'datetime'
     field :has_rating, 'bool'
     field :has_review, 'bool'
     field :open_graph_story, 'object'
     field :rating, 'int'
+    field :recommendation_type, 'string'
     field :review_text, 'string'
     field :reviewer, 'User'
     has_no_id

data/lib/facebook_ads/ad_objects/rich_media_element.rb

@@ -0,0 +1,39 @@
+# 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.
+
+# 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 RichMediaElement < AdObject
+
+    field :element, 'object'
+    field :element_type, 'string'
+    field :name, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/rtb_dynamic_post.rb

@@ -27,7 +27,7 @@ module FacebookAds
 
   class RtbDynamicPost < AdObject
 
-    field :child_attachments, { list: 'object' }
+    field :child_attachments, { list: 'DynamicPostChildAttachment' }
     field :created, 'datetime'
     field :description, 'string'
     field :id, 'string'
@@ -39,6 +39,20 @@ module FacebookAds
     field :product_id, 'string'
     field :title, 'string'
     has_no_post
+    has_no_delete
+
+    has_edge :comments do |edge|
+      edge.get 'Comment' do |api|
+        api.has_param :filter, { enum: -> { Comment::FILTER }}
+        api.has_param :live_filter, { enum: -> { Comment::LIVE_FILTER }}
+        api.has_param :order, { enum: -> { Comment::ORDER }}
+        api.has_param :since, 'datetime'
+      end
+    end
+
+    has_edge :likes do |edge|
+      edge.get 'Profile'
+    end
 
   end
 end

data/lib/facebook_ads/ad_objects/saved_audience.rb

@@ -0,0 +1,50 @@
+# 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.
+
+# 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 SavedAudience < AdObject
+
+    field :account, 'AdAccount'
+    field :approximate_count_lower_bound, 'int'
+    field :approximate_count_upper_bound, 'int'
+    field :delete_time, 'int'
+    field :description, 'string'
+    field :extra_info, 'string'
+    field :id, 'string'
+    field :name, 'string'
+    field :operation_status, 'CustomAudienceStatus'
+    field :page_deletion_marked_delete_time, 'int'
+    field :permission_for_actions, 'AudiencePermissionForActions'
+    field :run_status, 'string'
+    field :sentence_lines, { list: 'string' }
+    field :targeting, 'Targeting'
+    field :time_created, 'datetime'
+    field :time_updated, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/saved_message_response.rb

@@ -26,17 +26,6 @@ module FacebookAds
   # pull request for this class.
 
   class SavedMessageResponse < AdObject
-    CATEGORY = [
-      "STANDARD",
-      "INSTANT_REPLY",
-      "AWAY_MESSAGE",
-      "WELCOME_MESSAGE",
-      "FOLLOW_UP",
-      "MESSENGER_CODE",
-      "REFERRAL",
-      "APPOINTMENT_REMINDER",
-    ]
-
 
     field :category, 'string'
     field :id, 'string'
@@ -44,6 +33,8 @@ module FacebookAds
     field :is_enabled, 'bool'
     field :message, 'string'
     field :title, 'string'
+    has_no_post
+    has_no_delete
 
   end
 end

data/lib/facebook_ads/ad_objects/security_settings.rb

@@ -0,0 +1,36 @@
+# 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.
+
+# 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 SecuritySettings < AdObject
+
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

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