facebookbusiness 19.0.3 → 20.0.1

data/lib/facebook_ads/ad_objects/ig_refresh_access_token_for_ig_only_api.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 IgRefreshAccessTokenForIgOnlyApi < AdObject
+
+    field :access_token, 'string'
+    field :expires_in, 'int'
+    field :token_type, 'string'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ig_resumable_video_upload_status.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 IgResumableVideoUploadStatus < AdObject
+
+    field :processing_phase, 'VideoStatusProcessingPhase'
+    field :uploading_phase, 'VideoStatusUploadingPhase'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ig_user.rb

@@ -42,6 +42,7 @@ module FacebookAds
       edge.get 'IgbcAdsPermission'
       edge.post 'IgbcAdsPermission' do |api|
         api.has_param :creator_instagram_account, 'string'
+        api.has_param :creator_instagram_username, 'string'
         api.has_param :revoke, 'bool'
       end
     end
@@ -80,7 +81,8 @@ module FacebookAds
     end
 
     has_edge :dataset do |edge|
-      edge.get 'Dataset'
+      edge.get 'AdsPixel'
+      edge.post 'AdsPixel'
     end
 
     has_edge :insights do |edge|

data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb

@@ -0,0 +1,41 @@
+# 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 IgUserForIgOnlyApi < AdObject
+
+    field :account_type, 'string'
+    field :id, 'string'
+    field :media_count, 'int'
+    field :username, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :live_media do |edge|
+      edge.get
+    end
+
+    has_edge :media do |edge|
+      edge.get do |api|
+        api.has_param :since, 'datetime'
+        api.has_param :until, 'datetime'
+      end
+    end
+
+    has_edge :stories do |edge|
+      edge.get
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/image_copyright_dispute.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 ImageCopyrightDispute < AdObject
+
+    field :appeal_form_data, 'string'
+    field :dispute_form_data, 'string'
+    field :expiration_time, 'datetime'
+    field :id, 'string'
+    field :match_id, 'string'
+    field :status, 'string'
+    field :time_appealed, 'datetime'
+    field :time_created, 'datetime'
+    field :time_updated, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/image_reference_match.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 ImageReferenceMatch < AdObject
+
+    field :conflicting_countries, { list: 'string' }
+    field :country_resolution_history, { list: 'map<string, list<Object>>' }
+    field :creation_time, 'datetime'
+    field :current_conflict_resolved_countries, { list: 'hash' }
+    field :displayed_match_state, 'string'
+    field :dispute_form_data_entries_with_translations, { list: 'object' }
+    field :expiration_time, 'datetime'
+    field :id, 'string'
+    field :match_state, 'string'
+    field :matched_reference_copyright, 'ImageCopyright'
+    field :matched_reference_owner, 'Profile'
+    field :modification_history, { list: 'object' }
+    field :reference_copyright, 'ImageCopyright'
+    field :reference_owner, 'Profile'
+    field :rejection_form_data_entries_with_translations, { list: 'object' }
+    field :resolution_reason, 'string'
+    field :update_time, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/insights_result.rb

@@ -46,6 +46,199 @@ module FacebookAds
       "week",
     ]
 
+    METRIC = [
+      "blue_reels_play_count",
+      "creator_monetization_qualified_views",
+      "fb_media_matching_copyright_comment_count",
+      "fb_media_matching_copyright_daily_comment_count",
+      "fb_media_matching_copyright_daily_like_count",
+      "fb_media_matching_copyright_daily_post_impressions",
+      "fb_media_matching_copyright_daily_post_impressions_by_age_bucket_and_gender",
+      "fb_media_matching_copyright_daily_post_impressions_by_country",
+      "fb_media_matching_copyright_daily_post_impressions_by_locale",
+      "fb_media_matching_copyright_daily_post_impressions_by_matching_post_id",
+      "fb_media_matching_copyright_daily_post_impressions_by_matching_post_owner_id",
+      "fb_media_matching_copyright_daily_post_reactions_anger_count",
+      "fb_media_matching_copyright_daily_post_reactions_haha_count",
+      "fb_media_matching_copyright_daily_post_reactions_like_count",
+      "fb_media_matching_copyright_daily_post_reactions_love_count",
+      "fb_media_matching_copyright_daily_post_reactions_sorry_count",
+      "fb_media_matching_copyright_daily_post_reactions_wow_count",
+      "fb_media_matching_copyright_daily_post_share_count",
+      "fb_media_matching_copyright_like_count",
+      "fb_media_matching_copyright_post_impressions",
+      "fb_media_matching_copyright_post_impressions_by_age_bucket_and_gender",
+      "fb_media_matching_copyright_post_impressions_by_country",
+      "fb_media_matching_copyright_post_impressions_by_locale",
+      "fb_media_matching_copyright_post_impressions_by_matching_post_id",
+      "fb_media_matching_copyright_post_impressions_by_matching_post_owner_id",
+      "fb_media_matching_copyright_post_reactions_anger_count",
+      "fb_media_matching_copyright_post_reactions_haha_count",
+      "fb_media_matching_copyright_post_reactions_like_count",
+      "fb_media_matching_copyright_post_reactions_love_count",
+      "fb_media_matching_copyright_post_reactions_sorry_count",
+      "fb_media_matching_copyright_post_reactions_wow_count",
+      "fb_media_matching_copyright_post_share_count",
+      "fb_reels_replay_count",
+      "fb_reels_total_plays",
+      "has_total_video_views_by_publisher_platform_type",
+      "post_impressions_unique",
+      "post_video_avg_time_watched",
+      "post_video_followers",
+      "post_video_likes_by_reaction_type",
+      "post_video_retention_graph",
+      "post_video_social_actions",
+      "post_video_view_time",
+      "rights_manager_matching_copyright_matching_page_or_profile_view_count",
+      "rights_manager_matching_copyright_matching_video_view_count",
+      "rights_manager_matching_copyright_video_view_count",
+      "rights_manager_matching_copyright_video_view_count_60s",
+      "rights_manager_matching_copyright_video_view_count_60s_by_age_bucket_and_gender",
+      "rights_manager_matching_copyright_video_view_count_60s_by_country_id",
+      "rights_manager_matching_copyright_video_view_count_60s_by_locale",
+      "total_audio_only_product_listen_count",
+      "total_video_10s_views",
+      "total_video_10s_views_auto_played",
+      "total_video_10s_views_clicked_to_play",
+      "total_video_10s_views_organic",
+      "total_video_10s_views_paid",
+      "total_video_10s_views_sound_on",
+      "total_video_10s_views_unique",
+      "total_video_15s_views",
+      "total_video_30s_views",
+      "total_video_30s_views_auto_played",
+      "total_video_30s_views_clicked_to_play",
+      "total_video_30s_views_organic",
+      "total_video_30s_views_paid",
+      "total_video_30s_views_unique",
+      "total_video_60s_excludes_shorter_views",
+      "total_video_60s_excludes_shorter_views_by_age_bucket_and_gender",
+      "total_video_60s_excludes_shorter_views_by_distribution_source",
+      "total_video_60s_excludes_shorter_views_by_growth_accounting_bucket",
+      "total_video_60s_excludes_shorter_views_by_growth_accounting_bucket_and_time_since_creation_bucket",
+      "total_video_60s_excludes_shorter_views_by_is_60s_returning_viewer",
+      "total_video_60s_excludes_shorter_views_by_is_60s_returning_viewer_and_time_since_creation_bucket",
+      "total_video_60s_excludes_shorter_views_live",
+      "total_video_60s_excludes_shorter_views_unique",
+      "total_video_60s_excludes_shorter_views_unique_by_age_bucket_and_gender",
+      "total_video_60s_excludes_shorter_views_unique_by_growth_accounting_bucket",
+      "total_video_60s_excludes_shorter_views_unique_by_growth_accounting_bucket_and_time_since_creation_bucket",
+      "total_video_60s_excludes_shorter_views_unique_by_is_60s_returning_viewer",
+      "total_video_60s_excludes_shorter_views_unique_by_is_60s_returning_viewer_and_time_since_creation_bucket",
+      "total_video_ad_break_ad_cpm",
+      "total_video_ad_break_ad_impressions",
+      "total_video_ad_break_earnings",
+      "total_video_ad_break_earnings_with_subsidy",
+      "total_video_ad_impressions_by_monetization_type",
+      "total_video_avg_time_watched",
+      "total_video_avg_time_watched_by_distribution_source",
+      "total_video_avg_time_watched_by_is_60s_returning_viewer",
+      "total_video_avg_time_watched_by_time_since_creation_bucket",
+      "total_video_avg_time_watched_followers",
+      "total_video_avg_time_watched_live",
+      "total_video_comment_sentiment",
+      "total_video_comment_sentiment_by_factors",
+      "total_video_complete_views",
+      "total_video_complete_views_auto_played",
+      "total_video_complete_views_clicked_to_play",
+      "total_video_complete_views_organic",
+      "total_video_complete_views_organic_unique",
+      "total_video_complete_views_paid",
+      "total_video_complete_views_paid_unique",
+      "total_video_complete_views_unique",
+      "total_video_consumption_rate",
+      "total_video_followers_unique",
+      "total_video_growth_score",
+      "total_video_growth_score_by_factors",
+      "total_video_impressions",
+      "total_video_impressions_fan",
+      "total_video_impressions_fan_paid",
+      "total_video_impressions_fan_paid_unique",
+      "total_video_impressions_fan_unique",
+      "total_video_impressions_organic",
+      "total_video_impressions_organic_unique",
+      "total_video_impressions_paid",
+      "total_video_impressions_paid_unique",
+      "total_video_impressions_unique",
+      "total_video_impressions_viral",
+      "total_video_impressions_viral_unique",
+      "total_video_imps_count_unique_by_age_bucket",
+      "total_video_imps_count_unique_by_age_bucket_and_gender",
+      "total_video_imps_count_unique_by_gender",
+      "total_video_likes_by_reaction_type",
+      "total_video_negative_feedback",
+      "total_video_net_followers",
+      "total_video_net_followers_unique",
+      "total_video_net_followers_unique_by_time_since_creation_bucket",
+      "total_video_play_count",
+      "total_video_play_count_by_is_60s_returning_viewer_and_time_since_creation_bucket",
+      "total_video_play_count_by_time_since_creation_bucket",
+      "total_video_reactions_by_type_total",
+      "total_video_relative_retention_graph",
+      "total_video_retention_graph",
+      "total_video_retention_graph_15s",
+      "total_video_retention_graph_15s_followers",
+      "total_video_retention_graph_15s_newsfeed",
+      "total_video_retention_graph_15s_recommended",
+      "total_video_retention_graph_15s_shares",
+      "total_video_retention_graph_15s_watch",
+      "total_video_retention_graph_autoplayed",
+      "total_video_retention_graph_clicked_to_play",
+      "total_video_retention_graph_gender_female",
+      "total_video_retention_graph_gender_male",
+      "total_video_social_actions",
+      "total_video_social_actions_comment_by_distribution_type",
+      "total_video_social_actions_count_unique",
+      "total_video_social_actions_count_unique_by_age_bucket",
+      "total_video_social_actions_count_unique_by_age_bucket_and_gender",
+      "total_video_social_actions_count_unique_by_gender",
+      "total_video_social_actions_reaction_by_distribution_type",
+      "total_video_stories_by_action_type",
+      "total_video_unfollowers",
+      "total_video_unfollowers_unique",
+      "total_video_view_count_unique_by_age_bucket",
+      "total_video_view_count_unique_by_age_bucket_and_gender",
+      "total_video_view_count_unique_by_gender",
+      "total_video_view_time_by_age_bucket_and_gender",
+      "total_video_view_time_by_country_id",
+      "total_video_view_time_by_distribution_source",
+      "total_video_view_time_by_distribution_type",
+      "total_video_view_time_by_is_60s_returning_viewer_and_time_since_creation_bucket",
+      "total_video_view_time_by_region_id",
+      "total_video_view_time_by_time_since_creation_bucket",
+      "total_video_view_total_time",
+      "total_video_view_total_time_by_is_60s_returning_viewer",
+      "total_video_view_total_time_by_paid_non_paid",
+      "total_video_view_total_time_live",
+      "total_video_view_total_time_organic",
+      "total_video_view_total_time_paid",
+      "total_video_view_total_time_vod",
+      "total_video_views",
+      "total_video_views_autoplayed",
+      "total_video_views_by_age_bucket_and_gender",
+      "total_video_views_by_country_id",
+      "total_video_views_by_distribution_type",
+      "total_video_views_by_paid_non_paid",
+      "total_video_views_by_region_id",
+      "total_video_views_by_region_id_proper",
+      "total_video_views_clicked_to_play",
+      "total_video_views_gender_female",
+      "total_video_views_gender_female_live",
+      "total_video_views_gender_male",
+      "total_video_views_gender_male_live",
+      "total_video_views_live",
+      "total_video_views_live_autoplayed",
+      "total_video_views_live_clicked_to_play",
+      "total_video_views_organic",
+      "total_video_views_organic_unique",
+      "total_video_views_paid",
+      "total_video_views_paid_unique",
+      "total_video_views_sound_on",
+      "total_video_views_unique",
+      "total_video_views_vod",
+      "video_asset_60s_video_view_total_count_by_is_monetizable",
+    ]
+
 
     field :description, 'string'
     field :description_from_api_doc, 'string'

data/lib/facebook_ads/ad_objects/instagram_boostable_media_for_access_token.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 InstagramBoostableMediaForAccessToken < AdObject
+
+    field :has_product_tags, 'bool'
+    field :media, 'IgMedia'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/instagram_insights_result.rb

@@ -24,8 +24,6 @@ module FacebookAds
     METRIC = [
       "clips_replays_count",
       "comments",
-      "engagement",
-      "exits",
       "follows",
       "ig_reels_aggregated_all_plays_count",
       "ig_reels_avg_watch_time",
@@ -40,8 +38,6 @@ module FacebookAds
       "replies",
       "saved",
       "shares",
-      "taps_back",
-      "taps_forward",
       "total_interactions",
       "video_views",
     ]

data/lib/facebook_ads/ad_objects/instagram_related_product_tags.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 InstagramRelatedProductTags < AdObject
+
+    field :checkout_setting, 'string'
+    field :id, 'int'
+    field :image_uri, 'string'
+    field :name, 'string'
+    field :price_label, 'string'
+    field :sale_price_label, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/instagram_user.rb

@@ -34,7 +34,7 @@ module FacebookAds
     end
 
     has_edge :ar_effects do |edge|
-      edge.get
+      edge.get 'ArEffect'
     end
 
     has_edge :authorized_adaccounts do |edge|

data/lib/facebook_ads/ad_objects/instant_article_cta.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 InstantArticleCta < AdObject
+
+    field :id, 'string'
+    field :is_enabled, 'bool'
+    field :publisher_defined_value, 'double'
+    field :type, 'string'
+    field :update_time, 'datetime'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/instant_article_insights_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 InstantArticleInsightsQueryResult < AdObject
+
+    field :breakdowns, 'hash'
+    field :name, 'string'
+    field :time, 'datetime'
+    field :value, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ip_object.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 IpObject < AdObject
+
+    field :ip_permission, 'string'
+    field :user, 'object'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/keyword_delivery_report.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 KeywordDeliveryReport < AdObject
+
+    field :estimated_clicks, 'int'
+    field :estimated_conversions, 'int'
+    field :estimated_cost, 'double'
+    field :estimated_cpc, 'double'
+    field :estimated_ctr, 'double'
+    field :estimated_cvr, 'double'
+    field :estimated_impressions, 'int'
+    field :estimated_returns, 'double'
+    field :keyword, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/lead_gen_data_draft.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 LeadGenDataDraft < AdObject
+
+    field :block_display_for_non_targeted_viewer, 'bool'
+    field :created_time, 'datetime'
+    field :disqualified_end_component, 'object'
+    field :follow_up_action_url, 'string'
+    field :id, 'string'
+    field :is_optimized_for_quality, 'bool'
+    field :legal_content, 'object'
+    field :locale, 'string'
+    field :name, 'string'
+    field :page, 'Page'
+    field :question_page_custom_headline, 'string'
+    field :questions, { list: 'LeadGenDraftQuestion' }
+    field :status, 'string'
+    field :thank_you_page, 'object'
+    field :tracking_parameters, { list: 'hash' }
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/lead_gen_direct_crm_integration_config.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 LeadGenDirectCrmIntegrationConfig < AdObject
+
+    field :auth_id, 'string'
+    field :creation_time, 'datetime'
+    field :id, 'string'
+    field :lead_gen_data, 'LeadgenForm'
+    field :matched_fields, { list: 'hash' }
+    field :matched_fields_labels, { list: 'hash' }
+    field :resources, { list: 'hash' }
+    field :third_party_app_id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end