facebookbusiness 21.0.2 → 22.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 (72) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad_account.rb +19 -2
  3. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +15 -0
  4. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +1 -1
  5. data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb +3 -0
  6. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +4 -0
  7. data/lib/facebook_ads/ad_objects/ad_creative.rb +3 -3
  8. data/lib/facebook_ads/ad_objects/ad_creative_feature_customizations.rb +5 -0
  9. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +2 -0
  10. data/lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb +1 -1
  11. data/lib/facebook_ads/ad_objects/ad_creative_regional_regulation_disclaimer.rb +3 -0
  12. data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +1 -0
  13. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +35 -0
  14. data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +1 -0
  15. data/lib/facebook_ads/ad_objects/ad_set.rb +3 -1
  16. data/lib/facebook_ads/ad_objects/ad_video.rb +13 -17
  17. data/lib/facebook_ads/ad_objects/{parent_catalog_report.rb → ads_eligibility.rb} +2 -3
  18. data/lib/facebook_ads/ad_objects/ads_insights.rb +10 -0
  19. data/lib/facebook_ads/ad_objects/{ads_data_partner.rb → ads_mcme_conversion.rb} +6 -2
  20. data/lib/facebook_ads/ad_objects/ads_quick_views.rb +1 -0
  21. data/lib/facebook_ads/ad_objects/ads_user_settings.rb +3 -0
  22. data/lib/facebook_ads/ad_objects/album.rb +1 -0
  23. data/lib/facebook_ads/ad_objects/application.rb +12 -6
  24. data/lib/facebook_ads/ad_objects/audio_visual_reference_match.rb +1 -0
  25. data/lib/facebook_ads/ad_objects/automotive_model.rb +9 -0
  26. data/lib/facebook_ads/ad_objects/business.rb +0 -2
  27. data/lib/facebook_ads/ad_objects/{domain.rb → catalog_content_version_config.rb} +2 -2
  28. data/lib/facebook_ads/ad_objects/copyright_reference_container.rb +1 -0
  29. data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -1
  30. data/lib/facebook_ads/ad_objects/destination.rb +4 -0
  31. data/lib/facebook_ads/ad_objects/fb_image_copyright_match.rb +1 -0
  32. data/lib/facebook_ads/ad_objects/flight.rb +15 -0
  33. data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +1 -0
  34. data/lib/facebook_ads/ad_objects/{instagram_boostable_media_for_access_token.rb → funding_source_details_coupon_tiering.rb} +3 -3
  35. data/lib/facebook_ads/ad_objects/group.rb +1 -0
  36. data/lib/facebook_ads/ad_objects/home_listing.rb +10 -0
  37. data/lib/facebook_ads/ad_objects/hotel.rb +10 -0
  38. data/lib/facebook_ads/ad_objects/ig_media_for_ig_only_api.rb +1 -0
  39. data/lib/facebook_ads/ad_objects/ig_user.rb +18 -0
  40. data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +14 -1
  41. data/lib/facebook_ads/ad_objects/insights_result.rb +17 -0
  42. data/lib/facebook_ads/ad_objects/insights_value.rb +1 -0
  43. data/lib/facebook_ads/ad_objects/instagram_carousel.rb +0 -8
  44. data/lib/facebook_ads/ad_objects/instagram_comment.rb +1 -8
  45. data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +1 -0
  46. data/lib/facebook_ads/ad_objects/instagram_media.rb +0 -8
  47. data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +1 -0
  48. data/lib/facebook_ads/ad_objects/messenger_business_template.rb +2 -0
  49. data/lib/facebook_ads/ad_objects/music_work_copyright.rb +2 -0
  50. data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +0 -2
  51. data/lib/facebook_ads/ad_objects/page.rb +14 -21
  52. data/lib/facebook_ads/ad_objects/page_change_proposal.rb +0 -2
  53. data/lib/facebook_ads/ad_objects/product_catalog.rb +4 -0
  54. data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +3 -3
  55. data/lib/facebook_ads/ad_objects/recommended_ig_media.rb +0 -1
  56. data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb +2 -0
  57. data/lib/facebook_ads/ad_objects/{instagram_video_metadata.rb → targeting_subscriber_universe.rb} +3 -4
  58. data/lib/facebook_ads/ad_objects/third_party_partner_lift_request.rb +3 -0
  59. data/lib/facebook_ads/ad_objects/user.rb +7 -0
  60. data/lib/facebook_ads/ad_objects/vehicle.rb +9 -0
  61. data/lib/facebook_ads/ad_objects/vehicle_offer.rb +10 -0
  62. data/lib/facebook_ads/ad_objects/video_copyright_match.rb +1 -0
  63. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +40 -7
  64. data/lib/facebook_ads/ad_objects/whats_app_business_partner_client_verification_submission.rb +1 -0
  65. data/lib/facebook_ads/version.rb +2 -2
  66. data/lib/facebook_ads.rb +2 -2
  67. metadata +11 -16
  68. data/lib/facebook_ads/ad_objects/marketing_message_targeting.rb +0 -29
  69. data/lib/facebook_ads/ad_objects/merchant_report.rb +0 -39
  70. data/lib/facebook_ads/ad_objects/private_computation_environment.rb +0 -28
  71. data/lib/facebook_ads/ad_objects/product_catalog_user_permissions.rb +0 -34
  72. data/lib/facebook_ads/ad_objects/video_metrics_report.rb +0 -33
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 45da38f8e7ba7da881c3f7e35b8ab9a2bb7be37af933dafd74b1b4ccbed6e7f6
4
- data.tar.gz: 7acf07cdefb6cabd3bf1786c73bb17d3fd52152c10b0a9e694edc6fea9ca2611
3
+ metadata.gz: 17b89ae8481b4e80b94a2e479a2cd2446988fb8639eabc7475089b46aee277b5
4
+ data.tar.gz: 3b688020311bb1e0e8c41b07e67013bc8ea1271caee532bf73671e43c06efc0e
5
5
  SHA512:
6
- metadata.gz: 109d0da239a3ae7fb1d0573c320920f0b25601587f9b1ab89ab498ca157e698117a655ee1ecd8a0219d7aa48ba7ee03b1b208cfeb72b37600ccd103d32e83c7f
7
- data.tar.gz: 703f15bb2feeb0f40e3afb514b0ff86e595343c0402e74c514fccf62447a0463f383646a4125a2206ae430ffaa3749ceed6e70c3dde85c22b3f5b66dd0fe53ff
6
+ metadata.gz: ecf615162c8e26bee1d17655b431add7902611bde0ae52e67b1057a94b406f81a04e5c284616d8fa0d8500d778db85b24009ea8f7ee821e8ded05f100ca18345
7
+ data.tar.gz: 0e997577601bf68845e213dc41ada17f8f6efc80f99d7c54fc64ad60d941365aec4b93da710bb729f340c35cdb126008d33bd08a28edb8c4307c9cbdec3f6cbf
@@ -148,7 +148,6 @@ module FacebookAds
148
148
  "PRIMARY",
149
149
  "REGULATED_CATEGORIES_AUDIENCE",
150
150
  "STUDY_RULE_AUDIENCE",
151
- "SUBSCRIBER_SEGMENT",
152
151
  "VIDEO",
153
152
  "WEBSITE",
154
153
  ]
@@ -317,7 +316,6 @@ module FacebookAds
317
316
  api.has_param :image_file, 'string'
318
317
  api.has_param :image_hash, 'string'
319
318
  api.has_param :image_url, 'string'
320
- api.has_param :instagram_actor_id, 'string'
321
319
  api.has_param :instagram_branded_content, 'hash'
322
320
  api.has_param :instagram_permalink_url, 'string'
323
321
  api.has_param :instagram_user_id, 'string'
@@ -339,6 +337,7 @@ module FacebookAds
339
337
  api.has_param :portrait_customizations, 'hash'
340
338
  api.has_param :product_set_id, 'string'
341
339
  api.has_param :recommender_settings, 'hash'
340
+ api.has_param :regional_regulation_disclaimer_spec, 'hash'
342
341
  api.has_param :source_instagram_media_id, 'string'
343
342
  api.has_param :template_url, 'string'
344
343
  api.has_param :template_url_spec, 'string'
@@ -510,6 +509,7 @@ module FacebookAds
510
509
  api.has_param :frequency_control_specs, { list: 'object' }
511
510
  api.has_param :full_funnel_exploration_mode, { enum: -> { AdSet::FULL_FUNNEL_EXPLORATION_MODE }}
512
511
  api.has_param :is_dynamic_creative, 'bool'
512
+ api.has_param :is_sac_cfca_terms_certified, 'bool'
513
513
  api.has_param :lifetime_budget, 'int'
514
514
  api.has_param :lifetime_imps, 'int'
515
515
  api.has_param :lifetime_min_spend_target, 'int'
@@ -1145,6 +1145,15 @@ module FacebookAds
1145
1145
  end
1146
1146
  end
1147
1147
 
1148
+ has_edge :suggested_product_tags do |edge|
1149
+ edge.get 'AdAccountSuggestedTag' do |api|
1150
+ api.has_param :image_hash, 'string'
1151
+ api.has_param :instagram_actor_id, 'string'
1152
+ api.has_param :is_shops_ad, 'bool'
1153
+ api.has_param :page_id, 'string'
1154
+ end
1155
+ end
1156
+
1148
1157
  has_edge :targetingbrowse do |edge|
1149
1158
  edge.get 'AdAccountTargetingUnified' do |api|
1150
1159
  api.has_param :excluded_category, 'string'
@@ -1243,6 +1252,14 @@ module FacebookAds
1243
1252
  api.has_param :since, 'datetime'
1244
1253
  api.has_param :until, 'datetime'
1245
1254
  end
1255
+ edge.post 'AdVideo' do |api|
1256
+ api.has_param :description, 'string'
1257
+ api.has_param :privacy, 'string'
1258
+ api.has_param :title, 'string'
1259
+ api.has_param :upload_phase, { enum: -> { AdVideo::UPLOAD_PHASE }}
1260
+ api.has_param :video_id, 'string'
1261
+ api.has_param :video_state, { enum: -> { AdVideo::VIDEO_STATE }}
1262
+ end
1246
1263
  end
1247
1264
 
1248
1265
  end
@@ -60,6 +60,7 @@ module FacebookAds
60
60
  "APLUS_C_CATALOG_DUPLICATION",
61
61
  "APP_AEM_V2_INSTALLATION_PROMOTION",
62
62
  "APP_ENGAGED_VIEW_CONVERSIONS_DUPLICATION",
63
+ "ASC_AUTOMATION",
63
64
  "ASC_BUDGET_OPTIMIZATION",
64
65
  "ASC_CREATION_PACKAGE",
65
66
  "ASC_FRAGMENTATION_V2",
@@ -87,6 +88,7 @@ module FacebookAds
87
88
  "BUDGET_LIMITED",
88
89
  "CAPI",
89
90
  "CAPI_CRM_GUIDANCE",
91
+ "CAPI_PENETRATION",
90
92
  "CAPI_PERFORMANCE_MATCH_KEY",
91
93
  "CAPI_PERFORMANCE_MATCH_KEY_V2",
92
94
  "CASH_REWARDS_OPT_IN",
@@ -96,6 +98,7 @@ module FacebookAds
96
98
  "CONNECTED_SOURCES_DUPLICATION",
97
99
  "CONNECT_FACEBOOK_PAGE_TO_INSTAGRAM",
98
100
  "CONNECT_FACEBOOK_PAGE_TO_WHATSAPP",
101
+ "CONVERSION_LEADS_OPTIMIZATION",
99
102
  "CONVERSION_LEAD_ADS",
100
103
  "COST_GOAL",
101
104
  "COST_GOAL_BUDGET_LIMITED",
@@ -121,6 +124,11 @@ module FacebookAds
121
124
  "CTX_CTMPO_UPGRADE",
122
125
  "CTX_GUIDANCE",
123
126
  "CTX_PRECREATE",
127
+ "CTX_SABR_CBO",
128
+ "CTX_SABR_NON_CBO",
129
+ "CTX_ZO_CBO",
130
+ "CTX_ZO_NON_CBO",
131
+ "CUSTOM_AUDIENCE_RELAXATION",
124
132
  "DA_ADVANTAGE_PLUS_CREATIVE_INFO_LABELS",
125
133
  "DA_DUPLICATION_PRODUCT_TAGS",
126
134
  "DEAD_LINK",
@@ -137,6 +145,7 @@ module FacebookAds
137
145
  "FRAGMENTATION_RESOLUTION_UPDATE",
138
146
  "FRAGMENTATION_V2",
139
147
  "GENERATIVE_UNCROP_DUPLICATION",
148
+ "GEN_AI_MVP",
140
149
  "GES_TEST",
141
150
  "GUIDANCE_CENTER_CODE_GEN",
142
151
  "HEURISTIC_DEFAULT_DURATION",
@@ -172,7 +181,9 @@ module FacebookAds
172
181
  "NOT_APPLICABLE",
173
182
  "NO_DELIVERY_STATUS",
174
183
  "OFFSITE_CONVERSION",
184
+ "OFFSITE_CONVERSION_BASED_ON_SIGNALS",
175
185
  "OPTIMAL_BAU",
186
+ "OUTCOME_FORECASTER_BUDGET_RECOMMENDATION",
176
187
  "OUTCOME_FORECASTER_SHADOW_LOGGING",
177
188
  "PAYMENT_METHOD",
178
189
  "PERFORMANT_CREATIVE_REELS_OPT_IN",
@@ -196,11 +207,13 @@ module FacebookAds
196
207
  "REELS_DUPLICATION_UPSELL",
197
208
  "REELS_MUSIC_DUPLICATION",
198
209
  "REELS_PC_AND_MOBILE_FIRST_CREATIVE",
210
+ "REELS_PC_RECOMMENDATION",
199
211
  "REELS_PERFORMANT_CREATIVE",
200
212
  "REELS_PLACEMENT",
201
213
  "REVERT",
202
214
  "SABR_DEFAULT_DURATION",
203
215
  "SALES_CONVERSION",
216
+ "SAVED_AUDIENCE",
204
217
  "SCALE_GOOD_CAMPAIGN",
205
218
  "SCALE_GOOD_CAMPAIGN_DUPLICATION",
206
219
  "SCALE_GOOD_CAMPAIGN_SMB",
@@ -212,6 +225,7 @@ module FacebookAds
212
225
  "SHOPS_ADS_DUPLICATION",
213
226
  "SHOPS_ADS_TRAFFIC_CAP_SETTINGS",
214
227
  "SHOP_ADS_V2",
228
+ "SIGNALS_DOWN_FUNNEL_EVENT_OPTIMIZATION",
215
229
  "SIGNALS_GROWTH_CAPI",
216
230
  "SIGNALS_GROWTH_CAPI_PRECREATE",
217
231
  "SIGNALS_GROWTH_CAPI_TABLE",
@@ -244,6 +258,7 @@ module FacebookAds
244
258
  "WEB_ENGAGED_VIEW_CONVERSIONS",
245
259
  "ZERO_CONVERSION",
246
260
  "ZERO_IMPRESSION",
261
+ "ZERO_OUTCOME_BUDGET",
247
262
  ]
248
263
 
249
264
 
@@ -399,7 +399,6 @@ module FacebookAds
399
399
  "location_cluster_ids",
400
400
  "location_expansion",
401
401
  "marketing_message_channels",
402
- "marketing_message_targeting",
403
402
  "marketplace_product_categories",
404
403
  "messenger_positions",
405
404
  "mobile_device_model",
@@ -420,6 +419,7 @@ module FacebookAds
420
419
  "relationship_statuses",
421
420
  "rtb_flag",
422
421
  "site_category",
422
+ "subscriber_universe",
423
423
  "tafe_ca_mitigation_strategy",
424
424
  "targeting_automation",
425
425
  "targeting_optimization",
@@ -41,6 +41,8 @@ module FacebookAds
41
41
 
42
42
  field :acf_should_opt_out_video_adjustments, 'bool'
43
43
  field :aco_sticky_settings, { list: 'hash' }
44
+ field :actions_quick_view_created, 'bool'
45
+ field :active_ads_quick_view_created, 'bool'
44
46
  field :ad_account, 'AdAccount'
45
47
  field :ad_object_export_format, 'string'
46
48
  field :auto_review_video_caption, 'bool'
@@ -55,6 +57,7 @@ module FacebookAds
55
57
  field :draft_mode_enabled, 'bool'
56
58
  field :export_deleted_items_with_delivery, 'bool'
57
59
  field :export_summary_row, 'bool'
60
+ field :had_delivery_quick_view_created, 'bool'
58
61
  field :has_seen_groups_column_flexing_experience, 'bool'
59
62
  field :has_seen_instagram_column_flexing_experience, 'bool'
60
63
  field :has_seen_leads_column_flexing_experience, 'bool'
@@ -45,6 +45,7 @@ module FacebookAds
45
45
  "FOLLOW_USER",
46
46
  "GET_A_QUOTE",
47
47
  "GET_DIRECTIONS",
48
+ "GET_IN_TOUCH",
48
49
  "GET_OFFER",
49
50
  "GET_OFFER_VIEW",
50
51
  "GET_PROMOTIONS",
@@ -96,6 +97,7 @@ module FacebookAds
96
97
  "VIEW_CHANNEL",
97
98
  "VIEW_PRODUCT",
98
99
  "VISIT_PAGES_FEED",
100
+ "WATCH_LIVE_VIDEO",
99
101
  "WATCH_MORE",
100
102
  "WATCH_VIDEO",
101
103
  "WHATSAPP_MESSAGE",
@@ -107,6 +109,7 @@ module FacebookAds
107
109
  field :additional_data, 'AdAssetFeedAdditionalData'
108
110
  field :app_product_page_id, 'string'
109
111
  field :asset_customization_rules, { list: 'AdAssetFeedSpecAssetCustomizationRule' }
112
+ field :audios, { list: 'object' }
110
113
  field :autotranslate, { list: 'string' }
111
114
  field :bodies, { list: 'AdAssetFeedSpecBody' }
112
115
  field :call_ads_configuration, 'object'
@@ -114,6 +117,7 @@ module FacebookAds
114
117
  field :call_to_actions, { list: 'AdAssetFeedSpecCallToAction' }
115
118
  field :captions, { list: 'AdAssetFeedSpecCaption' }
116
119
  field :carousels, { list: 'AdAssetFeedSpecCarousel' }
120
+ field :ctwa_consent_data, { list: 'object' }
117
121
  field :descriptions, { list: 'AdAssetFeedSpecDescription' }
118
122
  field :events, { list: 'AdAssetFeedSpecEvents' }
119
123
  field :groups, { list: 'AdAssetFeedSpecGroupRule' }
@@ -45,6 +45,7 @@ module FacebookAds
45
45
  "FOLLOW_USER",
46
46
  "GET_A_QUOTE",
47
47
  "GET_DIRECTIONS",
48
+ "GET_IN_TOUCH",
48
49
  "GET_OFFER",
49
50
  "GET_OFFER_VIEW",
50
51
  "GET_PROMOTIONS",
@@ -96,6 +97,7 @@ module FacebookAds
96
97
  "VIEW_CHANNEL",
97
98
  "VIEW_PRODUCT",
98
99
  "VISIT_PAGES_FEED",
100
+ "WATCH_LIVE_VIDEO",
99
101
  "WATCH_MORE",
100
102
  "WATCH_VIDEO",
101
103
  "WHATSAPP_MESSAGE",
@@ -185,7 +187,6 @@ module FacebookAds
185
187
  field :dynamic_ad_voice, 'string'
186
188
  field :effective_authorization_category, 'string'
187
189
  field :effective_instagram_media_id, 'string'
188
- field :effective_instagram_story_id, 'string'
189
190
  field :effective_object_story_id, 'string'
190
191
  field :enable_direct_install, 'bool'
191
192
  field :enable_launch_instant_app, 'bool'
@@ -194,10 +195,8 @@ module FacebookAds
194
195
  field :image_crops, 'AdsImageCrops'
195
196
  field :image_hash, 'string'
196
197
  field :image_url, 'string'
197
- field :instagram_actor_id, 'string'
198
198
  field :instagram_branded_content, 'AdCreativeInstagramBrandedContent'
199
199
  field :instagram_permalink_url, 'string'
200
- field :instagram_story_id, 'string'
201
200
  field :instagram_user_id, 'string'
202
201
  field :interactive_components_spec, 'AdCreativeInteractiveComponentsSpec'
203
202
  field :link_deep_link_url, 'string'
@@ -222,6 +221,7 @@ module FacebookAds
222
221
  field :product_data, { list: 'AdCreativeProductData' }
223
222
  field :product_set_id, 'string'
224
223
  field :recommender_settings, 'AdCreativeRecommenderSettings'
224
+ field :regional_regulation_disclaimer_spec, 'AdCreativeRegionalRegulationDisclaimer'
225
225
  field :source_instagram_media_id, 'string'
226
226
  field :status, { enum: -> { STATUS }}
227
227
  field :template_url, 'string'
@@ -15,8 +15,13 @@ module FacebookAds
15
15
 
16
16
  class AdCreativeFeatureCustomizations < AdObject
17
17
 
18
+ field :background_color, 'string'
19
+ field :catalog_feed_tag_name, 'string'
20
+ field :font_name, 'string'
18
21
  field :image_crop_style, 'string'
19
22
  field :showcase_card_display, 'string'
23
+ field :text_extraction, 'object'
24
+ field :text_style, 'string'
20
25
  has_no_id
21
26
  has_no_get
22
27
  has_no_post
@@ -45,6 +45,7 @@ module FacebookAds
45
45
  "FOLLOW_USER",
46
46
  "GET_A_QUOTE",
47
47
  "GET_DIRECTIONS",
48
+ "GET_IN_TOUCH",
48
49
  "GET_OFFER",
49
50
  "GET_OFFER_VIEW",
50
51
  "GET_PROMOTIONS",
@@ -96,6 +97,7 @@ module FacebookAds
96
97
  "VIEW_CHANNEL",
97
98
  "VIEW_PRODUCT",
98
99
  "VISIT_PAGES_FEED",
100
+ "WATCH_LIVE_VIDEO",
99
101
  "WATCH_MORE",
100
102
  "WATCH_VIDEO",
101
103
  "WHATSAPP_MESSAGE",
@@ -15,7 +15,7 @@ module FacebookAds
15
15
 
16
16
  class AdCreativeObjectStorySpec < AdObject
17
17
 
18
- field :instagram_actor_id, 'string'
18
+ field :instagram_user_id, 'string'
19
19
  field :link_data, 'AdCreativeLinkData'
20
20
  field :page_id, 'string'
21
21
  field :photo_data, 'AdCreativePhotoData'
@@ -15,6 +15,9 @@ module FacebookAds
15
15
 
16
16
  class AdCreativeRegionalRegulationDisclaimer < AdObject
17
17
 
18
+ field :australia_finserv, 'object'
19
+ field :taiwan_finserv, 'object'
20
+ field :taiwan_universal, 'object'
18
21
  has_no_id
19
22
  has_no_get
20
23
  has_no_post
@@ -16,6 +16,7 @@ module FacebookAds
16
16
  class AdCreativeSourcingSpec < AdObject
17
17
 
18
18
  field :associated_product_set_id, 'string'
19
+ field :brand, 'object'
19
20
  field :enable_social_feedback_preservation, 'bool'
20
21
  field :promotion_metadata_spec, { list: 'AdCreativePromotionMetadataSpec' }
21
22
  field :site_links_spec, { list: 'AdCreativeSiteLinksSpec' }
@@ -46,6 +46,38 @@ module FacebookAds
46
46
  "TUTORIAL_COMPLETION",
47
47
  ]
48
48
 
49
+ LEAD_ADS_CUSTOM_EVENT_TYPE = [
50
+ "ACHIEVEMENT_UNLOCKED",
51
+ "ADD_PAYMENT_INFO",
52
+ "ADD_TO_CART",
53
+ "ADD_TO_WISHLIST",
54
+ "AD_IMPRESSION",
55
+ "COMPLETE_REGISTRATION",
56
+ "CONTACT",
57
+ "CONTENT_VIEW",
58
+ "CUSTOMIZE_PRODUCT",
59
+ "D2_RETENTION",
60
+ "D7_RETENTION",
61
+ "DONATE",
62
+ "FIND_LOCATION",
63
+ "INITIATED_CHECKOUT",
64
+ "LEAD",
65
+ "LEVEL_ACHIEVED",
66
+ "LISTING_INTERACTION",
67
+ "MESSAGING_CONVERSATION_STARTED_7D",
68
+ "OTHER",
69
+ "PURCHASE",
70
+ "RATE",
71
+ "SCHEDULE",
72
+ "SEARCH",
73
+ "SERVICE_BOOKING_REQUEST",
74
+ "SPENT_CREDITS",
75
+ "START_TRIAL",
76
+ "SUBMIT_APPLICATION",
77
+ "SUBSCRIBE",
78
+ "TUTORIAL_COMPLETION",
79
+ ]
80
+
49
81
 
50
82
  field :application_id, 'string'
51
83
  field :boosted_product_set_id, 'string'
@@ -55,7 +87,10 @@ module FacebookAds
55
87
  field :custom_event_type, { enum: -> { CUSTOM_EVENT_TYPE }}
56
88
  field :event_id, 'string'
57
89
  field :fundraiser_campaign_id, 'string'
90
+ field :lead_ads_custom_event_str, 'string'
91
+ field :lead_ads_custom_event_type, { enum: -> { LEAD_ADS_CUSTOM_EVENT_TYPE }}
58
92
  field :lead_ads_form_event_source_type, 'string'
93
+ field :lead_ads_offsite_conversion_type, 'string'
59
94
  field :mcme_conversion_id, 'string'
60
95
  field :object_store_url, 'string'
61
96
  field :offer_id, 'string'
@@ -39,6 +39,7 @@ module FacebookAds
39
39
 
40
40
  field :execution_options, { list: 'AdRuleExecutionOptions' }
41
41
  field :execution_type, { enum: -> { EXECUTION_TYPE }}
42
+ field :is_once_off, 'bool'
42
43
  field :id, 'string'
43
44
  has_no_post
44
45
  has_no_delete
@@ -172,6 +172,7 @@ module FacebookAds
172
172
  "1",
173
173
  "2",
174
174
  "3",
175
+ "4",
175
176
  ]
176
177
 
177
178
  TUNE_FOR_CATEGORY = [
@@ -228,7 +229,7 @@ module FacebookAds
228
229
  field :frequency_control_specs, { list: 'AdCampaignFrequencyControlSpecs' }
229
230
  field :full_funnel_exploration_mode, 'string'
230
231
  field :id, 'string'
231
- field :instagram_actor_id, 'string'
232
+ field :instagram_user_id, 'string'
232
233
  field :is_budget_schedule_enabled, 'bool'
233
234
  field :is_dynamic_creative, 'bool'
234
235
  field :issues_info, { list: 'AdCampaignIssuesInfo' }
@@ -265,6 +266,7 @@ module FacebookAds
265
266
  field :daily_imps, 'int'
266
267
  field :date_format, 'string'
267
268
  field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
269
+ field :is_sac_cfca_terms_certified, 'bool'
268
270
  field :line_number, 'int'
269
271
  field :rb_prediction_id, 'string'
270
272
  field :time_start, 'datetime'
@@ -23,17 +23,14 @@ module FacebookAds
23
23
  "AD_LIBRARY_WATERMARK",
24
24
  "AGE_UP",
25
25
  "ALBUM_MULTIMEDIA_POST",
26
- "ALOHA_CALL_VIDEO",
27
26
  "ALOHA_SUPERFRAME",
28
27
  "APP_REREVIEW_SCREENCAST",
29
28
  "APP_REVIEW_SCREENCAST",
30
29
  "ASSET_MANAGER",
31
30
  "ATLAS_VIDEO",
32
- "AUDIO_BRIEF",
33
31
  "AUDIO_BROADCAST",
34
32
  "AUDIO_COMMENT",
35
33
  "BROADCAST",
36
- "BULLETIN_ARTICLE_AUDIO",
37
34
  "CANVAS",
38
35
  "CFC_VIDEO",
39
36
  "CMS_MEDIA_MANAGER",
@@ -64,7 +61,6 @@ module FacebookAds
64
61
  "FB_COLLECTIBLE_VIDEO",
65
62
  "FB_SHORTS",
66
63
  "FB_SHORTS_CONTENT_REMIXABLE",
67
- "FB_SHORTS_CROSS_META_POST",
68
64
  "FB_SHORTS_GROUP_POST",
69
65
  "FB_SHORTS_LINKED_PRODUCT",
70
66
  "FB_SHORTS_PMV_POST",
@@ -73,7 +69,6 @@ module FacebookAds
73
69
  "FB_SHORTS_REMIX_POST",
74
70
  "FUNDRAISER_COVER_VIDEO",
75
71
  "GAME_CLIP",
76
- "GEMSTONE",
77
72
  "GIF_TO_VIDEO",
78
73
  "GOODWILL_ANNIVERSARY_DEPRECATED",
79
74
  "GOODWILL_ANNIVERSARY_PROMOTION_DEPRECATED",
@@ -82,7 +77,6 @@ module FacebookAds
82
77
  "GOODWILL_VIDEO_SHARE",
83
78
  "GOODWILL_VIDEO_TOKEN_REQUIRED",
84
79
  "GROUP_POST",
85
- "HACK_TV",
86
80
  "HEURISTIC_CLUSTER_VIDEO",
87
81
  "HIGHLIGHT_CLIP_VIDEO",
88
82
  "HUDDLE_BROADCAST",
@@ -93,13 +87,9 @@ module FacebookAds
93
87
  "INSTAGRAM_VIDEO_COPY",
94
88
  "INSTANT_APPLICATION_PREVIEW",
95
89
  "INSTANT_ARTICLE",
96
- "INSTANT_GAMES_PROMO",
97
- "INSTANT_GAME_CLIP",
98
90
  "ISSUE_MODULE",
99
91
  "JOBS_CAREERS",
100
92
  "JOBS_VISUAL_INTRO_ENTRY",
101
- "JOB_APPLICATION_VIDEO",
102
- "JOB_OPENING_VIDEO",
103
93
  "LEARN",
104
94
  "LEGACY",
105
95
  "LEGACY_CONTAINED_POST_BROADCAST",
@@ -114,7 +104,6 @@ module FacebookAds
114
104
  "MESSENGER_WATCH_TOGETHER",
115
105
  "MOMENTS_VIDEO",
116
106
  "MUSIC_CLIP",
117
- "MUSIC_CLIP_IN_AUDIO_DIGEST",
118
107
  "MUSIC_CLIP_IN_COMMENT",
119
108
  "MUSIC_CLIP_IN_LIGHTWEIGHT_STATUS",
120
109
  "MUSIC_CLIP_IN_MSGR_NOTE",
@@ -246,6 +235,12 @@ module FacebookAds
246
235
  "transfer",
247
236
  ]
248
237
 
238
+ VIDEO_STATE = [
239
+ "DRAFT",
240
+ "PUBLISHED",
241
+ "SCHEDULED",
242
+ ]
243
+
249
244
  VALIDATION_AD_PLACEMENTS = [
250
245
  "AUDIENCE_NETWORK_INSTREAM_VIDEO",
251
246
  "AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE",
@@ -277,12 +272,6 @@ module FacebookAds
277
272
  "uploaded",
278
273
  ]
279
274
 
280
- VIDEO_STATE = [
281
- "DRAFT",
282
- "PUBLISHED",
283
- "SCHEDULED",
284
- ]
285
-
286
275
  BACKDATED_TIME_GRANULARITY = [
287
276
  "day",
288
277
  "hour",
@@ -298,6 +287,7 @@ module FacebookAds
298
287
  field :audio_isrc, 'AudioIsrc'
299
288
  field :backdated_time, 'datetime'
300
289
  field :backdated_time_granularity, 'string'
290
+ field :boost_eligibility_info, 'object'
301
291
  field :content_category, 'string'
302
292
  field :content_tags, { list: 'string' }
303
293
  field :copyright, 'VideoCopyright'
@@ -398,10 +388,16 @@ module FacebookAds
398
388
  field :video_id_original, 'string'
399
389
  field :video_start_time_ms, 'int'
400
390
  field :waterfall_id, 'string'
391
+ field :video_id, 'string'
392
+ field :video_state, { enum: -> { VIDEO_STATE }}
401
393
  field :ad_placements_validation_only, 'bool'
402
394
  field :creative_folder_id, 'string'
403
395
  field :validation_ad_placements, { list: { enum: -> { VALIDATION_AD_PLACEMENTS }} }
404
396
 
397
+ has_edge :boost_ads_list do |edge|
398
+ edge.get
399
+ end
400
+
405
401
  has_edge :captions do |edge|
406
402
  edge.get
407
403
  edge.post 'AdVideo' do |api|
@@ -13,10 +13,9 @@ 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 ParentCatalogReport < AdObject
16
+ class AdsEligibility < AdObject
17
17
 
18
- field :purchase_conversion_value, 'double'
19
- field :purchases, 'int'
18
+ field :live_shopping, 'object'
20
19
  has_no_id
21
20
  has_no_get
22
21
  has_no_post
@@ -61,6 +61,7 @@ module FacebookAds
61
61
  "age",
62
62
  "app_id",
63
63
  "body_asset",
64
+ "breakdown_ad_objective",
64
65
  "breakdown_reporting_ad_id",
65
66
  "call_to_action_asset",
66
67
  "coarse_conversion_value",
@@ -77,6 +78,7 @@ module FacebookAds
77
78
  "hsid",
78
79
  "image_asset",
79
80
  "impression_device",
81
+ "impression_view_time_advertiser_hour_v2",
80
82
  "is_conversion_id_modeled",
81
83
  "is_rendered_as_delayed_skip_ad",
82
84
  "landing_destination",
@@ -193,6 +195,8 @@ module FacebookAds
193
195
  field :catalog_segment_value_omni_purchase_roas, { list: 'AdsActionStats' }
194
196
  field :catalog_segment_value_website_purchase_roas, { list: 'AdsActionStats' }
195
197
  field :clicks, 'string'
198
+ field :conversion_lead_rate, { list: 'AdsActionStats' }
199
+ field :conversion_leads, { list: 'AdsActionStats' }
196
200
  field :conversion_rate_ranking, 'string'
197
201
  field :conversion_values, { list: 'AdsActionStats' }
198
202
  field :conversions, { list: 'AdsActionStats' }
@@ -203,6 +207,7 @@ module FacebookAds
203
207
  field :cost_per_action_type, { list: 'AdsActionStats' }
204
208
  field :cost_per_ad_click, { list: 'AdsActionStats' }
205
209
  field :cost_per_conversion, { list: 'AdsActionStats' }
210
+ field :cost_per_conversion_lead, { list: 'AdsActionStats' }
206
211
  field :cost_per_dda_countby_convs, 'string'
207
212
  field :cost_per_estimated_ad_recallers, 'string'
208
213
  field :cost_per_inline_link_click, 'string'
@@ -246,6 +251,8 @@ module FacebookAds
246
251
  field :instant_experience_outbound_clicks, { list: 'AdsActionStats' }
247
252
  field :interactive_component_tap, { list: 'AdsActionStats' }
248
253
  field :labels, 'string'
254
+ field :landing_page_view_actions_per_link_click, 'string'
255
+ field :landing_page_view_per_purchase_rate, 'string'
249
256
  field :location, 'string'
250
257
  field :marketing_messages_cost_per_delivered, 'string'
251
258
  field :marketing_messages_cost_per_link_btn_click, 'string'
@@ -265,9 +272,11 @@ module FacebookAds
265
272
  field :outbound_clicks_ctr, { list: 'AdsActionStats' }
266
273
  field :place_page_name, 'string'
267
274
  field :purchase_roas, { list: 'AdsActionStats' }
275
+ field :purchases_per_link_click, 'string'
268
276
  field :qualifying_question_qualify_answer_rate, 'string'
269
277
  field :quality_ranking, 'string'
270
278
  field :reach, 'string'
279
+ field :result_values_performance_indicator, 'string'
271
280
  field :shops_assisted_purchases, 'string'
272
281
  field :social_spend, 'string'
273
282
  field :spend, 'string'
@@ -302,6 +311,7 @@ module FacebookAds
302
311
  field :video_play_retention_graph_actions, { list: 'AdsHistogramStats' }
303
312
  field :video_thruplay_watched_actions, { list: 'AdsActionStats' }
304
313
  field :video_time_watched_actions, { list: 'AdsActionStats' }
314
+ field :video_view_per_impression, { list: 'AdsActionStats' }
305
315
  field :website_ctr, { list: 'AdsActionStats' }
306
316
  field :website_purchase_roas, { list: 'AdsActionStats' }
307
317
  field :wish_bid, 'string'
@@ -13,11 +13,15 @@ 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 AdsDataPartner < AdObject
16
+ class AdsMcmeConversion < AdObject
17
17
 
18
+ field :creation_time, 'datetime'
19
+ field :description, 'string'
18
20
  field :id, 'string'
21
+ field :is_archived, 'bool'
22
+ field :mcme_conversion_type, 'string'
19
23
  field :name, 'string'
20
- field :rev_share_policies, { list: 'RevSharePolicy' }
24
+ field :omnichannel_object_id, 'string'
21
25
  has_no_post
22
26
  has_no_delete
23
27
 
@@ -22,6 +22,7 @@ module FacebookAds
22
22
  field :id, 'string'
23
23
  field :name, 'string'
24
24
  field :permission, 'string'
25
+ field :quick_view_type, 'string'
25
26
  field :sort, { list: 'object' }
26
27
  has_no_post
27
28
  has_no_delete
@@ -22,7 +22,9 @@ module FacebookAds
22
22
  field :ads_tool_visits, { list: 'object' }
23
23
  field :aplusc_carousel_cda_opt_in_status, 'string'
24
24
  field :aplusc_carousel_inline_comment_opt_in_status, 'string'
25
+ field :aplusc_enhance_cta_opt_in_status, 'string'
25
26
  field :aplusc_epa_opt_in_status, 'string'
27
+ field :aplusc_local_store_extension_opt_in_status, 'string'
26
28
  field :aplusc_opt_out_friction, { list: 'string' }
27
29
  field :autoflow_lite_opt_in_status, 'string'
28
30
  field :autoflow_lite_should_opt_in, 'bool'
@@ -34,6 +36,7 @@ module FacebookAds
34
36
  field :carousel_to_video_opt_in_status, 'string'
35
37
  field :connected_sources_catalog_opt_in_status, 'string'
36
38
  field :default_creation_mode, 'string'
39
+ field :dynamic_partnership_ads_opt_in_status, 'string'
37
40
  field :enhance_cta_text_extraction_opt_in_status, 'string'
38
41
  field :export_format_default, 'string'
39
42
  field :focus_mode_default, 'string'
@@ -113,6 +113,7 @@ module FacebookAds
113
113
  api.has_param :place, 'object'
114
114
  api.has_param :privacy, 'string'
115
115
  api.has_param :profile_id, 'int'
116
+ api.has_param :provenance_info, 'hash'
116
117
  api.has_param :proxied_app_id, 'string'
117
118
  api.has_param :published, 'bool'
118
119
  api.has_param :qn, 'string'