facebookbusiness 0.3.2.9 → 0.3.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1523cfedcc1698c92199caea344b4e57a490701c9b47adc4a0e63e446a0cacc9
-  data.tar.gz: 8cf7a3e6aeefffb338b7b31680aff80626c478e0fe4e7375f93bc0f51a8cb93c
+  metadata.gz: 8bb2c10dfe18230855620aaf85993be2e8ed2d8cbfe897fc38bb025b924a2294
+  data.tar.gz: 142dc97b71de60e546b48c66c532e852b58518388995d8f4bc64d1fb522c566e
 SHA512:
-  metadata.gz: e3d9c2f1d007f27d3bcbc87888d70b55c28b71f851caeeb41fbcd85a71e16c6e6fb2dd44c29ea6a751dac5b13c0893246bdcf22d7ddc77583f567384f7fd344a
-  data.tar.gz: 2d7012c5fbf2d4eefd86d90bb53b93aa63afddcfea0854f892f3cdfd3b66bc5d7837ddbd5aca0f8ab3cf1503281da236ffeb8b2212784a357d7fed0e0d3792d9
+  metadata.gz: e83233cb326813c013bdc6ce4261f211a44cde1e5999987ca0497a4168c03840e6d2817dd0712a5f0b4442decb7370f1f7aea604707aa45817e6ca52993a0068
+  data.tar.gz: 9aa9146d95db541740324fdb572f2c45d629f0471b5f58cf63938b98956cfba5c716bffa2c9a4de0c42af84faf062b41cd12a8fafbd47e3ca1df051cf3f272bf

data/lib/facebook_ads/ad_objects/ad.rb

@@ -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: %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

@@ -127,6 +127,7 @@ module FacebookAds
       "FOX",
       "LOOKALIKE",
       "MANAGED",
+      "MEASUREMENT",
       "OFFLINE_CONVERSION",
       "PARTNER",
       "STUDY_RULE_AUDIENCE",
@@ -162,6 +163,7 @@ module FacebookAds
     field :end_advertiser_name, 'string'
     field :extended_credit_invoice_group, 'ExtendedCreditInvoiceGroup'
     field :failed_delivery_checks, { list: 'DeliveryCheck' }
+    field :fb_entity, 'int'
     field :funding_source, 'string'
     field :funding_source_details, 'FundingSourceDetails'
     field :has_migrated_permissions, 'bool'
@@ -1175,6 +1177,7 @@ module FacebookAds
         api.has_param :is_bonus_media, 'bool'
         api.has_param :is_conversion_goal, 'bool'
         api.has_param :is_full_view, 'bool'
+        api.has_param :is_higher_average_frequency, 'bool'
         api.has_param :is_reach_and_frequency_io_buying, 'bool'
         api.has_param :is_reserved_buying, 'bool'
         api.has_param :expiration_time, 'int'

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -27,118 +27,32 @@ module FacebookAds
 
   class AdAccountTargetingUnified < AdObject
     LIMIT_TYPE = [
-      "adgroup_id",
-      "age_max",
-      "age_min",
-      "alternate_auto_targeting_option",
-      "app_install_state",
-      "audience_network_positions",
       "behaviors",
-      "brand_safety_content_filter_levels",
-      "brand_safety_content_severity_levels",
-      "catalog_based_targeting",
-      "cities",
       "college_years",
-      "conjunctive_user_adclusters",
-      "connections",
-      "contextual_targeting_categories",
-      "countries",
-      "country",
-      "country_groups",
-      "custom_audiences",
-      "device_platforms",
-      "direct_install_devices",
-      "dynamic_audience_ids",
       "education_majors",
       "education_schools",
       "education_statuses",
-      "effective_audience_network_positions",
-      "effective_device_platforms",
-      "effective_facebook_positions",
-      "effective_instagram_positions",
-      "effective_messenger_positions",
-      "effective_publisher_platforms",
-      "effective_whatsapp_positions",
-      "engagement_specs",
       "ethnic_affinity",
-      "exclude_previous_days",
-      "exclude_reached_since",
-      "excluded_connections",
-      "excluded_custom_audiences",
-      "excluded_dynamic_audience_ids",
-      "excluded_engagement_specs",
-      "excluded_geo_locations",
-      "excluded_mobile_device_model",
-      "excluded_product_audience_specs",
-      "excluded_publisher_categories",
-      "excluded_publisher_list_ids",
-      "excluded_user_adclusters",
-      "excluded_user_device",
-      "exclusions",
-      "facebook_positions",
       "family_statuses",
-      "fb_deal_id",
-      "flexible_spec",
-      "follow_profiles",
-      "follow_profiles_negative",
-      "format",
-      "friends_of_connections",
-      "gatekeepers",
-      "genders",
       "generation",
-      "geo_locations",
       "home_ownership",
       "home_type",
       "home_value",
       "household_composition",
       "income",
       "industries",
-      "instagram_positions",
-      "instream_video_sponsorship_placements",
-      "interest_defaults_source",
       "interested_in",
       "interests",
-      "is_whatsapp_destination_ad",
-      "keywords",
       "life_events",
-      "locales",
       "location_categories",
-      "location_cluster_ids",
-      "location_expansion",
-      "marketplace_product_categories",
-      "messenger_positions",
-      "mobile_device_model",
       "moms",
       "net_worth",
       "office_type",
-      "page_types",
-      "place_page_set_ids",
-      "political_views",
       "politics",
-      "product_audience_specs",
-      "prospecting_audience",
-      "publisher_platforms",
-      "publisher_visibility_categories",
-      "radius",
-      "regions",
       "relationship_statuses",
-      "rtb_flag",
-      "site_category",
-      "targeting_optimization",
-      "timezones",
-      "topic",
-      "trending",
       "user_adclusters",
-      "user_device",
-      "user_event",
-      "user_os",
-      "user_page_threads",
-      "user_page_threads_excluded",
-      "whatsapp_positions",
-      "wireless_carrier",
       "work_employers",
       "work_positions",
-      "zips",
     ]
 
     WHITELISTED_TYPES = [

data/lib/facebook_ads/ad_objects/ad_async_request.rb

@@ -26,18 +26,6 @@ module FacebookAds
   # pull request for this class.
 
   class AdAsyncRequest < AdObject
-    STATUS = [
-      "CANCELED",
-      "CANCELED_DEPENDENCY",
-      "ERROR",
-      "ERROR_CONFLICTS",
-      "ERROR_DEPENDENCY",
-      "INITIAL",
-      "IN_PROGRESS",
-      "PENDING_DEPENDENCY",
-      "SUCCESS",
-    ]
-
     STATUSES = [
       "CANCELED",
       "CANCELED_DEPENDENCY",
@@ -57,7 +45,7 @@ module FacebookAds
     field :input, 'hash'
     field :result, 'hash'
     field :scope_object_id, 'string'
-    field :status, { enum: -> { STATUS }}
+    field :status, 'string'
     field :type, 'string'
     field :updated_time, 'datetime'
     has_no_post

data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb

@@ -129,8 +129,8 @@ module FacebookAds
     field :bid_amount_old, 'int'
     field :bid_constraints_new, 'object'
     field :bid_constraints_old, 'object'
-    field :bid_info_new, { list: 'object' }
-    field :bid_info_old, { list: 'object' }
+    field :bid_info_new, 'hash'
+    field :bid_info_old, 'hash'
     field :bid_strategy_new, { enum: -> { BID_STRATEGY_NEW }}
     field :bid_strategy_old, { enum: -> { BID_STRATEGY_OLD }}
     field :bid_type_new, 'string'

data/lib/facebook_ads/ad_objects/ad_campaign_delivery_stats_unsupported_reasons.rb

@@ -27,7 +27,7 @@ module FacebookAds
 
   class AdCampaignDeliveryStatsUnsupportedReasons < AdObject
 
-    field :reason_data, { list: 'object' }
+    field :reason_data, 'hash'
     field :reason_type, 'string'
     field :id, 'string'
     has_no_get

data/lib/facebook_ads/ad_objects/ad_creative.rb

@@ -101,8 +101,6 @@ module FacebookAds
     STATUS = [
       "ACTIVE",
       "DELETED",
-      "PENDING_PROCESS",
-      "WITH_ISSUES",
     ]
 
     AUTHORIZATION_CATEGORY = [

data/lib/facebook_ads/ad_objects/ad_creative_link_data_template_video_spec.rb

@@ -28,7 +28,7 @@ module FacebookAds
   class AdCreativeLinkDataTemplateVideoSpec < AdObject
 
     field :categorization_criteria, 'string'
-    field :customization, { list: 'object' }
+    field :customization, 'hash'
     field :template_id, 'string'
     field :id, 'string'
     has_no_get

data/lib/facebook_ads/ad_objects/ad_monetization_property.rb

@@ -26,77 +26,6 @@ module FacebookAds
   # pull request for this class.
 
   class AdMonetizationProperty < AdObject
-    AGGREGATION_PERIOD = [
-      "DAY",
-      "HOUR",
-      "TOTAL",
-    ]
-
-    BREAKDOWNS = [
-      "AGE",
-      "APP",
-      "CLICKED_VIEW_TAG",
-      "COUNTRY",
-      "DEAL",
-      "DEAL_AD",
-      "DEAL_PAGE",
-      "DELIVERY_METHOD",
-      "DISPLAY_FORMAT",
-      "FAIL_REASON",
-      "GENDER",
-      "PLACEMENT",
-      "PLATFORM",
-      "PROPERTY",
-      "SDK_VERSION",
-    ]
-
-    METRICS = [
-      "FB_AD_NETWORK_BIDDING_BID_RATE",
-      "FB_AD_NETWORK_BIDDING_REQUEST",
-      "FB_AD_NETWORK_BIDDING_RESPONSE",
-      "FB_AD_NETWORK_BIDDING_REVENUE",
-      "FB_AD_NETWORK_BIDDING_WIN_RATE",
-      "FB_AD_NETWORK_CLICK",
-      "FB_AD_NETWORK_CLICK_VALUE_SCORE",
-      "FB_AD_NETWORK_CLICK_VALUE_SCORE_DENOMINATOR",
-      "FB_AD_NETWORK_CLICK_VALUE_SCORE_NUMERATOR",
-      "FB_AD_NETWORK_CPM",
-      "FB_AD_NETWORK_CTR",
-      "FB_AD_NETWORK_DIRECT_PUBLISHER_BILL",
-      "FB_AD_NETWORK_DIRECT_TOTAL_REVENUE",
-      "FB_AD_NETWORK_FAST_CLICK_DENOMINATOR",
-      "FB_AD_NETWORK_FAST_CLICK_NUMERATOR",
-      "FB_AD_NETWORK_FAST_CLICK_RATE",
-      "FB_AD_NETWORK_FAST_RETURN_DENOMINATOR",
-      "FB_AD_NETWORK_FAST_RETURN_NUMERATOR",
-      "FB_AD_NETWORK_FAST_RETURN_RATE",
-      "FB_AD_NETWORK_FILLED_REQUEST",
-      "FB_AD_NETWORK_FILL_RATE",
-      "FB_AD_NETWORK_IMP",
-      "FB_AD_NETWORK_NO_BID",
-      "FB_AD_NETWORK_NO_FILL",
-      "FB_AD_NETWORK_REQUEST",
-      "FB_AD_NETWORK_REVENUE",
-      "FB_AD_NETWORK_SHOW_RATE",
-      "FB_AD_NETWORK_VIDEO_GUARANTEE_REVENUE",
-      "FB_AD_NETWORK_VIDEO_MRC",
-      "FB_AD_NETWORK_VIDEO_MRC_RATE",
-      "FB_AD_NETWORK_VIDEO_VIEW",
-      "FB_AD_NETWORK_VIDEO_VIEW_RATE",
-      "FB_AD_NETWORK_WIN_RATE",
-    ]
-
-    ORDERING_COLUMN = [
-      "METRIC",
-      "TIME",
-      "VALUE",
-    ]
-
-    ORDERING_TYPE = [
-      "ASCENDING",
-      "DESCENDING",
-    ]
-
 
     field :id, 'string'
     has_no_post
@@ -104,24 +33,24 @@ module FacebookAds
 
     has_edge :adnetworkanalytics do |edge|
       edge.get 'AdNetworkAnalyticsSyncQueryResult' do |api|
-        api.has_param :aggregation_period, { enum: -> { AdMonetizationProperty::AGGREGATION_PERIOD }}
-        api.has_param :breakdowns, { list: { enum: -> { AdMonetizationProperty::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: -> { AdMonetizationProperty::METRICS }} }
-        api.has_param :ordering_column, { enum: -> { AdMonetizationProperty::ORDERING_COLUMN }}
-        api.has_param :ordering_type, { enum: -> { AdMonetizationProperty::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, 'datetime'
         api.has_param :until, 'datetime'
       end
       edge.post 'AdMonetizationProperty' do |api|
-        api.has_param :aggregation_period, { enum: -> { AdMonetizationProperty::AGGREGATION_PERIOD }}
-        api.has_param :breakdowns, { list: { enum: -> { AdMonetizationProperty::BREAKDOWNS }} }
-        api.has_param :metrics, { list: { enum: -> { AdMonetizationProperty::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: -> { AdMonetizationProperty::ORDERING_COLUMN }}
-        api.has_param :ordering_type, { enum: -> { AdMonetizationProperty::ORDERING_TYPE }}
+        api.has_param :ordering_column, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_COLUMN }}
+        api.has_param :ordering_type, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_TYPE }}
         api.has_param :since, 'datetime'
         api.has_param :until, 'datetime'
       end

data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb

@@ -26,6 +26,62 @@ module FacebookAds
   # pull request for this class.
 
   class AdNetworkAnalyticsSyncQueryResult < AdObject
+    AGGREGATION_PERIOD = [
+      "DAY",
+      "TOTAL",
+    ]
+
+    BREAKDOWNS = [
+      "AGE",
+      "APP",
+      "CLICKED_VIEW_TAG",
+      "COUNTRY",
+      "DEAL",
+      "DEAL_AD",
+      "DEAL_PAGE",
+      "DELIVERY_METHOD",
+      "DISPLAY_FORMAT",
+      "FAIL_REASON",
+      "GENDER",
+      "PLACEMENT",
+      "PLATFORM",
+      "PROPERTY",
+      "SDK_VERSION",
+    ]
+
+    METRICS = [
+      "FB_AD_NETWORK_BIDDING_BID_RATE",
+      "FB_AD_NETWORK_BIDDING_REQUEST",
+      "FB_AD_NETWORK_BIDDING_RESPONSE",
+      "FB_AD_NETWORK_BIDDING_REVENUE",
+      "FB_AD_NETWORK_BIDDING_WIN_RATE",
+      "FB_AD_NETWORK_CLICK",
+      "FB_AD_NETWORK_CPM",
+      "FB_AD_NETWORK_CTR",
+      "FB_AD_NETWORK_FILLED_REQUEST",
+      "FB_AD_NETWORK_FILL_RATE",
+      "FB_AD_NETWORK_IMP",
+      "FB_AD_NETWORK_REQUEST",
+      "FB_AD_NETWORK_REVENUE",
+      "FB_AD_NETWORK_SHOW_RATE",
+      "FB_AD_NETWORK_VIDEO_GUARANTEE_REVENUE",
+      "FB_AD_NETWORK_VIDEO_MRC",
+      "FB_AD_NETWORK_VIDEO_MRC_RATE",
+      "FB_AD_NETWORK_VIDEO_VIEW",
+      "FB_AD_NETWORK_VIDEO_VIEW_RATE",
+    ]
+
+    ORDERING_COLUMN = [
+      "METRIC",
+      "TIME",
+      "VALUE",
+    ]
+
+    ORDERING_TYPE = [
+      "ASCENDING",
+      "DESCENDING",
+    ]
+
 
     field :query_id, 'string'
     field :results, { list: 'object' }

data/lib/facebook_ads/ad_objects/ad_study.rb

@@ -37,6 +37,7 @@ module FacebookAds
     ]
 
     TYPE = [
+      "CONTINUOUS_LIFT_CONFIG",
       "LIFT",
       "SPLIT_TEST",
     ]

data/lib/facebook_ads/ad_objects/adgroup_activity.rb

@@ -75,8 +75,8 @@ module FacebookAds
     field :asset_feed_id_old, 'string'
     field :bid_amount_new, 'int'
     field :bid_amount_old, 'int'
-    field :bid_info_new, { list: 'object' }
-    field :bid_info_old, { list: 'object' }
+    field :bid_info_new, 'hash'
+    field :bid_info_old, 'hash'
     field :bid_type_new, 'string'
     field :bid_type_old, 'string'
     field :conversion_specs_new, { list: 'object' }

data/lib/facebook_ads/ad_objects/ads_optimal_delivery_growth_opportunity.rb

@@ -27,7 +27,7 @@ module FacebookAds
 
   class AdsOptimalDeliveryGrowthOpportunity < AdObject
 
-    field :child_metadata, { list: 'object' }
+    field :child_metadata, 'hash'
     field :metadata, 'object'
     field :optimization_type, 'string'
     field :id, 'string'