facebookbusiness 0.3.2.8 → 0.3.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c69bfed621525909407f9f30b022c25104279181f9016bc3c803efc4940b008
-  data.tar.gz: 403607141928ff8dc5941665df4a6dd261721185d22d124ef2f2a10c8693ed90
+  metadata.gz: 1523cfedcc1698c92199caea344b4e57a490701c9b47adc4a0e63e446a0cacc9
+  data.tar.gz: 8cf7a3e6aeefffb338b7b31680aff80626c478e0fe4e7375f93bc0f51a8cb93c
 SHA512:
-  metadata.gz: e70e918cdd1fba5f60c1423968c1707f8d03e2123bf938c37e34c200c892f94340b106a21083466d3333b8d18bfac0bf6d7efdcfe635a88bdf22d224bb8cd741
-  data.tar.gz: 28a26bd744ac080bc6bfeec6b5724ae8ebd71b6d624b579c5d2b9eda8fdac4fa033f6eb5ff759e0dca44407dc5f98e87eaca8f843e63a2c3521f6486827a9828
+  metadata.gz: e3d9c2f1d007f27d3bcbc87888d70b55c28b71f851caeeb41fbcd85a71e16c6e6fb2dd44c29ea6a751dac5b13c0893246bdcf22d7ddc77583f567384f7fd344a
+  data.tar.gz: 2d7012c5fbf2d4eefd86d90bb53b93aa63afddcfea0854f892f3cdfd3b66bc5d7837ddbd5aca0f8ab3cf1503281da236ffeb8b2212784a357d7fed0e0d3792d9

data/lib/facebook_ads/ad_objects/ad.rb

@@ -27,67 +27,67 @@ module FacebookAds
 
   class Ad < AdObject
     BID_TYPE = [
+      "ABSOLUTE_OCPM",
+      "CPA",
       "CPC",
       "CPM",
       "MULTI_PREMIUM",
-      "ABSOLUTE_OCPM",
-      "CPA",
     ]
 
     CONFIGURED_STATUS = [
       "ACTIVE",
-      "PAUSED",
-      "DELETED",
       "ARCHIVED",
+      "DELETED",
+      "PAUSED",
     ]
 
     EFFECTIVE_STATUS = [
       "ACTIVE",
-      "PAUSED",
+      "ADSET_PAUSED",
+      "ARCHIVED",
+      "CAMPAIGN_PAUSED",
       "DELETED",
-      "PENDING_REVIEW",
       "DISAPPROVED",
-      "PREAPPROVED",
+      "PAUSED",
       "PENDING_BILLING_INFO",
-      "CAMPAIGN_PAUSED",
-      "ARCHIVED",
-      "ADSET_PAUSED",
+      "PENDING_REVIEW",
+      "PREAPPROVED",
       "WITH_ISSUES",
     ]
 
     STATUS = [
       "ACTIVE",
-      "PAUSED",
-      "DELETED",
       "ARCHIVED",
+      "DELETED",
+      "PAUSED",
     ]
 
     DATE_PRESET = [
-      "today",
-      "yesterday",
-      "this_month",
-      "last_month",
-      "this_quarter",
-      "lifetime",
-      "last_3d",
-      "last_7d",
       "last_14d",
       "last_28d",
       "last_30d",
+      "last_3d",
+      "last_7d",
       "last_90d",
+      "last_month",
+      "last_quarter",
       "last_week_mon_sun",
       "last_week_sun_sat",
-      "last_quarter",
       "last_year",
+      "lifetime",
+      "this_month",
+      "this_quarter",
       "this_week_mon_today",
       "this_week_sun_today",
       "this_year",
+      "today",
+      "yesterday",
     ]
 
     EXECUTION_OPTIONS = [
-      "validate_only",
-      "synchronous_ad_review",
       "include_recommendations",
+      "synchronous_ad_review",
+      "validate_only",
     ]
 
     OPERATOR = [
@@ -97,8 +97,8 @@ module FacebookAds
 
     STATUS_OPTION = [
       "ACTIVE",
-      "PAUSED",
       "INHERITED_FROM_SOURCE",
+      "PAUSED",
     ]
 
 
@@ -148,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: -> { Ad::EXECUTION_OPTIONS }} }
+        api.has_param :execution_options, { list: { enum: %w{validate_only }} }
       end
       edge.post 'Ad' do |api|
         api.has_param :adlabels, { list: 'object' }
-        api.has_param :execution_options, { list: { enum: -> { Ad::EXECUTION_OPTIONS }} }
+        api.has_param :execution_options, { list: { enum: %w{validate_only }} }
       end
     end
 

data/lib/facebook_ads/ad_objects/ad_account.rb

@@ -84,15 +84,15 @@ module FacebookAds
     ]
 
     PERMITTED_TASKS = [
-      "MANAGE",
       "ADVERTISE",
       "ANALYZE",
+      "MANAGE",
     ]
 
     TASKS = [
-      "MANAGE",
       "ADVERTISE",
       "ANALYZE",
+      "MANAGE",
     ]
 
     CLAIM_OBJECTIVE = [
@@ -119,19 +119,19 @@ module FacebookAds
     ]
 
     SUBTYPE = [
-      "CUSTOM",
-      "WEBSITE",
       "APP",
-      "OFFLINE_CONVERSION",
+      "BAG_OF_ACCOUNTS",
       "CLAIM",
-      "PARTNER",
-      "MANAGED",
-      "VIDEO",
-      "LOOKALIKE",
+      "CUSTOM",
       "ENGAGEMENT",
-      "BAG_OF_ACCOUNTS",
-      "STUDY_RULE_AUDIENCE",
       "FOX",
+      "LOOKALIKE",
+      "MANAGED",
+      "OFFLINE_CONVERSION",
+      "PARTNER",
+      "STUDY_RULE_AUDIENCE",
+      "VIDEO",
+      "WEBSITE",
     ]
 
 
@@ -342,28 +342,28 @@ module FacebookAds
         api.has_param :name, 'string'
         api.has_param :user_columns, { list: 'string' }
         api.has_param :user_attribution_windows, { list: 'string' }
-        api.has_param :builtin_column_set, { enum: %w{ APP_ENGAGEMENT AUDIENCE_DIRECT BIDDING_AND_OPTIMIZATION CAROUSEL_ENGAGEMENT CROSS_DEVICE DELIVERY ENGAGEMENT HOUSEHOLD MESSAGING_ENGAGEMENT MESSENGER OFFLINE_CONVERSIONS PERFORMANCE PERFORMANCE_LEGACY TARGETING_AND_CREATIVE VIDEO_ENGAGEMENT VALIDATION_VIEW }}
+        api.has_param :builtin_column_set, { enum: %w{ APP_ENGAGEMENT AUDIENCE_DIRECT BIDDING_AND_OPTIMIZATION CAROUSEL_ENGAGEMENT CROSS_DEVICE DELIVERY ENGAGEMENT HOUSEHOLD MESSAGING_ENGAGEMENT MESSENGER OFFLINE_CONVERSIONS PERFORMANCE PERFORMANCE_LEGACY TARGETING_AND_CREATIVE VALIDATION_VIEW VIDEO_ENGAGEMENT }}
         api.has_param :normalized_filter, { list: 'object' }
         api.has_param :user_filter, { list: 'object' }
         api.has_param :sort, { list: 'object' }
         api.has_param :breakdowns, { list: 'string' }
         api.has_param :insights_section, 'object'
-        api.has_param :level, { enum: %w{politicalad ad adgroup campaign campaign_group account }}
-        api.has_param :date_preset, { enum: %w{today yesterday this_month last_month this_quarter lifetime last_3d last_7d last_14d last_28d last_30d last_90d last_week_mon_sun last_week_sun_sat last_quarter last_year this_week_mon_today this_week_sun_today this_year }}
+        api.has_param :level, { enum: %w{account ad adgroup campaign campaign_group politicalad }}
+        api.has_param :date_preset, { enum: %w{last_14d last_28d last_30d last_3d last_7d last_90d last_month last_quarter last_week_mon_sun last_week_sun_sat last_year lifetime this_month this_quarter this_week_mon_today this_week_sun_today this_year today yesterday }}
         api.has_param :date_interval, 'object'
         api.has_param :format_version, 'int'
-        api.has_param :creation_source, { enum: %w{adsManagerReporting newAdsManager adsExcelAddin }}
-        api.has_param :actions_group_by, { list: { enum: %w{action_canvas_component_id action_canvas_component_name action_carousel_card_id action_carousel_card_name action_destination action_device action_event_channel action_target_id action_type action_video_sound action_video_type action_converted_product_id interactive_component_sticker_id interactive_component_sticker_response }} }
+        api.has_param :creation_source, { enum: %w{adsExcelAddin adsManagerReporting newAdsManager }}
+        api.has_param :actions_group_by, { list: { enum: %w{action_canvas_component_id action_canvas_component_name action_carousel_card_id action_carousel_card_name action_converted_product_id action_destination action_device action_event_channel action_target_id action_type action_video_sound action_video_type interactive_component_sticker_id interactive_component_sticker_response }} }
         api.has_param :custom_column_set_id, 'string'
         api.has_param :data_columns, { list: 'string' }
         api.has_param :emails, { list: 'string' }
         api.has_param :export_columns, 'object'
         api.has_param :filters, { list: 'object' }
-        api.has_param :schedule_frequency, { enum: %w{daily weekly monthly }}
+        api.has_param :schedule_frequency, { enum: %w{daily monthly weekly }}
         api.has_param :sort_by, 'string'
         api.has_param :sort_dir, 'string'
         api.has_param :start_date, 'object'
-        api.has_param :status, { enum: %w{Active Paused Deleted }}
+        api.has_param :status, { enum: %w{Active Deleted Paused }}
         api.has_param :subscribers, { list: 'int' }
         api.has_param :time_increment, 'string'
       end
@@ -418,7 +418,7 @@ module FacebookAds
 
     has_edge :ads do |edge|
       edge.delete do |api|
-        api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_OLDEST DELETE_ARCHIVED_BEFORE }}
+        api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
         api.has_param :object_count, 'int'
         api.has_param :before_date, 'datetime'
         api.has_param :delete_offset, 'int'
@@ -462,7 +462,7 @@ module FacebookAds
 
     has_edge :adsets do |edge|
       edge.delete do |api|
-        api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_OLDEST DELETE_ARCHIVED_BEFORE }}
+        api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
         api.has_param :object_count, 'int'
         api.has_param :before_date, 'datetime'
         api.has_param :delete_offset, 'int'
@@ -600,7 +600,7 @@ module FacebookAds
         api.has_param :composer_source_surface, 'string'
         api.has_param :composer_type, 'string'
         api.has_param :formatting, { enum: -> { AdVideo::FORMATTING }}
-        api.has_param :fun_fact_prompt_id, 'string'
+        api.has_param :fun_fact_prompt_id, 'int'
         api.has_param :fun_fact_toastee_id, 'int'
         api.has_param :is_group_linking_post, 'bool'
         api.has_param :has_nickname, 'bool'
@@ -609,7 +609,7 @@ module FacebookAds
         api.has_param :is_boost_intended, 'bool'
         api.has_param :location_source_id, 'string'
         api.has_param :description, 'string'
-        api.has_param :offer_like_post_id, 'string'
+        api.has_param :offer_like_post_id, 'int'
         api.has_param :publish_event_id, 'int'
         api.has_param :react_mode_metadata, 'string'
         api.has_param :sales_promo_id, 'int'
@@ -661,6 +661,9 @@ module FacebookAds
     end
 
     has_edge :assigned_users do |edge|
+      edge.delete do |api|
+        api.has_param :user, 'int'
+      end
       edge.get 'AssignedUser' do |api|
         api.has_param :business, 'string'
       end
@@ -755,7 +758,7 @@ module FacebookAds
 
     has_edge :campaigns do |edge|
       edge.delete do |api|
-        api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_OLDEST DELETE_ARCHIVED_BEFORE }}
+        api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
         api.has_param :object_count, 'int'
         api.has_param :before_date, 'datetime'
         api.has_param :delete_offset, 'int'

data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb

@@ -29,22 +29,21 @@ module FacebookAds
     SUBVERTICAL = [
       "ACCOUNTING_AND_TAXES_AND_LEGAL",
       "AGRICULTURE_AND_FARMING",
-      "ECOMMERCE_AGRICULTURE_AND_FARMING",
       "AIR",
       "AIR_FREIGHT_OR_PACKAGE",
       "APPAREL_AND_ACCESSORIES",
       "ARTS",
       "AUCTIONS",
+      "AUTOMOTIVE_MANUFACTURER",
       "AUTO_AGENCY",
       "AUTO_RENTAL",
-      "AUTOMOTIVE_MANUFACTURER",
       "B2B",
       "B2B_MANUFACTURING",
       "BEAUTY_AND_PERSONAL_CARE",
       "BEER_AND_WINE_AND_LIQUOR",
       "BOOKSTORES",
-      "BUS_AND_TAXI_AND_AUTO_RETAL",
       "BUSINESS_SUPPORT_SERVICES",
+      "BUS_AND_TAXI_AND_AUTO_RETAL",
       "CABLE_AND_SATELLITE",
       "CAREER",
       "COMPUTING_AND_PERIPHERALS",
@@ -64,8 +63,9 @@ module FacebookAds
       "DESKTOP_SOFTWARE",
       "DIGITAL_ADVERTISING_AND_MARKETING_OR_UNTAGGED_AGENCIES",
       "ECATALOG",
-      "ED_TECH",
+      "ECOMMERCE_AGRICULTURE_AND_FARMING",
       "EDUCATION_RESOURCES",
+      "ED_TECH",
       "ELEARNING_AND_MASSIVE_ONLINE_OPEN_COURSES",
       "ENGINEERING_AND_DESIGN",
       "EVENTS",
@@ -98,6 +98,7 @@ module FacebookAds
       "OFFICE",
       "OIL_AND_GAS_AND_CONSUMABLE_FUEL",
       "ONLINE_OR_SOFTWARE",
+      "OTHER_WIRELINE_SERVICES",
       "PARTS_AND_SERVICE",
       "PET",
       "PET_RETAIL",
@@ -107,9 +108,9 @@ module FacebookAds
       "PR",
       "PUBLISHING_INTERNET",
       "RAILROADS",
-      "RECREATIONAL",
       "REAL_ESTATE",
       "REAL_MONEY_OR_SKILLED_GAMING",
+      "RECREATIONAL",
       "RELIGIOUS",
       "RESTAURANT",
       "RETAIL_AND_CREDIT_UNION_AND_COMMERCIAL_BANK",
@@ -132,7 +133,6 @@ module FacebookAds
       "SMB_RELIGIOUS",
       "SMB_RENTALS",
       "SMB_REPAIR_AND_MAINTENANCE",
-      "OTHER_WIRELINE_SERVICES",
       "SOFTWARE",
       "SPORTING",
       "SPORTS",
@@ -151,8 +151,8 @@ module FacebookAds
 
     VERTICAL = [
       "ADVERTISING_AND_MARKETING",
-      "AUTO_AGENCY",
       "AUTOMOTIVE",
+      "AUTO_AGENCY",
       "CONSUMER_PACKAGED_GOODS",
       "CPG_AND_BEVERAGE",
       "ECOMMERCE",
@@ -173,18 +173,18 @@ module FacebookAds
     ]
 
     STATUS = [
-      "PENDING",
-      "UNDER_REVIEW",
+      "APPEAL_APPROVED",
+      "APPEAL_DISAPPROVED",
+      "APPEAL_PENDING",
+      "APPEAL_UNDER_REVIEW",
       "APPROVED",
-      "DISAPPROVED",
-      "REQUESTED_CHANGE",
-      "CANCELLED",
       "AUTO_APPROVED",
       "AUTO_DISAPPROVED",
-      "APPEAL_PENDING",
-      "APPEAL_UNDER_REVIEW",
-      "APPEAL_APPROVED",
-      "APPEAL_DISAPPROVED",
+      "CANCELLED",
+      "DISAPPROVED",
+      "PENDING",
+      "REQUESTED_CHANGE",
+      "UNDER_REVIEW",
     ]
 
 

data/lib/facebook_ads/ad_objects/ad_account_default_objective.rb

@@ -27,45 +27,45 @@ module FacebookAds
 
   class AdAccountDefaultObjective < AdObject
     DEFAULT_OBJECTIVE_FOR_USER = [
-      "NONE",
-      "OFFER_CLAIMS",
-      "PAGE_LIKES",
+      "APP_INSTALLS",
+      "BRAND_AWARENESS",
+      "CANVAS_APP_ENGAGEMENT",
       "CANVAS_APP_INSTALLS",
       "EVENT_RESPONSES",
-      "CANVAS_APP_ENGAGEMENT",
-      "POST_ENGAGEMENT",
-      "WEBSITE_CONVERSIONS",
-      "MOBILE_APP_INSTALLS",
+      "LEAD_GENERATION",
       "LINK_CLICKS",
-      "MOBILE_APP_ENGAGEMENT",
-      "VIDEO_VIEWS",
       "LOCAL_AWARENESS",
-      "PRODUCT_CATALOG_SALES",
-      "LEAD_GENERATION",
-      "BRAND_AWARENESS",
-      "APP_INSTALLS",
       "MESSAGES",
-    ]
-
-    OBJECTIVE_FOR_LEVEL = [
+      "MOBILE_APP_ENGAGEMENT",
+      "MOBILE_APP_INSTALLS",
       "NONE",
       "OFFER_CLAIMS",
       "PAGE_LIKES",
-      "CANVAS_APP_INSTALLS",
-      "EVENT_RESPONSES",
-      "CANVAS_APP_ENGAGEMENT",
       "POST_ENGAGEMENT",
+      "PRODUCT_CATALOG_SALES",
+      "VIDEO_VIEWS",
       "WEBSITE_CONVERSIONS",
-      "MOBILE_APP_INSTALLS",
+    ]
+
+    OBJECTIVE_FOR_LEVEL = [
+      "APP_INSTALLS",
+      "BRAND_AWARENESS",
+      "CANVAS_APP_ENGAGEMENT",
+      "CANVAS_APP_INSTALLS",
+      "EVENT_RESPONSES",
+      "LEAD_GENERATION",
       "LINK_CLICKS",
-      "MOBILE_APP_ENGAGEMENT",
-      "VIDEO_VIEWS",
       "LOCAL_AWARENESS",
-      "PRODUCT_CATALOG_SALES",
-      "LEAD_GENERATION",
-      "BRAND_AWARENESS",
-      "APP_INSTALLS",
       "MESSAGES",
+      "MOBILE_APP_ENGAGEMENT",
+      "MOBILE_APP_INSTALLS",
+      "NONE",
+      "OFFER_CLAIMS",
+      "PAGE_LIKES",
+      "POST_ENGAGEMENT",
+      "PRODUCT_CATALOG_SALES",
+      "VIDEO_VIEWS",
+      "WEBSITE_CONVERSIONS",
     ]
 
 

data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb

@@ -27,31 +27,31 @@ module FacebookAds
 
   class AdAccountDeliveryEstimate < AdObject
     OPTIMIZATION_GOAL = [
-      "NONE",
+      "AD_RECALL_LIFT",
+      "APP_DOWNLOADS",
       "APP_INSTALLS",
       "BRAND_AWARENESS",
-      "AD_RECALL_LIFT",
       "CLICKS",
+      "DERIVED_EVENTS",
       "ENGAGED_USERS",
       "EVENT_RESPONSES",
       "IMPRESSIONS",
+      "LANDING_PAGE_VIEWS",
       "LEAD_GENERATION",
       "LINK_CLICKS",
+      "NONE",
       "OFFER_CLAIMS",
       "OFFSITE_CONVERSIONS",
       "PAGE_ENGAGEMENT",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
       "REACH",
+      "REPLIES",
       "SOCIAL_IMPRESSIONS",
-      "VIDEO_VIEWS",
-      "APP_DOWNLOADS",
+      "THRUPLAY",
       "TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
-      "LANDING_PAGE_VIEWS",
       "VALUE",
-      "THRUPLAY",
-      "REPLIES",
-      "DERIVED_EVENTS",
+      "VIDEO_VIEWS",
     ]