facebookbusiness 0.7.0.3 → 0.8.0.4

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -53,6 +53,7 @@ module FacebookAds
     ACTION_REPORT_TIME = [
       "conversion",
       "impression",
+      "mixed",
     ]
 
     BREAKDOWNS = [

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -32,8 +32,11 @@ module FacebookAds
     ]
 
     AUTOMATIC_MATCHING_FIELDS = [
+      "country",
       "ct",
+      "db",
       "em",
+      "external_id",
       "fn",
       "ge",
       "ln",
@@ -90,6 +93,7 @@ module FacebookAds
     has_edge :da_checks do |edge|
       edge.get 'DaCheck' do |api|
         api.has_param :checks, { list: 'string' }
+        api.has_param :connection_method, { enum: -> { DaCheck::CONNECTION_METHOD }}
       end
     end
 

data/lib/facebook_ads/ad_objects/application.rb

@@ -100,6 +100,7 @@ module FacebookAds
     field :android_key_hash, { list: 'string' }
     field :android_sdk_error_categories, { list: 'object' }
     field :app_domains, { list: 'string' }
+    field :app_events_config, 'object'
     field :app_events_feature_bitmask, 'int'
     field :app_events_session_timeout, 'int'
     field :app_install_tracked, 'bool'
@@ -227,6 +228,7 @@ module FacebookAds
         api.has_param :bundle_id, 'string'
         api.has_param :bundle_short_version, 'string'
         api.has_param :bundle_version, 'string'
+        api.has_param :click_id, 'string'
         api.has_param :consider_views, 'bool'
         api.has_param :custom_events, { list: 'object' }
         api.has_param :custom_events_file, 'file'
@@ -239,6 +241,7 @@ module FacebookAds
         api.has_param :include_dwell_data, 'bool'
         api.has_param :include_video_data, 'bool'
         api.has_param :install_referrer, 'string'
+        api.has_param :install_timestamp, 'int'
         api.has_param :installer_package, 'string'
         api.has_param :limited_data_use, 'bool'
         api.has_param :migration_bundle, 'string'
@@ -288,6 +291,18 @@ module FacebookAds
       edge.get 'Business'
     end
 
+    has_edge :aggregate_revenue do |edge|
+      edge.post do |api|
+        api.has_param :ecpms, { list: 'string' }
+        api.has_param :query_ids, { list: 'string' }
+        api.has_param :request_id, 'string'
+      end
+    end
+
+    has_edge :android_dialog_configs do |edge|
+      edge.get
+    end
+
     has_edge :app_event_types do |edge|
       edge.get
     end
@@ -389,6 +404,7 @@ module FacebookAds
     has_edge :da_checks do |edge|
       edge.get 'DaCheck' do |api|
         api.has_param :checks, { list: 'string' }
+        api.has_param :connection_method, { enum: -> { DaCheck::CONNECTION_METHOD }}
       end
     end
 
@@ -455,6 +471,12 @@ module FacebookAds
       end
     end
 
+    has_edge :live_videos do |edge|
+      edge.get 'LiveVideo' do |api|
+        api.has_param :broadcast_status, { enum: -> { LiveVideo::BROADCAST_STATUS }}
+      end
+    end
+
     has_edge :mmp_auditing do |edge|
       edge.post do |api|
         api.has_param :advertiser_id, 'string'
@@ -478,6 +500,7 @@ module FacebookAds
       edge.get do |api|
         api.has_param :device_id, 'string'
         api.has_param :extinfo, 'object'
+        api.has_param :os_version, 'string'
         api.has_param :platform, { enum: %w{ANDROID IOS }}
         api.has_param :sdk_version, 'string'
       end

data/lib/facebook_ads/ad_objects/atlas_campaign.rb

@@ -145,7 +145,7 @@ module FacebookAds
         api.has_param :dimensions, { list: { enum: %w{AD_ID AD_SET_ID CAMPAIGN_ID DEVICE_TYPE SOURCE_CHANNEL }} }
         api.has_param :granularity, { enum: %w{DAY HOUR MONTH WEEK_SUNDAY YEAR }}
         api.has_param :metric_scope, 'hash'
-        api.has_param :order_by, { list: 'string' }
+        api.has_param :order_by, { list: 'hash' }
       end
     end
 

data/lib/facebook_ads/ad_objects/automotive_model.rb

@@ -31,6 +31,7 @@ module FacebookAds
     field :automotive_model_id, 'string'
     field :availability, 'string'
     field :body_style, 'string'
+    field :category_specific_fields, 'CatalogSubVerticalList'
     field :currency, 'string'
     field :custom_label_0, 'string'
     field :description, 'string'

data/lib/facebook_ads/ad_objects/business.rb

@@ -78,6 +78,7 @@ module FacebookAds
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
+      "MESSAGING",
       "MODERATE",
       "MODERATE_COMMUNITY",
       "PAGES_MESSAGING",
@@ -117,11 +118,18 @@ module FacebookAds
     has_edge :access_token do |edge|
       edge.post 'Business' do |api|
         api.has_param :app_id, 'string'
+        api.has_param :fbe_external_business_id, 'string'
         api.has_param :scope, { list: 'Permission' }
         api.has_param :system_user_name, 'string'
       end
     end
 
+    has_edge :ad_accounts do |edge|
+      edge.delete do |api|
+        api.has_param :adaccount_id, 'string'
+      end
+    end
+
     has_edge :ad_studies do |edge|
       edge.get 'AdStudy'
       edge.post 'AdStudy' do |api|
@@ -207,6 +215,14 @@ module FacebookAds
       edge.get 'Business'
     end
 
+    has_edge :aggregate_revenue do |edge|
+      edge.post do |api|
+        api.has_param :ecpms, { list: 'string' }
+        api.has_param :query_ids, { list: 'string' }
+        api.has_param :request_id, 'string'
+      end
+    end
+
     has_edge :an_placements do |edge|
       edge.get 'AdPlacement'
     end
@@ -285,6 +301,10 @@ module FacebookAds
       edge.get 'ProductCatalog'
     end
 
+    has_edge :client_whatsapp_business_accounts do |edge|
+      edge.get 'WhatsAppBusinessAccount'
+    end
+
     has_edge :clients do |edge|
       edge.delete do |api|
         api.has_param :business, 'string'
@@ -292,6 +312,26 @@ module FacebookAds
       edge.get 'Business'
     end
 
+    has_edge :collaborative_ads_collaboration_requests do |edge|
+      edge.get 'CpasCollaborationRequest' do |api|
+        api.has_param :status, 'string'
+      end
+      edge.post 'CpasCollaborationRequest' do |api|
+        api.has_param :brands, { list: 'string' }
+        api.has_param :contact_email, 'string'
+        api.has_param :contact_first_name, 'string'
+        api.has_param :contact_last_name, 'string'
+        api.has_param :phone_number, 'string'
+        api.has_param :receiver_business, 'string'
+        api.has_param :requester_agency_or_brand, { enum: -> { CpasCollaborationRequest::REQUESTER_AGENCY_OR_BRAND }}
+        api.has_param :sender_client_business, 'string'
+      end
+    end
+
+    has_edge :collaborative_ads_suggested_partners do |edge|
+      edge.get 'CpasAdvertiserPartnershipRecommendation'
+    end
+
     has_edge :commerce_merchant_settings do |edge|
       edge.get 'CommerceMerchantSettings'
     end
@@ -307,6 +347,14 @@ module FacebookAds
       end
     end
 
+    has_edge :create_and_apply_publisher_block_list do |edge|
+      edge.post do |api|
+        api.has_param :is_auto_blocking_on, 'bool'
+        api.has_param :name, 'string'
+        api.has_param :publisher_urls, { list: 'string' }
+      end
+    end
+
     has_edge :customconversions do |edge|
       edge.post 'CustomConversion' do |api|
         api.has_param :advanced_rule, 'string'
@@ -359,6 +407,7 @@ module FacebookAds
         api.has_param :existing_client_business_id, 'string'
       end
       edge.post 'Business' do |api|
+        api.has_param :child_business_external_id, 'string'
         api.has_param :existing_client_business_id, 'string'
         api.has_param :name, 'string'
         api.has_param :sales_rep_email, 'string'
@@ -407,9 +456,11 @@ module FacebookAds
         api.has_param :client_id, 'string'
       end
       edge.get 'Business' do |api|
+        api.has_param :child_business_external_id, 'string'
         api.has_param :client_user_id, 'int'
       end
       edge.post 'Business' do |api|
+        api.has_param :child_business_external_id, 'string'
         api.has_param :name, 'string'
         api.has_param :page_permitted_tasks, { list: { enum: -> { Business::PAGE_PERMITTED_TASKS }} }
         api.has_param :sales_rep_email, 'string'
@@ -441,17 +492,22 @@ module FacebookAds
     has_edge :owned_product_catalogs do |edge|
       edge.get 'ProductCatalog'
       edge.post 'ProductCatalog' do |api|
-        api.has_param :commerce_merchant_settings, 'object'
+        api.has_param :catalog_segment_filter, 'object'
+        api.has_param :catalog_segment_product_set_id, 'string'
         api.has_param :da_display_settings, 'object'
         api.has_param :destination_catalog_settings, 'hash'
         api.has_param :flight_catalog_settings, 'hash'
         api.has_param :name, 'string'
-        api.has_param :onsite_commerce_merchant, 'object'
+        api.has_param :parent_catalog_id, 'string'
         api.has_param :store_catalog_settings, 'hash'
         api.has_param :vertical, { enum: -> { ProductCatalog::VERTICAL }}
       end
     end
 
+    has_edge :owned_whatsapp_business_accounts do |edge|
+      edge.get 'WhatsAppBusinessAccount'
+    end
+
     has_edge :pages do |edge|
       edge.delete do |api|
         api.has_param :page_id, 'int'

data/lib/facebook_ads/ad_objects/business_asset_group.rb

@@ -47,6 +47,7 @@ module FacebookAds
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
+      "MESSAGING",
       "MODERATE",
       "MODERATE_COMMUNITY",
       "PAGES_MESSAGING",

data/lib/facebook_ads/ad_objects/business_role_request.rb

@@ -29,10 +29,14 @@ module FacebookAds
     ROLE = [
       "ADMIN",
       "ADS_RIGHTS_REVIEWER",
+      "DEFAULT",
       "DEVELOPER",
       "EMPLOYEE",
       "FINANCE_ANALYST",
+      "FINANCE_EDIT",
       "FINANCE_EDITOR",
+      "FINANCE_VIEW",
+      "MANAGE",
       "PARTNER_CENTER_ADMIN",
       "PARTNER_CENTER_ANALYST",
       "PARTNER_CENTER_EDUCATION",

data/lib/facebook_ads/ad_objects/business_unit.rb

@@ -79,7 +79,7 @@ module FacebookAds
     has_edge :conversion_paths do |edge|
       edge.get do |api|
         api.has_param :click_lookback_window, 'int'
-        api.has_param :date_range, 'object'
+        api.has_param :date_range, 'hash'
         api.has_param :fb_conversion_event_id, 'int'
         api.has_param :limit, 'int'
         api.has_param :metric_context, 'hash'

data/lib/facebook_ads/ad_objects/business_user.rb

@@ -29,10 +29,14 @@ module FacebookAds
     ROLE = [
       "ADMIN",
       "ADS_RIGHTS_REVIEWER",
+      "DEFAULT",
       "DEVELOPER",
       "EMPLOYEE",
       "FINANCE_ANALYST",
+      "FINANCE_EDIT",
       "FINANCE_EDITOR",
+      "FINANCE_VIEW",
+      "MANAGE",
       "PARTNER_CENTER_ADMIN",
       "PARTNER_CENTER_ANALYST",
       "PARTNER_CENTER_EDUCATION",

data/lib/facebook_ads/ad_objects/campaign.rb

@@ -384,6 +384,7 @@ module FacebookAds
 
 
     field :account_id, 'string'
+    field :ad_strategy_id, 'string'
     field :adlabels, { list: 'AdLabel' }
     field :bid_strategy, { enum: -> { BID_STRATEGY }}
     field :boosted_object_id, 'string'

data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb

@@ -0,0 +1,88 @@
+# 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 CatalogSubVerticalList < AdObject
+
+    field :appliances, 'object'
+    field :baby_feeding, 'object'
+    field :baby_transport, 'object'
+    field :beauty, 'object'
+    field :bedding, 'object'
+    field :cameras, 'object'
+    field :cameras_and_photos, 'object'
+    field :cell_phones_and_smart_watches, 'object'
+    field :cleaning_supplies, 'object'
+    field :clo_offer, 'object'
+    field :clothing, 'object'
+    field :clothing_accessories, 'object'
+    field :clothing_group, 'object'
+    field :computer_components, 'object'
+    field :computers_and_tablets, 'object'
+    field :computers_laptops_and_tablets, 'object'
+    field :diapering_and_potty_training, 'object'
+    field :electronic_accessories_and_cables, 'object'
+    field :electronics_accessories, 'object'
+    field :furniture, 'object'
+    field :health, 'object'
+    field :home, 'object'
+    field :home_goods, 'object'
+    field :household_and_cleaning_supplies, 'object'
+    field :jewelry, 'object'
+    field :large_appliances, 'object'
+    field :loyalty_offer, 'object'
+    field :meetup_space, 'object'
+    field :nursery, 'object'
+    field :printers_and_scanners, 'object'
+    field :printers_scanners_and_fax_machines, 'object'
+    field :product_discount, 'object'
+    field :projectors, 'object'
+    field :shoes, 'object'
+    field :shoes_and_footwear, 'object'
+    field :software, 'object'
+    field :televisions_and_monitors, 'object'
+    field :test_child_sub_vertical, 'object'
+    field :test_grand_child_sub_vertical, 'object'
+    field :test_sub_vertical, 'object'
+    field :test_sub_vertical_alias, 'object'
+    field :test_sub_vertical_data_object, 'object'
+    field :third_party_electronics, 'object'
+    field :third_party_toys_and_games, 'object'
+    field :toys, 'object'
+    field :toys_and_games, 'object'
+    field :tvs_and_monitors, 'object'
+    field :vehicle_manufacturer, 'object'
+    field :video_game_consoles_and_video_games, 'object'
+    field :video_games_and_consoles, 'object'
+    field :video_projectors, 'object'
+    field :watches, 'object'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb

@@ -26,17 +26,14 @@ module FacebookAds
   # pull request for this class.
 
   class CommerceMerchantSettings < AdObject
-    MERCHANT_STATUS = [
-      "ENABLED",
-      "EXTERNALLY_DISABLED",
-    ]
-
 
     field :braintree_merchant_id, 'string'
     field :checkout_message, 'string'
     field :contact_email, 'string'
+    field :cta, 'string'
     field :disable_checkout_urls, 'bool'
     field :display_name, 'string'
+    field :external_merchant_id, 'string'
     field :facebook_channel, 'object'
     field :has_discount_code, 'bool'
     field :id, 'string'
@@ -54,22 +51,9 @@ module FacebookAds
     field :terms, 'string'
     field :terms_url_by_locale, 'hash'
     field :whatsapp_channel, 'object'
+    has_no_post
     has_no_delete
 
-    has_edge :facebook_channel do |edge|
-      edge.post 'CommerceMerchantSettings' do |api|
-        api.has_param :pages, { list: 'string' }
-      end
-    end
-
-    has_edge :instagram_channel do |edge|
-      edge.delete
-      edge.post 'CommerceMerchantSettings' do |api|
-        api.has_param :instagram_business_accounts, { list: 'string' }
-        api.has_param :instagram_users, { list: 'string' }
-      end
-    end
-
     has_edge :order_management_apps do |edge|
       edge.get 'Application'
       edge.post 'CommerceMerchantSettings'
@@ -92,6 +76,19 @@ module FacebookAds
       edge.get 'CommerceMerchantSettingsSetupStatus'
     end
 
+    has_edge :shipping_profiles do |edge|
+      edge.get do |api|
+        api.has_param :reference_id, 'string'
+      end
+      edge.post do |api|
+        api.has_param :handling_time, 'hash'
+        api.has_param :is_default_shipping_profile, 'bool'
+        api.has_param :name, 'string'
+        api.has_param :reference_id, 'string'
+        api.has_param :shipping_destinations, { list: 'hash' }
+      end
+    end
+
     has_edge :tax_settings do |edge|
       edge.get
     end