facebookbusiness 19.0.2 → 20.0.0

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

data/lib/facebook_ads/ad_objects/ads_conversion_goal.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 AdsConversionGoal < AdObject
+
+    field :ad_account_id, 'string'
+    field :conversion_event_value_source, 'string'
+    field :description, 'string'
+    field :goal_creation_method, 'string'
+    field :id, 'string'
+    field :name, 'string'
+    field :performance_goal, 'string'
+    field :update_status, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :conversion_events do |edge|
+      edge.get
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_creation_saved_state.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 AdsCreationSavedState < AdObject
+
+    field :ad_account, 'AdAccount'
+    field :id, 'string'
+    field :serialized_store_data, 'string'
+    field :time_updated, 'datetime'
+    field :user, 'object'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_custom_pivots_preview.rb

@@ -0,0 +1,33 @@
+# 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 AdsCustomPivotsPreview < AdObject
+
+    field :account_id, 'string'
+    field :account_name, 'string'
+    field :ad_id, 'string'
+    field :ad_name, 'string'
+    field :adset_id, 'string'
+    field :adset_name, 'string'
+    field :campaign_id, 'string'
+    field :campaign_name, 'string'
+    field :custom_breakdown, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_data_partner.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 AdsDataPartner < AdObject
+
+    field :id, 'string'
+    field :name, 'string'
+    field :rev_share_policies, { list: 'RevSharePolicy' }
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_dataset.rb

@@ -0,0 +1,75 @@
+# 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 AdsDataset < AdObject
+
+    field :can_proxy, 'bool'
+    field :collection_rate, 'double'
+    field :config, 'string'
+    field :creation_time, 'datetime'
+    field :creator, 'User'
+    field :dataset_id, 'string'
+    field :description, 'string'
+    field :duplicate_entries, 'int'
+    field :enable_auto_assign_to_accounts, 'bool'
+    field :enable_automatic_events, 'bool'
+    field :enable_automatic_matching, 'bool'
+    field :enable_real_time_event_log, 'bool'
+    field :event_stats, 'string'
+    field :event_time_max, 'int'
+    field :event_time_min, 'int'
+    field :first_party_cookie_status, 'string'
+    field :has_bapi_domains, 'bool'
+    field :has_catalog_microdata_activity, 'bool'
+    field :has_ofa_redacted_keys, 'bool'
+    field :has_sent_pii, 'bool'
+    field :id, 'string'
+    field :is_consolidated_container, 'bool'
+    field :is_created_by_business, 'bool'
+    field :is_crm, 'bool'
+    field :is_eligible_for_sharing_to_ad_account, 'bool'
+    field :is_eligible_for_sharing_to_business, 'bool'
+    field :is_eligible_for_value_optimization, 'bool'
+    field :is_mta_use, 'bool'
+    field :is_restricted_use, 'bool'
+    field :is_unavailable, 'bool'
+    field :last_fired_time, 'datetime'
+    field :last_upload_app, 'string'
+    field :last_upload_app_changed_time, 'int'
+    field :last_upload_time, 'int'
+    field :late_upload_reminder_eligibility, 'bool'
+    field :match_rate_approx, 'int'
+    field :matched_entries, 'int'
+    field :name, 'string'
+    field :no_ads_tracked_for_weekly_uploaded_events_reminder_eligibility, 'bool'
+    field :num_active_ad_set_tracked, 'int'
+    field :num_recent_offline_conversions_uploaded, 'int'
+    field :num_uploads, 'int'
+    field :owner_ad_account, 'AdAccount'
+    field :owner_business, 'Business'
+    field :percentage_of_late_uploads_in_external_suboptimal_window, 'int'
+    field :permissions, 'OfflineConversionDataSetPermissions'
+    field :server_last_fired_time, 'datetime'
+    field :show_automatic_events, 'bool'
+    field :upload_rate, 'double'
+    field :upload_reminder_eligibility, 'bool'
+    field :usage, 'OfflineConversionDataSetUsage'
+    field :valid_entries, 'int'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

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

data/lib/facebook_ads/ad_objects/ads_histogram_stats.rb

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

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -95,11 +95,14 @@ module FacebookAds
       "publisher_platform",
       "redownload",
       "region",
+      "signal_source_bucket",
       "skan_campaign_id",
       "skan_conversion_id",
       "skan_version",
       "standard_event_content_type",
       "title_asset",
+      "user_persona_id",
+      "user_persona_name",
       "video_asset",
     ]
 
@@ -161,6 +164,7 @@ module FacebookAds
     field :ad_id, 'string'
     field :ad_impression_actions, { list: 'AdsActionStats' }
     field :ad_name, 'string'
+    field :adjusted_offline_purchase, { list: 'object' }
     field :adset_end, 'string'
     field :adset_id, 'string'
     field :adset_name, 'string'
@@ -181,7 +185,6 @@ module FacebookAds
     field :catalog_segment_value_omni_purchase_roas, { list: 'AdsActionStats' }
     field :catalog_segment_value_website_purchase_roas, { list: 'AdsActionStats' }
     field :clicks, 'string'
-    field :conversion_lead_rate, 'string'
     field :conversion_rate_ranking, 'string'
     field :conversion_values, { list: 'AdsActionStats' }
     field :conversions, { list: 'AdsActionStats' }
@@ -192,7 +195,6 @@ module FacebookAds
     field :cost_per_action_type, { list: 'AdsActionStats' }
     field :cost_per_ad_click, { list: 'AdsActionStats' }
     field :cost_per_conversion, { list: 'AdsActionStats' }
-    field :cost_per_conversion_lead, 'string'
     field :cost_per_dda_countby_convs, 'string'
     field :cost_per_estimated_ad_recallers, 'string'
     field :cost_per_inline_link_click, 'string'
@@ -243,6 +245,7 @@ module FacebookAds
     field :marketing_messages_website_purchase_values, 'string'
     field :mobile_app_purchase_roas, { list: 'AdsActionStats' }
     field :objective, 'string'
+    field :onsite_conversion_messaging_detected_purchase_deduped, { list: 'AdsActionStats' }
     field :optimization_goal, 'string'
     field :outbound_clicks, { list: 'AdsActionStats' }
     field :outbound_clicks_ctr, { list: 'AdsActionStats' }
@@ -251,6 +254,7 @@ module FacebookAds
     field :qualifying_question_qualify_answer_rate, 'string'
     field :quality_ranking, 'string'
     field :reach, 'string'
+    field :shops_assisted_purchases, 'string'
     field :social_spend, 'string'
     field :spend, 'string'
     field :total_postbacks, 'string'

data/lib/facebook_ads/ad_objects/ads_naming_template.rb

@@ -0,0 +1,42 @@
+# 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 AdsNamingTemplate < AdObject
+    LEVEL = [
+      "ADGROUP",
+      "AD_ACCOUNT",
+      "CAMPAIGN",
+      "CAMPAIGN_GROUP",
+      "OPPORTUNITIES",
+      "PRIVACY_INFO_CENTER",
+      "TOPLINE",
+      "UNIQUE_ADCREATIVE",
+    ]
+
+
+    field :api_fields, { list: { list: 'map<string, list<map<string, string>>>' } }
+    field :api_version, 'string'
+    field :field_order, { list: 'string' }
+    field :id, 'string'
+    field :level, { enum: -> { LEVEL }}
+    field :separator, 'string'
+    field :template_version, 'string'
+    field :user_defined_fields, { list: { list: 'map<string, list<string>>' } }
+    field :value_separator, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_payment_cycle.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 AdsPaymentCycle < AdObject
+
+    field :account_id, 'string'
+    field :created_time, 'datetime'
+    field :multiplier, 'int'
+    field :requested_threshold_amount, 'int'
+    field :threshold_amount, 'int'
+    field :updated_time, 'datetime'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_pivot_rules.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 AdsPivotRules < AdObject
+
+    field :creation_time, 'datetime'
+    field :creator, 'Profile'
+    field :description, 'string'
+    field :id, 'string'
+    field :name, 'string'
+    field :permission, 'string'
+    field :rules, { list: 'object' }
+    field :scope, 'string'
+    field :update_by, 'Profile'
+    field :update_time, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_pixel.rb

@@ -45,6 +45,12 @@ module FacebookAds
       "FIRST_PARTY_COOKIE_ENABLED",
     ]
 
+    PERMITTED_TASKS = [
+      "ADVERTISE",
+      "ANALYZE",
+      "UPLOAD",
+    ]
+
     TASKS = [
       "AA_ANALYZE",
       "ADVERTISE",
@@ -69,6 +75,7 @@ module FacebookAds
     field :event_time_max, 'int'
     field :event_time_min, 'int'
     field :first_party_cookie_status, 'string'
+    field :has_1p_pixel_event, 'bool'
     field :id, 'string'
     field :is_consolidated_container, 'bool'
     field :is_created_by_business, 'bool'
@@ -96,7 +103,14 @@ module FacebookAds
     end
 
     has_edge :agencies do |edge|
+      edge.delete do |api|
+        api.has_param :business, 'string'
+      end
       edge.get 'Business'
+      edge.post 'AdsPixel' do |api|
+        api.has_param :business, 'string'
+        api.has_param :permitted_tasks, { list: { enum: -> { AdsPixel::PERMITTED_TASKS }} }
+      end
     end
 
     has_edge :ahp_configs do |edge|
@@ -183,9 +197,5 @@ module FacebookAds
       end
     end
 
-    has_edge :telemetry do |edge|
-      edge.post
-    end
-
   end
 end