facebookbusiness 0.12.0.1 → 21.0.0

data/lib/facebook_ads/ad_objects/ads_targeting_insights.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 AdsTargetingInsights < AdObject
+
+    field :audience_size, 'int'
+    field :clicks, 'int'
+    field :conversion_cost, 'double'
+    field :conversions, 'int'
+    field :description, 'string'
+    field :id, 'string'
+    field :impressions, 'string'
+    field :name, 'string'
+    field :revenue, 'double'
+    field :spend, 'double'
+    field :type, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_text_suggestions.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 AdsTextSuggestions < AdObject
+
+    field :ad_account_id, 'string'
+    field :bodies, { list: 'object' }
+    field :descriptions, { list: 'object' }
+    field :inactive_session_tally, 'int'
+    field :long, { list: 'object' }
+    field :short, { list: 'object' }
+    field :titles, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_user_settings.rb

@@ -0,0 +1,81 @@
+# 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 AdsUserSettings < AdObject
+
+    field :a_plus_c_survey_seen, 'bool'
+    field :add_overlays_opt_in_status, 'string'
+    field :adgroup_name_template, 'object'
+    field :ads_cs_catalog_opt_out_timestamp, { list: 'hash' }
+    field :ads_tool_visits, { list: 'object' }
+    field :aplusc_carousel_cda_opt_in_status, 'string'
+    field :aplusc_carousel_inline_comment_opt_in_status, 'string'
+    field :aplusc_epa_opt_in_status, 'string'
+    field :aplusc_opt_out_friction, { list: 'string' }
+    field :autoflow_lite_opt_in_status, 'string'
+    field :autoflow_lite_should_opt_in, 'bool'
+    field :blended_ads_creation_defaulting_opt_in_status, 'string'
+    field :blended_ads_creation_defaulting_opt_out_campaign_group_ids, { list: 'int' }
+    field :bookmarked_pages, { list: 'Page' }
+    field :campaign_group_name_template, 'object'
+    field :campaign_name_template, 'object'
+    field :carousel_to_video_opt_in_status, 'string'
+    field :connected_sources_catalog_opt_in_status, 'string'
+    field :default_creation_mode, 'string'
+    field :export_format_default, 'string'
+    field :focus_mode_default, 'string'
+    field :gen_ai_alpha_test_status, 'int'
+    field :id, 'string'
+    field :image_background_generation_opt_in_status, 'string'
+    field :image_expansion_opt_in_status, 'string'
+    field :is_ads_ai_consented, 'bool'
+    field :is_cbo_default_on, 'bool'
+    field :is_se_removal_guidance_dismissed, 'bool'
+    field :last_used_post_format, 'string'
+    field :last_visited_time, 'datetime'
+    field :music_on_reels_opt_in, { list: 'hash' }
+    field :muted_cbo_midflight_education_messages, { list: 'string' }
+    field :onsite_destination_optimization_opt_in, 'string'
+    field :open_tabs, { list: 'string' }
+    field :previously_seen_recommendations, { list: 'string' }
+    field :product_extensions_opt_in, 'string'
+    field :selected_ad_account, 'AdAccount'
+    field :selected_comparison_timerange, 'object'
+    field :selected_metric_cic, 'string'
+    field :selected_metrics_cic, { list: 'string' }
+    field :selected_page, 'Page'
+    field :selected_page_section, 'string'
+    field :selected_power_editor_pane, 'string'
+    field :selected_stat_range, 'object'
+    field :should_export_filter_empty_cols, 'string'
+    field :should_export_rows_without_unsupported_feature, 'string'
+    field :should_not_auto_expand_tree_table, 'bool'
+    field :should_not_show_cbo_campaign_toggle_off_confirmation_message, 'bool'
+    field :should_not_show_publish_message_on_editor_close, 'bool'
+    field :show_original_videos_opt_in, 'string'
+    field :static_ad_product_extensions_opt_in, 'string'
+    field :sticky_setting_after_default_on, 'string'
+    field :syd_campaign_trends_metric, 'string'
+    field :total_coupon_syd_dismissals, 'int'
+    field :total_coupon_upsell_dismissals, 'int'
+    field :url_prefill_removal_timestamp, 'int'
+    field :use_pe_create_flow, 'bool'
+    field :use_stepper_primary_entry, 'bool'
+    field :user, 'User'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule.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 AdsValueAdjustmentRule < AdObject
+
+    field :base_value, 'int'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :criterias do |edge|
+      edge.get
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.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 AdsValueAdjustmentRuleCollection < AdObject
+
+    field :id, 'string'
+    field :name, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :rules do |edge|
+      edge.get
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/adv_a_instance.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 AdvAInstance < AdObject
+
+    field :id, 'string'
+    field :instance_type, 'string'
+    field :name, 'string'
+    field :owner_business, 'Business'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/advertiser_verification_status.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 AdvertiserVerificationStatus < AdObject
+
+    field :banner_type, 'string'
+    field :grace_period_ends_at, 'datetime'
+    field :ufac_redirect_uri, 'string'
+    field :verification_status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/age_range.rb

@@ -1,20 +1,8 @@
-# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
-#
-# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
-# copy, modify, and distribute this software in source code or binary form for use
-# in connection with the web services and APIs provided by Facebook.
-#
-# As with any software that integrates with the Facebook platform, your use of
-# this software is subject to the Facebook Platform Policy
-# [http://developers.facebook.com/policy/]. This copyright notice shall be
-# included in all copies or substantial portions of the software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# 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
 

data/lib/facebook_ads/ad_objects/agency_client_declaration.rb

@@ -1,20 +1,8 @@
-# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
-#
-# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
-# copy, modify, and distribute this software in source code or binary form for use
-# in connection with the web services and APIs provided by Facebook.
-#
-# As with any software that integrates with the Facebook platform, your use of
-# this software is subject to the Facebook Platform Policy
-# [http://developers.facebook.com/policy/]. This copyright notice shall be
-# included in all copies or substantial portions of the software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# 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
 

data/lib/facebook_ads/ad_objects/album.rb

@@ -1,20 +1,8 @@
-# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
-#
-# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
-# copy, modify, and distribute this software in source code or binary form for use
-# in connection with the web services and APIs provided by Facebook.
-#
-# As with any software that integrates with the Facebook platform, your use of
-# this software is subject to the Facebook Platform Policy
-# [http://developers.facebook.com/policy/]. This copyright notice shall be
-# included in all copies or substantial portions of the software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# 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
 
@@ -35,12 +23,12 @@ module FacebookAds
     field :cover_photo, 'Photo'
     field :created_time, 'datetime'
     field :description, 'string'
-    field :edit_link, 'object'
+    field :edit_link, 'string'
     field :event, 'Event'
     field :from, 'object'
     field :id, 'string'
     field :is_user_facing, 'bool'
-    field :link, 'object'
+    field :link, 'string'
     field :location, 'string'
     field :modified_major, 'datetime'
     field :name, 'string'
@@ -111,7 +99,6 @@ module FacebookAds
         api.has_param :ios_bundle_id, 'string'
         api.has_param :is_explicit_location, 'bool'
         api.has_param :is_explicit_place, 'bool'
-        api.has_param :is_visual_search, 'bool'
         api.has_param :manual_privacy, 'bool'
         api.has_param :message, 'string'
         api.has_param :name, 'string'
@@ -129,7 +116,6 @@ module FacebookAds
         api.has_param :proxied_app_id, 'string'
         api.has_param :published, 'bool'
         api.has_param :qn, 'string'
-        api.has_param :scheduled_publish_time, 'int'
         api.has_param :spherical_metadata, 'hash'
         api.has_param :sponsor_id, 'string'
         api.has_param :sponsor_relationship, 'int'

data/lib/facebook_ads/ad_objects/alm_ad_account_info.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 AlmAdAccountInfo < AdObject
+
+    field :ad_account_id, 'string'
+    field :id, 'string'
+    field :managed_by, 'string'
+    field :owned_by, 'string'
+    field :parent_advertiser_id, 'string'
+    field :sub_vertical, 'string'
+    field :tag, { list: 'string' }
+    field :user_ids, { list: 'string' }
+    field :vertical, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/alm_end_advertiser_info.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 AlmEndAdvertiserInfo < AdObject
+
+    field :estimated_ad_budget, 'int'
+    field :id, 'string'
+    field :parent_advertiser_id, 'string'
+    field :parent_advertiser_name, 'string'
+    field :tag, { list: 'string' }
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/alm_event.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 AlmEvent < AdObject
+
+    field :ad_account_ids, { list: 'string' }
+    field :campaign_ids, { list: 'string' }
+    field :channel, 'string'
+    field :event, 'string'
+    field :event_time, 'datetime'
+    field :guidance, 'string'
+    field :guidance_detail, 'string'
+    field :id, 'string'
+    field :parent_advertiser_ids, { list: 'string' }
+    field :reseller_business_id, 'string'
+    field :sub_channel, 'string'
+    field :user_id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/alm_guidance.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 AlmGuidance < AdObject
+
+    field :ad_account_id, 'string'
+    field :guidances, { list: 'object' }
+    field :parent_advertiser_id, 'string'
+    field :parent_advertiser_name, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/alm_guidance_metrics.rb

@@ -0,0 +1,37 @@
+# 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 AlmGuidanceMetrics < AdObject
+
+    field :ad_account_id, 'string'
+    field :adopted_objects, { list: 'object' }
+    field :guidance_name, 'string'
+    field :guidance_type, 'string'
+    field :l28_adoption, 'int'
+    field :l28_available, 'int'
+    field :l28_click, 'int'
+    field :l28_conversion, 'int'
+    field :l28_impression, 'int'
+    field :l28_pitch, 'int'
+    field :last_pitch_ds, 'string'
+    field :parent_advertiser_id, 'string'
+    field :report_ds, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/am_oneshop_settings.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 AmOneshopSettings < AdObject
+
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

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

data/lib/facebook_ads/ad_objects/analytics_cohort_query_result.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 AnalyticsCohortQueryResult < AdObject
+
+    field :data, 'object'
+    field :error, 'object'
+    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/analytics_config.rb

@@ -0,0 +1,50 @@
+# 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 AnalyticsConfig < AdObject
+
+    field :analytics_access_for_authorized_ad_account, 'bool'
+    field :breakdowns_config, { list: 'object' }
+    field :builtin_fields_config, { list: 'object' }
+    field :deprecated_events_config, { list: 'object' }
+    field :events_config, { list: 'object' }
+    field :ios_purchase_validation_secret, 'string'
+    field :is_any_role_able_to_see_restricted_insights, 'bool'
+    field :is_implicit_purchase_logging_on_android_supported, 'bool'
+    field :is_implicit_purchase_logging_on_ios_supported, 'bool'
+    field :is_track_ios_app_uninstall_supported, 'bool'
+    field :journey_backfill_status, 'string'
+    field :journey_conversion_events, { list: 'string' }
+    field :journey_enabled, 'bool'
+    field :journey_impacting_change_time, 'datetime'
+    field :journey_timeout, 'string'
+    field :latest_sdk_versions, 'hash'
+    field :log_android_implicit_purchase_events, 'bool'
+    field :log_automatic_analytics_events, 'bool'
+    field :log_implicit_purchase_events, 'bool'
+    field :prev_journey_conversion_events, { list: 'string' }
+    field :query_approximation_accuracy_level, 'string'
+    field :query_currency, 'string'
+    field :query_timezone, 'string'
+    field :recent_events_update_time, 'datetime'
+    field :session_timeout_interval, 'int'
+    field :track_ios_app_uninstall, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end