facebookbusiness 19.0.2 → 20.0.0

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb

@@ -17,15 +17,20 @@ module FacebookAds
     CALL_TO_ACTION_TYPES = [
       "ADD_TO_CART",
       "APPLY_NOW",
+      "ASK_ABOUT_SERVICES",
+      "ASK_FOR_MORE_INFO",
       "AUDIO_CALL",
+      "BOOK_A_CONSULTATION",
       "BOOK_NOW",
       "BOOK_TRAVEL",
       "BUY",
       "BUY_NOW",
       "BUY_TICKETS",
+      "BUY_VIA_MESSAGE",
       "CALL",
       "CALL_ME",
       "CALL_NOW",
+      "CHAT_WITH_US",
       "CONFIRM",
       "CONTACT",
       "CONTACT_US",
@@ -38,6 +43,7 @@ module FacebookAds
       "FOLLOW_NEWS_STORYLINE",
       "FOLLOW_PAGE",
       "FOLLOW_USER",
+      "GET_A_QUOTE",
       "GET_DIRECTIONS",
       "GET_OFFER",
       "GET_OFFER_VIEW",
@@ -53,6 +59,7 @@ module FacebookAds
       "LIKE_PAGE",
       "LISTEN_MUSIC",
       "LISTEN_NOW",
+      "MAKE_AN_APPOINTMENT",
       "MESSAGE_PAGE",
       "MOBILE_DOWNLOAD",
       "NO_BUTTON",
@@ -86,6 +93,7 @@ module FacebookAds
       "USE_MOBILE_APP",
       "VIDEO_ANNOTATION",
       "VIDEO_CALL",
+      "VIEW_PRODUCT",
       "VISIT_PAGES_FEED",
       "WATCH_MORE",
       "WATCH_VIDEO",
@@ -112,9 +120,11 @@ module FacebookAds
     field :message_extensions, { list: 'AdAssetMessageExtensions' }
     field :onsite_destinations, { list: 'AdAssetOnsiteDestinations' }
     field :optimization_type, 'string'
+    field :promotional_metadata, 'object'
     field :reasons_to_shop, 'bool'
     field :shops_bundle, 'bool'
     field :titles, { list: 'AdAssetFeedSpecTitle' }
+    field :upcoming_events, { list: 'object' }
     field :videos, { list: 'AdAssetFeedSpecVideo' }
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb

@@ -34,6 +34,7 @@ module FacebookAds
       "OFFSITE_CONVERSIONS",
       "PAGE_LIKES",
       "POST_ENGAGEMENT",
+      "PROFILE_VISIT",
       "QUALITY_CALL",
       "QUALITY_LEAD",
       "REACH",

data/lib/facebook_ads/ad_objects/ad_campaign_delivery_stats.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 AdCampaignDeliveryStats < AdObject
+
+    field :bid_recommendation, 'int'
+    field :current_average_cost, 'double'
+    field :last_significant_edit_ts, 'int'
+    field :learning_stage_exit_info, 'object'
+    field :learning_stage_info, 'AdCampaignLearningStageInfo'
+    field :unsupported_features, { list: 'hash' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_campaign_group_incremental_conversion_optimization_config.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 AdCampaignGroupIncrementalConversionOptimizationConfig < AdObject
+
+    field :action_type, 'string'
+    field :ad_study_end_time, 'datetime'
+    field :ad_study_id, 'string'
+    field :ad_study_name, 'string'
+    field :ad_study_start_time, 'datetime'
+    field :cell_id, 'string'
+    field :cell_name, 'string'
+    field :holdout_size, 'double'
+    field :ico_type, 'string'
+    field :objectives, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_campaign_group_metrics_metadata.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 AdCampaignGroupMetricsMetadata < AdObject
+
+    field :budget_optimization, { list: 'string' }
+    field :duplication_flow_tips, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_campaign_group_stats.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 AdCampaignGroupStats < AdObject
+
+    field :actions, 'hash'
+    field :campaign_group_id, 'string'
+    field :clicks, 'int'
+    field :end_time, 'datetime'
+    field :impressions, 'int'
+    field :inline_actions, 'hash'
+    field :social_clicks, 'int'
+    field :social_impressions, 'int'
+    field :social_spent, 'int'
+    field :social_unique_clicks, 'int'
+    field :social_unique_impressions, 'int'
+    field :spent, 'int'
+    field :start_time, 'datetime'
+    field :unique_clicks, 'int'
+    field :unique_impressions, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/{page_saved_filter.rb → ad_campaign_group_structure_tree.rb}

@@ -13,15 +13,13 @@ module FacebookAds
   # on github and we'll fix in our codegen framework. We'll not be able to accept
   # pull request for this class.
 
-  class PageSavedFilter < AdObject
+  class AdCampaignGroupStructureTree < AdObject
 
-    field :display_name, 'string'
-    field :filters, { list: 'object' }
+    field :children, { list: 'AdCampaignGroupStructureTree' }
     field :id, 'string'
-    field :page_id, 'string'
-    field :section, 'string'
-    field :time_created, 'int'
+    field :name, 'string'
     field :time_updated, 'int'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_campaign_metrics_metadata.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 AdCampaignMetricsMetadata < AdObject
+
+    field :boosted_component_optimization, { list: 'string' }
+    field :creation_flow_tips, { list: 'string' }
+    field :default_opted_in_placements, { list: 'object' }
+    field :delivery_growth_optimizations, { list: 'object' }
+    field :duplication_flow_tips, { list: 'string' }
+    field :edit_flow_tips, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_campaign_multi_ads.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 AdCampaignMultiAds < AdObject
+
+    field :enroll_status, 'string'
+    field :source_type, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_campaign_stats.rb

@@ -0,0 +1,47 @@
+# 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 AdCampaignStats < AdObject
+
+    field :account_id, 'string'
+    field :actions, 'object'
+    field :adgroup_id, 'string'
+    field :campaign_id, 'string'
+    field :campaign_ids, { list: 'string' }
+    field :clicks, 'int'
+    field :end_time, 'object'
+    field :id, 'string'
+    field :impressions, 'string'
+    field :inline_actions, 'hash'
+    field :io_number, 'int'
+    field :is_completed, 'bool'
+    field :line_number, 'int'
+    field :newsfeed_position, 'object'
+    field :social_clicks, 'int'
+    field :social_impressions, 'string'
+    field :social_spent, 'int'
+    field :social_unique_clicks, 'int'
+    field :social_unique_impressions, 'string'
+    field :spent, 'int'
+    field :start_time, 'object'
+    field :topline_id, 'string'
+    field :unique_clicks, 'int'
+    field :unique_impressions, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_column_sizes.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 AdColumnSizes < AdObject
+
+    field :admarket_account, 'AdAccount'
+    field :app_id, 'string'
+    field :columns, { list: 'hash' }
+    field :id, 'string'
+    field :owner, 'User'
+    field :page, 'string'
+    field :report, 'string'
+    field :tab, 'string'
+    field :view, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_contract.rb

@@ -0,0 +1,65 @@
+# 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 AdContract < AdObject
+
+    field :account_id, 'string'
+    field :account_mgr_fbid, 'string'
+    field :account_mgr_name, 'string'
+    field :adops_person_name, 'string'
+    field :advertiser_address_fbid, 'string'
+    field :advertiser_fbid, 'string'
+    field :advertiser_name, 'string'
+    field :agency_discount, 'double'
+    field :agency_name, 'string'
+    field :bill_to_address_fbid, 'string'
+    field :bill_to_fbid, 'string'
+    field :campaign_name, 'string'
+    field :created_by, 'string'
+    field :created_date, 'int'
+    field :customer_io, 'string'
+    field :io_number, 'int'
+    field :io_terms, 'string'
+    field :io_type, 'string'
+    field :last_updated_by, 'string'
+    field :last_updated_date, 'int'
+    field :max_end_date, 'int'
+    field :mdc_fbid, 'string'
+    field :media_plan_number, 'string'
+    field :min_start_date, 'int'
+    field :msa_contract, 'string'
+    field :payment_terms, 'string'
+    field :rev_hold_flag, 'bool'
+    field :rev_hold_released_by, 'int'
+    field :rev_hold_released_on, 'int'
+    field :salesrep_fbid, 'string'
+    field :salesrep_name, 'string'
+    field :sold_to_address_fbid, 'string'
+    field :sold_to_fbid, 'string'
+    field :status, 'string'
+    field :subvertical, 'string'
+    field :thirdparty_billed, 'int'
+    field :thirdparty_uid, 'string'
+    field :thirdparty_url, 'string'
+    field :vat_country, 'string'
+    field :version, 'int'
+    field :vertical, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_conversion_values.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 AdConversionValues < AdObject
+
+    field :adgroup_id, 'string'
+    field :campaign_id, 'string'
+    field :values, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_conversions.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 AdConversions < AdObject
+
+    field :account_id, 'string'
+    field :adgroup_id, 'string'
+    field :campaign_id, 'string'
+    field :values, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_creation_package_config.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 AdCreationPackageConfig < AdObject
+
+    field :api_version, 'string'
+    field :id, 'string'
+    field :is_eligible_for_default_opt_in, 'bool'
+    field :objective, 'string'
+    field :package_id, 'string'
+    field :status, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_creative.rb

@@ -17,15 +17,20 @@ module FacebookAds
     CALL_TO_ACTION_TYPE = [
       "ADD_TO_CART",
       "APPLY_NOW",
+      "ASK_ABOUT_SERVICES",
+      "ASK_FOR_MORE_INFO",
       "AUDIO_CALL",
+      "BOOK_A_CONSULTATION",
       "BOOK_NOW",
       "BOOK_TRAVEL",
       "BUY",
       "BUY_NOW",
       "BUY_TICKETS",
+      "BUY_VIA_MESSAGE",
       "CALL",
       "CALL_ME",
       "CALL_NOW",
+      "CHAT_WITH_US",
       "CONFIRM",
       "CONTACT",
       "CONTACT_US",
@@ -38,6 +43,7 @@ module FacebookAds
       "FOLLOW_NEWS_STORYLINE",
       "FOLLOW_PAGE",
       "FOLLOW_USER",
+      "GET_A_QUOTE",
       "GET_DIRECTIONS",
       "GET_OFFER",
       "GET_OFFER_VIEW",
@@ -53,6 +59,7 @@ module FacebookAds
       "LIKE_PAGE",
       "LISTEN_MUSIC",
       "LISTEN_NOW",
+      "MAKE_AN_APPOINTMENT",
       "MESSAGE_PAGE",
       "MOBILE_DOWNLOAD",
       "NO_BUTTON",
@@ -86,6 +93,7 @@ module FacebookAds
       "USE_MOBILE_APP",
       "VIDEO_ANNOTATION",
       "VIDEO_CALL",
+      "VIEW_PRODUCT",
       "VISIT_PAGES_FEED",
       "WATCH_MORE",
       "WATCH_VIDEO",
@@ -168,6 +176,7 @@ module FacebookAds
     field :categorization_criteria, 'string'
     field :category_media_source, 'string'
     field :collaborative_ads_lsb_image_bank_id, 'string'
+    field :contextual_multi_ads, 'AdCreativeContextualMultiAds'
     field :creative_sourcing_spec, 'AdCreativeSourcingSpec'
     field :degrees_of_freedom_spec, 'AdCreativeDegreesOfFreedomSpec'
     field :destination_set_id, 'string'
@@ -193,7 +202,6 @@ module FacebookAds
     field :link_destination_display_url, 'string'
     field :link_og_id, 'string'
     field :link_url, 'string'
-    field :messenger_sponsored_message, 'string'
     field :name, 'string'
     field :object_id, 'string'
     field :object_store_url, 'string'
@@ -202,6 +210,7 @@ module FacebookAds
     field :object_type, { enum: -> { OBJECT_TYPE }}
     field :object_url, 'string'
     field :omnichannel_link_spec, 'AdCreativeOmnichannelLinkSpec'
+    field :page_welcome_message, 'string'
     field :photo_album_source_object_story_id, 'string'
     field :place_page_set_id, 'string'
     field :platform_customizations, 'AdCreativePlatformCustomization'

data/lib/facebook_ads/ad_objects/ad_creative_asset_groups_spec.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 AdCreativeAssetGroupsSpec < AdObject
+
+    field :groups, { list: 'object' }
+    field :origin, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads.rb

@@ -16,7 +16,9 @@ module FacebookAds
   class AdCreativeBrandedContentAds < AdObject
 
     field :ad_format, 'int'
+    field :content_search_input, 'string'
     field :creator_ad_permission_type, 'string'
+    field :facebook_boost_post_access_token, 'string'
     field :instagram_boost_post_access_token, 'string'
     field :is_mca_internal, 'bool'
     field :partners, { list: 'AdCreativeBrandedContentAdsPartners' }

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

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