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
@@ -57,10 +57,13 @@ module FacebookAds
57
57
  ACTION_REPORT_TIME = [
58
58
  "conversion",
59
59
  "impression",
60
+ "lifetime",
60
61
  "mixed",
61
62
  ]
62
63
 
63
64
  BREAKDOWNS = [
65
+ "ad_extension_domain",
66
+ "ad_extension_url",
64
67
  "ad_format_asset",
65
68
  "age",
66
69
  "app_id",
@@ -69,13 +72,18 @@ module FacebookAds
69
72
  "breakdown_reporting_ad_id",
70
73
  "call_to_action_asset",
71
74
  "coarse_conversion_value",
75
+ "comscore_market",
76
+ "comscore_market_code",
72
77
  "conversion_destination",
73
78
  "country",
79
+ "creative_relaxation_asset_type",
74
80
  "description_asset",
75
81
  "device_platform",
76
82
  "dma",
77
83
  "fidelity_type",
84
+ "flexible_format_asset_type",
78
85
  "frequency_value",
86
+ "gen_ai_asset_type",
79
87
  "gender",
80
88
  "hourly_stats_aggregated_by_advertiser_time_zone",
81
89
  "hourly_stats_aggregated_by_audience_time_zone",
@@ -83,6 +91,7 @@ module FacebookAds
83
91
  "image_asset",
84
92
  "impression_device",
85
93
  "impression_view_time_advertiser_hour_v2",
94
+ "is_auto_advance",
86
95
  "is_conversion_id_modeled",
87
96
  "is_rendered_as_delayed_skip_ad",
88
97
  "landing_destination",
@@ -204,10 +213,26 @@ module FacebookAds
204
213
  field :conversion_rate_ranking, 'string'
205
214
  field :conversion_values, { list: 'AdsActionStats' }
206
215
  field :conversions, { list: 'AdsActionStats' }
216
+ field :converted_product_app_custom_event_fb_mobile_purchase, { list: 'AdsActionStats' }
217
+ field :converted_product_app_custom_event_fb_mobile_purchase_value, { list: 'AdsActionStats' }
218
+ field :converted_product_offline_purchase, { list: 'AdsActionStats' }
219
+ field :converted_product_offline_purchase_value, { list: 'AdsActionStats' }
220
+ field :converted_product_omni_purchase, { list: 'AdsActionStats' }
221
+ field :converted_product_omni_purchase_values, { list: 'AdsActionStats' }
207
222
  field :converted_product_quantity, { list: 'AdsActionStats' }
208
223
  field :converted_product_value, { list: 'AdsActionStats' }
224
+ field :converted_product_website_pixel_purchase, { list: 'AdsActionStats' }
225
+ field :converted_product_website_pixel_purchase_value, { list: 'AdsActionStats' }
226
+ field :converted_promoted_product_app_custom_event_fb_mobile_purchase, { list: 'AdsActionStats' }
227
+ field :converted_promoted_product_app_custom_event_fb_mobile_purchase_value, { list: 'AdsActionStats' }
228
+ field :converted_promoted_product_offline_purchase, { list: 'AdsActionStats' }
229
+ field :converted_promoted_product_offline_purchase_value, { list: 'AdsActionStats' }
230
+ field :converted_promoted_product_omni_purchase, { list: 'AdsActionStats' }
231
+ field :converted_promoted_product_omni_purchase_values, { list: 'AdsActionStats' }
209
232
  field :converted_promoted_product_quantity, { list: 'AdsActionStats' }
210
233
  field :converted_promoted_product_value, { list: 'AdsActionStats' }
234
+ field :converted_promoted_product_website_pixel_purchase, { list: 'AdsActionStats' }
235
+ field :converted_promoted_product_website_pixel_purchase_value, { list: 'AdsActionStats' }
211
236
  field :cost_per_15_sec_video_view, { list: 'AdsActionStats' }
212
237
  field :cost_per_2_sec_continuous_video_view, { list: 'AdsActionStats' }
213
238
  field :cost_per_action_type, { list: 'AdsActionStats' }
@@ -218,8 +243,10 @@ module FacebookAds
218
243
  field :cost_per_estimated_ad_recallers, 'string'
219
244
  field :cost_per_inline_link_click, 'string'
220
245
  field :cost_per_inline_post_engagement, 'string'
246
+ field :cost_per_objective_result, { list: 'object' }
221
247
  field :cost_per_one_thousand_ad_impression, { list: 'AdsActionStats' }
222
248
  field :cost_per_outbound_click, { list: 'AdsActionStats' }
249
+ field :cost_per_result, { list: 'object' }
223
250
  field :cost_per_thruplay, { list: 'AdsActionStats' }
224
251
  field :cost_per_unique_action_type, { list: 'AdsActionStats' }
225
252
  field :cost_per_unique_click, 'string'
@@ -258,8 +285,11 @@ module FacebookAds
258
285
  field :interactive_component_tap, { list: 'AdsActionStats' }
259
286
  field :labels, 'string'
260
287
  field :landing_page_view_actions_per_link_click, 'string'
288
+ field :landing_page_view_per_link_click, 'string'
261
289
  field :landing_page_view_per_purchase_rate, 'string'
290
+ field :link_clicks_per_results, { list: 'object' }
262
291
  field :location, 'string'
292
+ field :marketing_messages_click_rate_benchmark, 'string'
263
293
  field :marketing_messages_cost_per_delivered, 'string'
264
294
  field :marketing_messages_cost_per_link_btn_click, 'string'
265
295
  field :marketing_messages_delivered, 'string'
@@ -272,6 +302,7 @@ module FacebookAds
272
302
  field :marketing_messages_quick_reply_btn_click_rate, 'string'
273
303
  field :marketing_messages_read, 'string'
274
304
  field :marketing_messages_read_rate, 'string'
305
+ field :marketing_messages_read_rate_benchmark, 'string'
275
306
  field :marketing_messages_sent, 'string'
276
307
  field :marketing_messages_spend, 'string'
277
308
  field :marketing_messages_spend_currency, 'string'
@@ -281,20 +312,39 @@ module FacebookAds
281
312
  field :marketing_messages_website_purchase_values, 'string'
282
313
  field :mobile_app_purchase_roas, { list: 'AdsActionStats' }
283
314
  field :objective, 'string'
315
+ field :objective_result_rate, { list: 'object' }
316
+ field :objective_results, { list: 'object' }
284
317
  field :onsite_conversion_messaging_detected_purchase_deduped, { list: 'AdsActionStats' }
285
318
  field :optimization_goal, 'string'
286
319
  field :outbound_clicks, { list: 'AdsActionStats' }
287
320
  field :outbound_clicks_ctr, { list: 'AdsActionStats' }
288
321
  field :place_page_name, 'string'
322
+ field :product_brand, 'string'
323
+ field :product_category, 'string'
324
+ field :product_content_id, 'string'
325
+ field :product_custom_label_0, 'string'
326
+ field :product_custom_label_1, 'string'
327
+ field :product_custom_label_2, 'string'
328
+ field :product_custom_label_3, 'string'
329
+ field :product_custom_label_4, 'string'
330
+ field :product_group_content_id, 'string'
331
+ field :product_group_retailer_id, 'string'
332
+ field :product_name, 'string'
333
+ field :product_retailer_id, 'string'
334
+ field :product_views, 'string'
335
+ field :purchase_per_landing_page_view, 'string'
289
336
  field :purchase_roas, { list: 'AdsActionStats' }
290
337
  field :purchases_per_link_click, 'string'
291
338
  field :qualifying_question_qualify_answer_rate, 'string'
292
339
  field :quality_ranking, 'string'
293
340
  field :reach, 'string'
341
+ field :result_rate, { list: 'object' }
294
342
  field :result_values_performance_indicator, 'string'
343
+ field :results, { list: 'object' }
295
344
  field :shops_assisted_purchases, 'string'
296
345
  field :social_spend, 'string'
297
346
  field :spend, 'string'
347
+ field :total_card_view, 'string'
298
348
  field :total_postbacks, 'string'
299
349
  field :total_postbacks_detailed, { list: 'AdsActionStats' }
300
350
  field :total_postbacks_detailed_v4, { list: 'AdsActionStats' }
@@ -21,6 +21,7 @@ module FacebookAds
21
21
  "CAMPAIGN_GROUP",
22
22
  "OPPORTUNITIES",
23
23
  "PRIVACY_INFO_CENTER",
24
+ "PRODUCT",
24
25
  "TOPLINE",
25
26
  "UNIQUE_ADCREATIVE",
26
27
  ]
@@ -15,8 +15,13 @@ module FacebookAds
15
15
 
16
16
  class AdsPixelCapiIntegrationQuality < AdObject
17
17
 
18
+ field :acr, 'object'
19
+ field :data_freshness, 'object'
20
+ field :dedupe_key_feedback, { list: 'object' }
21
+ field :event_coverage, 'object'
18
22
  field :event_match_quality, 'object'
19
23
  field :event_name, 'string'
24
+ field :event_potential_aly_acr_increase, 'object'
20
25
  has_no_id
21
26
  has_no_get
22
27
  has_no_post
@@ -27,6 +27,7 @@ module FacebookAds
27
27
  field :aplusc_local_store_extension_opt_in_status, 'string'
28
28
  field :aplusc_opt_out_friction, { list: 'string' }
29
29
  field :aplusc_videofilter_opt_in_status, 'string'
30
+ field :aplusc_videouncrop_opt_in_status, 'string'
30
31
  field :autoflow_lite_opt_in_status, 'string'
31
32
  field :autoflow_lite_should_opt_in, 'bool'
32
33
  field :blended_ads_creation_defaulting_opt_in_status, 'string'
@@ -36,6 +37,8 @@ module FacebookAds
36
37
  field :campaign_name_template, 'object'
37
38
  field :carousel_to_video_opt_in_status, 'string'
38
39
  field :connected_sources_catalog_opt_in_status, 'string'
40
+ field :da_add_overlays_opt_in_status, 'string'
41
+ field :da_hide_price_opt_in_status, 'string'
39
42
  field :default_creation_mode, 'string'
40
43
  field :dynamic_partnership_ads_opt_in_status, 'string'
41
44
  field :enhance_cta_text_extraction_opt_in_status, 'string'
@@ -44,19 +47,25 @@ module FacebookAds
44
47
  field :gen_ai_alpha_test_status, 'int'
45
48
  field :id, 'string'
46
49
  field :image_background_generation_opt_in_status, 'string'
50
+ field :image_brightness_and_contrast_opt_in_status, 'string'
47
51
  field :image_expansion_opt_in_status, 'string'
48
52
  field :is_ads_ai_consented, 'bool'
49
53
  field :is_cbo_default_on, 'bool'
50
54
  field :is_se_removal_guidance_dismissed, 'bool'
51
55
  field :last_used_post_format, 'string'
52
56
  field :last_visited_time, 'datetime'
57
+ field :metadata_brand_kit_opt_in_status, 'string'
53
58
  field :music_on_reels_opt_in, { list: 'hash' }
54
59
  field :muted_cbo_midflight_education_messages, { list: 'string' }
55
60
  field :onsite_destination_optimization_opt_in, 'string'
56
61
  field :open_tabs, { list: 'string' }
62
+ field :pac_relaxation_opt_in_status, 'string'
63
+ field :placement_group_square_opt_in_status, 'string'
64
+ field :placement_group_vertical_opt_in_status, 'string'
57
65
  field :previously_seen_recommendations, { list: 'string' }
58
66
  field :product_extensions_opt_in, 'string'
59
67
  field :sa_off_conv_loc_seen, 'string'
68
+ field :saoff_published_l2_conv_loc_seen, 'string'
60
69
  field :saon_migr_l1_seen_status, 'string'
61
70
  field :selected_ad_account, 'AdAccount'
62
71
  field :selected_comparison_timerange, 'object'
@@ -72,10 +81,12 @@ module FacebookAds
72
81
  field :should_not_show_cbo_campaign_toggle_off_confirmation_message, 'bool'
73
82
  field :should_not_show_publish_message_on_editor_close, 'bool'
74
83
  field :show_original_videos_opt_in, 'string'
84
+ field :show_summary_opt_in_status, 'string'
75
85
  field :static_ad_product_extensions_opt_in, 'string'
76
86
  field :sticky_setting_after_default_on, 'string'
77
87
  field :syd_campaign_trends_metric, 'string'
78
88
  field :text_optimizations_text_extraction_opt_in_status, 'string'
89
+ field :text_translation_opt_in_status, 'string'
79
90
  field :text_variations_sticky_opt_in_status, 'string'
80
91
  field :total_coupon_syd_dismissals, 'int'
81
92
  field :total_coupon_upsell_dismissals, 'int'
@@ -20,14 +20,24 @@ module FacebookAds
20
20
  "OMNI_CHANNEL",
21
21
  ]
22
22
 
23
+ STATUS = [
24
+ "ACTIVE",
25
+ "DELETED",
26
+ ]
27
+
23
28
 
24
29
  field :id, 'string'
25
30
  field :is_default_setting, 'bool'
26
31
  field :name, 'string'
27
32
  field :product_type, 'string'
33
+ field :status, 'string'
28
34
  field :rules, { list: 'hash' }
29
35
  has_no_delete
30
36
 
37
+ has_edge :delete_rule_set do |edge|
38
+ edge.post 'AdsValueAdjustmentRuleCollection'
39
+ end
40
+
31
41
  has_edge :rules do |edge|
32
42
  edge.get
33
43
  end
@@ -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 AiGeneratedProductImage < AdObject
17
+
18
+ field :flagged_for_manual_review, 'bool'
19
+ field :transformed_image_url, 'string'
20
+ has_no_id
21
+ has_no_get
22
+ has_no_post
23
+ has_no_delete
24
+
25
+ end
26
+ end
@@ -22,6 +22,7 @@ module FacebookAds
22
22
  field :event_time, 'datetime'
23
23
  field :guidance, 'string'
24
24
  field :guidance_detail, 'string'
25
+ field :guidance_type, 'string'
25
26
  field :id, 'string'
26
27
  field :parent_advertiser_ids, { list: 'string' }
27
28
  field :reseller_business_id, 'string'
@@ -17,6 +17,7 @@ module FacebookAds
17
17
 
18
18
  field :ad_account_id, 'string'
19
19
  field :guidances, { list: 'object' }
20
+ field :opportunity_score, 'double'
20
21
  field :parent_advertiser_id, 'string'
21
22
  field :parent_advertiser_name, 'string'
22
23
  has_no_id
@@ -23,8 +23,17 @@ module FacebookAds
23
23
  field :l28_available, 'int'
24
24
  field :l28_click, 'int'
25
25
  field :l28_conversion, 'int'
26
+ field :l28_has_click, 'bool'
27
+ field :l28_has_impression, 'bool'
26
28
  field :l28_impression, 'int'
29
+ field :l28_is_actioned, 'bool'
30
+ field :l28_is_adopted, 'bool'
31
+ field :l28_is_available, 'bool'
32
+ field :l28_is_pitched, 'bool'
27
33
  field :l28_pitch, 'int'
34
+ field :l28d_adopted_revenue, 'double'
35
+ field :last_actioned_ds, 'string'
36
+ field :last_adopted_ds, 'string'
28
37
  field :last_pitch_ds, 'string'
29
38
  field :parent_advertiser_id, 'string'
30
39
  field :report_ds, 'string'
@@ -0,0 +1,25 @@
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 ApacMonSellerStatusApiContainer < AdObject
17
+
18
+ field :structured_messaging_commerce, 'object'
19
+ has_no_id
20
+ has_no_get
21
+ has_no_post
22
+ has_no_delete
23
+
24
+ end
25
+ end
@@ -443,6 +443,10 @@ module FacebookAds
443
443
  end
444
444
  end
445
445
 
446
+ has_edge :connected_client_businesses do |edge|
447
+ edge.get 'Business'
448
+ end
449
+
446
450
  has_edge :da_checks do |edge|
447
451
  edge.get 'DaCheck' do |api|
448
452
  api.has_param :checks, { list: 'string' }
@@ -470,12 +474,6 @@ module FacebookAds
470
474
  edge.get 'AdsDataset'
471
475
  end
472
476
 
473
- has_edge :message_templates do |edge|
474
- edge.get do |api|
475
- api.has_param :template_id, 'string'
476
- end
477
- end
478
-
479
477
  has_edge :mmp_auditing do |edge|
480
478
  edge.post do |api|
481
479
  api.has_param :advertiser_id, 'string'
@@ -567,6 +565,19 @@ module FacebookAds
567
565
  edge.get
568
566
  end
569
567
 
568
+ has_edge :sgw_dataset_status do |edge|
569
+ edge.get do |api|
570
+ api.has_param :dataset_id, 'int'
571
+ end
572
+ end
573
+
574
+ has_edge :sgw_install_deferral_link do |edge|
575
+ edge.get do |api|
576
+ api.has_param :client_ip, 'string'
577
+ api.has_param :dataset_id, 'int'
578
+ end
579
+ end
580
+
570
581
  has_edge :subscribed_domains do |edge|
571
582
  edge.get
572
583
  edge.post 'Application' do |api|
@@ -0,0 +1,29 @@
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 AudioSubLabel < AdObject
17
+
18
+ field :expiration_timestamp, 'datetime'
19
+ field :flagged_timestamp, 'datetime'
20
+ field :id, 'string'
21
+ field :label_name, 'string'
22
+ field :last_update_timestamp, 'datetime'
23
+ field :num_audio_tracks, 'int'
24
+ field :state, 'string'
25
+ has_no_post
26
+ has_no_delete
27
+
28
+ end
29
+ end
@@ -13,14 +13,13 @@ module FacebookAds
13
13
  # on github and we'll fix in our codegen framework. We'll not be able to accept
14
14
  # pull request for this class.
15
15
 
16
- class ShadowIgMediaBoostedInsightsResult < AdObject
16
+ class BrandedContentFbPromodeUser < AdObject
17
17
 
18
- field :description, 'string'
18
+ field :delegate_page_for_ads_only_id, 'string'
19
+ field :is_iabp, 'bool'
20
+ field :is_managed, 'bool'
19
21
  field :name, 'string'
20
- field :organic_media_id, 'string'
21
- field :source_type, 'string'
22
- field :title, 'string'
23
- field :values, { list: 'object' }
22
+ field :profile_picture_url, 'string'
24
23
  has_no_id
25
24
  has_no_get
26
25
  has_no_post
@@ -78,6 +78,7 @@ module FacebookAds
78
78
  "PROFILE_PLUS_CREATE_CONTENT",
79
79
  "PROFILE_PLUS_FACEBOOK_ACCESS",
80
80
  "PROFILE_PLUS_FULL_CONTROL",
81
+ "PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT",
81
82
  "PROFILE_PLUS_MANAGE",
82
83
  "PROFILE_PLUS_MANAGE_LEADS",
83
84
  "PROFILE_PLUS_MESSAGING",
@@ -598,6 +599,7 @@ module FacebookAds
598
599
  "PROFILE_PLUS_CREATE_CONTENT",
599
600
  "PROFILE_PLUS_FACEBOOK_ACCESS",
600
601
  "PROFILE_PLUS_FULL_CONTROL",
602
+ "PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT",
601
603
  "PROFILE_PLUS_MANAGE",
602
604
  "PROFILE_PLUS_MANAGE_LEADS",
603
605
  "PROFILE_PLUS_MESSAGING",
@@ -980,6 +982,11 @@ module FacebookAds
980
982
  end
981
983
 
982
984
  has_edge :ads_dataset do |edge|
985
+ edge.get 'AdsDataset' do |api|
986
+ api.has_param :id_filter, 'string'
987
+ api.has_param :name_filter, 'string'
988
+ api.has_param :sort_by, { enum: -> { AdsDataset::SORT_BY }}
989
+ end
983
990
  edge.post 'Business' do |api|
984
991
  api.has_param :ad_account_id, 'string'
985
992
  api.has_param :app_id, 'string'
@@ -1039,10 +1046,15 @@ module FacebookAds
1039
1046
 
1040
1047
  has_edge :business_invoices do |edge|
1041
1048
  edge.get 'OmegaCustomerTrx' do |api|
1049
+ api.has_param :account_ids, { list: 'int' }
1050
+ api.has_param :advertiser_name, 'string'
1051
+ api.has_param :billing_period_end, 'string'
1052
+ api.has_param :billing_period_start, 'string'
1042
1053
  api.has_param :end_date, 'string'
1043
1054
  api.has_param :invoice_id, 'string'
1044
1055
  api.has_param :issue_end_date, 'string'
1045
1056
  api.has_param :issue_start_date, 'string'
1057
+ api.has_param :product_types, { list: { enum: -> { OmegaCustomerTrx::PRODUCT_TYPES }} }
1046
1058
  api.has_param :root_id, 'int'
1047
1059
  api.has_param :start_date, 'string'
1048
1060
  api.has_param :type, { enum: -> { OmegaCustomerTrx::TYPE }}
@@ -1055,6 +1067,7 @@ module FacebookAds
1055
1067
  api.has_param :email, 'string'
1056
1068
  api.has_param :invited_user_type, { list: { enum: -> { BusinessUser::INVITED_USER_TYPE }} }
1057
1069
  api.has_param :role, { enum: -> { BusinessUser::ROLE }}
1070
+ api.has_param :tasks, { list: { enum: -> { BusinessUser::TASKS }} }
1058
1071
  end
1059
1072
  end
1060
1073
 
@@ -1081,6 +1094,10 @@ module FacebookAds
1081
1094
  end
1082
1095
  end
1083
1096
 
1097
+ has_edge :client_instagram_assets do |edge|
1098
+ edge.get 'InstagramBusinessAsset'
1099
+ end
1100
+
1084
1101
  has_edge :client_offsite_signal_container_business_objects do |edge|
1085
1102
  edge.get 'OffsiteSignalContainerBusinessObject'
1086
1103
  end
@@ -1216,7 +1233,7 @@ module FacebookAds
1216
1233
  edge.delete do |api|
1217
1234
  api.has_param :instagram_account, 'string'
1218
1235
  end
1219
- edge.get 'InstagramUser'
1236
+ edge.get 'IgUser'
1220
1237
  end
1221
1238
 
1222
1239
  has_edge :instagram_business_accounts do |edge|
@@ -1240,6 +1257,12 @@ module FacebookAds
1240
1257
  end
1241
1258
  end
1242
1259
 
1260
+ has_edge :managed_partner_ads_funding_source_details do |edge|
1261
+ edge.get 'FundingSourceDetailsCoupon' do |api|
1262
+ api.has_param :year_quarter, 'string'
1263
+ end
1264
+ end
1265
+
1243
1266
  has_edge :managed_partner_business_setup do |edge|
1244
1267
  edge.post 'Business' do |api|
1245
1268
  api.has_param :active_ad_account_id, 'string'
@@ -1257,7 +1280,7 @@ module FacebookAds
1257
1280
  api.has_param :child_business_external_id, 'string'
1258
1281
  api.has_param :child_business_id, 'string'
1259
1282
  end
1260
- edge.post do |api|
1283
+ edge.post 'ManagedPartnerBusiness' do |api|
1261
1284
  api.has_param :ad_account_currency, 'string'
1262
1285
  api.has_param :catalog_id, 'string'
1263
1286
  api.has_param :child_business_external_id, 'string'
@@ -1267,18 +1290,18 @@ module FacebookAds
1267
1290
  api.has_param :no_ad_account, 'bool'
1268
1291
  api.has_param :page_name, 'string'
1269
1292
  api.has_param :page_profile_image_url, 'string'
1270
- api.has_param :partition_type, { enum: %w{AUTH FIXED FIXED_WITHOUT_PARTITION }}
1293
+ api.has_param :partition_type, { enum: -> { ManagedPartnerBusiness::PARTITION_TYPE }}
1271
1294
  api.has_param :partner_facebook_page_url, 'string'
1272
1295
  api.has_param :partner_registration_countries, { list: 'string' }
1273
1296
  api.has_param :sales_rep_email, 'string'
1274
1297
  api.has_param :seller_external_website_url, 'string'
1275
1298
  api.has_param :seller_targeting_countries, { list: 'string' }
1276
1299
  api.has_param :skip_partner_page_creation, 'bool'
1277
- api.has_param :survey_business_type, { enum: %w{ADVERTISER AGENCY APP_DEVELOPER PUBLISHER }}
1300
+ api.has_param :survey_business_type, { enum: -> { ManagedPartnerBusiness::SURVEY_BUSINESS_TYPE }}
1278
1301
  api.has_param :survey_num_assets, 'int'
1279
1302
  api.has_param :survey_num_people, 'int'
1280
- api.has_param :timezone_id, { enum: %w{0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 }}
1281
- api.has_param :vertical, { enum: %w{ADVERTISING AUTOMOTIVE CONSUMER_PACKAGED_GOODS ECOMMERCE EDUCATION ENERGY_AND_UTILITIES ENTERTAINMENT_AND_MEDIA FINANCIAL_SERVICES GAMING GOVERNMENT_AND_POLITICS HEALTH LUXURY MARKETING NON_PROFIT NOT_SET ORGANIZATIONS_AND_ASSOCIATIONS OTHER PROFESSIONAL_SERVICES RESTAURANT RETAIL TECHNOLOGY TELECOM TRAVEL }}
1303
+ api.has_param :timezone_id, { enum: -> { ManagedPartnerBusiness::TIMEZONE_ID }}
1304
+ api.has_param :vertical, { enum: -> { ManagedPartnerBusiness::VERTICAL }}
1282
1305
  end
1283
1306
  end
1284
1307
 
@@ -1302,8 +1325,12 @@ module FacebookAds
1302
1325
  api.has_param :instance_id, 'string'
1303
1326
  api.has_param :instance_version, 'string'
1304
1327
  api.has_param :is_sgw_instance, 'bool'
1328
+ api.has_param :is_sgw_pixel_from_meta_pixel, 'bool'
1305
1329
  api.has_param :partner_name, 'string'
1306
1330
  api.has_param :pixel_id, 'int'
1331
+ api.has_param :sgw_account_id, 'string'
1332
+ api.has_param :sgw_instance_url, 'string'
1333
+ api.has_param :sgw_pixel_id, 'int'
1307
1334
  end
1308
1335
  end
1309
1336
 
@@ -1347,7 +1374,11 @@ module FacebookAds
1347
1374
  end
1348
1375
 
1349
1376
  has_edge :owned_instagram_accounts do |edge|
1350
- edge.get 'InstagramUser'
1377
+ edge.get 'IgUser'
1378
+ end
1379
+
1380
+ has_edge :owned_instagram_assets do |edge|
1381
+ edge.get 'InstagramBusinessAsset'
1351
1382
  end
1352
1383
 
1353
1384
  has_edge :owned_offsite_signal_container_business_objects do |edge|
@@ -1576,6 +1607,7 @@ module FacebookAds
1576
1607
  api.has_param :instant_game_entry_point_data, 'string'
1577
1608
  api.has_param :is_boost_intended, 'bool'
1578
1609
  api.has_param :is_group_linking_post, 'bool'
1610
+ api.has_param :is_partnership_ad, 'bool'
1579
1611
  api.has_param :is_voice_clip, 'bool'
1580
1612
  api.has_param :location_source_id, 'string'
1581
1613
  api.has_param :og_action_type_id, 'string'
@@ -1585,6 +1617,7 @@ module FacebookAds
1585
1617
  api.has_param :og_suggestion_mechanism, 'string'
1586
1618
  api.has_param :original_fov, 'int'
1587
1619
  api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
1620
+ api.has_param :partnership_ad_ad_code, 'string'
1588
1621
  api.has_param :publish_event_id, 'int'
1589
1622
  api.has_param :referenced_sticker_id, 'string'
1590
1623
  api.has_param :replace_video_id, 'string'
@@ -49,6 +49,7 @@ module FacebookAds
49
49
  "PROFILE_PLUS_CREATE_CONTENT",
50
50
  "PROFILE_PLUS_FACEBOOK_ACCESS",
51
51
  "PROFILE_PLUS_FULL_CONTROL",
52
+ "PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT",
52
53
  "PROFILE_PLUS_MANAGE",
53
54
  "PROFILE_PLUS_MANAGE_LEADS",
54
55
  "PROFILE_PLUS_MESSAGING",
@@ -32,6 +32,24 @@ module FacebookAds
32
32
  "PARTNER_CENTER_OPERATIONS",
33
33
  ]
34
34
 
35
+ TASKS = [
36
+ "ADMIN",
37
+ "ADS_RIGHTS_REVIEWER",
38
+ "DEFAULT",
39
+ "DEVELOPER",
40
+ "EMPLOYEE",
41
+ "FINANCE_ANALYST",
42
+ "FINANCE_EDIT",
43
+ "FINANCE_EDITOR",
44
+ "FINANCE_VIEW",
45
+ "MANAGE",
46
+ "PARTNER_CENTER_ADMIN",
47
+ "PARTNER_CENTER_ANALYST",
48
+ "PARTNER_CENTER_EDUCATION",
49
+ "PARTNER_CENTER_MARKETING",
50
+ "PARTNER_CENTER_OPERATIONS",
51
+ ]
52
+
35
53
 
36
54
  field :created_by, 'object'
37
55
  field :created_time, 'datetime'
@@ -46,6 +64,7 @@ module FacebookAds
46
64
  field :owner, 'Business'
47
65
  field :role, 'string'
48
66
  field :status, 'string'
67
+ field :tasks, { list: 'string' }
49
68
  field :updated_by, 'object'
50
69
  field :updated_time, 'datetime'
51
70
 
@@ -37,6 +37,24 @@ module FacebookAds
37
37
  "PARTNER_CENTER_OPERATIONS",
38
38
  ]
39
39
 
40
+ TASKS = [
41
+ "ADMIN",
42
+ "ADS_RIGHTS_REVIEWER",
43
+ "DEFAULT",
44
+ "DEVELOPER",
45
+ "EMPLOYEE",
46
+ "FINANCE_ANALYST",
47
+ "FINANCE_EDIT",
48
+ "FINANCE_EDITOR",
49
+ "FINANCE_VIEW",
50
+ "MANAGE",
51
+ "PARTNER_CENTER_ADMIN",
52
+ "PARTNER_CENTER_ANALYST",
53
+ "PARTNER_CENTER_EDUCATION",
54
+ "PARTNER_CENTER_MARKETING",
55
+ "PARTNER_CENTER_OPERATIONS",
56
+ ]
57
+
40
58
 
41
59
  field :business, 'Business'
42
60
  field :business_role_request, 'BusinessRoleRequest'
@@ -50,6 +68,7 @@ module FacebookAds
50
68
  field :name, 'string'
51
69
  field :pending_email, 'string'
52
70
  field :role, 'string'
71
+ field :tasks, { list: 'string' }
53
72
  field :title, 'string'
54
73
  field :two_fac_status, 'string'
55
74
  field :invited_user_type, { list: { enum: -> { INVITED_USER_TYPE }} }
@@ -74,5 +93,9 @@ module FacebookAds
74
93
  edge.get 'ProductCatalog'
75
94
  end
76
95
 
96
+ has_edge :assigned_whatsapp_business_accounts do |edge|
97
+ edge.get 'WhatsAppBusinessAccount'
98
+ end
99
+
77
100
  end
78
101
  end