facebookbusiness 0.3.2.8 → 0.3.2.9

data/lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb

@@ -32,17 +32,17 @@ module FacebookAds
       "device_os",
       "device_type",
       "event",
+      "event_detection_method",
+      "event_source",
+      "event_total_counts",
+      "event_value_count",
       "host",
       "people_reached",
       "pii_keys",
       "pii_lift",
       "pixel_fire",
-      "event_detection_method",
       "url",
-      "event_value_count",
       "url_by_rule",
-      "event_total_counts",
-      "event_source",
     ]
 
 

data/lib/facebook_ads/ad_objects/application.rb

@@ -27,91 +27,92 @@ module FacebookAds
 
   class Application < AdObject
     SUPPORTED_PLATFORMS = [
-      "WEB",
-      "CANVAS",
-      "MOBILE_WEB",
-      "IPHONE",
-      "IPAD",
-      "ANDROID",
-      "WINDOWS",
       "AMAZON",
-      "SUPPLEMENTARY_IMAGES",
+      "ANDROID",
+      "CANVAS",
       "GAMEROOM",
       "INSTANT_GAME",
+      "IPAD",
+      "IPHONE",
+      "MOBILE_WEB",
+      "SUPPLEMENTARY_IMAGES",
+      "WEB",
+      "WINDOWS",
     ]
 
     AN_PLATFORMS = [
-      "IOS",
       "ANDROID",
-      "MOBILE_WEB",
       "DESKTOP",
       "INSTANT_ARTICLES",
+      "IOS",
+      "MOBILE_WEB",
       "UNKNOWN",
     ]
 
     AGGREGATION_PERIOD = [
-      "HOUR",
       "DAY",
+      "HOUR",
       "TOTAL",
     ]
 
     BREAKDOWNS = [
       "AGE",
       "APP",
+      "CLICKED_VIEW_TAG",
       "COUNTRY",
-      "DELIVERY_METHOD",
-      "DISPLAY_FORMAT",
       "DEAL",
       "DEAL_AD",
       "DEAL_PAGE",
+      "DELIVERY_METHOD",
+      "DISPLAY_FORMAT",
+      "FAIL_REASON",
       "GENDER",
       "PLACEMENT",
       "PLATFORM",
       "PROPERTY",
-      "CLICKED_VIEW_TAG",
-      "FAIL_REASON",
+      "SDK_VERSION",
     ]
 
     METRICS = [
+      "FB_AD_NETWORK_BIDDING_BID_RATE",
       "FB_AD_NETWORK_BIDDING_REQUEST",
       "FB_AD_NETWORK_BIDDING_RESPONSE",
-      "FB_AD_NETWORK_BIDDING_BID_RATE",
+      "FB_AD_NETWORK_BIDDING_REVENUE",
       "FB_AD_NETWORK_BIDDING_WIN_RATE",
-      "FB_AD_NETWORK_REQUEST",
+      "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_SHOW_RATE",
-      "FB_AD_NETWORK_CLICK",
-      "FB_AD_NETWORK_CTR",
-      "FB_AD_NETWORK_BIDDING_REVENUE",
+      "FB_AD_NETWORK_NO_BID",
+      "FB_AD_NETWORK_NO_FILL",
+      "FB_AD_NETWORK_REQUEST",
       "FB_AD_NETWORK_REVENUE",
-      "FB_AD_NETWORK_CPM",
+      "FB_AD_NETWORK_SHOW_RATE",
       "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_VIDEO_VIEW",
+      "FB_AD_NETWORK_VIDEO_VIEW_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",
-      "FB_AD_NETWORK_NO_FILL",
-      "FB_AD_NETWORK_NO_BID",
     ]
 
     ORDERING_COLUMN = [
+      "METRIC",
       "TIME",
       "VALUE",
-      "METRIC",
     ]
 
     ORDERING_TYPE = [
@@ -126,19 +127,19 @@ module FacebookAds
 
     REQUEST_TYPE = [
       "APP_INDEXING",
-      "PLUGIN",
       "BUTTON_SAMPLING",
+      "PLUGIN",
     ]
 
     MUTATION_METHOD = [
-      "REPLACE",
       "ADD",
       "DELETE",
+      "REPLACE",
     ]
 
     POST_METHOD = [
-      "EYMT",
       "CODELESS",
+      "EYMT",
     ]
 
     SCORE_TYPE = [
@@ -155,8 +156,8 @@ module FacebookAds
     ROLE = [
       "administrators",
       "developers",
-      "testers",
       "insights users",
+      "testers",
     ]
 
 
@@ -293,7 +294,7 @@ module FacebookAds
 
     has_edge :activities do |edge|
       edge.post do |api|
-        api.has_param :event, { enum: %w{MOBILE_APP_INSTALL CUSTOM_APP_EVENTS DEFERRED_APP_LINK }}
+        api.has_param :event, { enum: %w{CUSTOM_APP_EVENTS DEFERRED_APP_LINK MOBILE_APP_INSTALL }}
         api.has_param :attribution, 'string'
         api.has_param :advertiser_id, 'string'
         api.has_param :anon_id, 'string'
@@ -388,11 +389,11 @@ module FacebookAds
     has_edge :app_insights do |edge|
       edge.get do |api|
         api.has_param :metric_key, 'string'
-        api.has_param :period, { enum: %w{mins_15 hourly daily weekly monthly lifetime days_28 range }}
+        api.has_param :period, { enum: %w{daily days_28 hourly lifetime mins_15 monthly range weekly }}
         api.has_param :since, 'datetime'
         api.has_param :until, 'datetime'
         api.has_param :breakdowns, { list: 'string' }
-        api.has_param :aggregateby, { enum: %w{COUNT COUNT_IDENTIFIED_USERS USERS TOPK SUM SUM_PER_EVENT SUM_IDENTIFIED_USERS USD_SUM USD_SUM_PER_EVENT USD_SUM_IDENTIFIED_USERS USD_SUM_PER_USER UNKNOWN_USERS SCORE MEDIAN_VALUE MEDIAN_VALUE_PER_USER DAU WAU MAU PERCENTILES_COUNT PERCENTILES_VALUE PERCENTILES_USD_VALUE OVERLAP COUNT_PER_USER VALUE_PER_USER USD_VALUE_PER_USER SESSIONS_PER_JOURNEY CONVERTED_JOURNEY_PERCENT MEDIAN_JOURNEY_LENGTH AVERAGE_JOURNEY_LENGTH JOURNEY_CHANNEL_INCLUSION EVENT_SOURCE_IDS SESSION_BOUNCE_RATE JOURNEY_INCLUSION USER_PROPERTY_USER_COUNT }}
+        api.has_param :aggregateby, { enum: %w{AVERAGE_JOURNEY_LENGTH CONVERTED_JOURNEY_PERCENT COUNT COUNT_IDENTIFIED_USERS COUNT_PER_USER DAU EVENT_SOURCE_IDS JOURNEY_CHANNEL_INCLUSION JOURNEY_INCLUSION MAU MEDIAN_JOURNEY_LENGTH MEDIAN_VALUE MEDIAN_VALUE_PER_USER OVERLAP PERCENTILES_COUNT PERCENTILES_USD_VALUE PERCENTILES_VALUE SCORE SESSIONS_PER_JOURNEY SESSION_BOUNCE_RATE SUM SUM_IDENTIFIED_USERS SUM_PER_EVENT TOPK UNKNOWN_USERS USD_SUM USD_SUM_IDENTIFIED_USERS USD_SUM_PER_EVENT USD_SUM_PER_USER USD_VALUE_PER_USER USERS USER_PROPERTY_USER_COUNT VALUE_PER_USER WAU }}
         api.has_param :event_name, 'string'
         api.has_param :ecosystem, { enum: %w{GAME NON_GAME }}
         api.has_param :intervals_to_aggregate, 'int'
@@ -523,7 +524,7 @@ module FacebookAds
       end
       edge.post do |api|
         api.has_param :order_id, 'string'
-        api.has_param :status, { enum: %w{CREATED CONFIRMED CANCELLED DELIVERED READY_FOR_PICKUP OUT_FOR_DELIVERY }}
+        api.has_param :status, { enum: %w{CANCELLED CONFIRMED CREATED DELIVERED OUT_FOR_DELIVERY READY_FOR_PICKUP }}
       end
     end
 

data/lib/facebook_ads/ad_objects/async_request.rb

@@ -27,16 +27,16 @@ module FacebookAds
 
   class AsyncRequest < AdObject
     STATUS = [
-      "INITIALIZED",
+      "ERROR",
       "EXECUTING",
       "FINISHED",
-      "ERROR",
+      "INITIALIZED",
     ]
 
     TYPE = [
-      "DRAFTS",
-      "BATCH_API",
       "ASYNC_ADGROUP_CREATION",
+      "BATCH_API",
+      "DRAFTS",
     ]
 
 

data/lib/facebook_ads/ad_objects/audio_copyright.rb

@@ -27,8 +27,8 @@ module FacebookAds
 
   class AudioCopyright < AdObject
     UPDATE_SOURCE = [
-      "edit_reference_dialog",
       "ddex",
+      "edit_reference_dialog",
       "reference_conflict_dialog",
     ]
 

data/lib/facebook_ads/ad_objects/business.rb

@@ -27,9 +27,9 @@ module FacebookAds
 
   class Business < AdObject
     TWO_FACTOR_TYPE = [
-      "none",
       "admin_required",
       "all_required",
+      "none",
     ]
 
     VERTICAL = [
@@ -43,52 +43,123 @@ module FacebookAds
       "FINANCIAL_SERVICES",
       "GAMING",
       "GOVERNMENT_AND_POLITICS",
+      "HEALTH",
+      "LUXURY",
       "MARKETING",
+      "NON_PROFIT",
       "ORGANIZATIONS_AND_ASSOCIATIONS",
+      "OTHER",
       "PROFESSIONAL_SERVICES",
+      "RESTAURANT",
       "RETAIL",
       "TECHNOLOGY",
       "TELECOM",
       "TRAVEL",
-      "NON_PROFIT",
-      "RESTAURANT",
-      "HEALTH",
-      "LUXURY",
-      "OTHER",
+    ]
+
+    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",
     ]
 
     ACCESS_TYPE = [
-      "OWNER",
       "AGENCY",
+      "OWNER",
     ]
 
     PERMITTED_TASKS = [
-      "MANAGE",
       "ADVERTISE",
       "ANALYZE",
+      "MANAGE",
     ]
 
     SURVEY_BUSINESS_TYPE = [
-      "AGENCY",
       "ADVERTISER",
+      "AGENCY",
       "APP_DEVELOPER",
       "PUBLISHER",
     ]
 
     PAGE_PERMITTED_ROLES = [
-      "MANAGER",
-      "CONTENT_CREATOR",
-      "MODERATOR",
       "ADVERTISER",
+      "CONTENT_CREATOR",
       "INSIGHTS_ANALYST",
+      "MANAGER",
+      "MODERATOR",
     ]
 
     ROLE = [
-      "FINANCE_EDITOR",
-      "FINANCE_ANALYST",
-      "ADS_RIGHTS_REVIEWER",
       "ADMIN",
+      "ADS_RIGHTS_REVIEWER",
       "EMPLOYEE",
+      "FINANCE_ANALYST",
+      "FINANCE_EDITOR",
     ]
 
 
@@ -161,6 +232,7 @@ module FacebookAds
     has_edge :adaccountcreationrequests do |edge|
       edge.get 'AdAccountCreationRequest' do |api|
         api.has_param :status, { list: { enum: -> { AdAccountCreationRequest::STATUS }} }
+        api.has_param :ad_account_creation_request_id, 'string'
       end
       edge.post 'AdAccountCreationRequest' do |api|
         api.has_param :extended_credit_id, 'string'
@@ -197,24 +269,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: -> { Business::AGGREGATION_PERIOD }}
+        api.has_param :breakdowns, { list: { enum: -> { Business::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: -> { Business::METRICS }} }
+        api.has_param :ordering_column, { enum: -> { Business::ORDERING_COLUMN }}
+        api.has_param :ordering_type, { enum: -> { Business::ORDERING_TYPE }}
         api.has_param :since, 'datetime'
         api.has_param :until, 'datetime'
       end
       edge.post 'Business' 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: -> { Business::AGGREGATION_PERIOD }}
+        api.has_param :breakdowns, { list: { enum: -> { Business::BREAKDOWNS }} }
+        api.has_param :metrics, { list: { enum: -> { Business::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: -> { Business::ORDERING_COLUMN }}
+        api.has_param :ordering_type, { enum: -> { Business::ORDERING_TYPE }}
         api.has_param :since, 'datetime'
         api.has_param :until, 'datetime'
       end
@@ -674,7 +746,13 @@ module FacebookAds
     has_edge :upload_event do |edge|
       edge.get 'MeasurementUploadEvent'
       edge.post 'MeasurementUploadEvent' do |api|
+        api.has_param :aggregation_level, { enum: -> { MeasurementUploadEvent::AGGREGATION_LEVEL }}
+        api.has_param :conversion_end_date, 'string'
+        api.has_param :conversion_start_date, 'string'
+        api.has_param :event_status, { enum: -> { MeasurementUploadEvent::EVENT_STATUS }}
         api.has_param :group, { enum: -> { MeasurementUploadEvent::GROUP }}
+        api.has_param :lookback_window, { enum: -> { MeasurementUploadEvent::LOOKBACK_WINDOW }}
+        api.has_param :match_universe, { enum: -> { MeasurementUploadEvent::MATCH_UNIVERSE }}
         api.has_param :upload_end_time, 'datetime'
         api.has_param :upload_start_time, 'datetime'
         api.has_param :upload_tag, 'string'