facebookbusiness 0.3.2.9 → 0.3.2.10

data/lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb

@@ -33,6 +33,7 @@ module FacebookAds
       "device_type",
       "event",
       "event_detection_method",
+      "event_processing_results",
       "event_source",
       "event_total_counts",
       "event_value_count",

data/lib/facebook_ads/ad_objects/application.rb

@@ -49,77 +49,6 @@ module FacebookAds
       "UNKNOWN",
     ]
 
-    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",
-    ]
-
     PLATFORM = [
       "ANDROID",
       "IOS",
@@ -327,24 +256,24 @@ module FacebookAds
 
     has_edge :adnetworkanalytics do |edge|
       edge.get 'AdNetworkAnalyticsSyncQueryResult' do |api|
-        api.has_param :aggregation_period, { enum: -> { Application::AGGREGATION_PERIOD }}
-        api.has_param :breakdowns, { list: { enum: -> { Application::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: -> { Application::METRICS }} }
-        api.has_param :ordering_column, { enum: -> { Application::ORDERING_COLUMN }}
-        api.has_param :ordering_type, { enum: -> { Application::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 'Application' do |api|
-        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 :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: -> { Application::ORDERING_COLUMN }}
-        api.has_param :ordering_type, { enum: -> { Application::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/{lead_gen_qualifier.rb → brand_safety_block_list_usage.rb}

@@ -25,13 +25,14 @@ 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 LeadGenQualifier < AdObject
+  class BrandSafetyBlockListUsage < AdObject
 
-    field :category, 'string'
-    field :field_key, 'string'
+    field :current_usage, 'int'
+    field :new_usage, 'int'
+    field :platform, 'string'
+    field :position, 'string'
+    field :threshold, 'int'
     field :id, 'string'
-    field :label, 'string'
-    field :question, 'string'
     has_no_get
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/business.rb

@@ -57,77 +57,6 @@ module FacebookAds
       "TRAVEL",
     ]
 
-    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 = [
       "AGENCY",
       "OWNER",
@@ -269,24 +198,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, 'datetime'
         api.has_param :until, 'datetime'
       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, 'datetime'
         api.has_param :until, 'datetime'
       end
@@ -424,8 +353,18 @@ module FacebookAds
       edge.get 'Business'
     end
 
+    has_edge :credit_cards do |edge|
+      edge.get 'BusinessCreditCardLegacy'
+    end
+
+    has_edge :creditcards do |edge|
+      edge.get 'BusinessCreditCardLegacy'
+    end
+
     has_edge :customconversions do |edge|
-      edge.get 'CustomConversion'
+      edge.get 'CustomConversion' do |api|
+        api.has_param :include_archived, 'bool'
+      end
       edge.post 'CustomConversion' do |api|
         api.has_param :name, 'string'
         api.has_param :description, 'string'
@@ -743,6 +682,15 @@ module FacebookAds
       end
     end
 
+    has_edge :third_party_measurement_report_dataset do |edge|
+      edge.get 'ThirdPartyMeasurementReportDataset'
+      edge.post 'ThirdPartyMeasurementReportDataset' do |api|
+        api.has_param :category, { enum: -> { ThirdPartyMeasurementReportDataset::CATEGORY }}
+        api.has_param :product, { enum: -> { ThirdPartyMeasurementReportDataset::PRODUCT }}
+        api.has_param :schema, { list: 'hash' }
+      end
+    end
+
     has_edge :upload_event do |edge|
       edge.get 'MeasurementUploadEvent'
       edge.post 'MeasurementUploadEvent' do |api|

data/lib/facebook_ads/ad_objects/business_activity_log_event.rb

@@ -40,7 +40,7 @@ module FacebookAds
     field :acting_user_name, 'string'
     field :event_time, 'int'
     field :event_type, 'string'
-    field :extra_data, { list: 'object' }
+    field :extra_data, 'hash'
     field :target_business_id, 'string'
     field :target_business_name, 'string'
     field :target_business_object_id, 'string'

data/lib/facebook_ads/ad_objects/business_credit_card_legacy.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class BusinessCreditCardLegacy < AdObject
+
+    field :address, 'object'
+    field :business_id, 'string'
+    field :credit_card_suffix, 'string'
+    field :credit_card_type, 'string'
+    field :expiration_month, 'int'
+    field :expiration_year, 'int'
+    field :first_name, 'string'
+    field :fraud_status, 'string'
+    field :id, 'string'
+    field :last_name, 'string'
+    field :middle_name, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audience.rb

@@ -65,6 +65,7 @@ module FacebookAds
       "FOX",
       "LOOKALIKE",
       "MANAGED",
+      "MEASUREMENT",
       "OFFLINE_CONVERSION",
       "PARTNER",
       "STUDY_RULE_AUDIENCE",

data/lib/facebook_ads/ad_objects/custom_conversion.rb

@@ -61,6 +61,7 @@ module FacebookAds
     field :first_fired_time, 'datetime'
     field :id, 'string'
     field :is_archived, 'bool'
+    field :is_unavailable, 'bool'
     field :last_fired_time, 'datetime'
     field :name, 'string'
     field :offline_conversion_data_set, 'OfflineConversionDataSet'

data/lib/facebook_ads/ad_objects/dog_notification_settings.rb

@@ -29,7 +29,7 @@ module FacebookAds
 
     field :dog_check_key, 'string'
     field :id, 'string'
-    field :subscription_status_per_channel, { list: 'object' }
+    field :subscription_status_per_channel, 'hash'
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/dynamic_item_display_bundle.rb

@@ -27,12 +27,12 @@ module FacebookAds
 
   class DynamicItemDisplayBundle < AdObject
 
-    field :additional_urls, { list: 'object' }
+    field :additional_urls, 'hash'
     field :description, 'string'
     field :id, 'string'
     field :name, 'string'
     field :product_set, 'ProductSet'
-    field :text_tokens, { list: 'object' }
+    field :text_tokens, 'hash'
     field :url, 'string'
 
     has_edge :bundle_folders do |edge|

data/lib/facebook_ads/ad_objects/dynamic_item_display_bundle_folder.rb

@@ -32,7 +32,7 @@ module FacebookAds
     field :name, 'string'
     field :product_catalog, 'ProductCatalog'
     field :product_set, 'ProductSet'
-    field :valid_labels, { list: 'object' }
+    field :valid_labels, 'map<string, list<string>>'
     field :bundles, { list: 'string' }
 
     has_edge :bundles do |edge|

data/lib/facebook_ads/ad_objects/event.rb

@@ -33,35 +33,6 @@ module FacebookAds
       "public",
     ]
 
-    PROJECTION = [
-      "CUBEMAP",
-      "EQUIRECTANGULAR",
-      "HALF_EQUIRECTANGULAR",
-    ]
-
-    SPATIAL_AUDIO_FORMAT = [
-      "ambiX_4",
-    ]
-
-    STATUS = [
-      "LIVE_NOW",
-      "SCHEDULED_CANCELED",
-      "SCHEDULED_LIVE",
-      "SCHEDULED_UNPUBLISHED",
-      "UNPUBLISHED",
-    ]
-
-    STEREOSCOPIC_MODE = [
-      "LEFT_RIGHT",
-      "MONO",
-      "TOP_BOTTOM",
-    ]
-
-    STREAM_TYPE = [
-      "AMBIENT",
-      "REGULAR",
-    ]
-
     EVENT_STATE_FILTER = [
       "canceled",
       "draft",
@@ -122,13 +93,6 @@ module FacebookAds
       edge.get 'User' do |api|
         api.has_param :user, 'int'
       end
-      edge.post 'Event' do |api|
-        api.has_param :eid, 'string'
-        api.has_param :action_context, 'object'
-        api.has_param :app_context, 'object'
-        api.has_param :tracking, 'string'
-        api.has_param :uid, 'int'
-      end
     end
 
     has_edge :comments do |edge|
@@ -154,13 +118,6 @@ module FacebookAds
       edge.get 'User' do |api|
         api.has_param :user, 'int'
       end
-      edge.post 'Event' do |api|
-        api.has_param :eid, 'string'
-        api.has_param :action_context, 'object'
-        api.has_param :app_context, 'object'
-        api.has_param :tracking, 'string'
-        api.has_param :uid, 'int'
-      end
     end
 
     has_edge :feed do |edge|
@@ -289,29 +246,29 @@ module FacebookAds
 
     has_edge :live_videos do |edge|
       edge.get 'NullNode'
-      edge.post 'Event' do |api|
+      edge.post 'LiveVideo' do |api|
         api.has_param :title, 'string'
         api.has_param :description, 'string'
         api.has_param :save_vod, 'bool'
         api.has_param :published, 'bool'
-        api.has_param :status, { enum: -> { Event::STATUS }}
+        api.has_param :status, { enum: -> { LiveVideo::STATUS }}
         api.has_param :privacy, 'string'
         api.has_param :stop_on_delete_stream, 'bool'
-        api.has_param :stream_type, { enum: -> { Event::STREAM_TYPE }}
+        api.has_param :stream_type, { enum: -> { LiveVideo::STREAM_TYPE }}
         api.has_param :content_tags, { list: 'string' }
         api.has_param :is_spherical, 'bool'
         api.has_param :is_audio_only, 'bool'
         api.has_param :planned_start_time, 'int'
         api.has_param :schedule_custom_profile_image, 'file'
-        api.has_param :projection, { enum: -> { Event::PROJECTION }}
-        api.has_param :spatial_audio_format, { enum: -> { Event::SPATIAL_AUDIO_FORMAT }}
+        api.has_param :projection, { enum: -> { LiveVideo::PROJECTION }}
+        api.has_param :spatial_audio_format, { enum: -> { LiveVideo::SPATIAL_AUDIO_FORMAT }}
         api.has_param :encoding_settings, 'string'
         api.has_param :live_encoders, { list: 'string' }
         api.has_param :original_fov, 'int'
         api.has_param :fisheye_video_cropped, 'bool'
         api.has_param :front_z_rotation, 'double'
         api.has_param :attribution_app_id, 'string'
-        api.has_param :stereoscopic_mode, { enum: -> { Event::STEREOSCOPIC_MODE }}
+        api.has_param :stereoscopic_mode, { enum: -> { LiveVideo::STEREOSCOPIC_MODE }}
       end
     end
 
@@ -319,13 +276,6 @@ module FacebookAds
       edge.get 'User' do |api|
         api.has_param :user, 'int'
       end
-      edge.post 'Event' do |api|
-        api.has_param :eid, 'string'
-        api.has_param :action_context, 'object'
-        api.has_param :app_context, 'object'
-        api.has_param :tracking, 'string'
-        api.has_param :uid, 'int'
-      end
     end
 
     has_edge :noreply do |edge|