facebookbusiness 22.0.2 → 23.0.0

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 (97) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad.rb +3 -0
  3. data/lib/facebook_ads/ad_objects/ad_account.rb +23 -40
  4. data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +1 -0
  5. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +31 -1
  6. data/lib/facebook_ads/ad_objects/ad_account_agency_fee_config.rb +34 -0
  7. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +1 -0
  8. data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb +4 -0
  9. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +2 -0
  10. data/lib/facebook_ads/ad_objects/ad_asset_onsite_destinations.rb +1 -0
  11. data/lib/facebook_ads/ad_objects/ad_asset_target_rule_targeting.rb +1 -0
  12. data/lib/facebook_ads/ad_objects/ad_async_request_set.rb +1 -0
  13. data/lib/facebook_ads/ad_objects/{shadow_ig_media_boosted_insights_result.rb → ad_campaign_group_agency_fee_config_for_api.rb} +4 -7
  14. data/lib/facebook_ads/ad_objects/ad_creative.rb +2 -0
  15. data/lib/facebook_ads/ad_objects/ad_creative_feature_customizations.rb +1 -0
  16. data/lib/facebook_ads/ad_objects/ad_creative_features_spec.rb +7 -0
  17. data/lib/facebook_ads/ad_objects/ad_creative_format_transformation_spec.rb +26 -0
  18. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +1 -0
  19. data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +1 -0
  20. data/lib/facebook_ads/ad_objects/{ad_account_suggested_tag.rb → ad_creative_media_sourcing_spec.rb} +1 -4
  21. data/lib/facebook_ads/ad_objects/ad_creative_site_links_spec.rb +3 -0
  22. data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +1 -0
  23. data/lib/facebook_ads/ad_objects/ad_preview.rb +4 -0
  24. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +2 -0
  25. data/lib/facebook_ads/ad_objects/ad_report_run.rb +2 -0
  26. data/lib/facebook_ads/ad_objects/ad_rule_history.rb +1 -0
  27. data/lib/facebook_ads/ad_objects/ad_set.rb +22 -0
  28. data/lib/facebook_ads/ad_objects/ad_video.rb +3 -13
  29. data/lib/facebook_ads/ad_objects/ads_action_stats.rb +3 -0
  30. data/lib/facebook_ads/ad_objects/ads_dataset.rb +5 -0
  31. data/lib/facebook_ads/ad_objects/ads_histogram_stats.rb +3 -0
  32. data/lib/facebook_ads/ad_objects/ads_insights.rb +47 -0
  33. data/lib/facebook_ads/ad_objects/ads_naming_template.rb +1 -0
  34. data/lib/facebook_ads/ad_objects/ads_pixel_capi_integration_quality.rb +5 -0
  35. data/lib/facebook_ads/ad_objects/ads_user_settings.rb +10 -0
  36. data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +10 -0
  37. data/lib/facebook_ads/ad_objects/ai_generated_product_image.rb +26 -0
  38. data/lib/facebook_ads/ad_objects/alm_guidance.rb +1 -0
  39. data/lib/facebook_ads/ad_objects/alm_guidance_metrics.rb +9 -0
  40. data/lib/facebook_ads/ad_objects/apac_mon_seller_status_api_container.rb +24 -0
  41. data/lib/facebook_ads/ad_objects/application.rb +17 -0
  42. data/lib/facebook_ads/ad_objects/audio_sub_label.rb +29 -0
  43. data/lib/facebook_ads/ad_objects/business.rb +25 -7
  44. data/lib/facebook_ads/ad_objects/business_role_request.rb +19 -0
  45. data/lib/facebook_ads/ad_objects/business_user.rb +19 -0
  46. data/lib/facebook_ads/ad_objects/campaign.rb +2 -0
  47. data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb +0 -1
  48. data/lib/facebook_ads/ad_objects/china_business_onboarding_vetting_request.rb +3 -0
  49. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +4 -0
  50. data/lib/facebook_ads/ad_objects/content_delivery_report.rb +2 -0
  51. data/lib/facebook_ads/ad_objects/copyright_ownership_transfer.rb +28 -0
  52. data/lib/facebook_ads/ad_objects/creative_multicell_test_config.rb +4 -0
  53. data/lib/facebook_ads/ad_objects/ctwa_whats_app_numbers_info.rb +1 -0
  54. data/lib/facebook_ads/ad_objects/ctx_default_optimization_config.rb +1 -0
  55. data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -1
  56. data/lib/facebook_ads/ad_objects/custom_audience_integrity_flags_and_appeal_status.rb +29 -0
  57. data/lib/facebook_ads/ad_objects/event.rb +3 -0
  58. data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +3 -0
  59. data/lib/facebook_ads/ad_objects/group.rb +2 -0
  60. data/lib/facebook_ads/ad_objects/home_listing.rb +2 -0
  61. data/lib/facebook_ads/ad_objects/ig_comment_from_user.rb +1 -0
  62. data/lib/facebook_ads/ad_objects/ig_media.rb +3 -0
  63. data/lib/facebook_ads/ad_objects/ig_user.rb +7 -1
  64. data/lib/facebook_ads/ad_objects/ig_user_export_for_cam.rb +23 -0
  65. data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +8 -2
  66. data/lib/facebook_ads/ad_objects/ig_user_messenger_profile.rb +26 -0
  67. data/lib/facebook_ads/ad_objects/insights_result.rb +1 -2
  68. data/lib/facebook_ads/ad_objects/{ads_value_adjustment_rule.rb → instagram_business_asset.rb} +3 -6
  69. data/lib/facebook_ads/ad_objects/{bespoke_partner_guidance_laser.rb → instagram_thread.rb} +4 -6
  70. data/lib/facebook_ads/ad_objects/instagram_user.rb +0 -11
  71. data/lib/facebook_ads/ad_objects/lead_gen_client_validation_rules.rb +27 -0
  72. data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +2 -0
  73. data/lib/facebook_ads/ad_objects/lead_gen_thank_you_page.rb +1 -0
  74. data/lib/facebook_ads/ad_objects/managed_partner_business.rb +544 -0
  75. data/lib/facebook_ads/ad_objects/management_site_link.rb +31 -0
  76. data/lib/facebook_ads/ad_objects/messenger_call_settings.rb +2 -0
  77. data/lib/facebook_ads/ad_objects/messenger_profile.rb +0 -2
  78. data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +4 -0
  79. data/lib/facebook_ads/ad_objects/organization.rb +0 -2
  80. data/lib/facebook_ads/ad_objects/page.rb +11 -7
  81. data/lib/facebook_ads/ad_objects/product_catalog.rb +38 -1
  82. data/lib/facebook_ads/ad_objects/product_catalog_check_marketplace_partner_sellers_status.rb +27 -0
  83. data/lib/facebook_ads/ad_objects/product_feed.rb +1 -0
  84. data/lib/facebook_ads/ad_objects/product_group.rb +1 -0
  85. data/lib/facebook_ads/ad_objects/product_item.rb +8 -0
  86. data/lib/facebook_ads/ad_objects/product_item_video_data.rb +26 -0
  87. data/lib/facebook_ads/ad_objects/shadow_ig_user_ctx_partner_app_welcome_message_flow.rb +31 -0
  88. data/lib/facebook_ads/ad_objects/targeting.rb +2 -0
  89. data/lib/facebook_ads/ad_objects/third_party_partner_viewability_request.rb +1 -0
  90. data/lib/facebook_ads/ad_objects/user.rb +4 -1
  91. data/lib/facebook_ads/ad_objects/vehicle.rb +3 -0
  92. data/lib/facebook_ads/ad_objects/{split_test_config.rb → website_creative_info.rb} +3 -7
  93. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +6 -3
  94. data/lib/facebook_ads/ad_objects/whats_app_business_pre_verified_phone_number.rb +1 -1
  95. data/lib/facebook_ads/version.rb +2 -2
  96. metadata +20 -8
  97. data/lib/facebook_ads/ad_objects/keyword_delivery_report.rb +0 -33
@@ -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",
@@ -51,6 +53,7 @@ module FacebookAds
51
53
  "INSTANT_ARTICLE_RECIRCULATION_AD",
52
54
  "INSTANT_ARTICLE_STANDARD",
53
55
  "INSTREAM_BANNER_DESKTOP",
56
+ "INSTREAM_BANNER_FULLSCREEN_IOS",
54
57
  "INSTREAM_BANNER_FULLSCREEN_MOBILE",
55
58
  "INSTREAM_BANNER_IMMERSIVE_MOBILE",
56
59
  "INSTREAM_BANNER_MOBILE",
@@ -85,6 +88,7 @@ module FacebookAds
85
88
  "product_metadata_automation",
86
89
  "profile_card",
87
90
  "standard_enhancements_catalog",
91
+ "video_to_image",
88
92
  ]
89
93
 
90
94
  RENDER_TYPE = [
@@ -107,9 +107,11 @@ module FacebookAds
107
107
  field :product_item_id, 'string'
108
108
  field :product_set, 'ProductSet'
109
109
  field :product_set_id, 'string'
110
+ field :product_set_optimization, 'string'
110
111
  field :retention_days, 'string'
111
112
  field :value_semantic_type, 'string'
112
113
  field :variation, 'string'
114
+ field :whats_app_business_phone_number_id, 'string'
113
115
  field :whatsapp_phone_number, 'string'
114
116
  has_no_id
115
117
  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",
@@ -92,6 +92,16 @@ module FacebookAds
92
92
  "PAUSED",
93
93
  ]
94
94
 
95
+ BUDGET_SOURCE = [
96
+ "NONE",
97
+ "RMN",
98
+ ]
99
+
100
+ CREATIVE_SEQUENCE_REPETITION_PATTERN = [
101
+ "FULL_SEQUENCE",
102
+ "LAST_AD",
103
+ ]
104
+
95
105
  DATE_PRESET = [
96
106
  "DATA_MAXIMUM",
97
107
  "LAST_14D",
@@ -119,8 +129,11 @@ module FacebookAds
119
129
  "APP",
120
130
  "APPLINKS_AUTOMATIC",
121
131
  "FACEBOOK",
132
+ "FACEBOOK_LIVE",
122
133
  "FACEBOOK_PAGE",
134
+ "IMAGINE",
123
135
  "INSTAGRAM_DIRECT",
136
+ "INSTAGRAM_LIVE",
124
137
  "INSTAGRAM_PROFILE",
125
138
  "INSTAGRAM_PROFILE_AND_FACEBOOK_PAGE",
126
139
  "MESSAGING_INSTAGRAM_DIRECT_MESSENGER",
@@ -176,6 +189,7 @@ module FacebookAds
176
189
  "3",
177
190
  "4",
178
191
  "5",
192
+ "6",
179
193
  ]
180
194
 
181
195
  TUNE_FOR_CATEGORY = [
@@ -220,6 +234,7 @@ module FacebookAds
220
234
  field :configured_status, { enum: -> { CONFIGURED_STATUS }}
221
235
  field :created_time, 'datetime'
222
236
  field :creative_sequence, { list: 'string' }
237
+ field :creative_sequence_repetition_pattern, 'string'
223
238
  field :daily_budget, 'string'
224
239
  field :daily_min_spend_target, 'string'
225
240
  field :daily_spend_cap, 'string'
@@ -236,6 +251,7 @@ module FacebookAds
236
251
  field :is_ba_skip_delayed_eligible, 'bool'
237
252
  field :is_budget_schedule_enabled, 'bool'
238
253
  field :is_dynamic_creative, 'bool'
254
+ field :is_incremental_attribution_enabled, 'bool'
239
255
  field :issues_info, { list: 'AdCampaignIssuesInfo' }
240
256
  field :learning_stage_info, 'AdCampaignLearningStageInfo'
241
257
  field :lifetime_budget, 'string'
@@ -266,6 +282,8 @@ module FacebookAds
266
282
  field :time_based_ad_rotation_intervals, { list: 'int' }
267
283
  field :updated_time, 'datetime'
268
284
  field :use_new_app_click, 'bool'
285
+ field :budget_source, { enum: -> { BUDGET_SOURCE }}
286
+ field :budget_split_set_id, 'string'
269
287
  field :campaign_spec, 'object'
270
288
  field :daily_imps, 'int'
271
289
  field :date_format, 'string'
@@ -379,6 +397,7 @@ module FacebookAds
379
397
  api.has_param :fields, { list: 'string' }
380
398
  api.has_param :filtering, { list: 'object' }
381
399
  api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
400
+ api.has_param :limit, 'int'
382
401
  api.has_param :product_id_limit, 'int'
383
402
  api.has_param :sort, { list: 'string' }
384
403
  api.has_param :summary, { list: 'string' }
@@ -402,6 +421,7 @@ module FacebookAds
402
421
  api.has_param :fields, { list: 'string' }
403
422
  api.has_param :filtering, { list: 'object' }
404
423
  api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
424
+ api.has_param :limit, 'int'
405
425
  api.has_param :product_id_limit, 'int'
406
426
  api.has_param :sort, { list: 'string' }
407
427
  api.has_param :summary, { list: 'string' }
@@ -417,6 +437,8 @@ module FacebookAds
417
437
  has_edge :message_delivery_estimate do |edge|
418
438
  edge.get 'MessageDeliveryEstimate' do |api|
419
439
  api.has_param :bid_amount, 'int'
440
+ api.has_param :daily_budget, 'int'
441
+ api.has_param :is_direct_send_campaign, 'bool'
420
442
  api.has_param :lifetime_budget, 'int'
421
443
  api.has_param :lifetime_in_days, 'int'
422
444
  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",
@@ -50,9 +47,7 @@ module FacebookAds
50
47
  "DIM_SUM",
51
48
  "DIRECTED_POST_ATTACHMENT",
52
49
  "DIRECT_INBOX",
53
- "DIRECT_INBOX_REACTION",
54
50
  "DROPS_SHOPPING_EVENT_PAGE",
55
- "DYNAMIC_ITEM_DISPLAY_BUNDLE",
56
51
  "DYNAMIC_ITEM_VIDEO",
57
52
  "DYNAMIC_TEMPLATE_VIDEO",
58
53
  "EVENT_COVER_VIDEO",
@@ -65,7 +60,6 @@ module FacebookAds
65
60
  "FB_SHORTS_GROUP_POST",
66
61
  "FB_SHORTS_LINKED_PRODUCT",
67
62
  "FB_SHORTS_PMV_POST",
68
- "FB_SHORTS_PMV_POST_NO_NEWSFEED_NOR_TIMELINE",
69
63
  "FB_SHORTS_POST",
70
64
  "FB_SHORTS_REMIX_POST",
71
65
  "FUNDRAISER_COVER_VIDEO",
@@ -80,6 +74,7 @@ module FacebookAds
80
74
  "GROUP_POST",
81
75
  "HEURISTIC_CLUSTER_VIDEO",
82
76
  "HIGHLIGHT_CLIP_VIDEO",
77
+ "HORIZON_WORLDS_TV",
83
78
  "HUDDLE_BROADCAST",
84
79
  "IG_REELS_XPV",
85
80
  "IG_STORIES_READER",
@@ -110,7 +105,6 @@ module FacebookAds
110
105
  "NEO_ASYNC_GAME_VIDEO",
111
106
  "NEW_CONTAINED_POST_BROADCAST",
112
107
  "NO_STORY",
113
- "NPE_COLLAB_COPYRIGHT_CHECK",
114
108
  "OCULUS_CREATOR_PORTAL",
115
109
  "OCULUS_VENUES_BROADCAST",
116
110
  "ORIGINALITY_SELF_ADVOCACY",
@@ -120,8 +114,6 @@ module FacebookAds
120
114
  "PAID_CONTENT_PREVIEW",
121
115
  "PAID_CONTENT_VIDEO",
122
116
  "PAID_CONTENT_VIDEO__POST",
123
- "PAPER_DOCUMENT_AUDIO",
124
- "PAPER_DOCUMENT_VIDEO",
125
117
  "PIXELCLOUD",
126
118
  "PODCAST_HIGHLIGHT",
127
119
  "PODCAST_ML_PREVIEW",
@@ -150,11 +142,9 @@ module FacebookAds
150
142
  "SLIDESHOW_ANIMOTO",
151
143
  "SLIDESHOW_SHAKR",
152
144
  "SLIDESHOW_VARIATION_VIDEO",
153
- "SOUNDBITES_VIDEO",
154
145
  "SOUND_PLATFORM_STREAM",
155
146
  "SRT_ATTACHMENT",
156
147
  "STORIES_VIDEO",
157
- "STORIES_WEARABLE",
158
148
  "STORYLINE",
159
149
  "STORYLINE_WITH_EXTERNAL_MUSIC",
160
150
  "STORY_ARCHIVE_VIDEO",
@@ -162,10 +152,8 @@ module FacebookAds
162
152
  "STREAM_HIGHLIGHTS_VIDEO",
163
153
  "TAROT_DIGEST",
164
154
  "TEMPORARY_UNLISTED",
165
- "TEMP_MULTIMEDIA_POST",
166
155
  "TEMP_VIDEO_COPYRIGHT_SCAN",
167
156
  "UNLISTED",
168
- "UNLISTED_HORIZON",
169
157
  "UNLISTED_OCULUS",
170
158
  "VIDEO_COMMENT",
171
159
  "VIDEO_COMPOSITION_VARIATION",
@@ -355,6 +343,7 @@ module FacebookAds
355
343
  field :instant_game_entry_point_data, 'string'
356
344
  field :is_boost_intended, 'bool'
357
345
  field :is_group_linking_post, 'bool'
346
+ field :is_partnership_ad, 'bool'
358
347
  field :is_voice_clip, 'bool'
359
348
  field :location_source_id, 'string'
360
349
  field :name, 'string'
@@ -365,6 +354,7 @@ module FacebookAds
365
354
  field :og_suggestion_mechanism, 'string'
366
355
  field :original_fov, 'int'
367
356
  field :original_projection_type, { enum: -> { ORIGINAL_PROJECTION_TYPE }}
357
+ field :partnership_ad_ad_code, 'string'
368
358
  field :publish_event_id, 'int'
369
359
  field :referenced_sticker_id, 'string'
370
360
  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'
@@ -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,10 @@ 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'
262
290
  field :location, 'string'
291
+ field :marketing_messages_click_rate_benchmark, 'string'
263
292
  field :marketing_messages_cost_per_delivered, 'string'
264
293
  field :marketing_messages_cost_per_link_btn_click, 'string'
265
294
  field :marketing_messages_delivered, 'string'
@@ -272,6 +301,7 @@ module FacebookAds
272
301
  field :marketing_messages_quick_reply_btn_click_rate, 'string'
273
302
  field :marketing_messages_read, 'string'
274
303
  field :marketing_messages_read_rate, 'string'
304
+ field :marketing_messages_read_rate_benchmark, 'string'
275
305
  field :marketing_messages_sent, 'string'
276
306
  field :marketing_messages_spend, 'string'
277
307
  field :marketing_messages_spend_currency, 'string'
@@ -281,17 +311,34 @@ module FacebookAds
281
311
  field :marketing_messages_website_purchase_values, 'string'
282
312
  field :mobile_app_purchase_roas, { list: 'AdsActionStats' }
283
313
  field :objective, 'string'
314
+ field :objective_result_rate, { list: 'object' }
315
+ field :objective_results, { list: 'object' }
284
316
  field :onsite_conversion_messaging_detected_purchase_deduped, { list: 'AdsActionStats' }
285
317
  field :optimization_goal, 'string'
286
318
  field :outbound_clicks, { list: 'AdsActionStats' }
287
319
  field :outbound_clicks_ctr, { list: 'AdsActionStats' }
288
320
  field :place_page_name, 'string'
321
+ field :product_brand, 'string'
322
+ field :product_category, 'string'
323
+ field :product_content_id, 'string'
324
+ field :product_custom_label_0, 'string'
325
+ field :product_custom_label_1, 'string'
326
+ field :product_custom_label_2, 'string'
327
+ field :product_custom_label_3, 'string'
328
+ field :product_custom_label_4, 'string'
329
+ field :product_group_content_id, 'string'
330
+ field :product_group_retailer_id, 'string'
331
+ field :product_name, 'string'
332
+ field :product_retailer_id, 'string'
333
+ field :purchase_per_landing_page_view, 'string'
289
334
  field :purchase_roas, { list: 'AdsActionStats' }
290
335
  field :purchases_per_link_click, 'string'
291
336
  field :qualifying_question_qualify_answer_rate, 'string'
292
337
  field :quality_ranking, 'string'
293
338
  field :reach, 'string'
339
+ field :result_rate, { list: 'object' }
294
340
  field :result_values_performance_indicator, 'string'
341
+ field :results, { list: 'object' }
295
342
  field :shops_assisted_purchases, 'string'
296
343
  field :social_spend, 'string'
297
344
  field :spend, 'string'
@@ -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'
@@ -76,6 +85,7 @@ module FacebookAds
76
85
  field :sticky_setting_after_default_on, 'string'
77
86
  field :syd_campaign_trends_metric, 'string'
78
87
  field :text_optimizations_text_extraction_opt_in_status, 'string'
88
+ field :text_translation_opt_in_status, 'string'
79
89
  field :text_variations_sticky_opt_in_status, 'string'
80
90
  field :total_coupon_syd_dismissals, 'int'
81
91
  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
@@ -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,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 ApacMonSellerStatusApiContainer < AdObject
17
+
18
+ has_no_id
19
+ has_no_get
20
+ has_no_post
21
+ has_no_delete
22
+
23
+ end
24
+ 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' }
@@ -567,6 +571,19 @@ module FacebookAds
567
571
  edge.get
568
572
  end
569
573
 
574
+ has_edge :sgw_dataset_status do |edge|
575
+ edge.get do |api|
576
+ api.has_param :dataset_id, 'int'
577
+ end
578
+ end
579
+
580
+ has_edge :sgw_install_deferral_link do |edge|
581
+ edge.get do |api|
582
+ api.has_param :client_ip, 'string'
583
+ api.has_param :dataset_id, 'int'
584
+ end
585
+ end
586
+
570
587
  has_edge :subscribed_domains do |edge|
571
588
  edge.get
572
589
  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