facebookbusiness 18.0.4 → 19.0.1

data/lib/facebook_ads/ad_objects/ads_histogram_stats.rb

@@ -45,7 +45,11 @@ module FacebookAds
     field :interactive_component_sticker_id, 'string'
     field :interactive_component_sticker_response, 'string'
     field :skan_click, { list: 'int' }
+    field :skan_click_second_postback, { list: 'int' }
+    field :skan_click_third_postback, { list: 'int' }
     field :skan_view, { list: 'int' }
+    field :skan_view_second_postback, { list: 'int' }
+    field :skan_view_third_postback, { list: 'int' }
     field :value, { list: 'int' }
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -39,6 +39,8 @@ module FacebookAds
       "action_type",
       "action_video_sound",
       "action_video_type",
+      "conversion_destination",
+      "signal_source_bucket",
       "standard_event_content_type",
     ]
 
@@ -55,6 +57,7 @@ module FacebookAds
       "body_asset",
       "call_to_action_asset",
       "coarse_conversion_value",
+      "conversion_destination",
       "country",
       "description_asset",
       "device_platform",
@@ -68,6 +71,7 @@ module FacebookAds
       "image_asset",
       "impression_device",
       "is_conversion_id_modeled",
+      "landing_destination",
       "link_url_asset",
       "marketing_messages_btn_name",
       "mdsa_landing_destination",
@@ -106,7 +110,7 @@ module FacebookAds
       "last_week_mon_sun",
       "last_week_sun_sat",
       "last_year",
-      "maximum",
+      "lifetime",
       "this_month",
       "this_quarter",
       "this_week_mon_today",
@@ -134,6 +138,8 @@ module FacebookAds
       "action_type",
       "action_video_sound",
       "action_video_type",
+      "conversion_destination",
+      "signal_source_bucket",
       "standard_event_content_type",
     ]
 

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -128,6 +128,7 @@ module FacebookAds
         api.has_param :namespace_id, 'string'
         api.has_param :partner_agent, 'string'
         api.has_param :platforms, { list: 'hash' }
+        api.has_param :progress, 'object'
         api.has_param :test_event_code, 'string'
         api.has_param :trace, 'int'
         api.has_param :upload_id, 'string'
@@ -136,10 +137,6 @@ module FacebookAds
       end
     end
 
-    has_edge :meapitocapiconsolidationhelper do |edge|
-      edge.post
-    end
-
     has_edge :offline_event_uploads do |edge|
       edge.get 'OfflineConversionDataSetUpload' do |api|
         api.has_param :end_time, 'datetime'

data/lib/facebook_ads/ad_objects/analytics_segment.rb

@@ -0,0 +1,39 @@
+# 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 AnalyticsSegment < AdObject
+
+    field :custom_audience_ineligiblity_reasons, { list: 'string' }
+    field :description, 'string'
+    field :estimated_custom_audience_size, 'int'
+    field :event_info_rules, { list: 'object' }
+    field :event_rules, { list: 'object' }
+    field :filter_set, 'string'
+    field :has_demographic_rules, 'bool'
+    field :id, 'string'
+    field :is_all_user, 'bool'
+    field :is_eligible_for_push_campaign, 'bool'
+    field :is_internal, 'bool'
+    field :name, 'string'
+    field :percentile_rules, { list: 'object' }
+    field :time_last_seen, 'int'
+    field :time_last_updated, 'int'
+    field :user_property_rules, { list: 'object' }
+    field :web_param_rules, { list: 'object' }
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/application.rb

@@ -458,6 +458,7 @@ module FacebookAds
         api.has_param :click_attr_window, 'int'
         api.has_param :custom_events, { list: 'object' }
         api.has_param :decline_reason, 'string'
+        api.has_param :engagement_type, 'string'
         api.has_param :event, 'string'
         api.has_param :event_reported_time, 'int'
         api.has_param :fb_ad_id, 'int'

data/lib/facebook_ads/ad_objects/branded_content_shadow_ig_media_id.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 BrandedContentShadowIgMediaId < AdObject
+
+    field :eligibility_errors, { list: 'string' }
+    field :id, 'string'
+    field :owner_id, 'string'
+    field :permalink, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/branded_content_shadow_ig_user_id.rb

@@ -0,0 +1,24 @@
+# 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 BrandedContentShadowIgUserId < AdObject
+
+    field :id, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/business.rb

@@ -35,6 +35,7 @@ module FacebookAds
       "LUXURY",
       "MARKETING",
       "NON_PROFIT",
+      "NOT_SET",
       "ORGANIZATIONS_AND_ASSOCIATIONS",
       "OTHER",
       "PROFESSIONAL_SERVICES",
@@ -720,7 +721,7 @@ module FacebookAds
         api.has_param :survey_num_assets, 'int'
         api.has_param :survey_num_people, 'int'
         api.has_param :timezone_id, 'int'
-        api.has_param :vertical, { enum: %w{ADVERTISING AUTOMOTIVE CONSUMER_PACKAGED_GOODS ECOMMERCE EDUCATION ENERGY_AND_UTILITIES ENTERTAINMENT_AND_MEDIA FINANCIAL_SERVICES GAMING GOVERNMENT_AND_POLITICS HEALTH LUXURY MARKETING NON_PROFIT ORGANIZATIONS_AND_ASSOCIATIONS OTHER PROFESSIONAL_SERVICES RESTAURANT RETAIL TECHNOLOGY TELECOM TRAVEL }}
+        api.has_param :vertical, { enum: %w{ADVERTISING AUTOMOTIVE CONSUMER_PACKAGED_GOODS ECOMMERCE EDUCATION ENERGY_AND_UTILITIES ENTERTAINMENT_AND_MEDIA FINANCIAL_SERVICES GAMING GOVERNMENT_AND_POLITICS HEALTH LUXURY MARKETING NON_PROFIT NOT_SET ORGANIZATIONS_AND_ASSOCIATIONS OTHER PROFESSIONAL_SERVICES RESTAURANT RETAIL TECHNOLOGY TELECOM TRAVEL }}
       end
     end
 
@@ -815,6 +816,7 @@ module FacebookAds
     has_edge :owned_product_catalogs do |edge|
       edge.get 'ProductCatalog'
       edge.post 'ProductCatalog' do |api|
+        api.has_param :additional_vertical_option, { enum: -> { ProductCatalog::ADDITIONAL_VERTICAL_OPTION }}
         api.has_param :catalog_segment_filter, 'object'
         api.has_param :catalog_segment_product_set_id, 'string'
         api.has_param :da_display_settings, 'object'
@@ -885,7 +887,6 @@ module FacebookAds
 
     has_edge :picture do |edge|
       edge.get 'ProfilePictureSource' do |api|
-        api.has_param :breaking_change, { enum: -> { ProfilePictureSource::BREAKING_CHANGE }}
         api.has_param :height, 'int'
         api.has_param :redirect, 'bool'
         api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}
@@ -911,6 +912,12 @@ module FacebookAds
       end
     end
 
+    has_edge :self_certified_whatsapp_business_submissions do |edge|
+      edge.get 'WhatsAppBusinessPartnerClientVerificationSubmission' do |api|
+        api.has_param :end_business_id, 'string'
+      end
+    end
+
     has_edge :setup_managed_partner_adaccounts do |edge|
       edge.post 'Business' do |api|
         api.has_param :credit_line_id, 'string'

data/lib/facebook_ads/ad_objects/campaign.rb

@@ -18,6 +18,7 @@ module FacebookAds
       "COST_CAP",
       "LOWEST_COST_WITHOUT_CAP",
       "LOWEST_COST_WITH_BID_CAP",
+      "LOWEST_COST_WITH_MIN_ROAS",
     ]
 
     CONFIGURED_STATUS = [
@@ -56,7 +57,7 @@ module FacebookAds
       "last_week_mon_sun",
       "last_week_sun_sat",
       "last_year",
-      "maximum",
+      "lifetime",
       "this_month",
       "this_quarter",
       "this_week_mon_today",

data/lib/facebook_ads/ad_objects/canvas.rb

@@ -44,6 +44,10 @@ module FacebookAds
     field :use_retailer_item_ids, 'bool'
     has_no_delete
 
+    has_edge :preview do |edge|
+      edge.get 'CanvasPreview'
+    end
+
     has_edge :previews do |edge|
       edge.get 'TextWithEntities' do |api|
         api.has_param :user_ids, { list: 'int' }

data/lib/facebook_ads/ad_objects/canvas_preview.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 CanvasPreview < AdObject
+
+    field :body, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb

@@ -74,13 +74,6 @@ module FacebookAds
       end
     end
 
-    has_edge :onsite_conversion_events do |edge|
-      edge.get do |api|
-        api.has_param :created_after, 'datetime'
-        api.has_param :created_before, 'datetime'
-      end
-    end
-
     has_edge :order_management_apps do |edge|
       edge.get 'Application'
       edge.post 'CommerceMerchantSettings'

data/lib/facebook_ads/ad_objects/commerce_order.rb

@@ -105,6 +105,7 @@ module FacebookAds
     has_edge :refunds do |edge|
       edge.get
       edge.post 'CommerceOrder' do |api|
+        api.has_param :adjustment_amount, 'hash'
         api.has_param :deductions, { list: 'hash' }
         api.has_param :idempotency_key, 'string'
         api.has_param :items, { list: 'hash' }

data/lib/facebook_ads/ad_objects/custom_audience.rb

@@ -158,6 +158,17 @@ module FacebookAds
       end
     end
 
+    has_edge :salts do |edge|
+      edge.get 'CustomAudienceSalts' do |api|
+        api.has_param :params, { list: 'string' }
+      end
+      edge.post 'CustomAudience' do |api|
+        api.has_param :salt, 'string'
+        api.has_param :valid_from, 'datetime'
+        api.has_param :valid_to, 'datetime'
+      end
+    end
+
     has_edge :sessions do |edge|
       edge.get 'CustomAudienceSession' do |api|
         api.has_param :session_id, 'int'

data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb

@@ -74,6 +74,7 @@ module FacebookAds
       "WEB_PIXEL_COMBINATION_EVENTS",
       "WEB_PIXEL_HITS",
       "WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS",
+      "WHATSAPP_SUBSCRIBER_POOL",
     ]
 
     TYPE = [

data/lib/facebook_ads/ad_objects/custom_audience_salts.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 CustomAudienceSalts < AdObject
+
+    field :app_id, 'int'
+    field :public_key, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/group.rb

@@ -21,9 +21,9 @@ module FacebookAds
     ]
 
     POST_PERMISSIONS = [
-      "0",
-      "1",
-      "2",
+      "ADMIN_ONLY",
+      "ANYONE",
+      "NONE",
     ]
 
     PURPOSE = [
@@ -394,7 +394,6 @@ module FacebookAds
 
     has_edge :picture do |edge|
       edge.get 'ProfilePictureSource' do |api|
-        api.has_param :breaking_change, { enum: -> { ProfilePictureSource::BREAKING_CHANGE }}
         api.has_param :height, 'int'
         api.has_param :redirect, 'bool'
         api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}

data/lib/facebook_ads/ad_objects/ig_media.rb

@@ -34,6 +34,14 @@ module FacebookAds
     field :username, 'string'
     has_no_delete
 
+    has_edge :branded_content_partner_promote do |edge|
+      edge.get 'BrandedContentShadowIgUserId'
+      edge.post 'BrandedContentShadowIgUserId' do |api|
+        api.has_param :permission, 'bool'
+        api.has_param :sponsor_id, 'int'
+      end
+    end
+
     has_edge :children do |edge|
       edge.get 'IgMedia'
     end

data/lib/facebook_ads/ad_objects/ig_user.rb

@@ -38,6 +38,34 @@ module FacebookAds
       edge.get 'UserAvailableCatalogs'
     end
 
+    has_edge :branded_content_ad_permissions do |edge|
+      edge.get 'IgbcAdsPermission'
+      edge.post 'IgbcAdsPermission' do |api|
+        api.has_param :creator_instagram_account, 'string'
+        api.has_param :revoke, 'bool'
+      end
+    end
+
+    has_edge :branded_content_advertisable_medias do |edge|
+      edge.get 'BrandedContentShadowIgMediaId' do |api|
+        api.has_param :creator_username, 'string'
+        api.has_param :only_fetch_allowlisted, 'bool'
+        api.has_param :permalinks, { list: 'string' }
+      end
+    end
+
+    has_edge :branded_content_tag_approval do |edge|
+      edge.delete do |api|
+        api.has_param :user_ids, { list: 'int' }
+      end
+      edge.get 'BrandedContentShadowIgUserId' do |api|
+        api.has_param :user_ids, { list: 'int' }
+      end
+      edge.post 'BrandedContentShadowIgUserId' do |api|
+        api.has_param :user_ids, { list: 'int' }
+      end
+    end
+
     has_edge :catalog_product_search do |edge|
       edge.get 'ShadowIgUserCatalogProductSearch' do |api|
         api.has_param :catalog_id, 'string'

data/lib/facebook_ads/ad_objects/insights_result.rb

@@ -27,7 +27,7 @@ module FacebookAds
       "last_week_mon_sun",
       "last_week_sun_sat",
       "last_year",
-      "maximum",
+      "lifetime",
       "this_month",
       "this_quarter",
       "this_week_mon_today",

data/lib/facebook_ads/ad_objects/instagram_insights_result.rb

@@ -22,15 +22,12 @@ module FacebookAds
     ]
 
     METRIC = [
-      "carousel_album_engagement",
-      "carousel_album_impressions",
-      "carousel_album_reach",
-      "carousel_album_saved",
-      "carousel_album_video_views",
+      "clips_replays_count",
       "comments",
       "engagement",
       "exits",
       "follows",
+      "ig_reels_aggregated_all_plays_count",
       "ig_reels_avg_watch_time",
       "ig_reels_video_view_total_time",
       "impressions",

data/lib/facebook_ads/ad_objects/instagram_user.rb

@@ -47,5 +47,9 @@ module FacebookAds
       end
     end
 
+    has_edge :upcoming_events do |edge|
+      edge.get
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/leadgen_form.rb

@@ -79,7 +79,7 @@ module FacebookAds
     field :questions, { list: 'LeadGenQuestion' }
     field :status, 'string'
     field :thank_you_page, 'LeadGenThankYouPage'
-    field :tracking_parameters, { list: 'hash' }
+    field :tracking_parameters, { list: 'KeyValue' }
     has_no_delete
 
     has_edge :leads do |edge|

data/lib/facebook_ads/ad_objects/page.rb

@@ -332,6 +332,7 @@ module FacebookAds
       "message_context",
       "message_deliveries",
       "message_echoes",
+      "message_edits",
       "message_mention",
       "message_reactions",
       "message_reads",
@@ -388,6 +389,7 @@ module FacebookAds
     field :app_id, 'string'
     field :artists_we_like, 'string'
     field :attire, 'string'
+    field :available_promo_offer_ids, { list: 'map<string, list<map<string, string>>>' }
     field :awards, 'string'
     field :band_interests, 'string'
     field :band_members, 'string'
@@ -436,7 +438,6 @@ module FacebookAds
     field :has_lead_access, 'HasLeadAccess'
     field :has_transitioned_to_new_page_experience, 'bool'
     field :has_whatsapp_business_number, 'bool'
-    field :has_whatsapp_enterprise_number_using_cloud_api, 'bool'
     field :has_whatsapp_number, 'bool'
     field :hometown, 'string'
     field :hours, 'hash'
@@ -480,7 +481,6 @@ module FacebookAds
     field :offer_eligible, 'bool'
     field :overall_star_rating, 'double'
     field :owner_business, 'Business'
-    field :page_about_story, 'PageAboutStory'
     field :page_token, 'string'
     field :parent_page, 'Page'
     field :parking, 'PageParking'
@@ -955,15 +955,6 @@ module FacebookAds
       edge.get 'InstagramUser'
     end
 
-    has_edge :instant_articles_stats do |edge|
-      edge.get 'InstantArticlesStats' do |api|
-        api.has_param :metrics_list, { list: 'hash' }
-        api.has_param :page_list, { list: 'string' }
-        api.has_param :since, 'datetime'
-        api.has_param :until, 'datetime'
-      end
-    end
-
     has_edge :leadgen_forms do |edge|
       edge.get 'LeadgenForm'
       edge.post 'LeadgenForm' do |api|
@@ -1266,7 +1257,6 @@ module FacebookAds
 
     has_edge :picture do |edge|
       edge.get 'ProfilePictureSource' do |api|
-        api.has_param :breaking_change, { enum: -> { ProfilePictureSource::BREAKING_CHANGE }}
         api.has_param :height, 'int'
         api.has_param :redirect, 'bool'
         api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -14,12 +14,18 @@ module FacebookAds
   # pull request for this class.
 
   class ProductCatalog < AdObject
+    ADDITIONAL_VERTICAL_OPTION = [
+      "LOCAL_DA_CATALOG",
+      "LOCAL_PRODUCTS",
+    ]
+
     VERTICAL = [
       "adoptable_pets",
       "bookable",
       "commerce",
       "destinations",
       "flights",
+      "generic",
       "home_listings",
       "hotels",
       "jobs",
@@ -97,12 +103,14 @@ module FacebookAds
     field :feed_count, 'int'
     field :id, 'string'
     field :is_catalog_segment, 'bool'
+    field :is_local_catalog, 'bool'
     field :name, 'string'
     field :owner_business, 'Business'
     field :product_count, 'int'
     field :store_catalog_settings, 'StoreCatalogSettings'
     field :user_access_expire_time, 'datetime'
     field :vertical, 'string'
+    field :additional_vertical_option, { enum: -> { ADDITIONAL_VERTICAL_OPTION }}
     field :catalog_segment_filter, 'object'
     field :catalog_segment_product_set_id, 'string'
     field :destination_catalog_settings, 'hash'
@@ -452,9 +460,6 @@ module FacebookAds
         api.has_param :material, 'string'
         api.has_param :mobile_link, 'string'
         api.has_param :name, 'string'
-        api.has_param :offer_price_amount, 'int'
-        api.has_param :offer_price_end_date, 'datetime'
-        api.has_param :offer_price_start_date, 'datetime'
         api.has_param :ordering_index, 'int'
         api.has_param :origin_country, { enum: -> { ProductItem::ORIGIN_COUNTRY }}
         api.has_param :pattern, 'string'

data/lib/facebook_ads/ad_objects/product_feed.rb

@@ -97,6 +97,7 @@ module FacebookAds
       "LANGUAGE_AND_COUNTRY",
       "LOCAL",
       "SMART_PIXEL_LANGUAGE_OR_COUNTRY",
+      "VERSION",
     ]
 
 

data/lib/facebook_ads/ad_objects/product_group.rb

@@ -70,9 +70,6 @@ module FacebookAds
         api.has_param :material, 'string'
         api.has_param :mobile_link, 'string'
         api.has_param :name, 'string'
-        api.has_param :offer_price_amount, 'int'
-        api.has_param :offer_price_end_date, 'datetime'
-        api.has_param :offer_price_start_date, 'datetime'
         api.has_param :ordering_index, 'int'
         api.has_param :pattern, 'string'
         api.has_param :price, 'int'