facebookbusiness 19.0.3 → 20.0.1

data/lib/facebook_ads/ad_objects/ad_account_custom_audience_limits.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 AdAccountCustomAudienceLimits < AdObject
+
+    field :audience_update_quota_in_total, 'int'
+    field :audience_update_quota_left, 'double'
+    field :has_hit_audience_update_limit, 'bool'
+    field :next_audience_update_available_time, 'string'
+    field :rate_limit_reset_time, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_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_account_optimization_goals_aemv2_eligibility.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 AdAccountOptimizationGoalsAemv2Eligibility < AdObject
+    OPTIMIZATION_GOAL = [
+      "AD_RECALL_LIFT",
+      "APP_INSTALLS",
+      "APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
+      "CONVERSATIONS",
+      "DERIVED_EVENTS",
+      "ENGAGED_USERS",
+      "EVENT_RESPONSES",
+      "IMPRESSIONS",
+      "IN_APP_VALUE",
+      "LANDING_PAGE_VIEWS",
+      "LEAD_GENERATION",
+      "LINK_CLICKS",
+      "MEANINGFUL_CALL_ATTEMPT",
+      "MESSAGING_APPOINTMENT_CONVERSION",
+      "MESSAGING_PURCHASE_CONVERSION",
+      "NONE",
+      "OFFSITE_CONVERSIONS",
+      "PAGE_LIKES",
+      "POST_ENGAGEMENT",
+      "PROFILE_VISIT",
+      "QUALITY_CALL",
+      "QUALITY_LEAD",
+      "REACH",
+      "REMINDERS_SET",
+      "SUBSCRIBERS",
+      "THRUPLAY",
+      "VALUE",
+      "VISIT_INSTAGRAM_PROFILE",
+    ]
+
+
+    field :is_disabled, 'bool'
+    field :optimization_goal, { enum: -> { OPTIMIZATION_GOAL }}
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_payment_details.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 AdAccountPaymentDetails < AdObject
+
+    field :amount, 'CurrencyAmount'
+    field :create_date, 'int'
+    field :id, 'string'
+    field :last_action_status, 'string'
+    field :metadata, 'object'
+    field :payment_details_id, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_payment_options.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 AdAccountPaymentOptions < AdObject
+
+    field :available_altpay_options, { list: 'object' }
+    field :available_card_types, { list: 'string' }
+    field :available_payment_options, { list: 'string' }
+    field :existing_payment_methods, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_prepay_details.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 AdAccountPrepayDetails < AdObject
+
+    field :default_funding_amount, 'CurrencyAmount'
+    field :max_acceptable_amount, 'CurrencyAmount'
+    field :min_acceptable_amount, 'CurrencyAmount'
+    field :should_collect_business_details, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_promotion_progress_bar.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 AdAccountPromotionProgressBar < AdObject
+
+    field :adaccount_permission, 'bool'
+    field :coupon_currency, 'string'
+    field :coupon_value, 'int'
+    field :expiration_time, 'datetime'
+    field :progress_completed, 'bool'
+    field :promotion_type, 'string'
+    field :spend_requirement_in_cent, 'int'
+    field :spend_since_enrollment, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

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

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

data/lib/facebook_ads/ad_objects/ad_account_smart_suggested_ads.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 AdAccountSmartSuggestedAds < AdObject
+
+    field :ad_creative_spec, 'string'
+    field :description, 'string'
+    field :guidance_spec, { list: 'string' }
+    field :thumbnail_url, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_spend_limit.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 AdAccountSpendLimit < AdObject
+
+    field :amount_spent, 'string'
+    field :group_id, 'string'
+    field :limit_id, 'string'
+    field :limit_value, 'string'
+    field :time_created, 'int'
+    field :time_start, 'int'
+    field :time_stop, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_subsidy_amount_details.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 AdAccountSubsidyAmountDetails < AdObject
+
+    field :entered_amount, 'CurrencyAmount'
+    field :fee_amount, 'CurrencyAmount'
+    field :total_amount, 'CurrencyAmount'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_suggested_tag.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 AdAccountSuggestedTag < AdObject
+
+    field :product_id, 'int'
+    field :x, 'double'
+    field :y, 'double'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

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

data/lib/facebook_ads/ad_objects/ad_account_user_permissions.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 AdAccountUserPermissions < AdObject
+
+    field :business, 'Business'
+    field :business_persona, 'object'
+    field :created_by, 'User'
+    field :created_time, 'datetime'
+    field :email, 'string'
+    field :status, 'string'
+    field :tasks, { list: 'string' }
+    field :updated_by, 'User'
+    field :updated_time, 'datetime'
+    field :user, 'User'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb

@@ -0,0 +1,100 @@
+# 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 AdAccountUserSettings < AdObject
+    SYD_CAMPAIGN_TRENDS_OBJECTIVE = [
+      "APP_INSTALLS",
+      "BRAND_AWARENESS",
+      "EVENT_RESPONSES",
+      "LEAD_GENERATION",
+      "LINK_CLICKS",
+      "LOCAL_AWARENESS",
+      "MESSAGES",
+      "OFFER_CLAIMS",
+      "OUTCOME_APP_PROMOTION",
+      "OUTCOME_AWARENESS",
+      "OUTCOME_ENGAGEMENT",
+      "OUTCOME_LEADS",
+      "OUTCOME_SALES",
+      "OUTCOME_TRAFFIC",
+      "PAGE_LIKES",
+      "POST_ENGAGEMENT",
+      "PRODUCT_CATALOG_SALES",
+      "REACH",
+      "STORE_VISITS",
+      "VIDEO_VIEWS",
+      "WEBSITE_CONVERSIONS",
+    ]
+
+
+    field :acf_should_opt_out_video_adjustments, 'bool'
+    field :aco_sticky_settings, { list: 'hash' }
+    field :ad_account, 'AdAccount'
+    field :ad_object_export_format, 'string'
+    field :auto_review_video_caption, 'bool'
+    field :campaign_overview_columns, { list: 'string' }
+    field :column_suggestion_status, 'string'
+    field :default_account_overview_agegender_metrics, { list: 'string' }
+    field :default_account_overview_location_metrics, { list: 'string' }
+    field :default_account_overview_metrics, { list: 'string' }
+    field :default_account_overview_time_metrics, { list: 'string' }
+    field :default_builtin_column_preset, 'string'
+    field :default_nam_time_range, 'string'
+    field :draft_mode_enabled, 'bool'
+    field :export_deleted_items_with_delivery, 'bool'
+    field :export_summary_row, 'bool'
+    field :has_seen_groups_column_flexing_experience, 'bool'
+    field :has_seen_leads_column_flexing_experience, 'bool'
+    field :has_seen_shops_ads_metrics_onboarding_tour, 'bool'
+    field :has_seen_shops_column_flexing_experience, 'bool'
+    field :hidden_optimization_tips, { list: 'hash' }
+    field :id, 'string'
+    field :is_3p_auth_setting_set, 'bool'
+    field :is_text_variation_nux_close, 'bool'
+    field :last_used_columns, 'object'
+    field :last_used_pe_filters, { list: 'object' }
+    field :last_used_website_urls, { list: 'string' }
+    field :outlier_preferences, 'object'
+    field :pinned_ad_object_ids, { list: 'string' }
+    field :rb_export_format, 'string'
+    field :rb_export_raw_data, 'bool'
+    field :rb_export_summary_row, 'bool'
+    field :saip_advertiser_setup_optimisation_guidance_overall_state, 'string'
+    field :saip_advertiser_setup_optimisation_guidance_state, { list: 'hash' }
+    field :shops_ads_metrics_onboarding_tour_close_count, 'int'
+    field :shops_ads_metrics_onboarding_tour_last_action_time, 'datetime'
+    field :should_default_image_auto_crop, 'bool'
+    field :should_default_image_auto_crop_for_tail, 'bool'
+    field :should_default_image_auto_crop_optimization, 'bool'
+    field :should_default_image_dof_toggle, 'bool'
+    field :should_default_image_lpp_ads_to_square, 'bool'
+    field :should_default_instagram_profile_card_optimization, 'bool'
+    field :should_default_text_swapping_optimization, 'bool'
+    field :should_logout_of_3p_sourcing, 'bool'
+    field :show_archived_data, 'bool'
+    field :show_text_variation_nux_tooltip, 'bool'
+    field :syd_campaign_trends_activemetric, 'string'
+    field :syd_campaign_trends_attribution, 'string'
+    field :syd_campaign_trends_metrics, { list: 'string' }
+    field :syd_campaign_trends_objective, { enum: -> { SYD_CAMPAIGN_TRENDS_OBJECTIVE }}
+    field :syd_campaign_trends_time_range, 'string'
+    field :syd_landing_page_opt_in_status, 'string'
+    field :text_variations_opt_in_type, 'string'
+    field :user, 'User'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_youth_ads_advertiser.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 AdAccountYouthAdsAdvertiser < AdObject
+
+    field :is_youth_ads_advertiser, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_asset_feed_additional_data_page_nudge_message.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 AdAssetFeedAdditionalDataPageNudgeMessage < AdObject
+
+    field :enabled, 'bool'
+    field :quick_replies, { list: 'object' }
+    field :text, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb

@@ -93,6 +93,7 @@ module FacebookAds
       "USE_MOBILE_APP",
       "VIDEO_ANNOTATION",
       "VIDEO_CALL",
+      "VIEW_PRODUCT",
       "VISIT_PAGES_FEED",
       "WATCH_MORE",
       "WATCH_VIDEO",
@@ -123,6 +124,7 @@ module FacebookAds
     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