facebookbusiness 0.3.1.5 → 0.3.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: add2f8aed69610e8ddc864a5ba440642dcf7cfcb8c8b9eb4c92710a564d14d63
-  data.tar.gz: 6f4f79123e8a2241e2b76874fa8813e8c4256a81b0ddfcdcf3c0e7e0986744fa
+  metadata.gz: 93c0accb24029cf6a49a011fb74bebb1af810ea260c42b821340d0edd6051d7a
+  data.tar.gz: 2a4152b9d688a9f29f0cfe1b7ce4fa5eafbe7b94686d7e06b320c19e5ae24e7f
 SHA512:
-  metadata.gz: db84c0c38c93e7771e33a5d572dd5c17e49c9e8dd098510c6e6ba0df1135d3c76574beae6d6f9092aa2969af5d411b65a23c76edf55b2736f85a930a58d47440
-  data.tar.gz: 205b0b5fbf5dff918d061d4945eb636e068c89fa8af7f6fc2b71bcc320d380415318916ce0f6b629b493fad8a37fb0aeec5aeecac8407410cafcfc7d491c9914
+  metadata.gz: 6d218df3eb051c8ac7df5ef1f5bb1cef36923df853d9e617caa2a4c847834a2b17251d6a4acb4c5c17528f740e2750dd71ad500ee716e83ddb3087e120abd647
+  data.tar.gz: 3494390ba28a81a799ad85d7eef83fded1f3ac078df7d35c03887ea48def5a16e913bf4753e64f75a9d1e98cb04ee7106ea25b1f5b69aed1ed152791232fe8da

data/lib/facebook_ads/ad_objects/ad.rb

@@ -122,6 +122,7 @@ module FacebookAds
     field :failed_delivery_checks, { list: 'DeliveryCheck' }
     field :id, 'string'
     field :impression_control_map, { list: 'string' }
+    field :issues_info, { list: 'AdgroupIssuesInfo' }
     field :last_updated_by_app_id, 'string'
     field :locations, { list: 'int' }
     field :name, 'string'
@@ -144,7 +145,6 @@ module FacebookAds
     field :adset_spec, 'AdSet'
     field :draft_adgroup_id, 'string'
     field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
-    field :redownload, 'bool'
 
     has_edge :adcreatives do |edge|
       edge.get 'AdCreative'

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -484,7 +484,6 @@ module FacebookAds
         api.has_param :execution_options, { list: { enum: -> { Ad::EXECUTION_OPTIONS }} }
         api.has_param :adlabels, { list: 'object' }
         api.has_param :bid_amount, 'int'
-        api.has_param :redownload, 'bool'
         api.has_param :source_ad_id, 'string'
         api.accepts_files!
       end
@@ -512,7 +511,7 @@ module FacebookAds
         api.has_param :ad_draft_id, 'string'
       end
       edge.post 'AdSet' do |api|
-        api.has_param :ad_keywords, 'hash'
+        api.has_param :ad_keywords, 'object'
         api.has_param :adlabels, { list: 'object' }
         api.has_param :bid_amount, 'int'
         api.has_param :bid_adjustments, 'object'
@@ -549,7 +548,6 @@ module FacebookAds
         api.has_param :pacing_type, { list: 'string' }
         api.has_param :promoted_object, 'object'
         api.has_param :rb_prediction_id, 'string'
-        api.has_param :redownload, 'bool'
         api.has_param :rf_prediction_id, 'string'
         api.has_param :source_adset_id, 'string'
         api.has_param :start_time, 'datetime'
@@ -1143,10 +1141,6 @@ module FacebookAds
       end
     end
 
-    has_edge :ratecard do |edge|
-      edge.get 'RateCard'
-    end
-
     has_edge :reachestimate do |edge|
       edge.get 'ReachEstimate' do |api|
         api.has_param :targeting_spec, 'Targeting'

data/lib/facebook_ads/ad_objects/ad_account_user_permissions.rb

@@ -28,7 +28,7 @@ module FacebookAds
   class AdAccountUserPermissions < AdObject
 
     field :business, 'Business'
-    field :business_persona, 'BusinessPersona'
+    field :business_persona, 'object'
     field :created_by, 'User'
     field :created_time, 'datetime'
     field :email, 'string'

data/lib/facebook_ads/ad_objects/ad_asset_feed.rb

@@ -93,6 +93,7 @@ module FacebookAds
       "BRAND",
       "ASSET_CUSTOMIZATION",
       "DCO_PARITY",
+      "PREVIEW_DYNAMIC_RENDERING",
     ]
 
     CALL_TO_ACTION_TYPE = [

data/lib/facebook_ads/ad_objects/ad_set.rb

@@ -214,7 +214,6 @@ module FacebookAds
     field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
     field :line_number, 'int'
     field :rb_prediction_id, 'string'
-    field :redownload, 'bool'
     field :time_start, 'datetime'
     field :time_stop, 'datetime'
     field :topline_id, 'string'
@@ -243,11 +242,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: -> { AdSet::EXECUTION_OPTIONS }} }
+        api.has_param :execution_options, { list: { enum: %w{validate_only }} }
       end
       edge.post 'AdSet' do |api|
         api.has_param :adlabels, { list: 'object' }
-        api.has_param :execution_options, { list: { enum: -> { AdSet::EXECUTION_OPTIONS }} }
+        api.has_param :execution_options, { list: { enum: %w{validate_only }} }
       end
     end
 

data/lib/facebook_ads/ad_objects/{ad_account_all_payment_methods.rb → adgroup_issues_info.rb}

@@ -25,8 +25,11 @@ 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 AdAccountAllPaymentMethods < AdObject
+  class AdgroupIssuesInfo < AdObject
 
+    field :error_code, 'int'
+    field :error_message, 'string'
+    field :error_summary, 'string'
     field :id, 'string'
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -131,11 +131,9 @@ module FacebookAds
     field :actions, { list: 'AdsActionStats' }
     field :activity_recency, 'string'
     field :ad_click_actions, { list: 'AdsActionStats' }
-    field :ad_click_value, { list: 'AdsActionStats' }
     field :ad_format_asset, 'string'
     field :ad_id, 'string'
     field :ad_impression_actions, { list: 'AdsActionStats' }
-    field :ad_impression_value, { list: 'AdsActionStats' }
     field :ad_name, 'string'
     field :adset_id, 'string'
     field :adset_name, 'string'
@@ -155,11 +153,11 @@ module FacebookAds
     field :cost_per_2_sec_continuous_video_view, { list: 'AdsActionStats' }
     field :cost_per_action_type, { list: 'AdsActionStats' }
     field :cost_per_ad_click, { list: 'AdsActionStats' }
-    field :cost_per_ad_impression, { list: 'AdsActionStats' }
     field :cost_per_dda_countby_convs, 'string'
     field :cost_per_estimated_ad_recallers, 'string'
     field :cost_per_inline_link_click, 'string'
     field :cost_per_inline_post_engagement, 'string'
+    field :cost_per_one_thousand_ad_impression, { list: 'AdsActionStats' }
     field :cost_per_outbound_click, { list: 'AdsActionStats' }
     field :cost_per_unique_action_type, { list: 'AdsActionStats' }
     field :cost_per_unique_click, 'string'

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -31,6 +31,18 @@ module FacebookAds
       "NAME",
     ]
 
+    DATA_USE_SETTING = [
+      "EMPTY",
+      "ADVERTISING_AND_ANALYTICS",
+      "ANALYTICS_ONLY",
+    ]
+
+    FIRST_PARTY_COOKIE_STATUS = [
+      "EMPTY",
+      "FIRST_PARTY_COOKIE_ENABLED",
+      "FIRST_PARTY_COOKIE_DISABLED",
+    ]
+
     TASKS = [
       "EDIT",
       "ANALYZE",
@@ -53,6 +65,8 @@ module FacebookAds
     field :code, 'string'
     field :creation_time, 'datetime'
     field :creator, 'User'
+    field :data_use_setting, 'string'
+    field :first_party_cookie_status, 'string'
     field :id, 'string'
     field :is_created_by_business, 'bool'
     field :last_fired_time, 'datetime'

data/lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb

@@ -33,13 +33,20 @@ module FacebookAds
       "device_type",
       "event",
       "host",
+      "people_reached",
+      "pii_keys",
+      "pii_lift",
       "pixel_fire",
+      "event_detection_method",
       "url",
+      "event_value_count",
+      "url_by_rule",
       "event_total_counts",
+      "event_source",
     ]
 
 
-    field :aggregation, { enum: -> { AGGREGATION }}
+    field :aggregation, 'string'
     field :data, { list: 'AdsPixelStats' }
     field :start_time, 'datetime'
     field :id, 'string'

data/lib/facebook_ads/ad_objects/application.rb

@@ -49,6 +49,73 @@ module FacebookAds
       "UNKNOWN",
     ]
 
+    AGGREGATION_PERIOD = [
+      "HOUR",
+      "DAY",
+      "TOTAL",
+    ]
+
+    BREAKDOWNS = [
+      "AGE",
+      "APP",
+      "COUNTRY",
+      "DELIVERY_METHOD",
+      "DISPLAY_FORMAT",
+      "DEAL",
+      "DEAL_AD",
+      "DEAL_PAGE",
+      "GENDER",
+      "PLACEMENT",
+      "PLATFORM",
+      "PROPERTY",
+      "CLICKED_VIEW_TAG",
+    ]
+
+    METRICS = [
+      "FB_AD_NETWORK_BIDDING_REQUEST",
+      "FB_AD_NETWORK_BIDDING_RESPONSE",
+      "FB_AD_NETWORK_BIDDING_BID_RATE",
+      "FB_AD_NETWORK_BIDDING_WIN_RATE",
+      "FB_AD_NETWORK_REQUEST",
+      "FB_AD_NETWORK_FILLED_REQUEST",
+      "FB_AD_NETWORK_FILL_RATE",
+      "FB_AD_NETWORK_IMP",
+      "FB_AD_NETWORK_SHOW_RATE",
+      "FB_AD_NETWORK_CLICK",
+      "FB_AD_NETWORK_CTR",
+      "FB_AD_NETWORK_BIDDING_REVENUE",
+      "FB_AD_NETWORK_REVENUE",
+      "FB_AD_NETWORK_CPM",
+      "FB_AD_NETWORK_VIDEO_GUARANTEE_REVENUE",
+      "FB_AD_NETWORK_VIDEO_VIEW",
+      "FB_AD_NETWORK_VIDEO_VIEW_RATE",
+      "FB_AD_NETWORK_VIDEO_MRC",
+      "FB_AD_NETWORK_VIDEO_MRC_RATE",
+      "FB_AD_NETWORK_WIN_RATE",
+      "FB_AD_NETWORK_DIRECT_TOTAL_REVENUE",
+      "FB_AD_NETWORK_DIRECT_PUBLISHER_BILL",
+      "FB_AD_NETWORK_FAST_CLICK_RATE",
+      "FB_AD_NETWORK_FAST_RETURN_RATE",
+      "FB_AD_NETWORK_CLICK_VALUE_SCORE",
+      "FB_AD_NETWORK_FAST_CLICK_NUMERATOR",
+      "FB_AD_NETWORK_FAST_CLICK_DENOMINATOR",
+      "FB_AD_NETWORK_FAST_RETURN_NUMERATOR",
+      "FB_AD_NETWORK_FAST_RETURN_DENOMINATOR",
+      "FB_AD_NETWORK_CLICK_VALUE_SCORE_NUMERATOR",
+      "FB_AD_NETWORK_CLICK_VALUE_SCORE_DENOMINATOR",
+    ]
+
+    ORDERING_COLUMN = [
+      "TIME",
+      "VALUE",
+      "METRIC",
+    ]
+
+    ORDERING_TYPE = [
+      "ASCENDING",
+      "DESCENDING",
+    ]
+
     PLATFORM = [
       "ANDROID",
       "IOS",
@@ -130,6 +197,7 @@ module FacebookAds
     field :gdpv4_enabled, 'bool'
     field :gdpv4_nux_content, 'string'
     field :gdpv4_nux_enabled, 'bool'
+    field :groups_app_settings, 'object'
     field :has_messenger_product, 'bool'
     field :hosting_url, 'string'
     field :icon_url, 'string'
@@ -252,24 +320,24 @@ module FacebookAds
 
     has_edge :adnetworkanalytics do |edge|
       edge.get 'AdNetworkAnalyticsSyncQueryResult' do |api|
-        api.has_param :aggregation_period, { enum: -> { AdNetworkAnalyticsSyncQueryResult::AGGREGATION_PERIOD }}
-        api.has_param :breakdowns, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::BREAKDOWNS }} }
+        api.has_param :aggregation_period, { enum: -> { Application::AGGREGATION_PERIOD }}
+        api.has_param :breakdowns, { list: { enum: -> { Application::BREAKDOWNS }} }
         api.has_param :filters, { list: 'hash' }
         api.has_param :limit, 'int'
-        api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
-        api.has_param :ordering_column, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_COLUMN }}
-        api.has_param :ordering_type, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_TYPE }}
+        api.has_param :metrics, { list: { enum: -> { Application::METRICS }} }
+        api.has_param :ordering_column, { enum: -> { Application::ORDERING_COLUMN }}
+        api.has_param :ordering_type, { enum: -> { Application::ORDERING_TYPE }}
         api.has_param :since, 'object'
         api.has_param :until, 'object'
       end
       edge.post 'Application' do |api|
-        api.has_param :aggregation_period, { enum: -> { AdNetworkAnalyticsSyncQueryResult::AGGREGATION_PERIOD }}
-        api.has_param :breakdowns, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::BREAKDOWNS }} }
-        api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
+        api.has_param :aggregation_period, { enum: -> { Application::AGGREGATION_PERIOD }}
+        api.has_param :breakdowns, { list: { enum: -> { Application::BREAKDOWNS }} }
+        api.has_param :metrics, { list: { enum: -> { Application::METRICS }} }
         api.has_param :filters, { list: 'object' }
         api.has_param :limit, 'int'
-        api.has_param :ordering_column, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_COLUMN }}
-        api.has_param :ordering_type, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_TYPE }}
+        api.has_param :ordering_column, { enum: -> { Application::ORDERING_COLUMN }}
+        api.has_param :ordering_type, { enum: -> { Application::ORDERING_TYPE }}
         api.has_param :since, 'object'
         api.has_param :until, 'object'
       end
@@ -499,6 +567,12 @@ module FacebookAds
       end
     end
 
+    has_edge :groups_app_settings do |edge|
+      edge.post do |api|
+        api.has_param :post_install_url, 'object'
+      end
+    end
+
     has_edge :insights_event_labels do |edge|
       edge.get do |api|
         api.has_param :add, { list: 'string' }

data/lib/facebook_ads/ad_objects/audience_insights_rule.rb

@@ -36,7 +36,7 @@ module FacebookAds
     field :language, 'string'
     field :name, 'string'
     field :rule_components, { list: 'object' }
-    field :studies, { list: 'AudienceStudy' }
+    field :studies, { list: 'object' }
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/business.rb

@@ -57,73 +57,6 @@ module FacebookAds
       "OTHER",
     ]
 
-    AGGREGATION_PERIOD = [
-      "HOUR",
-      "DAY",
-      "TOTAL",
-    ]
-
-    BREAKDOWNS = [
-      "AGE",
-      "APP",
-      "COUNTRY",
-      "DELIVERY_METHOD",
-      "DISPLAY_FORMAT",
-      "DEAL",
-      "DEAL_AD",
-      "DEAL_PAGE",
-      "GENDER",
-      "PLACEMENT",
-      "PLATFORM",
-      "PROPERTY",
-      "CLICKED_VIEW_TAG",
-    ]
-
-    METRICS = [
-      "FB_AD_NETWORK_BIDDING_REQUEST",
-      "FB_AD_NETWORK_BIDDING_RESPONSE",
-      "FB_AD_NETWORK_BIDDING_BID_RATE",
-      "FB_AD_NETWORK_BIDDING_WIN_RATE",
-      "FB_AD_NETWORK_REQUEST",
-      "FB_AD_NETWORK_FILLED_REQUEST",
-      "FB_AD_NETWORK_FILL_RATE",
-      "FB_AD_NETWORK_IMP",
-      "FB_AD_NETWORK_SHOW_RATE",
-      "FB_AD_NETWORK_CLICK",
-      "FB_AD_NETWORK_CTR",
-      "FB_AD_NETWORK_BIDDING_REVENUE",
-      "FB_AD_NETWORK_REVENUE",
-      "FB_AD_NETWORK_CPM",
-      "FB_AD_NETWORK_VIDEO_GUARANTEE_REVENUE",
-      "FB_AD_NETWORK_VIDEO_VIEW",
-      "FB_AD_NETWORK_VIDEO_VIEW_RATE",
-      "FB_AD_NETWORK_VIDEO_MRC",
-      "FB_AD_NETWORK_VIDEO_MRC_RATE",
-      "FB_AD_NETWORK_WIN_RATE",
-      "FB_AD_NETWORK_DIRECT_TOTAL_REVENUE",
-      "FB_AD_NETWORK_DIRECT_PUBLISHER_BILL",
-      "FB_AD_NETWORK_FAST_CLICK_RATE",
-      "FB_AD_NETWORK_FAST_RETURN_RATE",
-      "FB_AD_NETWORK_CLICK_VALUE_SCORE",
-      "FB_AD_NETWORK_FAST_CLICK_NUMERATOR",
-      "FB_AD_NETWORK_FAST_CLICK_DENOMINATOR",
-      "FB_AD_NETWORK_FAST_RETURN_NUMERATOR",
-      "FB_AD_NETWORK_FAST_RETURN_DENOMINATOR",
-      "FB_AD_NETWORK_CLICK_VALUE_SCORE_NUMERATOR",
-      "FB_AD_NETWORK_CLICK_VALUE_SCORE_DENOMINATOR",
-    ]
-
-    ORDERING_COLUMN = [
-      "TIME",
-      "VALUE",
-      "METRIC",
-    ]
-
-    ORDERING_TYPE = [
-      "ASCENDING",
-      "DESCENDING",
-    ]
-
     ACCESS_TYPE = [
       "OWNER",
       "AGENCY",
@@ -272,24 +205,24 @@ module FacebookAds
 
     has_edge :adnetworkanalytics do |edge|
       edge.get 'AdNetworkAnalyticsSyncQueryResult' do |api|
-        api.has_param :aggregation_period, { enum: -> { Business::AGGREGATION_PERIOD }}
-        api.has_param :breakdowns, { list: { enum: -> { Business::BREAKDOWNS }} }
+        api.has_param :aggregation_period, { enum: -> { AdNetworkAnalyticsSyncQueryResult::AGGREGATION_PERIOD }}
+        api.has_param :breakdowns, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::BREAKDOWNS }} }
         api.has_param :filters, { list: 'hash' }
         api.has_param :limit, 'int'
-        api.has_param :metrics, { list: { enum: -> { Business::METRICS }} }
-        api.has_param :ordering_column, { enum: -> { Business::ORDERING_COLUMN }}
-        api.has_param :ordering_type, { enum: -> { Business::ORDERING_TYPE }}
+        api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
+        api.has_param :ordering_column, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_COLUMN }}
+        api.has_param :ordering_type, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_TYPE }}
         api.has_param :since, 'object'
         api.has_param :until, 'object'
       end
       edge.post 'Business' do |api|
-        api.has_param :aggregation_period, { enum: -> { Business::AGGREGATION_PERIOD }}
-        api.has_param :breakdowns, { list: { enum: -> { Business::BREAKDOWNS }} }
-        api.has_param :metrics, { list: { enum: -> { Business::METRICS }} }
+        api.has_param :aggregation_period, { enum: -> { AdNetworkAnalyticsSyncQueryResult::AGGREGATION_PERIOD }}
+        api.has_param :breakdowns, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::BREAKDOWNS }} }
+        api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
         api.has_param :filters, { list: 'object' }
         api.has_param :limit, 'int'
-        api.has_param :ordering_column, { enum: -> { Business::ORDERING_COLUMN }}
-        api.has_param :ordering_type, { enum: -> { Business::ORDERING_TYPE }}
+        api.has_param :ordering_column, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_COLUMN }}
+        api.has_param :ordering_type, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_TYPE }}
         api.has_param :since, 'object'
         api.has_param :until, 'object'
       end
@@ -720,7 +653,7 @@ module FacebookAds
     end
 
     has_edge :spaco_dataset_collections do |edge|
-      edge.post 'SpacoDsDataCollection' do |api|
+      edge.post do |api|
         api.has_param :spaco_data_collections, { list: 'object' }
       end
     end