facebookbusiness 0.3.2.4 → 0.3.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92d8e6150a41c991f5284f79653ac1876701468cb7b086e26177de237fe66072
-  data.tar.gz: cbbade9f87de5e8c6cf4eeb63636059a724330285bab6d1d9db27edc2616a8e1
+  metadata.gz: cf63dff5203faf0fcf1674e0bbb48adc93344766bed806659c3e8bd29dbe55d7
+  data.tar.gz: e5d2572335703d5958e5bf1c3104cb151687f0da46fbd10617c877eeb75c9b88
 SHA512:
-  metadata.gz: 2b995fa21002d8885821e79f846fecc4f65459e572710086b8e097298efa2b3d096d8ef8c8d3e59ade7b219b5313221038a1f34500418fb9035a03c0e272c283
-  data.tar.gz: cd1430916889b4104b88dd0639c56692aa3bfe3d2fcc159bebbb8536c567d2058c18535c537011583276d19518462ccac06713ad808fb758b8df7fca0db196e5
+  metadata.gz: b9a1c7effe67b71622face91fb617b4f6f34695e9679825a936b728f73fda3649c6e2d671dc2362c9a2b8fe98ccbca2304fe322d767205ff117e8081c9f4a2c3
+  data.tar.gz: f9067cf46af560fc7e6455ad973941a2d27dea1ac710c8dd06c055e216b0d87c516baa5af946ade39dfee86a3fd5e19f162e8065148b9878629c58defcae9b44

data/README.md

@@ -254,3 +254,6 @@ end
 
 ## Reporting Bugs/Feedback
 Please raise any issue on GitHub.
+
+## License
+Facebook Business SDK for Ruby is licensed under the LICENSE file in the root directory of this source tree.

data/lib/facebook_ads/ad_objects/ad.rb

@@ -52,6 +52,7 @@ module FacebookAds
       "CAMPAIGN_PAUSED",
       "ARCHIVED",
       "ADSET_PAUSED",
+      "WITH_ISSUES",
     ]
 
     STATUS = [
@@ -147,11 +148,11 @@ module FacebookAds
     has_edge :adlabels do |edge|
       edge.delete do |api|
         api.has_param :adlabels, { list: 'object' }
-        api.has_param :execution_options, { list: { enum: %w{validate_only }} }
+        api.has_param :execution_options, { list: { enum: -> { Ad::EXECUTION_OPTIONS }} }
       end
       edge.post 'Ad' do |api|
         api.has_param :adlabels, { list: 'object' }
-        api.has_param :execution_options, { list: { enum: %w{validate_only }} }
+        api.has_param :execution_options, { list: { enum: -> { Ad::EXECUTION_OPTIONS }} }
       end
     end
 

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -213,6 +213,16 @@ module FacebookAds
       end
     end
 
+    has_edge :ad_place_page_sets do |edge|
+      edge.get 'AdPlacePageSet'
+      edge.post 'AdPlacePageSet' do |api|
+        api.has_param :name, 'string'
+        api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
+        api.has_param :parent_page, 'string'
+        api.has_param :targeted_area_type, { enum: -> { AdPlacePageSet::TARGETED_AREA_TYPE }}
+      end
+    end
+
     has_edge :ad_studies do |edge|
       edge.get 'AdStudy'
     end
@@ -268,7 +278,7 @@ module FacebookAds
         api.has_param :image_url, 'string'
         api.has_param :instagram_actor_id, 'string'
         api.has_param :instagram_permalink_url, 'string'
-        api.has_param :instagram_story_id, 'int'
+        api.has_param :portrait_customizations, 'hash'
         api.has_param :link_og_id, 'string'
         api.has_param :link_url, 'string'
         api.has_param :name, 'string'
@@ -423,6 +433,7 @@ module FacebookAds
         api.has_param :object_id, 'string'
         api.has_param :action, { enum: -> { AdAccountAdRulesHistory::ACTION }}
         api.has_param :hide_no_changes, 'bool'
+        api.has_param :evaluation_type, { enum: -> { AdAccountAdRulesHistory::EVALUATION_TYPE }}
       end
     end
 
@@ -796,6 +807,7 @@ module FacebookAds
         api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
         api.has_param :date_preset, { enum: -> { Campaign::DATE_PRESET }}
         api.has_param :is_completed, 'bool'
+        api.has_param :time_range, 'object'
       end
       edge.post 'Campaign' do |api|
         api.has_param :name, 'string'
@@ -942,7 +954,7 @@ module FacebookAds
     end
 
     has_edge :emailimport do |edge|
-      edge.post 'EmailImport' do |api|
+      edge.post do |api|
         api.has_param :name, 'string'
         api.has_param :third_party_data, 'string'
       end

data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb

@@ -40,6 +40,11 @@ module FacebookAds
       "UNPAUSED",
     ]
 
+    EVALUATION_TYPE = [
+      "SCHEDULE",
+      "TRIGGER",
+    ]
+
 
     field :evaluation_spec, 'AdRuleEvaluationSpec'
     field :exception_code, 'int'

data/lib/facebook_ads/ad_objects/ad_place_page_set.rb

@@ -26,6 +26,17 @@ module FacebookAds
   # pull request for this class.
 
   class AdPlacePageSet < AdObject
+    LOCATION_TYPES = [
+      "recent",
+      "home",
+    ]
+
+    TARGETED_AREA_TYPE = [
+      "CUSTOM_RADIUS",
+      "MARKETING_AREA",
+      "NONE",
+    ]
+
 
     field :account_id, 'string'
     field :id, 'string'
@@ -33,6 +44,7 @@ module FacebookAds
     field :name, 'string'
     field :pages_count, 'int'
     field :parent_page, 'Page'
+    field :targeted_area_type, { enum: -> { TARGETED_AREA_TYPE }}
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/ad_preview.rb

@@ -27,29 +27,29 @@ module FacebookAds
 
   class AdPreview < AdObject
     AD_FORMAT = [
-      "RIGHT_COLUMN_STANDARD",
-      "DESKTOP_FEED_STANDARD",
-      "MOBILE_FEED_STANDARD",
-      "MOBILE_FEED_BASIC",
-      "MOBILE_INTERSTITIAL",
-      "MOBILE_BANNER",
-      "MOBILE_MEDIUM_RECTANGLE",
-      "MOBILE_FULLWIDTH",
-      "MOBILE_NATIVE",
-      "INSTAGRAM_STANDARD",
-      "INSTAGRAM_STORY",
       "AUDIENCE_NETWORK_INSTREAM_VIDEO",
-      "AUDIENCE_NETWORK_OUTSTREAM_VIDEO",
       "AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE",
+      "AUDIENCE_NETWORK_OUTSTREAM_VIDEO",
       "AUDIENCE_NETWORK_REWARDED_VIDEO",
+      "DESKTOP_FEED_STANDARD",
+      "FACEBOOK_STORY_MOBILE",
+      "INSTAGRAM_STANDARD",
+      "INSTAGRAM_STORY",
       "INSTANT_ARTICLE_STANDARD",
       "INSTREAM_VIDEO_DESKTOP",
       "INSTREAM_VIDEO_MOBILE",
+      "MARKETPLACE_MOBILE",
       "MESSENGER_MOBILE_INBOX_MEDIA",
+      "MOBILE_BANNER",
+      "MOBILE_FEED_BASIC",
+      "MOBILE_FEED_STANDARD",
+      "MOBILE_FULLWIDTH",
+      "MOBILE_INTERSTITIAL",
+      "MOBILE_MEDIUM_RECTANGLE",
+      "MOBILE_NATIVE",
+      "RIGHT_COLUMN_STANDARD",
       "SUGGESTED_VIDEO_DESKTOP",
       "SUGGESTED_VIDEO_MOBILE",
-      "MARKETPLACE_MOBILE",
-      "FACEBOOK_STORY_MOBILE",
       "WATCH_FEED_MOBILE",
     ]
 

data/lib/facebook_ads/ad_objects/ad_set.rb

@@ -63,6 +63,7 @@ module FacebookAds
       "CAMPAIGN_PAUSED",
       "ARCHIVED",
       "ADSET_PAUSED",
+      "WITH_ISSUES",
     ]
 
     OPTIMIZATION_GOAL = [

data/lib/facebook_ads/ad_objects/ad_study_objective.rb

@@ -47,6 +47,10 @@ module FacebookAds
     field :results, { list: 'string' }
     field :type, 'string'
 
+    has_edge :ad_place_page_sets do |edge|
+      edge.get 'AdPlacePageSet'
+    end
+
     has_edge :adspixels do |edge|
       edge.get 'AdsPixel'
     end

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -114,6 +114,7 @@ module FacebookAds
       "CIVIC_PROPOSAL_COVER_VIDEO",
       "HEURISTIC_CLUSTER_VIDEO",
       "DCO_AUTOGEN_VIDEO",
+      "SOTTO_CONTENT",
     ]
 
     CONTENT_CATEGORY = [

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -119,18 +119,6 @@ module FacebookAds
       end
     end
 
-    has_edge :extractors do |edge|
-      edge.get 'SignalsIwlExtractor' do |api|
-        api.has_param :current_domain, 'object'
-      end
-      edge.post 'SignalsIwlExtractor' do |api|
-        api.has_param :domain_uri, 'object'
-        api.has_param :event_type, { enum: -> { SignalsIWLExtractor::EVENT_TYPE }}
-        api.has_param :extractor_config, 'hash'
-        api.has_param :extractor_type, { enum: -> { SignalsIWLExtractor::EXTRACTOR_TYPE }}
-      end
-    end
-
     has_edge :pending_shared_agencies do |edge|
       edge.get 'Business'
     end

data/lib/facebook_ads/ad_objects/application.rb

@@ -136,6 +136,11 @@ module FacebookAds
       "DELETE",
     ]
 
+    POST_METHOD = [
+      "EYMT",
+      "CODELESS",
+    ]
+
     SCORE_TYPE = [
       "CUSTOM",
       "NUMERIC",
@@ -178,7 +183,6 @@ module FacebookAds
     field :auto_event_mapping_android, { list: 'object' }
     field :auto_event_mapping_ios, { list: 'object' }
     field :auto_event_setup_enabled, 'bool'
-    field :business, 'Business'
     field :canvas_fluid_height, 'bool'
     field :canvas_fluid_width, 'int'
     field :canvas_url, 'string'
@@ -351,29 +355,6 @@ module FacebookAds
       end
     end
 
-    has_edge :ads_app_insights do |edge|
-      edge.get do |api|
-        api.has_param :metric, { enum: %w{ads_api_call ads_api_error ads_api_error_rate }}
-        api.has_param :since, 'datetime'
-        api.has_param :until, 'datetime'
-        api.has_param :details, { enum: %w{daily hourly }}
-        api.has_param :filters, 'object'
-        api.has_param :breakdowns, { list: { enum: %w{none ad_account_id method version error }} }
-        api.has_param :limit, 'int'
-        api.has_param :timeseries, 'bool'
-      end
-    end
-
-    has_edge :ads_app_insights_dimensions do |edge|
-      edge.get do |api|
-        api.has_param :dimension, { enum: %w{ad_account_id method version }}
-        api.has_param :since, 'datetime'
-        api.has_param :until, 'datetime'
-        api.has_param :details, { enum: %w{daily hourly }}
-        api.has_param :limit, 'int'
-      end
-    end
-
     has_edge :agencies do |edge|
       edge.get 'Business'
     end
@@ -517,6 +498,7 @@ module FacebookAds
       edge.post 'Application' do |api|
         api.has_param :mutation_method, { enum: -> { Application::MUTATION_METHOD }}
         api.has_param :platform, { enum: -> { Application::PLATFORM }}
+        api.has_param :post_method, { enum: -> { Application::POST_METHOD }}
         api.has_param :mappings, { list: 'hash' }
       end
     end
@@ -782,10 +764,6 @@ module FacebookAds
       end
     end
 
-    has_edge :pixel_helper_debugging_info do |edge|
-      edge.get 'ExternalEventSourcePixelHelperDebuggingInfo'
-    end
-
     has_edge :products do |edge|
       edge.get do |api|
         api.has_param :product_ids, { list: 'string' }
@@ -798,13 +776,6 @@ module FacebookAds
       end
     end
 
-    has_edge :recent_debuggings do |edge|
-      edge.get 'ExternalEventSourceDebugging' do |api|
-        api.has_param :event_name, 'string'
-        api.has_param :diagnostic, 'string'
-      end
-    end
-
     has_edge :roles do |edge|
       edge.delete do |api|
         api.has_param :user, 'int'

data/lib/facebook_ads/ad_objects/business.rb

@@ -428,6 +428,17 @@ module FacebookAds
       end
     end
 
+    has_edge :creative_compass_study do |edge|
+      edge.get 'CreativeDemocracyRun'
+      edge.post 'CreativeDemocracyRun' do |api|
+        api.has_param :campaign_id, { list: 'string' }
+        api.has_param :creative_id, { list: 'string' }
+        api.has_param :description, 'string'
+        api.has_param :name, 'string'
+        api.has_param :placement, { enum: -> { CreativeDemocracyRun::PLACEMENT }}
+      end
+    end
+
     has_edge :customconversions do |edge|
       edge.get 'CustomConversion'
       edge.post 'CustomConversion' do |api|
@@ -750,6 +761,17 @@ module FacebookAds
       end
     end
 
+    has_edge :upload_event do |edge|
+      edge.get 'MeasurementUploadEvent'
+      edge.post 'MeasurementUploadEvent' do |api|
+        api.has_param :group, { enum: -> { MeasurementUploadEvent::GROUP }}
+        api.has_param :upload_end_time, 'object'
+        api.has_param :upload_start_time, 'object'
+        api.has_param :upload_tag, 'string'
+        api.has_param :version, { enum: -> { MeasurementUploadEvent::VERSION }}
+      end
+    end
+
     has_edge :user_invitations do |edge|
       edge.delete do |api|
         api.has_param :email, 'string'

data/lib/facebook_ads/ad_objects/campaign.rb

@@ -50,6 +50,7 @@ module FacebookAds
       "CAMPAIGN_PAUSED",
       "ARCHIVED",
       "ADSET_PAUSED",
+      "WITH_ISSUES",
     ]
 
     STATUS = [
@@ -162,11 +163,11 @@ module FacebookAds
     has_edge :adlabels do |edge|
       edge.delete do |api|
         api.has_param :adlabels, { list: 'object' }
-        api.has_param :execution_options, { list: { enum: %w{validate_only }} }
+        api.has_param :execution_options, { list: { enum: -> { Campaign::EXECUTION_OPTIONS }} }
       end
       edge.post 'Campaign' do |api|
         api.has_param :adlabels, { list: 'object' }
-        api.has_param :execution_options, { list: { enum: %w{validate_only }} }
+        api.has_param :execution_options, { list: { enum: -> { Campaign::EXECUTION_OPTIONS }} }
       end
     end
 

data/lib/facebook_ads/ad_objects/check_batch_request_status.rb

@@ -30,6 +30,7 @@ module FacebookAds
     field :errors, { list: 'object' }
     field :errors_total_count, 'int'
     field :handle, 'string'
+    field :invalid_item_ids, { list: 'string' }
     field :status, 'string'
     field :id, 'string'
     has_no_get

data/lib/facebook_ads/ad_objects/{ads_segments.rb → creative_democracy_run.rb}

@@ -25,20 +25,55 @@ 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 AdsSegments < AdObject
+  class CreativeDemocracyRun < AdObject
+    PLACEMENT = [
+      "AUDIENCE_NETWORK_INSTREAM_VIDEO",
+      "AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE",
+      "AUDIENCE_NETWORK_OUTSTREAM_VIDEO",
+      "AUDIENCE_NETWORK_REWARDED_VIDEO",
+      "DESKTOP_FEED_STANDARD",
+      "FACEBOOK_STORY_MOBILE",
+      "INSTAGRAM_STANDARD",
+      "INSTAGRAM_STORY",
+      "INSTANT_ARTICLE_STANDARD",
+      "INSTREAM_VIDEO_DESKTOP",
+      "INSTREAM_VIDEO_MOBILE",
+      "MARKETPLACE_MOBILE",
+      "MESSENGER_MOBILE_INBOX_MEDIA",
+      "MOBILE_BANNER",
+      "MOBILE_FEED_BASIC",
+      "MOBILE_FEED_STANDARD",
+      "MOBILE_FULLWIDTH",
+      "MOBILE_INTERSTITIAL",
+      "MOBILE_MEDIUM_RECTANGLE",
+      "MOBILE_NATIVE",
+      "RIGHT_COLUMN_STANDARD",
+      "SUGGESTED_VIDEO_DESKTOP",
+      "SUGGESTED_VIDEO_MOBILE",
+      "WATCH_FEED_MOBILE",
+    ]
+
 
-    field :daily_audience_size, 'int'
-    field :daily_impressions, 'int'
     field :description, 'string'
+    field :end_date, 'string'
     field :id, 'string'
     field :name, 'string'
-    field :path, { list: 'string' }
-    field :popularity, 'double'
-    field :projected_cpm, 'int'
-    field :projected_daily_revenue, 'int'
-    has_no_get
-    has_no_post
+    field :placement, 'string'
+    field :report_data, { list: { list: 'object' } }
+    field :report_files, { list: 'object' }
+    field :start_date, 'string'
+    field :status, 'string'
+    field :campaign_id, { list: 'string' }
+    field :creative_id, { list: 'string' }
     has_no_delete
 
+    has_edge :campaign_id do |edge|
+      edge.get 'Campaign'
+    end
+
+    has_edge :creative_id do |edge|
+      edge.get 'AdCreative'
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/group.rb

@@ -126,7 +126,6 @@ module FacebookAds
     field :subdomain, 'string'
     field :updated_time, 'datetime'
     field :venue, 'Location'
-    has_no_post
     has_no_delete
 
     has_edge :admins do |edge|