facebookbusiness 19.0.3 → 20.0.0

data/lib/facebook_ads/ad_objects/ad_limits_enforcement_data.rb

@@ -0,0 +1,30 @@
+# 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 AdLimitsEnforcementData < AdObject
+
+    field :ad_limit_on_page, 'int'
+    field :ad_limit_on_scope, 'int'
+    field :ad_volume_on_page, 'int'
+    field :ad_volume_on_scope, 'int'
+    field :is_admin, 'bool'
+    field :page_name, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_network_analytics_async_query_export.rb

@@ -0,0 +1,28 @@
+# 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 AdNetworkAnalyticsAsyncQueryExport < AdObject
+
+    field :error, 'object'
+    field :export_link, 'string'
+    field :query_id, 'string'
+    field :status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_preview.rb

@@ -23,6 +23,7 @@ module FacebookAds
       "DESKTOP_FEED_STANDARD",
       "FACEBOOK_PROFILE_FEED_DESKTOP",
       "FACEBOOK_PROFILE_FEED_MOBILE",
+      "FACEBOOK_PROFILE_REELS_MOBILE",
       "FACEBOOK_REELS_BANNER",
       "FACEBOOK_REELS_BANNER_DESKTOP",
       "FACEBOOK_REELS_MOBILE",

data/lib/facebook_ads/ad_objects/ad_proposal.rb

@@ -0,0 +1,41 @@
+# 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 AdProposal < AdObject
+
+    field :ad_proposal_type_name, 'string'
+    field :adaccount, 'AdAccount'
+    field :creation_time, 'datetime'
+    field :creator, 'User'
+    field :delivery_interface, 'string'
+    field :expiration_time, 'datetime'
+    field :has_conflict, 'bool'
+    field :id, 'string'
+    field :kpi_metric, 'string'
+    field :message, 'string'
+    field :name, 'string'
+    field :proposal_dts_template, 'string'
+    field :proposal_template_name, 'string'
+    field :recommendation, 'string'
+    field :review_time, 'datetime'
+    field :reviewed_by, 'User'
+    field :send_time, 'datetime'
+    field :status, 'string'
+    field :use_testing, 'bool'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_recommendation.rb

@@ -34,6 +34,7 @@ module FacebookAds
     field :message, 'string'
     field :recommendation_data, 'AdRecommendationData'
     field :title, 'string'
+    field :value, 'string'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/ad_rule_history.rb

@@ -19,11 +19,14 @@ module FacebookAds
       "CHANGED_BID",
       "CHANGED_BUDGET",
       "EMAIL",
+      "ENABLE_ADVANTAGE_CAMPAIGN_BUDGET",
       "ENABLE_ADVANTAGE_PLUS_CREATIVE",
       "ENABLE_ADVANTAGE_PLUS_PLACEMENTS",
       "ENABLE_AUTOFLOW",
       "ENABLE_GEN_UNCROP",
+      "ENABLE_MUSIC",
       "ENABLE_SEMANTIC_BASED_AUDIENCE_EXPANSION",
+      "ENABLE_SHOPS_ADS",
       "ENDPOINT_PINGED",
       "ERROR",
       "FACEBOOK_NOTIFICATION_SENT",

data/lib/facebook_ads/ad_objects/ad_saved_keywords.rb

@@ -0,0 +1,29 @@
+# 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 AdSavedKeywords < AdObject
+
+    field :account, 'AdAccount'
+    field :id, 'string'
+    field :keywords, 'AdKeywords'
+    field :name, 'string'
+    field :run_status, 'string'
+    field :time_created, 'datetime'
+    field :time_updated, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_saved_location.rb

@@ -0,0 +1,32 @@
+# 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 AdSavedLocation < AdObject
+
+    field :cities, { list: 'TargetingGeoLocationCity' }
+    field :countries, { list: 'string' }
+    field :country_groups, { list: 'string' }
+    field :custom_locations, { list: 'TargetingGeoLocationCustomLocation' }
+    field :geo_markets, { list: 'TargetingGeoLocationMarket' }
+    field :id, 'string'
+    field :location_sentences, { list: 'string' }
+    field :name, 'string'
+    field :regions, { list: 'TargetingGeoLocationRegion' }
+    field :zips, { list: 'TargetingGeoLocationZip' }
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_saved_report.rb

@@ -0,0 +1,40 @@
+# 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 AdSavedReport < AdObject
+
+    field :app_owner, 'Application'
+    field :breakdowns, { list: 'string' }
+    field :builtin_column_set, 'string'
+    field :creation_source, 'string'
+    field :date_interval, 'object'
+    field :date_preset, 'string'
+    field :format_version, 'int'
+    field :id, 'string'
+    field :insights_section, 'object'
+    field :is_shared_unread, 'bool'
+    field :level, 'string'
+    field :name, 'string'
+    field :normalized_filter, { list: 'string' }
+    field :sort, { list: 'object' }
+    field :user_attribution_windows, { list: 'string' }
+    field :user_columns, { list: 'string' }
+    field :user_filter, { list: 'string' }
+    field :user_owner, 'User'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_set.rb

@@ -72,6 +72,7 @@ module FacebookAds
       "OFFSITE_CONVERSIONS",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "PROFILE_VISIT",
       "QUALITY_CALL",
       "QUALITY_LEAD",
       "REACH",
@@ -117,6 +118,7 @@ module FacebookAds
       "APPLINKS_AUTOMATIC",
       "FACEBOOK",
       "INSTAGRAM_DIRECT",
+      "INSTAGRAM_PROFILE",
       "MESSAGING_INSTAGRAM_DIRECT_MESSENGER",
       "MESSAGING_INSTAGRAM_DIRECT_MESSENGER_WHATSAPP",
       "MESSAGING_INSTAGRAM_DIRECT_WHATSAPP",
@@ -128,7 +130,6 @@ module FacebookAds
       "ON_POST",
       "ON_VIDEO",
       "SHOP_AUTOMATIC",
-      "UNDEFINED",
       "WEBSITE",
       "WHATSAPP",
     ]
@@ -164,6 +165,11 @@ module FacebookAds
       "VIDEO_SOUND_ON",
     ]
 
+    REGIONAL_REGULATED_CATEGORIES = [
+      "0",
+      "1",
+    ]
+
     TUNE_FOR_CATEGORY = [
       "CREDIT",
       "EMPLOYMENT",
@@ -233,7 +239,8 @@ module FacebookAds
     field :promoted_object, 'AdPromotedObject'
     field :recommendations, { list: 'AdRecommendation' }
     field :recurring_budget_semantics, 'bool'
-    field :regional_regulation_identities, 'object'
+    field :regional_regulated_categories, { list: 'string' }
+    field :regional_regulation_identities, 'RegionalRegulationIdentities'
     field :review_feedback, 'string'
     field :rf_prediction_id, 'string'
     field :source_adset, 'AdSet'

data/lib/facebook_ads/ad_objects/ad_study.rb

@@ -15,6 +15,7 @@ module FacebookAds
 
   class AdStudy < AdObject
     TYPE = [
+      "BACKEND_AB_TESTING",
       "CONTINUOUS_LIFT_CONFIG",
       "GEO_LIFT",
       "LIFT",

data/lib/facebook_ads/ad_objects/ad_topline.rb

@@ -0,0 +1,57 @@
+# 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 AdTopline < AdObject
+
+    field :account_id, 'string'
+    field :client_approval_date, 'datetime'
+    field :created_by, 'string'
+    field :created_date, 'datetime'
+    field :description, 'string'
+    field :flight_end_date, 'datetime'
+    field :flight_start_date, 'datetime'
+    field :func_cap_amount, 'string'
+    field :func_cap_amount_with_offset, 'string'
+    field :func_line_amount, 'string'
+    field :func_line_amount_with_offset, 'string'
+    field :func_price, 'string'
+    field :func_price_with_offset, 'string'
+    field :gender, 'string'
+    field :id, 'string'
+    field :impressions, 'int'
+    field :io_number, 'int'
+    field :is_bonus_line, 'int'
+    field :keywords, 'string'
+    field :last_updated_by, 'string'
+    field :last_updated_date, 'datetime'
+    field :line_number, 'int'
+    field :line_position, 'int'
+    field :line_type, 'string'
+    field :location, 'string'
+    field :max_age, 'string'
+    field :max_budget, 'string'
+    field :min_age, 'string'
+    field :price_per_trp, 'string'
+    field :product_type, 'string'
+    field :rev_assurance_approval_date, 'datetime'
+    field :targets, 'string'
+    field :trp_updated_time, 'int'
+    field :trp_value, 'string'
+    field :uom, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_topline_detail.rb

@@ -0,0 +1,36 @@
+# 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 AdToplineDetail < AdObject
+
+    field :active_status, 'int'
+    field :ad_account_id, 'string'
+    field :flight_end_date, 'datetime'
+    field :flight_start_date, 'datetime'
+    field :id, 'string'
+    field :io_number, 'int'
+    field :line_number, 'int'
+    field :price, 'double'
+    field :quantity, 'double'
+    field :sf_detail_line_id, 'string'
+    field :subline_id, 'string'
+    field :targets, 'string'
+    field :time_created, 'datetime'
+    field :time_updated, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_video.rb

@@ -28,6 +28,7 @@ module FacebookAds
       "APP_REREVIEW_SCREENCAST",
       "APP_REVIEW_SCREENCAST",
       "ASSET_MANAGER",
+      "ATLAS_VIDEO",
       "AUDIO_BRIEF",
       "AUDIO_BROADCAST",
       "AUDIO_COMMENT",
@@ -166,7 +167,6 @@ module FacebookAds
       "SOUNDBITES_VIDEO",
       "SOUND_PLATFORM_STREAM",
       "SRT_ATTACHMENT",
-      "STAGES_BROADCAST",
       "STORIES_VIDEO",
       "STORIES_WEARABLE",
       "STORYLINE",
@@ -178,7 +178,6 @@ module FacebookAds
       "TEMPORARY_UNLISTED",
       "TEMP_MULTIMEDIA_POST",
       "UNLISTED",
-      "UNLISTED_HACK_TV",
       "UNLISTED_HORIZON",
       "UNLISTED_OCULUS",
       "VIDEO_COMMENT",
@@ -294,7 +293,7 @@ module FacebookAds
 
     field :ad_breaks, { list: 'int' }
     field :admin_creator, 'User'
-    field :audio_isrc, 'object'
+    field :audio_isrc, 'AudioIsrc'
     field :backdated_time, 'datetime'
     field :backdated_time_granularity, 'string'
     field :content_category, 'string'
@@ -338,7 +337,6 @@ module FacebookAds
     field :universal_video_id, 'string'
     field :updated_time, 'datetime'
     field :views, 'int'
-    field :adaptive_type, 'string'
     field :animated_effect_id, 'int'
     field :application_id, 'string'
     field :asked_fun_fact_prompt_id, 'int'
@@ -383,7 +381,6 @@ module FacebookAds
     field :original_fov, 'int'
     field :original_projection_type, { enum: -> { ORIGINAL_PROJECTION_TYPE }}
     field :publish_event_id, 'int'
-    field :react_mode_metadata, 'string'
     field :referenced_sticker_id, 'string'
     field :replace_video_id, 'string'
     field :slideshow_spec, 'hash'
@@ -489,7 +486,7 @@ module FacebookAds
     end
 
     has_edge :tags do |edge|
-      edge.get
+      edge.get 'TaggableSubject'
       edge.post 'AdVideo' do |api|
         api.has_param :tag_uid, 'int'
         api.has_param :uid, 'int'

data/lib/facebook_ads/ad_objects/ad_volume.rb

@@ -0,0 +1,34 @@
+# 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 AdVolume < AdObject
+
+    field :ad_volume_break_down, { list: 'object' }
+    field :ads_running_or_in_review_count, 'int'
+    field :future_limit_activation_date, 'string'
+    field :future_limit_on_ads_running_or_in_review, 'int'
+    field :individual_accounts_ad_volume, 'int'
+    field :is_gpa_page, 'bool'
+    field :limit_on_ads_running_or_in_review, 'int'
+    field :owning_business_ad_volume, 'int'
+    field :partner_business_ad_volume, 'int'
+    field :user_role, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/adgroup_facebook_feedback.rb

@@ -0,0 +1,31 @@
+# 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 AdgroupFacebookFeedback < AdObject
+
+    field :id, 'string'
+    field :preview, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+    has_edge :comments do |edge|
+      edge.get 'Comment' do |api|
+        api.has_param :order, { enum: -> { Comment::ORDER }}
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/adjacent_content_delivery_report.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 AdjacentContentDeliveryReport < AdObject
+
+    field :content, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/adoptable_pet.rb

@@ -0,0 +1,77 @@
+# 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 AdoptablePet < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
+    VISIBILITY = [
+      "PUBLISHED",
+      "STAGING",
+    ]
+
+
+    field :adoptable_pet_id, 'string'
+    field :adoption_application_form_url, 'string'
+    field :age_bucket, 'string'
+    field :animal_type, 'string'
+    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 :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
+    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'
+    field :visibility, { enum: -> { VISIBILITY }}
+    has_no_post
+    has_no_delete
+
+    has_edge :augmented_realities_metadata do |edge|
+      edge.get 'DynamicArMetadata'
+    end
+
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
+    has_edge :videos_metadata do |edge|
+      edge.get 'DynamicVideoMetadata'
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_action_stats.rb

@@ -16,12 +16,26 @@ module FacebookAds
   class AdsActionStats < AdObject
 
     field :_1d_click, 'string'
+    field :_1d_click_all_conversions, 'string'
+    field :_1d_click_first_conversion, 'string'
     field :_1d_ev, 'string'
+    field :_1d_ev_all_conversions, 'string'
+    field :_1d_ev_first_conversion, 'string'
     field :_1d_view, 'string'
+    field :_1d_view_all_conversions, 'string'
+    field :_1d_view_first_conversion, 'string'
     field :_28d_click, 'string'
+    field :_28d_click_all_conversions, 'string'
+    field :_28d_click_first_conversion, 'string'
     field :_28d_view, 'string'
+    field :_28d_view_all_conversions, 'string'
+    field :_28d_view_first_conversion, 'string'
     field :_7d_click, 'string'
+    field :_7d_click_all_conversions, 'string'
+    field :_7d_click_first_conversion, 'string'
     field :_7d_view, 'string'
+    field :_7d_view_all_conversions, 'string'
+    field :_7d_view_first_conversion, 'string'
     field :action_brand, 'string'
     field :action_canvas_component_id, 'string'
     field :action_canvas_component_name, 'string'

data/lib/facebook_ads/ad_objects/ads_anomaly_detection.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 AdsAnomalyDetection < AdObject
+
+    field :anomaly_data, { list: 'object' }
+    field :day, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end