facebookbusiness 22.0.2 → 23.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/{ad_account_suggested_tag.rb → ab_test_post_test_actions.rb} +2 -4
  3. data/lib/facebook_ads/ad_objects/ad.rb +3 -0
  4. data/lib/facebook_ads/ad_objects/ad_account.rb +27 -40
  5. data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +1 -0
  6. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +35 -1
  7. data/lib/facebook_ads/ad_objects/ad_account_agency_fee_config.rb +34 -0
  8. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +1 -0
  9. data/lib/facebook_ads/ad_objects/ad_account_optimization_goals_aemv2_eligibility.rb +1 -0
  10. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +2 -0
  11. data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb +6 -0
  12. data/lib/facebook_ads/ad_objects/ad_activity.rb +8 -0
  13. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +2 -0
  14. data/lib/facebook_ads/ad_objects/ad_asset_onsite_destinations.rb +1 -0
  15. data/lib/facebook_ads/ad_objects/ad_asset_target_rule_targeting.rb +1 -0
  16. data/lib/facebook_ads/ad_objects/ad_async_request_set.rb +1 -0
  17. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +1 -0
  18. data/lib/facebook_ads/ad_objects/ad_campaign_group_agency_fee_config_for_api.rb +27 -0
  19. data/lib/facebook_ads/ad_objects/ad_creative.rb +4 -0
  20. data/lib/facebook_ads/ad_objects/ad_creative_feature_customizations.rb +1 -0
  21. data/lib/facebook_ads/ad_objects/ad_creative_features_spec.rb +9 -0
  22. data/lib/facebook_ads/ad_objects/ad_creative_format_transformation_spec.rb +26 -0
  23. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +1 -0
  24. data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +1 -0
  25. data/lib/facebook_ads/ad_objects/ad_creative_media_sourcing_spec.rb +24 -0
  26. data/lib/facebook_ads/ad_objects/ad_creative_site_links_spec.rb +3 -0
  27. data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +2 -0
  28. data/lib/facebook_ads/ad_objects/ad_preview.rb +7 -0
  29. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +29 -0
  30. data/lib/facebook_ads/ad_objects/ad_report_run.rb +2 -0
  31. data/lib/facebook_ads/ad_objects/ad_rule_history.rb +1 -0
  32. data/lib/facebook_ads/ad_objects/ad_set.rb +31 -0
  33. data/lib/facebook_ads/ad_objects/ad_video.rb +4 -13
  34. data/lib/facebook_ads/ad_objects/ads_action_stats.rb +3 -0
  35. data/lib/facebook_ads/ad_objects/ads_dataset.rb +5 -0
  36. data/lib/facebook_ads/ad_objects/ads_histogram_stats.rb +3 -0
  37. data/lib/facebook_ads/ad_objects/ads_insights.rb +50 -0
  38. data/lib/facebook_ads/ad_objects/ads_naming_template.rb +1 -0
  39. data/lib/facebook_ads/ad_objects/ads_pixel_capi_integration_quality.rb +5 -0
  40. data/lib/facebook_ads/ad_objects/ads_user_settings.rb +11 -0
  41. data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +10 -0
  42. data/lib/facebook_ads/ad_objects/ai_generated_product_image.rb +26 -0
  43. data/lib/facebook_ads/ad_objects/alm_event.rb +1 -0
  44. data/lib/facebook_ads/ad_objects/alm_guidance.rb +1 -0
  45. data/lib/facebook_ads/ad_objects/alm_guidance_metrics.rb +9 -0
  46. data/lib/facebook_ads/ad_objects/apac_mon_seller_status_api_container.rb +25 -0
  47. data/lib/facebook_ads/ad_objects/application.rb +17 -6
  48. data/lib/facebook_ads/ad_objects/audio_sub_label.rb +29 -0
  49. data/lib/facebook_ads/ad_objects/{shadow_ig_media_boosted_insights_result.rb → branded_content_fb_promode_user.rb} +5 -6
  50. data/lib/facebook_ads/ad_objects/business.rb +40 -7
  51. data/lib/facebook_ads/ad_objects/business_asset_group.rb +1 -0
  52. data/lib/facebook_ads/ad_objects/business_role_request.rb +19 -0
  53. data/lib/facebook_ads/ad_objects/business_user.rb +23 -0
  54. data/lib/facebook_ads/ad_objects/campaign.rb +3 -0
  55. data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb +0 -1
  56. data/lib/facebook_ads/ad_objects/china_business_onboarding_vetting_request.rb +3 -0
  57. data/lib/facebook_ads/ad_objects/collaborative_ads_partner_businesses.rb +1 -0
  58. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +6 -0
  59. data/lib/facebook_ads/ad_objects/content_delivery_report.rb +2 -4
  60. data/lib/facebook_ads/ad_objects/copyright_ownership_transfer.rb +28 -0
  61. data/lib/facebook_ads/ad_objects/creative_multicell_test_config.rb +4 -0
  62. data/lib/facebook_ads/ad_objects/ctwa_whats_app_numbers_info.rb +1 -0
  63. data/lib/facebook_ads/ad_objects/ctx_default_optimization_config.rb +1 -0
  64. data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -1
  65. data/lib/facebook_ads/ad_objects/custom_audience_integrity_flags_and_appeal_status.rb +29 -0
  66. data/lib/facebook_ads/ad_objects/delivery_window.rb +1 -0
  67. data/lib/facebook_ads/ad_objects/event.rb +1 -0
  68. data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +3 -0
  69. data/lib/facebook_ads/ad_objects/group.rb +2 -0
  70. data/lib/facebook_ads/ad_objects/home_listing.rb +2 -0
  71. data/lib/facebook_ads/ad_objects/ig_comment_from_user.rb +1 -0
  72. data/lib/facebook_ads/ad_objects/ig_media.rb +3 -0
  73. data/lib/facebook_ads/ad_objects/ig_user.rb +26 -0
  74. data/lib/facebook_ads/ad_objects/ig_user_export_for_cam.rb +549 -0
  75. data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +8 -2
  76. data/lib/facebook_ads/ad_objects/ig_user_messenger_profile.rb +26 -0
  77. data/lib/facebook_ads/ad_objects/image_copyright.rb +1 -0
  78. data/lib/facebook_ads/ad_objects/image_reference_match.rb +1 -0
  79. data/lib/facebook_ads/ad_objects/insights_result.rb +1 -2
  80. data/lib/facebook_ads/ad_objects/{ads_value_adjustment_rule.rb → instagram_business_asset.rb} +3 -6
  81. data/lib/facebook_ads/ad_objects/{bespoke_partner_guidance_laser.rb → instagram_thread.rb} +4 -6
  82. data/lib/facebook_ads/ad_objects/instagram_user.rb +0 -11
  83. data/lib/facebook_ads/ad_objects/lead_gen_client_validation_rules.rb +27 -0
  84. data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +2 -0
  85. data/lib/facebook_ads/ad_objects/lead_gen_thank_you_page.rb +1 -0
  86. data/lib/facebook_ads/ad_objects/lookalike_spec.rb +2 -0
  87. data/lib/facebook_ads/ad_objects/managed_partner_business.rb +544 -0
  88. data/lib/facebook_ads/ad_objects/management_site_link.rb +31 -0
  89. data/lib/facebook_ads/ad_objects/mcom_invoice_status.rb +3 -0
  90. data/lib/facebook_ads/ad_objects/message_delivery_estimate.rb +1 -0
  91. data/lib/facebook_ads/ad_objects/messenger_call_settings.rb +2 -0
  92. data/lib/facebook_ads/ad_objects/messenger_profile.rb +0 -2
  93. data/lib/facebook_ads/ad_objects/omega_customer_trx.rb +5 -0
  94. data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +4 -0
  95. data/lib/facebook_ads/ad_objects/organization.rb +0 -2
  96. data/lib/facebook_ads/ad_objects/page.rb +17 -7
  97. data/lib/facebook_ads/ad_objects/product_catalog.rb +44 -1
  98. data/lib/facebook_ads/ad_objects/product_catalog_check_marketplace_partner_sellers_status.rb +27 -0
  99. data/lib/facebook_ads/ad_objects/product_feed.rb +1 -0
  100. data/lib/facebook_ads/ad_objects/product_group.rb +1 -0
  101. data/lib/facebook_ads/ad_objects/product_item.rb +10 -0
  102. data/lib/facebook_ads/ad_objects/product_item_video_data.rb +26 -0
  103. data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +1 -0
  104. data/lib/facebook_ads/ad_objects/robot.rb +1 -0
  105. data/lib/facebook_ads/ad_objects/shadow_ig_user_ctx_partner_app_welcome_message_flow.rb +31 -0
  106. data/lib/facebook_ads/ad_objects/system_user.rb +4 -0
  107. data/lib/facebook_ads/ad_objects/targeting.rb +2 -0
  108. data/lib/facebook_ads/ad_objects/third_party_partner_viewability_request.rb +1 -0
  109. data/lib/facebook_ads/ad_objects/unified_thread.rb +0 -1
  110. data/lib/facebook_ads/ad_objects/user.rb +8 -1
  111. data/lib/facebook_ads/ad_objects/user_page_one_time_opt_in_token_settings.rb +1 -0
  112. data/lib/facebook_ads/ad_objects/vehicle.rb +3 -0
  113. data/lib/facebook_ads/ad_objects/{split_test_config.rb → website_creative_info.rb} +3 -7
  114. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +8 -4
  115. data/lib/facebook_ads/ad_objects/whats_app_business_pre_verified_phone_number.rb +1 -1
  116. data/lib/facebook_ads/version.rb +2 -2
  117. metadata +22 -9
  118. data/lib/facebook_ads/ad_objects/event_tour.rb +0 -35
  119. data/lib/facebook_ads/ad_objects/keyword_delivery_report.rb +0 -33
@@ -96,6 +96,7 @@ module FacebookAds
96
96
  "VIDEO_CALL",
97
97
  "VIEW_CART",
98
98
  "VIEW_CHANNEL",
99
+ "VIEW_IN_CART",
99
100
  "VIEW_PRODUCT",
100
101
  "VISIT_PAGES_FEED",
101
102
  "WATCH_LIVE_VIDEO",
@@ -186,6 +187,7 @@ module FacebookAds
186
187
  field :creative_sourcing_spec, 'AdCreativeSourcingSpec'
187
188
  field :degrees_of_freedom_spec, 'AdCreativeDegreesOfFreedomSpec'
188
189
  field :destination_set_id, 'string'
190
+ field :destination_spec, 'AdCreativeDestinationSpec'
189
191
  field :dynamic_ad_voice, 'string'
190
192
  field :effective_authorization_category, 'string'
191
193
  field :effective_instagram_media_id, 'string'
@@ -193,6 +195,7 @@ module FacebookAds
193
195
  field :enable_direct_install, 'bool'
194
196
  field :enable_launch_instant_app, 'bool'
195
197
  field :facebook_branded_content, 'AdCreativeFacebookBrandedContent'
198
+ field :format_transformation_spec, 'AdCreativeFormatTransformationSpec'
196
199
  field :id, 'string'
197
200
  field :image_crops, 'AdsImageCrops'
198
201
  field :image_hash, 'string'
@@ -224,6 +227,7 @@ module FacebookAds
224
227
  field :product_set_id, 'string'
225
228
  field :recommender_settings, 'AdCreativeRecommenderSettings'
226
229
  field :regional_regulation_disclaimer_spec, 'AdCreativeRegionalRegulationDisclaimer'
230
+ field :source_facebook_post_id, 'string'
227
231
  field :source_instagram_media_id, 'string'
228
232
  field :status, { enum: -> { STATUS }}
229
233
  field :template_url, 'string'
@@ -19,6 +19,7 @@ module FacebookAds
19
19
  field :catalog_feed_tag_name, 'string'
20
20
  field :font_name, 'string'
21
21
  field :image_crop_style, 'string'
22
+ field :pe_carousel, 'object'
22
23
  field :showcase_card_display, 'string'
23
24
  field :text_extraction, 'object'
24
25
  field :text_style, 'string'
@@ -21,6 +21,7 @@ module FacebookAds
21
21
  field :advantage_plus_creative, 'AdCreativeFeatureDetails'
22
22
  field :app_highlights, 'AdCreativeFeatureDetails'
23
23
  field :audio, 'AdCreativeFeatureDetails'
24
+ field :biz_ai, 'AdCreativeFeatureDetails'
24
25
  field :carousel_to_video, 'AdCreativeFeatureDetails'
25
26
  field :catalog_feed_tag, 'AdCreativeFeatureDetails'
26
27
  field :customize_product_recommendation, 'AdCreativeFeatureDetails'
@@ -33,6 +34,7 @@ module FacebookAds
33
34
  field :fb_reels_tag, 'AdCreativeFeatureDetails'
34
35
  field :fb_story_tag, 'AdCreativeFeatureDetails'
35
36
  field :feed_caption_optimization, 'AdCreativeFeatureDetails'
37
+ field :hide_price, 'AdCreativeFeatureDetails'
36
38
  field :ig_feed_tag, 'AdCreativeFeatureDetails'
37
39
  field :ig_glados_feed, 'AdCreativeFeatureDetails'
38
40
  field :ig_reels_tag, 'AdCreativeFeatureDetails'
@@ -51,20 +53,27 @@ module FacebookAds
51
53
  field :media_order, 'AdCreativeFeatureDetails'
52
54
  field :media_type_automation, 'AdCreativeFeatureDetails'
53
55
  field :multi_photo_to_video, 'AdCreativeFeatureDetails'
56
+ field :music_generation, 'AdCreativeFeatureDetails'
54
57
  field :pac_relaxation, 'AdCreativeFeatureDetails'
55
58
  field :product_extensions, 'AdCreativeFeatureDetails'
56
59
  field :product_metadata_automation, 'AdCreativeFeatureDetails'
57
60
  field :product_tags, 'AdCreativeFeatureDetails'
58
61
  field :profile_card, 'AdCreativeFeatureDetails'
62
+ field :profile_extension, 'AdCreativeFeatureDetails'
63
+ field :show_summary, 'AdCreativeFeatureDetails'
59
64
  field :site_extensions, 'AdCreativeFeatureDetails'
60
65
  field :standard_enhancements, 'AdCreativeFeatureDetails'
61
66
  field :standard_enhancements_catalog, 'AdCreativeFeatureDetails'
62
67
  field :text_generation, 'AdCreativeFeatureDetails'
63
68
  field :text_optimizations, 'AdCreativeFeatureDetails'
69
+ field :text_overlay_translation, 'AdCreativeFeatureDetails'
70
+ field :text_translation, 'AdCreativeFeatureDetails'
64
71
  field :video_auto_crop, 'AdCreativeFeatureDetails'
65
72
  field :video_filtering, 'AdCreativeFeatureDetails'
66
73
  field :video_highlight, 'AdCreativeFeatureDetails'
74
+ field :video_to_image, 'AdCreativeFeatureDetails'
67
75
  field :video_uncrop, 'AdCreativeFeatureDetails'
76
+ field :wa_mm_text_truncation_length, 'AdCreativeFeatureDetails'
68
77
  has_no_id
69
78
  has_no_get
70
79
  has_no_post
@@ -0,0 +1,26 @@
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+
4
+ # This source code is licensed under the license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ # FB:AUTOGEN
8
+
9
+ module FacebookAds
10
+ # This class is auto-generated.
11
+
12
+ # For any issues or feature requests related to this class, please let us know
13
+ # on github and we'll fix in our codegen framework. We'll not be able to accept
14
+ # pull request for this class.
15
+
16
+ class AdCreativeFormatTransformationSpec < AdObject
17
+
18
+ field :data_source, { list: 'string' }
19
+ field :format, 'string'
20
+ has_no_id
21
+ has_no_get
22
+ has_no_post
23
+ has_no_delete
24
+
25
+ end
26
+ end
@@ -96,6 +96,7 @@ module FacebookAds
96
96
  "VIDEO_CALL",
97
97
  "VIEW_CART",
98
98
  "VIEW_CHANNEL",
99
+ "VIEW_IN_CART",
99
100
  "VIEW_PRODUCT",
100
101
  "VISIT_PAGES_FEED",
101
102
  "WATCH_LIVE_VIDEO",
@@ -17,6 +17,7 @@ module FacebookAds
17
17
  CUSTOM_TEXT_TYPE = [
18
18
  "free_shipping",
19
19
  "popular",
20
+ "sale",
20
21
  ]
21
22
 
22
23
  OVERLAY_TEMPLATE = [
@@ -0,0 +1,24 @@
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+
4
+ # This source code is licensed under the license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ # FB:AUTOGEN
8
+
9
+ module FacebookAds
10
+ # This class is auto-generated.
11
+
12
+ # For any issues or feature requests related to this class, please let us know
13
+ # on github and we'll fix in our codegen framework. We'll not be able to accept
14
+ # pull request for this class.
15
+
16
+ class AdCreativeMediaSourcingSpec < AdObject
17
+
18
+ has_no_id
19
+ has_no_get
20
+ has_no_post
21
+ has_no_delete
22
+
23
+ end
24
+ end
@@ -15,6 +15,9 @@ module FacebookAds
15
15
 
16
16
  class AdCreativeSiteLinksSpec < AdObject
17
17
 
18
+ field :is_site_link_sticky, 'bool'
19
+ field :site_link_hash, 'string'
20
+ field :site_link_id, 'string'
18
21
  field :site_link_image_hash, 'string'
19
22
  field :site_link_image_url, 'string'
20
23
  field :site_link_recommendation_type, 'string'
@@ -17,10 +17,12 @@ module FacebookAds
17
17
 
18
18
  field :associated_product_set_id, 'string'
19
19
  field :brand, 'object'
20
+ field :dynamic_site_links_spec, 'object'
20
21
  field :enable_social_feedback_preservation, 'bool'
21
22
  field :promotion_metadata_spec, { list: 'AdCreativePromotionMetadataSpec' }
22
23
  field :site_links_spec, { list: 'AdCreativeSiteLinksSpec' }
23
24
  field :source_url, 'string'
25
+ field :website_summary_spec, 'object'
24
26
  has_no_id
25
27
  has_no_get
26
28
  has_no_post
@@ -26,6 +26,8 @@ module FacebookAds
26
26
  "FACEBOOK_PROFILE_REELS_MOBILE",
27
27
  "FACEBOOK_REELS_BANNER",
28
28
  "FACEBOOK_REELS_BANNER_DESKTOP",
29
+ "FACEBOOK_REELS_BANNER_FULLSCREEN_IOS",
30
+ "FACEBOOK_REELS_BANNER_FULLSCREEN_MOBILE",
29
31
  "FACEBOOK_REELS_MOBILE",
30
32
  "FACEBOOK_REELS_POSTLOOP",
31
33
  "FACEBOOK_REELS_STICKER",
@@ -40,7 +42,9 @@ module FacebookAds
40
42
  "INSTAGRAM_PROFILE_FEED",
41
43
  "INSTAGRAM_PROFILE_REELS",
42
44
  "INSTAGRAM_REELS",
45
+ "INSTAGRAM_REELS_INSTREAM",
43
46
  "INSTAGRAM_REELS_OVERLAY",
47
+ "INSTAGRAM_REELS_WEB",
44
48
  "INSTAGRAM_SEARCH_CHAIN",
45
49
  "INSTAGRAM_SEARCH_GRID",
46
50
  "INSTAGRAM_STANDARD",
@@ -51,6 +55,7 @@ module FacebookAds
51
55
  "INSTANT_ARTICLE_RECIRCULATION_AD",
52
56
  "INSTANT_ARTICLE_STANDARD",
53
57
  "INSTREAM_BANNER_DESKTOP",
58
+ "INSTREAM_BANNER_FULLSCREEN_IOS",
54
59
  "INSTREAM_BANNER_FULLSCREEN_MOBILE",
55
60
  "INSTREAM_BANNER_IMMERSIVE_MOBILE",
56
61
  "INSTREAM_BANNER_MOBILE",
@@ -85,6 +90,8 @@ module FacebookAds
85
90
  "product_metadata_automation",
86
91
  "profile_card",
87
92
  "standard_enhancements_catalog",
93
+ "text_overlay_translation",
94
+ "video_to_image",
88
95
  ]
89
96
 
90
97
  RENDER_TYPE = [
@@ -46,6 +46,30 @@ module FacebookAds
46
46
  "TUTORIAL_COMPLETION",
47
47
  ]
48
48
 
49
+ FULL_FUNNEL_OBJECTIVE = [
50
+ "APP_INSTALLS",
51
+ "BRAND_AWARENESS",
52
+ "EVENT_RESPONSES",
53
+ "LEAD_GENERATION",
54
+ "LINK_CLICKS",
55
+ "LOCAL_AWARENESS",
56
+ "MESSAGES",
57
+ "OFFER_CLAIMS",
58
+ "OUTCOME_APP_PROMOTION",
59
+ "OUTCOME_AWARENESS",
60
+ "OUTCOME_ENGAGEMENT",
61
+ "OUTCOME_LEADS",
62
+ "OUTCOME_SALES",
63
+ "OUTCOME_TRAFFIC",
64
+ "PAGE_LIKES",
65
+ "POST_ENGAGEMENT",
66
+ "PRODUCT_CATALOG_SALES",
67
+ "REACH",
68
+ "STORE_VISITS",
69
+ "VIDEO_VIEWS",
70
+ "WEBSITE_CONVERSIONS",
71
+ ]
72
+
49
73
  LEAD_ADS_CUSTOM_EVENT_TYPE = [
50
74
  "ACHIEVEMENT_UNLOCKED",
51
75
  "ADD_PAYMENT_INFO",
@@ -85,7 +109,9 @@ module FacebookAds
85
109
  field :custom_conversion_id, 'string'
86
110
  field :custom_event_str, 'string'
87
111
  field :custom_event_type, { enum: -> { CUSTOM_EVENT_TYPE }}
112
+ field :dataset_split_id, 'string'
88
113
  field :event_id, 'string'
114
+ field :full_funnel_objective, { enum: -> { FULL_FUNNEL_OBJECTIVE }}
89
115
  field :fundraiser_campaign_id, 'string'
90
116
  field :lead_ads_custom_event_str, 'string'
91
117
  field :lead_ads_custom_event_type, { enum: -> { LEAD_ADS_CUSTOM_EVENT_TYPE }}
@@ -93,6 +119,7 @@ module FacebookAds
93
119
  field :lead_ads_offsite_conversion_type, 'string'
94
120
  field :mcme_conversion_id, 'string'
95
121
  field :object_store_url, 'string'
122
+ field :object_store_urls, { list: 'string' }
96
123
  field :offer_id, 'string'
97
124
  field :offline_conversion_data_set_id, 'string'
98
125
  field :offsite_conversion_event_id, 'string'
@@ -107,9 +134,11 @@ module FacebookAds
107
134
  field :product_item_id, 'string'
108
135
  field :product_set, 'ProductSet'
109
136
  field :product_set_id, 'string'
137
+ field :product_set_optimization, 'string'
110
138
  field :retention_days, 'string'
111
139
  field :value_semantic_type, 'string'
112
140
  field :variation, 'string'
141
+ field :whats_app_business_phone_number_id, 'string'
113
142
  field :whatsapp_phone_number, 'string'
114
143
  has_no_id
115
144
  has_no_get
@@ -22,6 +22,7 @@ module FacebookAds
22
22
  field :date_start, 'string'
23
23
  field :date_stop, 'string'
24
24
  field :emails, { list: 'string' }
25
+ field :error_code, 'int'
25
26
  field :friendly_name, 'string'
26
27
  field :id, 'string'
27
28
  field :is_async_export, 'int'
@@ -42,6 +43,7 @@ module FacebookAds
42
43
  field :fields, { list: 'string' }
43
44
  field :filtering, { list: 'object' }
44
45
  field :level, 'adaccountinsights_level_enum_param'
46
+ field :limit, 'int'
45
47
  field :product_id_limit, 'int'
46
48
  field :sort, { list: 'string' }
47
49
  field :summary, { list: 'string' }
@@ -23,6 +23,7 @@ module FacebookAds
23
23
  "CONVERT_ASC_CP_SINGLE_INSTANCE",
24
24
  "EMAIL",
25
25
  "ENABLE_ADVANTAGE_CAMPAIGN_BUDGET",
26
+ "ENABLE_ADVANTAGE_PLUS_AUDIENCE",
26
27
  "ENABLE_ADVANTAGE_PLUS_CREATIVE",
27
28
  "ENABLE_ADVANTAGE_PLUS_PLACEMENTS",
28
29
  "ENABLE_AUTOFLOW",
@@ -57,6 +57,7 @@ module FacebookAds
57
57
  "AD_RECALL_LIFT",
58
58
  "APP_INSTALLS",
59
59
  "APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
60
+ "AUTOMATIC_OBJECTIVE",
60
61
  "CONVERSATIONS",
61
62
  "DERIVED_EVENTS",
62
63
  "ENGAGED_USERS",
@@ -92,6 +93,22 @@ module FacebookAds
92
93
  "PAUSED",
93
94
  ]
94
95
 
96
+ AUTOMATIC_MANUAL_STATE = [
97
+ "AUTOMATIC",
98
+ "MANUAL",
99
+ "UNSET",
100
+ ]
101
+
102
+ BUDGET_SOURCE = [
103
+ "NONE",
104
+ "RMN",
105
+ ]
106
+
107
+ CREATIVE_SEQUENCE_REPETITION_PATTERN = [
108
+ "FULL_SEQUENCE",
109
+ "LAST_AD",
110
+ ]
111
+
95
112
  DATE_PRESET = [
96
113
  "DATA_MAXIMUM",
97
114
  "LAST_14D",
@@ -119,8 +136,11 @@ module FacebookAds
119
136
  "APP",
120
137
  "APPLINKS_AUTOMATIC",
121
138
  "FACEBOOK",
139
+ "FACEBOOK_LIVE",
122
140
  "FACEBOOK_PAGE",
141
+ "IMAGINE",
123
142
  "INSTAGRAM_DIRECT",
143
+ "INSTAGRAM_LIVE",
124
144
  "INSTAGRAM_PROFILE",
125
145
  "INSTAGRAM_PROFILE_AND_FACEBOOK_PAGE",
126
146
  "MESSAGING_INSTAGRAM_DIRECT_MESSENGER",
@@ -176,6 +196,8 @@ module FacebookAds
176
196
  "3",
177
197
  "4",
178
198
  "5",
199
+ "6",
200
+ "7",
179
201
  ]
180
202
 
181
203
  TUNE_FOR_CATEGORY = [
@@ -205,6 +227,7 @@ module FacebookAds
205
227
  field :adset_schedule, { list: 'DayPart' }
206
228
  field :asset_feed_id, 'string'
207
229
  field :attribution_spec, { list: 'AttributionSpec' }
230
+ field :automatic_manual_state, 'string'
208
231
  field :bid_adjustments, 'AdBidAdjustments'
209
232
  field :bid_amount, 'int'
210
233
  field :bid_constraints, 'AdCampaignBidConstraint'
@@ -220,6 +243,7 @@ module FacebookAds
220
243
  field :configured_status, { enum: -> { CONFIGURED_STATUS }}
221
244
  field :created_time, 'datetime'
222
245
  field :creative_sequence, { list: 'string' }
246
+ field :creative_sequence_repetition_pattern, 'string'
223
247
  field :daily_budget, 'string'
224
248
  field :daily_min_spend_target, 'string'
225
249
  field :daily_spend_cap, 'string'
@@ -236,6 +260,7 @@ module FacebookAds
236
260
  field :is_ba_skip_delayed_eligible, 'bool'
237
261
  field :is_budget_schedule_enabled, 'bool'
238
262
  field :is_dynamic_creative, 'bool'
263
+ field :is_incremental_attribution_enabled, 'bool'
239
264
  field :issues_info, { list: 'AdCampaignIssuesInfo' }
240
265
  field :learning_stage_info, 'AdCampaignLearningStageInfo'
241
266
  field :lifetime_budget, 'string'
@@ -266,6 +291,8 @@ module FacebookAds
266
291
  field :time_based_ad_rotation_intervals, { list: 'int' }
267
292
  field :updated_time, 'datetime'
268
293
  field :use_new_app_click, 'bool'
294
+ field :budget_source, { enum: -> { BUDGET_SOURCE }}
295
+ field :budget_split_set_id, 'string'
269
296
  field :campaign_spec, 'object'
270
297
  field :daily_imps, 'int'
271
298
  field :date_format, 'string'
@@ -379,6 +406,7 @@ module FacebookAds
379
406
  api.has_param :fields, { list: 'string' }
380
407
  api.has_param :filtering, { list: 'object' }
381
408
  api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
409
+ api.has_param :limit, 'int'
382
410
  api.has_param :product_id_limit, 'int'
383
411
  api.has_param :sort, { list: 'string' }
384
412
  api.has_param :summary, { list: 'string' }
@@ -402,6 +430,7 @@ module FacebookAds
402
430
  api.has_param :fields, { list: 'string' }
403
431
  api.has_param :filtering, { list: 'object' }
404
432
  api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
433
+ api.has_param :limit, 'int'
405
434
  api.has_param :product_id_limit, 'int'
406
435
  api.has_param :sort, { list: 'string' }
407
436
  api.has_param :summary, { list: 'string' }
@@ -417,6 +446,8 @@ module FacebookAds
417
446
  has_edge :message_delivery_estimate do |edge|
418
447
  edge.get 'MessageDeliveryEstimate' do |api|
419
448
  api.has_param :bid_amount, 'int'
449
+ api.has_param :daily_budget, 'int'
450
+ api.has_param :is_direct_send_campaign, 'bool'
420
451
  api.has_param :lifetime_budget, 'int'
421
452
  api.has_param :lifetime_in_days, 'int'
422
453
  api.has_param :optimization_goal, { enum: -> { MessageDeliveryEstimate::OPTIMIZATION_GOAL }}
@@ -15,13 +15,11 @@ module FacebookAds
15
15
 
16
16
  class AdVideo < AdObject
17
17
  CONTAINER_TYPE = [
18
- "ACO_AUTOEXTRACTED_VIDEO",
19
18
  "ACO_VIDEO_VARIATION",
20
19
  "ADS_AI_GENERATED",
21
20
  "AD_BREAK_PREVIEW",
22
21
  "AD_DERIVATIVE",
23
22
  "AD_LIBRARY_WATERMARK",
24
- "AGE_UP",
25
23
  "ALBUM_MULTIMEDIA_POST",
26
24
  "ALOHA_SUPERFRAME",
27
25
  "APP_REREVIEW_SCREENCAST",
@@ -32,7 +30,6 @@ module FacebookAds
32
30
  "AUDIO_COMMENT",
33
31
  "BROADCAST",
34
32
  "CANVAS",
35
- "CFC_VIDEO",
36
33
  "CMS_MEDIA_MANAGER",
37
34
  "CONTAINED_POST_ATTACHMENT",
38
35
  "CONTAINED_POST_AUDIO_BROADCAST",
@@ -43,6 +40,7 @@ module FacebookAds
43
40
  "CREATION_ML_PRECREATION",
44
41
  "CREATOR_FAN_CHALLENGE",
45
42
  "CREATOR_STOREFRONT_PERSONALIZED_VIDEO",
43
+ "CREATOR_STOREFRONT_PROMOTIONAL_VIDEO",
46
44
  "DATAGENIX_VIDEO",
47
45
  "DCO_AD_ASSET_FEED",
48
46
  "DCO_AUTOGEN_VIDEO",
@@ -50,9 +48,7 @@ module FacebookAds
50
48
  "DIM_SUM",
51
49
  "DIRECTED_POST_ATTACHMENT",
52
50
  "DIRECT_INBOX",
53
- "DIRECT_INBOX_REACTION",
54
51
  "DROPS_SHOPPING_EVENT_PAGE",
55
- "DYNAMIC_ITEM_DISPLAY_BUNDLE",
56
52
  "DYNAMIC_ITEM_VIDEO",
57
53
  "DYNAMIC_TEMPLATE_VIDEO",
58
54
  "EVENT_COVER_VIDEO",
@@ -65,7 +61,6 @@ module FacebookAds
65
61
  "FB_SHORTS_GROUP_POST",
66
62
  "FB_SHORTS_LINKED_PRODUCT",
67
63
  "FB_SHORTS_PMV_POST",
68
- "FB_SHORTS_PMV_POST_NO_NEWSFEED_NOR_TIMELINE",
69
64
  "FB_SHORTS_POST",
70
65
  "FB_SHORTS_REMIX_POST",
71
66
  "FUNDRAISER_COVER_VIDEO",
@@ -80,6 +75,7 @@ module FacebookAds
80
75
  "GROUP_POST",
81
76
  "HEURISTIC_CLUSTER_VIDEO",
82
77
  "HIGHLIGHT_CLIP_VIDEO",
78
+ "HORIZON_WORLDS_TV",
83
79
  "HUDDLE_BROADCAST",
84
80
  "IG_REELS_XPV",
85
81
  "IG_STORIES_READER",
@@ -110,7 +106,6 @@ module FacebookAds
110
106
  "NEO_ASYNC_GAME_VIDEO",
111
107
  "NEW_CONTAINED_POST_BROADCAST",
112
108
  "NO_STORY",
113
- "NPE_COLLAB_COPYRIGHT_CHECK",
114
109
  "OCULUS_CREATOR_PORTAL",
115
110
  "OCULUS_VENUES_BROADCAST",
116
111
  "ORIGINALITY_SELF_ADVOCACY",
@@ -120,8 +115,6 @@ module FacebookAds
120
115
  "PAID_CONTENT_PREVIEW",
121
116
  "PAID_CONTENT_VIDEO",
122
117
  "PAID_CONTENT_VIDEO__POST",
123
- "PAPER_DOCUMENT_AUDIO",
124
- "PAPER_DOCUMENT_VIDEO",
125
118
  "PIXELCLOUD",
126
119
  "PODCAST_HIGHLIGHT",
127
120
  "PODCAST_ML_PREVIEW",
@@ -150,11 +143,9 @@ module FacebookAds
150
143
  "SLIDESHOW_ANIMOTO",
151
144
  "SLIDESHOW_SHAKR",
152
145
  "SLIDESHOW_VARIATION_VIDEO",
153
- "SOUNDBITES_VIDEO",
154
146
  "SOUND_PLATFORM_STREAM",
155
147
  "SRT_ATTACHMENT",
156
148
  "STORIES_VIDEO",
157
- "STORIES_WEARABLE",
158
149
  "STORYLINE",
159
150
  "STORYLINE_WITH_EXTERNAL_MUSIC",
160
151
  "STORY_ARCHIVE_VIDEO",
@@ -162,10 +153,8 @@ module FacebookAds
162
153
  "STREAM_HIGHLIGHTS_VIDEO",
163
154
  "TAROT_DIGEST",
164
155
  "TEMPORARY_UNLISTED",
165
- "TEMP_MULTIMEDIA_POST",
166
156
  "TEMP_VIDEO_COPYRIGHT_SCAN",
167
157
  "UNLISTED",
168
- "UNLISTED_HORIZON",
169
158
  "UNLISTED_OCULUS",
170
159
  "VIDEO_COMMENT",
171
160
  "VIDEO_COMPOSITION_VARIATION",
@@ -355,6 +344,7 @@ module FacebookAds
355
344
  field :instant_game_entry_point_data, 'string'
356
345
  field :is_boost_intended, 'bool'
357
346
  field :is_group_linking_post, 'bool'
347
+ field :is_partnership_ad, 'bool'
358
348
  field :is_voice_clip, 'bool'
359
349
  field :location_source_id, 'string'
360
350
  field :name, 'string'
@@ -365,6 +355,7 @@ module FacebookAds
365
355
  field :og_suggestion_mechanism, 'string'
366
356
  field :original_fov, 'int'
367
357
  field :original_projection_type, { enum: -> { ORIGINAL_PROJECTION_TYPE }}
358
+ field :partnership_ad_ad_code, 'string'
368
359
  field :publish_event_id, 'int'
369
360
  field :referenced_sticker_id, 'string'
370
361
  field :replace_video_id, 'string'
@@ -55,6 +55,9 @@ module FacebookAds
55
55
  field :action_video_sound, 'string'
56
56
  field :action_video_type, 'string'
57
57
  field :dda, 'string'
58
+ field :incrementality, 'string'
59
+ field :incrementality_all_conversions, 'string'
60
+ field :incrementality_first_conversion, 'string'
58
61
  field :inline, 'string'
59
62
  field :interactive_component_sticker_id, 'string'
60
63
  field :interactive_component_sticker_response, 'string'
@@ -14,6 +14,11 @@ module FacebookAds
14
14
  # pull request for this class.
15
15
 
16
16
  class AdsDataset < AdObject
17
+ SORT_BY = [
18
+ "LAST_FIRED_TIME",
19
+ "NAME",
20
+ ]
21
+
17
22
 
18
23
  field :can_proxy, 'bool'
19
24
  field :collection_rate, 'double'
@@ -55,6 +55,9 @@ module FacebookAds
55
55
  field :action_video_sound, 'string'
56
56
  field :action_video_type, 'string'
57
57
  field :dda, { list: 'int' }
58
+ field :incrementality, { list: 'int' }
59
+ field :incrementality_all_conversions, { list: 'int' }
60
+ field :incrementality_first_conversion, { list: 'int' }
58
61
  field :inline, { list: 'int' }
59
62
  field :interactive_component_sticker_id, 'string'
60
63
  field :interactive_component_sticker_response, 'string'