facebookbusiness 22.0.0 → 22.0.2

data/lib/facebook_ads/ad_objects/branded_content_shadow_ig_media_id.rb

@@ -20,6 +20,7 @@ module FacebookAds
     field :id, 'string'
     field :owner_id, 'string'
     field :permalink, 'string'
+    field :recommended_campaign_objectives, { list: 'string' }
     has_no_get
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/business.rb

@@ -64,6 +64,7 @@ module FacebookAds
       "ANALYZE",
       "CASHIER_ROLE",
       "CREATE_CONTENT",
+      "GLOBAL_STRUCTURE_MANAGEMENT",
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
@@ -583,6 +584,7 @@ module FacebookAds
       "ANALYZE",
       "CASHIER_ROLE",
       "CREATE_CONTENT",
+      "GLOBAL_STRUCTURE_MANAGEMENT",
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
@@ -977,6 +979,15 @@ module FacebookAds
       end
     end
 
+    has_edge :ads_dataset do |edge|
+      edge.post 'Business' do |api|
+        api.has_param :ad_account_id, 'string'
+        api.has_param :app_id, 'string'
+        api.has_param :is_crm, 'bool'
+        api.has_param :name, 'string'
+      end
+    end
+
     has_edge :ads_reporting_mmm_reports do |edge|
       edge.get 'AdsReportBuilderMmmReport' do |api|
         api.has_param :filtering, { list: 'hash' }
@@ -1164,12 +1175,6 @@ module FacebookAds
       end
     end
 
-    has_edge :draft_negative_keyword_lists do |edge|
-      edge.post do |api|
-        api.has_param :negative_keyword_list_file, 'file'
-      end
-    end
-
     has_edge :event_source_groups do |edge|
       edge.get 'EventSourceGroup'
       edge.post 'EventSourceGroup' do |api|
@@ -1277,8 +1282,10 @@ module FacebookAds
       end
     end
 
-    has_edge :negative_keyword_lists do |edge|
-      edge.get 'NegativeKeywordList'
+    has_edge :onboard_partners_to_mm_lite do |edge|
+      edge.post do |api|
+        api.has_param :solution_id, 'string'
+      end
     end
 
     has_edge :openbridge_configurations do |edge|
@@ -1364,6 +1371,7 @@ module FacebookAds
       edge.get 'ProductCatalog'
       edge.post 'ProductCatalog' do |api|
         api.has_param :additional_vertical_option, { enum: -> { ProductCatalog::ADDITIONAL_VERTICAL_OPTION }}
+        api.has_param :business_metadata, 'hash'
         api.has_param :catalog_segment_filter, 'object'
         api.has_param :catalog_segment_product_set_id, 'string'
         api.has_param :da_display_settings, 'object'
@@ -1402,6 +1410,10 @@ module FacebookAds
       end
     end
 
+    has_edge :passback_attribution_metadata_configs do |edge|
+      edge.get
+    end
+
     has_edge :pending_client_ad_accounts do |edge|
       edge.get 'BusinessAdAccountRequest'
     end

data/lib/facebook_ads/ad_objects/business_agreement.rb

@@ -16,6 +16,7 @@ module FacebookAds
   class BusinessAgreement < AdObject
     REQUEST_STATUS = [
       "APPROVE",
+      "CANCELED",
       "DECLINE",
       "EXPIRED",
       "IN_PROGRESS",

data/lib/facebook_ads/ad_objects/business_asset_group.rb

@@ -35,6 +35,7 @@ module FacebookAds
       "ANALYZE",
       "CASHIER_ROLE",
       "CREATE_CONTENT",
+      "GLOBAL_STRUCTURE_MANAGEMENT",
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",

data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb

@@ -16,6 +16,7 @@ module FacebookAds
   class BusinessAssetSharingAgreement < AdObject
     REQUEST_STATUS = [
       "APPROVE",
+      "CANCELED",
       "DECLINE",
       "EXPIRED",
       "IN_PROGRESS",

data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb

@@ -16,6 +16,7 @@ module FacebookAds
   class BusinessOwnedObjectOnBehalfOfRequest < AdObject
     STATUS = [
       "APPROVE",
+      "CANCELED",
       "DECLINE",
       "EXPIRED",
       "IN_PROGRESS",

data/lib/facebook_ads/ad_objects/campaign.rb

@@ -389,6 +389,7 @@ module FacebookAds
 
     field :account_id, 'string'
     field :adlabels, { list: 'AdLabel' }
+    field :advantage_state_info, 'AdCampaignGroupAdvantageState'
     field :bid_strategy, { enum: -> { BID_STRATEGY }}
     field :boosted_object_id, 'string'
     field :brand_lift_studies, { list: 'AdStudy' }

data/lib/facebook_ads/ad_objects/catalog_collection.rb

@@ -0,0 +1,27 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 CatalogCollection < AdObject
+
+    field :description, 'string'
+    field :title, 'string'
+    field :url, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/creative_multicell_test_config.rb

@@ -0,0 +1,26 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 CreativeMulticellTestConfig < AdObject
+
+    field :daily_budget, 'int'
+    field :lifetime_budget, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ctx_default_optimization_config.rb

@@ -0,0 +1,26 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 CtxDefaultOptimizationConfig < AdObject
+
+    field :objective, 'string'
+    field :optimization_goal, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audience.rb

@@ -174,6 +174,16 @@ module FacebookAds
       end
     end
 
+    has_edge :health do |edge|
+      edge.get 'CustomAudienceHealth' do |api|
+        api.has_param :calculated_date, 'string'
+        api.has_param :processed_date, 'string'
+        api.has_param :value_aggregation_duration, 'int'
+        api.has_param :value_currency, 'string'
+        api.has_param :value_version, 'int'
+      end
+    end
+
     has_edge :salts do |edge|
       edge.get 'CustomAudienceSalts' do |api|
         api.has_param :params, { list: 'string' }

data/lib/facebook_ads/ad_objects/custom_audience_health.rb

@@ -0,0 +1,25 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 CustomAudienceHealth < AdObject
+
+    field :health, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/event.rb

@@ -52,6 +52,7 @@ module FacebookAds
       "community",
       "friends",
       "group",
+      "messenger_community",
       "private",
       "public",
       "work_company",

data/lib/facebook_ads/ad_objects/home_listing.rb

@@ -81,6 +81,7 @@ module FacebookAds
     field :price, 'string'
     field :property_type, 'string'
     field :sanitized_images, { list: 'string' }
+    field :tags, { list: 'string' }
     field :unit_price, 'object'
     field :url, 'string'
     field :visibility, { enum: -> { VISIBILITY }}

data/lib/facebook_ads/ad_objects/ig_user.rb

@@ -69,6 +69,7 @@ module FacebookAds
         api.has_param :ad_code, 'string'
         api.has_param :creator_username, 'string'
         api.has_param :only_fetch_allowlisted, 'bool'
+        api.has_param :only_fetch_recommended_content, 'bool'
         api.has_param :permalinks, { list: 'string' }
       end
     end
@@ -92,6 +93,10 @@ module FacebookAds
       end
     end
 
+    has_edge :connected_threads_user do |edge|
+      edge.get 'ThreadsUser'
+    end
+
     has_edge :content_publishing_limit do |edge|
       edge.get 'ContentPublishingLimitResponse' do |api|
         api.has_param :since, 'datetime'
@@ -117,6 +122,11 @@ module FacebookAds
       end
     end
 
+    has_edge :instagram_backed_threads_user do |edge|
+      edge.get 'ThreadsUser'
+      edge.post 'ThreadsUser'
+    end
+
     has_edge :live_media do |edge|
       edge.get 'IgMedia' do |api|
         api.has_param :since, 'datetime'

data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb

@@ -136,7 +136,7 @@ module FacebookAds
       edge.delete
       edge.get
       edge.post do |api|
-        api.has_param :subscribed_fields, { list: { enum: %w{comments creator_marketplace_invited_creator_onboarding creator_marketplace_projects delta live_comments mentions message_reactions messages messaging_handover messaging_optins messaging_postbacks messaging_referral messaging_seen standby story_insights story_reactions }} }
+        api.has_param :subscribed_fields, { list: { enum: %w{comments creator_marketplace_invited_creator_onboarding creator_marketplace_projects delta live_comments mentions message_reactions messages messaging_handover messaging_optins messaging_postbacks messaging_referral messaging_seen onboarding_welcome_message_series standby story_insights story_reactions }} }
       end
     end
 
@@ -145,6 +145,9 @@ module FacebookAds
     end
 
     has_edge :welcome_message_flows do |edge|
+      edge.delete do |api|
+        api.has_param :flow_id, 'string'
+      end
       edge.get 'CtxPartnerAppWelcomeMessageFlow' do |api|
         api.has_param :app_id, 'string'
         api.has_param :flow_id, 'string'

data/lib/facebook_ads/ad_objects/insights_value.rb

@@ -21,6 +21,7 @@ module FacebookAds
     field :engagement_source, 'string'
     field :message_type, 'string'
     field :messaging_channel, 'string'
+    field :monetization_tool, 'string'
     field :recurring_notifications_entry_point, 'string'
     field :recurring_notifications_frequency, 'string'
     field :recurring_notifications_topic, 'string'

data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb

@@ -21,6 +21,8 @@ module FacebookAds
     field :chat_on_whatsapp_text, 'string'
     field :contact_information_text, 'string'
     field :creatives_overview_default_text, 'string'
+    field :custom_disclaimer_editor_state, 'string'
+    field :custom_disclaimer_title, 'string'
     field :data_privacy_policy_setting_description, 'string'
     field :default_appointment_scheduling_inline_context, 'string'
     field :default_disqualified_end_component, 'object'
@@ -43,6 +45,7 @@ module FacebookAds
     field :personal_info_text, 'string'
     field :phone_number_inline_context_text, 'string'
     field :privacy_policy_link_text, 'string'
+    field :privacy_policy_link_text_for_optional_privacy_policy, 'string'
     field :privacy_policy_title_section_title_text, 'string'
     field :privacy_setting_description, 'string'
     field :products_section_headers, { list: 'hash' }
@@ -51,6 +54,7 @@ module FacebookAds
     field :return_to_facebook_text, 'string'
     field :review_your_info_text, 'string'
     field :secure_sharing_text, 'string'
+    field :secure_sharing_text_for_optional_privacy_policy, 'string'
     field :slide_to_submit_text, 'string'
     field :social_proof_section_headers, { list: 'hash' }
     field :submit_button_text, 'string'

data/lib/facebook_ads/ad_objects/message_delivery_estimate.rb

@@ -15,6 +15,7 @@ module FacebookAds
 
   class MessageDeliveryEstimate < AdObject
     OPTIMIZATION_GOAL = [
+      "ADVERTISER_SILOED_VALUE",
       "AD_RECALL_LIFT",
       "APP_INSTALLS",
       "APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
@@ -34,6 +35,7 @@ module FacebookAds
       "OFFSITE_CONVERSIONS",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "PROFILE_AND_PAGE_ENGAGEMENT",
       "PROFILE_VISIT",
       "QUALITY_CALL",
       "QUALITY_LEAD",

data/lib/facebook_ads/ad_objects/page.rb

@@ -109,6 +109,7 @@ module FacebookAds
       "ANALYZE",
       "CASHIER_ROLE",
       "CREATE_CONTENT",
+      "GLOBAL_STRUCTURE_MANAGEMENT",
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
@@ -137,6 +138,7 @@ module FacebookAds
       "ANALYZE",
       "CASHIER_ROLE",
       "CREATE_CONTENT",
+      "GLOBAL_STRUCTURE_MANAGEMENT",
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
@@ -243,6 +245,14 @@ module FacebookAds
       "MESSENGER",
     ]
 
+    ACTIONS = [
+      "BAN_USER",
+      "BLOCK_USER",
+      "MOVE_TO_SPAM",
+      "UNBAN_USER",
+      "UNBLOCK_USER",
+    ]
+
     MODEL = [
       "ARABIC",
       "CHINESE",
@@ -1133,6 +1143,13 @@ module FacebookAds
       end
     end
 
+    has_edge :moderate_conversations do |edge|
+      edge.post 'Page' do |api|
+        api.has_param :actions, { list: { enum: -> { Page::ACTIONS }} }
+        api.has_param :user_ids, { list: 'hash' }
+      end
+    end
+
     has_edge :nlp_configs do |edge|
       edge.post 'Page' do |api|
         api.has_param :api_version, 'object'
@@ -1176,14 +1193,6 @@ module FacebookAds
       end
     end
 
-    has_edge :pass_thread_metadata do |edge|
-      edge.post 'Page' do |api|
-        api.has_param :metadata, 'string'
-        api.has_param :recipient, 'object'
-        api.has_param :target_app_id, 'int'
-      end
-    end
-
     has_edge :personas do |edge|
       edge.get 'Persona'
       edge.post 'Persona' do |api|
@@ -1369,6 +1378,10 @@ module FacebookAds
       edge.get 'CommerceMerchantSettingsSetupStatus'
     end
 
+    has_edge :store_locations do |edge|
+      edge.get 'StoreLocation'
+    end
+
     has_edge :stories do |edge|
       edge.get 'Stories' do |api|
         api.has_param :since, 'datetime'

data/lib/facebook_ads/ad_objects/page_call_to_action.rb

@@ -56,6 +56,7 @@ module FacebookAds
       "CHARITY_DONATE",
       "CHECK_IN",
       "CONTACT_US",
+      "CREATOR_STOREFRONT",
       "DONATE_NOW",
       "EMAIL",
       "FOLLOW_PAGE",

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -108,6 +108,7 @@ module FacebookAds
     field :user_access_expire_time, 'datetime'
     field :vertical, 'string'
     field :additional_vertical_option, { enum: -> { ADDITIONAL_VERTICAL_OPTION }}
+    field :business_metadata, 'hash'
     field :catalog_segment_filter, 'object'
     field :catalog_segment_product_set_id, 'string'
     field :destination_catalog_settings, 'hash'

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -390,6 +390,7 @@ module FacebookAds
       "ITEM_PRICE_NOT_POSITIVE",
       "ITEM_STALE_OUT_OF_STOCK",
       "MARKETPLACE_DISABLED_BY_USER",
+      "MARKETPLACE_PARTNER_AUCTION_NO_BID_CLOSE_TIME",
       "MARKETPLACE_PARTNER_LISTING_LIMIT_EXCEEDED",
       "MARKETPLACE_PARTNER_NOT_LOCAL_ITEM",
       "MARKETPLACE_PARTNER_NOT_SHIPPED_ITEM",
@@ -792,6 +793,7 @@ module FacebookAds
     field :product_feed, 'ProductFeed'
     field :product_group, 'ProductGroup'
     field :product_local_info, 'ProductItemLocalInfo'
+    field :product_relationship, 'string'
     field :product_type, 'string'
     field :quantity_to_sell_on_facebook, 'int'
     field :retailer_id, 'string'

data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb

@@ -17,6 +17,10 @@ module FacebookAds
 
     field :australia_finserv_beneficiary, 'string'
     field :australia_finserv_payer, 'string'
+    field :india_finserv_beneficiary, 'string'
+    field :india_finserv_payer, 'string'
+    field :singapore_universal_beneficiary, 'string'
+    field :singapore_universal_payer, 'string'
     field :taiwan_finserv_beneficiary, 'string'
     field :taiwan_finserv_payer, 'string'
     field :taiwan_universal_beneficiary, 'string'

data/lib/facebook_ads/ad_objects/server_side/attribution_data.rb

@@ -46,6 +46,9 @@ module FacebookAds
         # Attribution woindow in days.
         attr_accessor :attr_window
 
+        # The share of value generated by this click-conversion pair that is attributed to Meta.
+        attr_accessor :attribution_value
+
 
 
         # @param [String] scope
@@ -56,7 +59,8 @@ module FacebookAds
         # @param [Float] attribution_share
         # @param [String] attribution_model
         # @param [String] attr_window
-        def initialize(scope: nil, visit_time: nil, ad_id: nil, adset_id: nil, campaign_id: nil, attribution_share: nil, attribution_model: nil, attr_window: nil)
+        # @param [Float] attribution_value
+        def initialize(scope: nil, visit_time: nil, ad_id: nil, adset_id: nil, campaign_id: nil, attribution_share: nil, attribution_model: nil, attr_window: nil, attribution_value: nil)
           unless scope.nil?
             self.scope = scope
           end
@@ -81,6 +85,9 @@ module FacebookAds
           unless attr_window.nil?
             self.attr_window = attr_window
           end
+          unless attribution_value.nil?
+            self.attribution_value = attribution_value
+          end
         end
 
         # build the object using the input hash
@@ -122,6 +129,10 @@ module FacebookAds
           if attributes.has_key?(:'attr_window')
             self.attr_window = attributes[:'attr_window']
           end
+
+          if attributes.has_key?(:'attribution_value')
+            self.attribution_share = attributes[:'attribution_value']
+          end
         end
 
         # Checks equality by comparing each attribute.
@@ -135,7 +146,8 @@ module FacebookAds
               campaign_id == o.campaign_id &&
               attribution_share == o.attribution_share &&
               attribution_model == o.attribution_model &&
-              attr_window == o.attr_window
+              attr_window == o.attr_window &&
+              attribution_value == o.attribution_value
         end
 
         # @see the `==` method
@@ -147,7 +159,7 @@ module FacebookAds
         # @return [Fixnum] Hash code
         def hash
           [
-            scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window
+            scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window, attribution_value
           ].hash
         end
 
@@ -177,6 +189,9 @@ module FacebookAds
           unless attr_window.nil?
             hash['attr_window'] = attr_window
           end
+          unless attribution_value.nil?
+            hash['attribution_value'] = attribution_value
+          end
           hash.to_s
         end
 
@@ -208,6 +223,9 @@ module FacebookAds
           unless attr_window.nil?
             hash['attr_window'] = attr_window
           end
+          unless attribution_value.nil?
+            hash['attribution_value'] = attribution_value
+          end
           hash
         end
 

data/lib/facebook_ads/ad_objects/server_side/custom_data.rb

@@ -25,6 +25,10 @@ module FacebookAds
       # Example: 142.54.
       attr_accessor :value
 
+      # A numeric net_revenue associated with this event. This could be a monetary net_revenue or a net_revenue in some other metric.
+      # Example: 30.54.
+      attr_accessor :net_revenue
+
       # The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code.
       # Example: 'usd'.
       attr_accessor :currency
@@ -83,6 +87,7 @@ module FacebookAds
 
 
       # @param [Float] value
+      # @param [Float] net_revenue
       # @param [String] currency
       # @param [String] content_name
       # @param [String] content_category
@@ -98,6 +103,7 @@ module FacebookAds
       # @param [String] item_number
       # @param [String] custom_properties
       def initialize(value: nil,
+                     net_revenue: nil,
                      currency: nil,
                      content_name: nil,
                      content_category: nil,
@@ -116,6 +122,9 @@ module FacebookAds
         unless value.nil?
           self.value = value
         end
+        unless net_revenue.nil?
+          self.net_revenue = net_revenue
+        end
         unless currency.nil?
           self.currency = currency
         end
@@ -173,6 +182,10 @@ module FacebookAds
           self.value = attributes[:'value']
         end
 
+        if attributes.has_key?(:'net_revenue')
+          self.net_revenue = attributes[:'net_revenue']
+        end
+
         if attributes.has_key?(:'currency')
           self.currency = attributes[:'currency']
         end
@@ -239,6 +252,7 @@ module FacebookAds
         return true if self.equal?(o)
         self.class == o.class &&
             value == o.value &&
+            net_revenue == o.net_revenue &&
             currency == o.currency &&
             content_name == o.content_name &&
             content_category == o.content_category &&
@@ -265,6 +279,7 @@ module FacebookAds
       def hash
         [
             value,
+            net_revenue,
             currency,
             content_name,
             content_category,
@@ -289,6 +304,9 @@ module FacebookAds
         unless value.nil?
           hash['value'] = value
         end
+        unless net_revenue.nil?
+          hash['net_revenue'] = net_revenue
+        end
         unless currency.nil?
           hash['currency'] = currency
         end
@@ -342,6 +360,9 @@ module FacebookAds
         unless value.nil?
           hash['value'] = value
         end
+        unless net_revenue.nil?
+          hash['net_revenue'] = net_revenue
+        end
         unless currency.nil?
           hash['currency'] = FacebookAds::ServerSide::Util.normalize(currency, 'currency')
         end