facebookbusiness 0.7.0.3 → 0.9.0.0

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -43,6 +43,7 @@ module FacebookAds
       "CANDIDATE_VIDEOS",
       "CANVAS",
       "CFC_VIDEO",
+      "CMS_MEDIA_MANAGER",
       "CONTAINED_POST_ATTACHMENT",
       "CONTAINED_POST_AUDIO_BROADCAST",
       "CONTAINED_POST_BROADCAST",
@@ -77,6 +78,7 @@ module FacebookAds
       "HEURISTIC_CLUSTER_VIDEO",
       "HEURISTIC_PREVIEW",
       "HIGHLIGHT_CLIP_VIDEO",
+      "IG_REELS_XPV",
       "IG_STORIES_READER",
       "INSPIRATION_VIDEO",
       "INSTAGRAM_VIDEO_COPY",
@@ -129,12 +131,14 @@ module FacebookAds
       "STORYLINE_WITH_EXTERNAL_MUSIC",
       "STORY_ARCHIVE_VIDEO",
       "STORY_CARD_TEMPLATE",
+      "STREAM_HIGHLIGHTS_VIDEO",
       "TAROT_DIGEST",
       "TEMP_MULTIMEDIA_POST",
       "UNLISTED",
       "VIDEO_COMMENT",
       "VIDEO_CREATIVE_EDITOR_AUTOGEN_AD_VIDEO",
       "VIDEO_SUPERRES",
+      "VU_GENERATED_VIDEO",
       "WOODHENGE",
       "WORK_KNOWLEDGE_VIDEO",
       "YOUR_DAY",
@@ -300,6 +304,7 @@ module FacebookAds
     field :replace_video_id, 'string'
     field :sales_promo_id, 'int'
     field :slideshow_spec, 'hash'
+    field :source_instagram_media_id, 'string'
     field :start_offset, 'int'
     field :swap_mode, { enum: -> { SWAP_MODE }}
     field :text_format_metadata, 'string'
@@ -380,6 +385,12 @@ module FacebookAds
       end
     end
 
+    has_edge :reactions do |edge|
+      edge.get 'Profile' do |api|
+        api.has_param :type, { enum: -> { Profile::TYPE }}
+      end
+    end
+
     has_edge :sharedposts do |edge|
       edge.get 'Post'
     end

data/lib/facebook_ads/ad_objects/adgroup_activity.rb

@@ -113,6 +113,8 @@ module FacebookAds
     field :stop_time_old, 'datetime'
     field :target_spec_id_new, 'string'
     field :target_spec_id_old, 'string'
+    field :targets_spec_new, 'object'
+    field :targets_spec_old, 'object'
     field :tracking_pixel_ids_new, { list: 'string' }
     field :tracking_pixel_ids_old, { list: 'string' }
     field :tracking_specs_new, { list: 'object' }

data/lib/facebook_ads/ad_objects/adoptable_pet.rb

@@ -35,17 +35,25 @@ module FacebookAds
     field :applinks, 'CatalogItemAppLinks'
     field :availability, 'string'
     field :breed, 'string'
+    field :category_specific_fields, 'CatalogSubVerticalList'
+    field :coat_length, 'string'
+    field :color, 'string'
     field :currency, 'string'
     field :description, 'string'
+    field :features, { list: 'string' }
     field :gender, 'string'
     field :id, 'string'
     field :images, { list: 'string' }
     field :name, 'string'
     field :price, 'string'
     field :sanitized_images, { list: 'string' }
+    field :secondary_color, 'string'
+    field :shelter_email, 'string'
     field :shelter_name, 'string'
     field :shelter_page_id, 'Page'
+    field :shelter_phone, 'string'
     field :size, 'string'
+    field :tertiary_color, 'string'
     field :url, 'string'
     has_no_post
     has_no_delete

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
@@ -242,10 +258,6 @@ module FacebookAds
 
     has_edge :business_users do |edge|
       edge.get 'BusinessUser'
-      edge.post 'BusinessUser' do |api|
-        api.has_param :email, 'string'
-        api.has_param :role, { enum: -> { BusinessUser::ROLE }}
-      end
     end
 
     has_edge :claim_custom_conversions do |edge|
@@ -285,6 +297,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 +308,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 +343,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'
@@ -354,11 +398,16 @@ module FacebookAds
       edge.get 'InstagramUser'
     end
 
+    has_edge :instagram_business_accounts do |edge|
+      edge.get 'IgUser'
+    end
+
     has_edge :managed_businesses do |edge|
       edge.delete do |api|
         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'
@@ -514,11 +570,6 @@ module FacebookAds
 
     has_edge :system_users do |edge|
       edge.get 'SystemUser'
-      edge.post 'SystemUser' do |api|
-        api.has_param :name, 'string'
-        api.has_param :role, { enum: -> { SystemUser::ROLE }}
-        api.has_param :system_user_id, 'int'
-      end
     end
 
     has_edge :third_party_measurement_report_dataset do |edge|

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'
@@ -112,7 +112,6 @@ module FacebookAds
     has_edge :reports do |edge|
       edge.get do |api|
         api.has_param :filter_by, 'string'
-        api.has_param :metric_scope, 'hash'
         api.has_param :order_by, 'string'
       end
     end

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

@@ -93,6 +93,7 @@ module FacebookAds
       "LOCAL_AWARENESS",
       "MESSAGES",
       "OFFER_CLAIMS",
+      "OUTCOME_LEADS",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
       "PRODUCT_CATALOG_SALES",
@@ -101,6 +102,11 @@ module FacebookAds
       "VIDEO_VIEWS",
     ]
 
+    SMART_PROMOTION_TYPE = [
+      "GUIDED_CREATION",
+      "SMART_APP_PROMOTION",
+    ]
+
     SPECIAL_AD_CATEGORIES = [
       "CREDIT",
       "EMPLOYMENT",
@@ -384,6 +390,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'
@@ -420,6 +427,7 @@ module FacebookAds
     field :adbatch, { list: 'object' }
     field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
     field :iterative_split_test_configs, { list: 'object' }
+    field :smart_promotion_type, { enum: -> { SMART_PROMOTION_TYPE }}
     field :upstream_events, 'hash'
 
     has_edge :ad_studies do |edge|