facebookbusiness 0.3.1 → 0.3.1.1

data/lib/facebook_ads/ad_objects/business_activity_log_event.rb

@@ -46,7 +46,8 @@ module FacebookAds
     field :target_business_object_id, 'string'
     field :target_business_object_name, 'string'
     field :target_business_object_type, 'string'
-    field :id, 'string'
+    has_no_id
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/business_ad_account_request.rb

@@ -29,6 +29,7 @@ module FacebookAds
 
     field :ad_account, 'AdAccount'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/business_advertisable_applications_result.rb

@@ -30,7 +30,7 @@ module FacebookAds
     field :has_insight_permission, 'bool'
     field :id, 'string'
     field :name, 'string'
-    field :photo_url, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/business_application_request.rb

@@ -27,8 +27,9 @@ module FacebookAds
 
   class BusinessApplicationRequest < AdObject
 
-    field :application, 'Application'
+    field :application, 'object'
     field :id, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/business_matched_search_applications_edge_data.rb

@@ -49,7 +49,8 @@ module FacebookAds
     field :store, 'string'
     field :unique_id, 'string'
     field :url, 'string'
-    field :id, 'string'
+    has_no_id
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/business_page_request.rb

@@ -29,6 +29,7 @@ module FacebookAds
 
     field :id, 'string'
     field :page, 'Page'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/business_project.rb

@@ -32,54 +32,13 @@ module FacebookAds
     field :creator, 'object'
     field :id, 'string'
     field :name, 'string'
-
-    has_edge :adaccounts do |edge|
-      edge.delete do |api|
-        api.has_param :adaccount_id, 'string'
-      end
-      edge.get 'AdAccount'
-      edge.post 'BusinessProject' do |api|
-        api.has_param :adaccount_id, 'string'
-      end
-    end
-
-    has_edge :apps do |edge|
-      edge.delete do |api|
-        api.has_param :app_id, 'string'
-      end
-      edge.get 'Application'
-      edge.post 'BusinessProject' do |api|
-        api.has_param :app_id, 'string'
-      end
-    end
+    has_no_post
+    has_no_delete
 
     has_edge :assets do |edge|
       edge.delete do |api|
         api.has_param :asset_id, 'string'
       end
-      edge.post 'BusinessProject' do |api|
-        api.has_param :asset_id, 'string'
-      end
-    end
-
-    has_edge :pages do |edge|
-      edge.delete do |api|
-        api.has_param :page_id, 'int'
-      end
-      edge.get 'Page'
-      edge.post 'BusinessProject' do |api|
-        api.has_param :page_id, 'int'
-      end
-    end
-
-    has_edge :product_catalogs do |edge|
-      edge.delete do |api|
-        api.has_param :product_catalog_id, 'string'
-      end
-      edge.get 'ProductCatalog'
-      edge.post 'BusinessProject' do |api|
-        api.has_param :product_catalog_id, 'string'
-      end
     end
 
   end

data/lib/facebook_ads/ad_objects/business_user.rb

@@ -50,25 +50,5 @@ module FacebookAds
     field :title, 'string'
     field :two_fac_status, 'string'
 
-    has_edge :assigned_ad_accounts do |edge|
-      edge.get 'AdAccount'
-    end
-
-    has_edge :assigned_monetization_properties do |edge|
-      edge.get 'AdMonetizationProperty'
-    end
-
-    has_edge :assigned_pages do |edge|
-      edge.get 'Page'
-    end
-
-    has_edge :assigned_product_catalogs do |edge|
-      edge.get 'ProductCatalog'
-    end
-
-    has_edge :businesssettinglogs do |edge|
-      edge.get 'BusinessSettingLogsData'
-    end
-
   end
 end

data/lib/facebook_ads/ad_objects/campaign.rb

@@ -81,6 +81,12 @@ module FacebookAds
       "this_year",
     ]
 
+    DELETE_STRATEGY = [
+      "DELETE_ANY",
+      "DELETE_OLDEST",
+      "DELETE_ARCHIVED_BEFORE",
+    ]
+
     EXECUTION_OPTIONS = [
       "validate_only",
       "include_recommendations",
@@ -108,12 +114,6 @@ module FacebookAds
       "ANY",
     ]
 
-    STATUS_OPTION = [
-      "ACTIVE",
-      "PAUSED",
-      "INHERITED_FROM_SOURCE",
-    ]
-
 
     field :account_id, 'string'
     field :adlabels, { list: 'AdLabel' }
@@ -130,16 +130,9 @@ module FacebookAds
     field :daily_budget, 'string'
     field :effective_status, { enum: -> { EFFECTIVE_STATUS }}
     field :id, 'string'
-    field :is_autobid, 'bool'
-    field :is_average_price_pacing, 'bool'
-    field :kpi_custom_conversion_id, 'string'
-    field :kpi_type, 'string'
-    field :last_budget_toggling_time, 'datetime'
     field :lifetime_budget, 'string'
     field :name, 'string'
     field :objective, 'string'
-    field :pacing_type, { list: 'string' }
-    field :promoted_object, 'AdPromotedObject'
     field :recommendations, { list: 'AdRecommendation' }
     field :source_campaign, 'Campaign'
     field :source_campaign_id, 'string'
@@ -147,82 +140,75 @@ module FacebookAds
     field :start_time, 'datetime'
     field :status, { enum: -> { STATUS }}
     field :stop_time, 'datetime'
-    field :topline_id, 'string'
     field :updated_time, 'datetime'
     field :adbatch, { list: 'object' }
     field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
-    field :upstream_events, 'hash'
     field :iterative_split_test_configs, { list: 'object' }
-
-    has_edge :ad_studies do |edge|
-      edge.get 'AdStudy'
-    end
+    field :promoted_object, 'object'
 
     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: -> { AdLabel::EXECUTION_OPTIONS }} }
       end
-      edge.post 'Campaign' do |api|
+      edge.post 'AdLabel' 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: -> { AdLabel::EXECUTION_OPTIONS }} }
+      end
+    end
+
+    has_edge :adrules_governed do |edge|
+      edge.get 'AdRule' do |api|
+        api.has_param :pass_evaluation, 'bool'
       end
     end
 
     has_edge :ads do |edge|
       edge.get 'Ad' do |api|
-        api.has_param :effective_status, { list: 'string' }
+        api.has_param :ad_draft_id, 'string'
         api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
-        api.has_param :include_deleted, 'bool'
+        api.has_param :effective_status, { list: 'string' }
         api.has_param :time_range, 'object'
         api.has_param :updated_since, 'int'
-        api.has_param :ad_draft_id, 'string'
       end
     end
 
     has_edge :adsets do |edge|
       edge.get 'AdSet' do |api|
-        api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
+        api.has_param :ad_draft_id, 'string'
         api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
+        api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
         api.has_param :is_completed, 'bool'
         api.has_param :time_range, 'object'
-        api.has_param :ad_draft_id, 'string'
       end
     end
 
     has_edge :copies do |edge|
       edge.get 'Campaign' do |api|
-        api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
         api.has_param :date_preset, { enum: -> { Campaign::DATE_PRESET }}
+        api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
         api.has_param :is_completed, 'bool'
         api.has_param :time_range, 'object'
       end
-      edge.post 'Campaign' do |api|
-        api.has_param :deep_copy, 'bool'
-        api.has_param :rename_options, 'object'
-        api.has_param :status_option, { enum: -> { Campaign::STATUS_OPTION }}
-        api.has_param :start_time, 'datetime'
-        api.has_param :end_time, 'datetime'
-      end
     end
 
     has_edge :insights do |edge|
       edge.get 'AdsInsights' do |api|
-        api.has_param :default_summary, 'bool'
-        api.has_param :fields, { list: 'string' }
-        api.has_param :filtering, { list: 'object' }
-        api.has_param :summary, { list: 'string' }
-        api.has_param :sort, { list: 'string' }
         api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
         api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
         api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
         api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
         api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
+        api.has_param :default_summary, 'bool'
         api.has_param :export_columns, { list: 'string' }
         api.has_param :export_format, 'string'
         api.has_param :export_name, 'string'
+        api.has_param :fields, { list: { enum: -> { AdsInsights::SUMMARY }} }
+        api.has_param :filtering, { list: 'object' }
         api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
         api.has_param :product_id_limit, 'int'
+        api.has_param :sort, { list: 'string' }
+        api.has_param :summary, { list: { enum: -> { AdsInsights::SUMMARY }} }
         api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
         api.has_param :time_increment, 'string'
         api.has_param :time_range, 'object'
@@ -230,21 +216,21 @@ module FacebookAds
         api.has_param :use_account_attribution_setting, 'bool'
       end
       edge.post 'AdReportRun' do |api|
-        api.has_param :default_summary, 'bool'
-        api.has_param :fields, { list: 'string' }
-        api.has_param :filtering, { list: 'object' }
-        api.has_param :summary, { list: 'string' }
-        api.has_param :sort, { list: 'string' }
         api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
         api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
         api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
         api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
         api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
+        api.has_param :default_summary, 'bool'
         api.has_param :export_columns, { list: 'string' }
         api.has_param :export_format, 'string'
         api.has_param :export_name, 'string'
+        api.has_param :fields, { list: { enum: -> { AdsInsights::SUMMARY }} }
+        api.has_param :filtering, { list: 'object' }
         api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
         api.has_param :product_id_limit, 'int'
+        api.has_param :sort, { list: 'string' }
+        api.has_param :summary, { list: { enum: -> { AdsInsights::SUMMARY }} }
         api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
         api.has_param :time_increment, 'string'
         api.has_param :time_range, 'object'

data/lib/facebook_ads/ad_objects/canvas.rb

@@ -43,7 +43,7 @@ module FacebookAds
     end
 
     has_edge :preview_notifications do |edge|
-      edge.post 'Canvas' do |api|
+      edge.post do |api|
         api.has_param :user_ids, { list: 'int' }
       end
     end

data/lib/facebook_ads/ad_objects/canvas_body_element.rb

@@ -28,7 +28,8 @@ module FacebookAds
   class CanvasBodyElement < AdObject
 
     field :element, 'object'
-    field :id, 'string'
+    has_no_id
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/check_batch_request_status.rb

@@ -31,7 +31,8 @@ module FacebookAds
     field :errors_total_count, 'int'
     field :handle, 'string'
     field :status, 'string'
-    field :id, 'string'
+    has_no_id
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/conversion_action_query.rb

@@ -53,7 +53,8 @@ module FacebookAds
     field :_question_creator, { list: 'string' }
     field :response, { list: 'string' }
     field :subtype, { list: 'string' }
-    field :id, 'string'
+    has_no_id
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/copyright_attribution_insights.rb

@@ -32,7 +32,8 @@ module FacebookAds
     field :l7_attribution_video_view, 'int'
     field :l7_attribution_video_view_delta, 'double'
     field :metrics_ending_date, 'string'
-    field :id, 'string'
+    has_no_id
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/cover_photo.rb

@@ -32,6 +32,7 @@ module FacebookAds
     field :offset_x, 'double'
     field :offset_y, 'double'
     field :source, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/custom_audience.rb

@@ -28,12 +28,11 @@ module FacebookAds
   class CustomAudience < AdObject
     include CustomAudienceHelpers
     CLAIM_OBJECTIVE = [
-      "AUTOMOTIVE_MODEL",
+      "AUTO_OFFER",
       "HOME_LISTING",
       "PRODUCT",
       "TRAVEL",
       "VEHICLE",
-      "VEHICLE_OFFER",
     ]
 
     CONTENT_TYPE = [
@@ -71,72 +70,83 @@ module FacebookAds
       "FOX",
     ]
 
+    FIELDS = [
+      "account_id",
+      "customer_file_source",
+      "data_source",
+      "delivery_status",
+      "description",
+      "external_event_source",
+      "id",
+      "approximate_count",
+      "is_value_based",
+      "lookalike_audience_ids",
+      "lookalike_spec",
+      "name",
+      "operation_status",
+      "opt_out_link",
+      "permission_for_actions",
+      "pixel_id",
+      "retention_days",
+      "rule",
+      "rule_aggregation",
+      "sharing_status",
+      "subtype",
+      "time_content_updated",
+      "time_created",
+      "time_updated",
+    ]
+
 
     field :account_id, 'string'
     field :approximate_count, 'int'
     field :customer_file_source, 'string'
     field :data_source, 'CustomAudienceDataSource'
-    field :data_source_types, 'string'
     field :delivery_status, 'CustomAudienceStatus'
     field :description, 'string'
-    field :excluded_custom_audiences, { list: 'CustomAudience' }
-    field :expiry_time, 'int'
     field :external_event_source, 'AdsPixel'
-    field :household_audience, 'int'
     field :id, 'string'
-    field :included_custom_audiences, { list: 'CustomAudience' }
-    field :is_household, 'bool'
-    field :is_snapshot, 'bool'
     field :is_value_based, 'bool'
-    field :list_of_accounts, { list: 'string' }
     field :lookalike_audience_ids, { list: 'string' }
     field :lookalike_spec, 'LookalikeSpec'
     field :name, 'string'
     field :operation_status, 'CustomAudienceStatus'
     field :opt_out_link, 'string'
-    field :permission_for_actions, 'AudiencePermissionForActions'
+    field :permission_for_actions, 'object'
     field :pixel_id, 'string'
     field :retention_days, 'int'
-    field :rev_share_policy_id, 'int'
     field :rule, 'string'
     field :rule_aggregation, 'string'
-    field :rule_v2, 'string'
-    field :seed_audience, 'int'
     field :sharing_status, 'CustomAudienceSharingStatus'
-    field :study_spec, 'AudienceInsightsStudySpec'
     field :subtype, 'string'
     field :time_content_updated, 'int'
     field :time_created, 'int'
     field :time_updated, 'int'
-    field :creation_params, 'hash'
-    field :parent_audience_id, 'int'
-    field :tags, { list: 'string' }
-    field :associated_audience_id, 'int'
-    field :is_household_exclusion, 'bool'
     field :allowed_domains, { list: 'string' }
-    field :partner_reference_key, 'string'
-    field :prefill, 'bool'
-    field :inclusions, { list: 'object' }
-    field :exclusions, { list: 'object' }
-    field :countries, 'string'
-    field :origin_audience_id, 'string'
-    field :details, 'string'
-    field :source, 'string'
-    field :isprivate, 'bool'
-    field :additionalmetadata, 'string'
-    field :minage, 'int'
-    field :maxage, 'int'
-    field :expectedsize, 'int'
-    field :gender, 'string'
-    field :partnerid, 'string'
-    field :accountid, 'string'
     field :claim_objective, { enum: -> { CLAIM_OBJECTIVE }}
     field :content_type, { enum: -> { CONTENT_TYPE }}
+    field :dataset_id, 'string'
     field :event_source_group, 'string'
-    field :product_set_id, 'string'
     field :event_sources, { list: 'hash' }
-    field :video_group_ids, { list: 'string' }
-    field :dataset_id, 'string'
+    field :list_of_accounts, { list: 'int' }
+    field :origin_audience_id, 'string'
+    field :prefill, 'bool'
+    field :product_set_id, 'string'
+    field :associated_audience_id, 'int'
+    field :creation_params, 'hash'
+    field :exclusions, { list: 'object' }
+    field :inclusions, { list: 'object' }
+    field :parent_audience_id, 'int'
+    field :tags, { list: 'string' }
+
+    has_edge :ad_accounts do |edge|
+      edge.post 'AdAccount' do |api|
+        api.has_param :adaccounts, { list: 'string' }
+        api.has_param :permissions, 'string'
+        api.has_param :relationship_type, { list: 'string' }
+        api.has_param :replace, 'bool'
+      end
+    end
 
     has_edge :adaccounts do |edge|
       edge.delete do |api|
@@ -145,12 +155,6 @@ module FacebookAds
       edge.get 'AdAccount' do |api|
         api.has_param :permissions, 'string'
       end
-      edge.post 'CustomAudience' do |api|
-        api.has_param :adaccounts, { list: 'string' }
-        api.has_param :permissions, 'string'
-        api.has_param :replace, 'bool'
-        api.has_param :relationship_type, { list: 'string' }
-      end
     end
 
     has_edge :ads do |edge|
@@ -160,28 +164,6 @@ module FacebookAds
       end
     end
 
-    has_edge :capabilities do |edge|
-      edge.delete do |api|
-        api.has_param :adaccounts, { list: 'string' }
-      end
-      edge.post do |api|
-        api.has_param :accounts_capabilities, 'string'
-        api.has_param :relationship_type, { list: 'string' }
-      end
-    end
-
-    has_edge :data do |edge|
-      edge.post do |api|
-        api.has_param :action_type, { enum: %w{add remove match optout }}
-        api.has_param :encoding, { enum: %w{md5 sha256 plain }}
-        api.has_param :entry_type, { enum: %w{0 1 2 3 4 5 6 }}
-        api.has_param :entries, { list: 'string' }
-        api.has_param :session_id, 'int'
-        api.has_param :batch_seq, 'int'
-        api.has_param :last_batch_flag, 'bool'
-      end
-    end
-
     has_edge :prefills do |edge|
       edge.get 'CustomAudiencePrefillState'
     end
@@ -192,33 +174,16 @@ module FacebookAds
       end
     end
 
-    has_edge :shared_account_info do |edge|
-      edge.get 'CustomAudiencesharedAccountInfo'
-    end
-
-    has_edge :upload do |edge|
+    has_edge :users do |edge|
       edge.delete do |api|
-        api.has_param :session, 'object'
-        api.has_param :payload, 'object'
         api.has_param :namespace, 'string'
-      end
-      edge.post 'CustomAudience' do |api|
-        api.has_param :session, 'object'
         api.has_param :payload, 'object'
-        api.has_param :namespace, 'string'
-      end
-    end
-
-    has_edge :users do |edge|
-      edge.delete do |api|
         api.has_param :session, 'object'
-        api.has_param :payload, 'object'
-        api.has_param :namespace, 'string'
       end
-      edge.post 'CustomAudience' do |api|
-        api.has_param :session, 'object'
-        api.has_param :payload, 'object'
+      edge.post 'User' do |api|
         api.has_param :namespace, 'string'
+        api.has_param :payload, 'object'
+        api.has_param :session, 'object'
       end
     end