facebookbusiness 0.12.0.1 → 21.0.0

data/lib/facebook_ads/ad_objects/ads_insights.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
 
@@ -28,13 +16,20 @@ module FacebookAds
   class AdsInsights < AdObject
     ACTION_ATTRIBUTION_WINDOWS = [
       "1d_click",
+      "1d_ev",
       "1d_view",
       "28d_click",
       "28d_view",
+      "28d_view_all_conversions",
+      "28d_view_first_conversion",
       "7d_click",
       "7d_view",
+      "7d_view_all_conversions",
+      "7d_view_first_conversion",
       "dda",
       "default",
+      "skan_click",
+      "skan_view",
     ]
 
     ACTION_BREAKDOWNS = [
@@ -48,6 +43,11 @@ module FacebookAds
       "action_type",
       "action_video_sound",
       "action_video_type",
+      "conversion_destination",
+      "matched_persona_id",
+      "matched_persona_name",
+      "signal_source_bucket",
+      "standard_event_content_type",
     ]
 
     ACTION_REPORT_TIME = [
@@ -61,29 +61,56 @@ module FacebookAds
       "age",
       "app_id",
       "body_asset",
+      "breakdown_reporting_ad_id",
       "call_to_action_asset",
+      "coarse_conversion_value",
+      "conversion_destination",
       "country",
       "description_asset",
       "device_platform",
       "dma",
+      "fidelity_type",
       "frequency_value",
       "gender",
       "hourly_stats_aggregated_by_advertiser_time_zone",
       "hourly_stats_aggregated_by_audience_time_zone",
+      "hsid",
       "image_asset",
       "impression_device",
+      "is_conversion_id_modeled",
+      "is_rendered_as_delayed_skip_ad",
+      "landing_destination",
       "link_url_asset",
+      "marketing_messages_btn_name",
+      "mdsa_landing_destination",
+      "media_asset_url",
+      "media_creator",
+      "media_destination_url",
+      "media_format",
+      "media_origin_url",
+      "media_text_content",
+      "media_type",
+      "mmm",
       "place_page_id",
       "platform_position",
+      "postback_sequence_index",
       "product_id",
       "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",
     ]
 
     DATE_PRESET = [
+      "data_maximum",
       "last_14d",
       "last_28d",
       "last_30d",
@@ -123,6 +150,11 @@ module FacebookAds
       "action_type",
       "action_video_sound",
       "action_video_type",
+      "conversion_destination",
+      "matched_persona_id",
+      "matched_persona_name",
+      "signal_source_bucket",
+      "standard_event_content_type",
     ]
 
 
@@ -131,12 +163,10 @@ module FacebookAds
     field :account_name, 'string'
     field :action_values, { list: 'AdsActionStats' }
     field :actions, { list: 'AdsActionStats' }
-    field :ad_bid_value, 'string'
     field :ad_click_actions, { list: 'AdsActionStats' }
     field :ad_id, 'string'
     field :ad_impression_actions, { list: 'AdsActionStats' }
     field :ad_name, 'string'
-    field :adset_bid_value, 'string'
     field :adset_end, 'string'
     field :adset_id, 'string'
     field :adset_name, 'string'
@@ -146,6 +176,7 @@ module FacebookAds
     field :auction_bid, 'string'
     field :auction_competitiveness, 'string'
     field :auction_max_competitor_bid, 'string'
+    field :average_purchases_conversion_value, { list: 'AdsActionStats' }
     field :buying_type, 'string'
     field :campaign_id, 'string'
     field :campaign_name, 'string'
@@ -183,6 +214,7 @@ module FacebookAds
     field :cpm, 'string'
     field :cpp, 'string'
     field :created_time, 'string'
+    field :creative_media_type, 'string'
     field :ctr, 'string'
     field :date_start, 'string'
     field :date_stop, 'string'
@@ -203,14 +235,20 @@ module FacebookAds
     field :inline_link_click_ctr, 'string'
     field :inline_link_clicks, 'string'
     field :inline_post_engagement, 'string'
+    field :instagram_upcoming_event_reminders_set, 'string'
     field :instant_experience_clicks_to_open, 'string'
     field :instant_experience_clicks_to_start, 'string'
     field :instant_experience_outbound_clicks, { list: 'AdsActionStats' }
     field :interactive_component_tap, { list: 'AdsActionStats' }
     field :labels, 'string'
     field :location, 'string'
+    field :marketing_messages_cost_per_delivered, 'string'
+    field :marketing_messages_cost_per_link_btn_click, 'string'
+    field :marketing_messages_spend, 'string'
+    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' }
@@ -218,13 +256,13 @@ module FacebookAds
     field :purchase_roas, { list: 'AdsActionStats' }
     field :qualifying_question_qualify_answer_rate, 'string'
     field :quality_ranking, 'string'
-    field :quality_score_ectr, 'string'
-    field :quality_score_ecvr, 'string'
-    field :quality_score_organic, 'string'
     field :reach, 'string'
+    field :shops_assisted_purchases, 'string'
     field :social_spend, 'string'
     field :spend, 'string'
     field :total_postbacks, 'string'
+    field :total_postbacks_detailed, { list: 'AdsActionStats' }
+    field :total_postbacks_detailed_v4, { list: 'AdsActionStats' }
     field :unique_actions, { list: 'AdsActionStats' }
     field :unique_clicks, 'string'
     field :unique_conversions, { list: 'AdsActionStats' }
@@ -247,10 +285,10 @@ module FacebookAds
     field :video_p75_watched_actions, { list: 'AdsActionStats' }
     field :video_p95_watched_actions, { list: 'AdsActionStats' }
     field :video_play_actions, { list: 'AdsActionStats' }
-    field :video_play_curve_actions, { list: 'object' }
-    field :video_play_retention_0_to_15s_actions, { list: 'object' }
-    field :video_play_retention_20_to_60s_actions, { list: 'object' }
-    field :video_play_retention_graph_actions, { list: 'object' }
+    field :video_play_curve_actions, { list: 'AdsHistogramStats' }
+    field :video_play_retention_0_to_15s_actions, { list: 'AdsHistogramStats' }
+    field :video_play_retention_20_to_60s_actions, { list: 'AdsHistogramStats' }
+    field :video_play_retention_graph_actions, { list: 'AdsHistogramStats' }
     field :video_thruplay_watched_actions, { list: 'AdsActionStats' }
     field :video_time_watched_actions, { list: 'AdsActionStats' }
     field :website_ctr, { list: 'AdsActionStats' }

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_optimal_delivery_growth_opportunity.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
 
@@ -27,7 +15,7 @@ module FacebookAds
 
   class AdsOptimalDeliveryGrowthOpportunity < AdObject
 
-    field :child_metadata, 'hash'
+    field :child_metadata, { list: 'hash' }
     field :metadata, 'object'
     field :optimization_type, 'string'
     has_no_id

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

@@ -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
 
@@ -57,6 +45,13 @@ module FacebookAds
       "FIRST_PARTY_COOKIE_ENABLED",
     ]
 
+    PERMITTED_TASKS = [
+      "ADVERTISE",
+      "ANALYZE",
+      "EDIT",
+      "UPLOAD",
+    ]
+
     TASKS = [
       "AA_ANALYZE",
       "ADVERTISE",
@@ -69,21 +64,62 @@ module FacebookAds
     field :automatic_matching_fields, { list: 'string' }
     field :can_proxy, 'bool'
     field :code, 'string'
+    field :config, 'string'
     field :creation_time, 'datetime'
     field :creator, 'User'
     field :data_use_setting, 'string'
+    field :description, 'string'
+    field :duplicate_entries, 'int'
+    field :enable_auto_assign_to_accounts, 'bool'
     field :enable_automatic_matching, 'bool'
+    field :event_stats, 'string'
+    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'
     field :is_crm, '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 :match_rate_approx, 'int'
+    field :matched_entries, 'int'
     field :name, 'string'
     field :owner_ad_account, 'AdAccount'
     field :owner_business, 'Business'
+    field :usage, 'OfflineConversionDataSetUsage'
+    field :user_access_expire_time, 'datetime'
+    field :valid_entries, 'int'
     has_no_delete
 
+    has_edge :adaccounts do |edge|
+      edge.get 'AdAccount' do |api|
+        api.has_param :business, 'string'
+      end
+    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|
+      edge.post do |api|
+        api.has_param :applink_autosetup, 'bool'
+      end
+    end
+
     has_edge :assigned_users do |edge|
       edge.get 'AssignedUser' do |api|
         api.has_param :business, 'string'
@@ -102,10 +138,12 @@ module FacebookAds
     end
 
     has_edge :events do |edge|
-      edge.post 'AdsPixel' do |api|
+      edge.post do |api|
         api.has_param :data, { list: 'string' }
         api.has_param :namespace_id, 'string'
         api.has_param :partner_agent, 'string'
+        api.has_param :platforms, { list: 'hash' }
+        api.has_param :progress, 'object'
         api.has_param :test_event_code, 'string'
         api.has_param :trace, 'int'
         api.has_param :upload_id, 'string'
@@ -114,6 +152,20 @@ module FacebookAds
       end
     end
 
+    has_edge :offline_event_uploads do |edge|
+      edge.get 'OfflineConversionDataSetUpload' do |api|
+        api.has_param :end_time, 'datetime'
+        api.has_param :order, { enum: -> { OfflineConversionDataSetUpload::ORDER }}
+        api.has_param :sort_by, { enum: -> { OfflineConversionDataSetUpload::SORT_BY }}
+        api.has_param :start_time, 'datetime'
+        api.has_param :upload_tag, 'string'
+      end
+    end
+
+    has_edge :openbridge_configurations do |edge|
+      edge.get 'OpenBridgeConfiguration'
+    end
+
     has_edge :shadowtraffichelper do |edge|
       edge.post
     end
@@ -146,9 +198,5 @@ module FacebookAds
       end
     end
 
-    has_edge :telemetry do |edge|
-      edge.post
-    end
-
   end
 end

data/lib/facebook_ads/ad_objects/ads_pixel_capability_override.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 AdsPixelCapabilityOverride < AdObject
+
+    field :capability, 'string'
+    field :id, 'string'
+    field :override_value, 'string'
+    field :reason, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_pixel_capi_setup_quality.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 AdsPixelCapiSetupQuality < AdObject
+
+    field :event_match_quality, 'object'
+    field :event_name, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_pixel_delivery_recommendations.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 AdsPixelDeliveryRecommendations < AdObject
+
+    field :custom_event_type, 'string'
+    field :optimization_goal, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_pixel_domain_control_rule.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 AdsPixelDomainControlRule < AdObject
+
+    field :domain_list, { list: 'object' }
+    field :type, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_pixel_domain_last_fired_time.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 AdsPixelDomainLastFiredTime < AdObject
+
+    field :domain_name, 'string'
+    field :last_fired_time, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_pixel_event_last_fired_time.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 AdsPixelEventLastFiredTime < AdObject
+
+    field :event, 'string'
+    field :last_fired_time, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end