facebookbusiness 21.0.2 → 22.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 (102) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad_account.rb +33 -3
  3. data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +1 -0
  4. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +35 -0
  5. data/lib/facebook_ads/ad_objects/ad_account_amount_spent_history.rb +28 -0
  6. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +2 -0
  7. data/lib/facebook_ads/ad_objects/ad_account_live_video_advertiser.rb +2 -0
  8. data/lib/facebook_ads/ad_objects/ad_account_optimization_goals_aemv2_eligibility.rb +2 -0
  9. data/lib/facebook_ads/ad_objects/ad_account_spend_cap_change_history.rb +28 -0
  10. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +3 -1
  11. data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb +6 -0
  12. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +5 -0
  13. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +2 -0
  14. data/lib/facebook_ads/ad_objects/ad_campaign_group_advantage_state.rb +28 -0
  15. data/lib/facebook_ads/ad_objects/ad_campaign_issues_info.rb +1 -0
  16. data/lib/facebook_ads/ad_objects/ad_creative.rb +5 -4
  17. data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads.rb +1 -0
  18. data/lib/facebook_ads/ad_objects/ad_creative_feature_customizations.rb +5 -0
  19. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +3 -0
  20. data/lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb +1 -2
  21. data/lib/facebook_ads/ad_objects/ad_creative_regional_regulation_disclaimer.rb +5 -0
  22. data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +1 -0
  23. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +35 -0
  24. data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +1 -0
  25. data/lib/facebook_ads/ad_objects/ad_rule_history.rb +1 -0
  26. data/lib/facebook_ads/ad_objects/ad_set.rb +7 -1
  27. data/lib/facebook_ads/ad_objects/ad_video.rb +15 -23
  28. data/lib/facebook_ads/ad_objects/adgroup_issues_info.rb +1 -0
  29. data/lib/facebook_ads/ad_objects/{parent_catalog_report.rb → ads_eligibility.rb} +2 -3
  30. data/lib/facebook_ads/ad_objects/ads_insights.rb +25 -0
  31. data/lib/facebook_ads/ad_objects/{ads_data_partner.rb → ads_mcme_conversion.rb} +6 -2
  32. data/lib/facebook_ads/ad_objects/{ads_pixel_capi_setup_quality.rb → ads_pixel_capi_integration_quality.rb} +1 -1
  33. data/lib/facebook_ads/ad_objects/ads_quick_views.rb +2 -0
  34. data/lib/facebook_ads/ad_objects/ads_user_settings.rb +6 -0
  35. data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +8 -1
  36. data/lib/facebook_ads/ad_objects/album.rb +1 -0
  37. data/lib/facebook_ads/ad_objects/application.rb +16 -6
  38. data/lib/facebook_ads/ad_objects/audio_visual_reference_match.rb +1 -0
  39. data/lib/facebook_ads/ad_objects/automotive_model.rb +9 -0
  40. data/lib/facebook_ads/ad_objects/branded_content_shadow_ig_media_id.rb +1 -0
  41. data/lib/facebook_ads/ad_objects/business.rb +20 -10
  42. data/lib/facebook_ads/ad_objects/business_agreement.rb +1 -0
  43. data/lib/facebook_ads/ad_objects/business_asset_group.rb +1 -0
  44. data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb +1 -0
  45. data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +1 -0
  46. data/lib/facebook_ads/ad_objects/campaign.rb +1 -0
  47. data/lib/facebook_ads/ad_objects/catalog_collection.rb +27 -0
  48. data/lib/facebook_ads/ad_objects/{domain.rb → catalog_content_version_config.rb} +2 -2
  49. data/lib/facebook_ads/ad_objects/copyright_reference_container.rb +1 -0
  50. data/lib/facebook_ads/ad_objects/{instagram_boostable_media_for_access_token.rb → creative_multicell_test_config.rb} +3 -3
  51. data/lib/facebook_ads/ad_objects/{instagram_video_metadata.rb → ctx_default_optimization_config.rb} +3 -4
  52. data/lib/facebook_ads/ad_objects/custom_audience.rb +11 -1
  53. data/lib/facebook_ads/ad_objects/custom_audience_health.rb +25 -0
  54. data/lib/facebook_ads/ad_objects/destination.rb +4 -0
  55. data/lib/facebook_ads/ad_objects/event.rb +1 -0
  56. data/lib/facebook_ads/ad_objects/fb_image_copyright_match.rb +1 -0
  57. data/lib/facebook_ads/ad_objects/flight.rb +15 -0
  58. data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +1 -0
  59. data/lib/facebook_ads/ad_objects/funding_source_details_coupon_tiering.rb +26 -0
  60. data/lib/facebook_ads/ad_objects/group.rb +1 -0
  61. data/lib/facebook_ads/ad_objects/home_listing.rb +11 -0
  62. data/lib/facebook_ads/ad_objects/hotel.rb +10 -0
  63. data/lib/facebook_ads/ad_objects/ig_media_for_ig_only_api.rb +1 -0
  64. data/lib/facebook_ads/ad_objects/ig_user.rb +28 -0
  65. data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +17 -1
  66. data/lib/facebook_ads/ad_objects/insights_result.rb +17 -0
  67. data/lib/facebook_ads/ad_objects/insights_value.rb +2 -0
  68. data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +1 -0
  69. data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +5 -0
  70. data/lib/facebook_ads/ad_objects/message_delivery_estimate.rb +2 -0
  71. data/lib/facebook_ads/ad_objects/messenger_business_template.rb +2 -0
  72. data/lib/facebook_ads/ad_objects/music_work_copyright.rb +2 -0
  73. data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +0 -2
  74. data/lib/facebook_ads/ad_objects/page.rb +35 -29
  75. data/lib/facebook_ads/ad_objects/page_call_to_action.rb +1 -0
  76. data/lib/facebook_ads/ad_objects/page_change_proposal.rb +0 -2
  77. data/lib/facebook_ads/ad_objects/product_catalog.rb +5 -0
  78. data/lib/facebook_ads/ad_objects/product_item.rb +2 -0
  79. data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +3 -3
  80. data/lib/facebook_ads/ad_objects/recommended_ig_media.rb +0 -1
  81. data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb +6 -0
  82. data/lib/facebook_ads/ad_objects/{private_computation_environment.rb → store_location.rb} +8 -6
  83. data/lib/facebook_ads/ad_objects/targeting_subscriber_universe.rb +27 -0
  84. data/lib/facebook_ads/ad_objects/third_party_partner_lift_request.rb +3 -0
  85. data/lib/facebook_ads/ad_objects/threads_user.rb +26 -0
  86. data/lib/facebook_ads/ad_objects/user.rb +9 -2
  87. data/lib/facebook_ads/ad_objects/vehicle.rb +10 -0
  88. data/lib/facebook_ads/ad_objects/vehicle_offer.rb +11 -0
  89. data/lib/facebook_ads/ad_objects/video_copyright_match.rb +1 -0
  90. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +40 -7
  91. data/lib/facebook_ads/ad_objects/whats_app_business_partner_client_verification_submission.rb +1 -0
  92. data/lib/facebook_ads/version.rb +2 -2
  93. data/lib/facebook_ads.rb +2 -2
  94. metadata +21 -21
  95. data/lib/facebook_ads/ad_objects/instagram_carousel.rb +0 -41
  96. data/lib/facebook_ads/ad_objects/instagram_comment.rb +0 -37
  97. data/lib/facebook_ads/ad_objects/instagram_media.rb +0 -46
  98. data/lib/facebook_ads/ad_objects/marketing_message_targeting.rb +0 -29
  99. data/lib/facebook_ads/ad_objects/merchant_report.rb +0 -39
  100. data/lib/facebook_ads/ad_objects/negative_keyword_list.rb +0 -33
  101. data/lib/facebook_ads/ad_objects/product_catalog_user_permissions.rb +0 -34
  102. data/lib/facebook_ads/ad_objects/video_metrics_report.rb +0 -33
@@ -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
@@ -19,6 +19,7 @@ module FacebookAds
19
19
  "CHANGED_BID",
20
20
  "CHANGED_BUDGET",
21
21
  "CONSOLIDATE_ASC_FRAGMENTATION",
22
+ "CONSOLIDATE_FRAGMENTATION",
22
23
  "CONVERT_ASC_CP_SINGLE_INSTANCE",
23
24
  "EMAIL",
24
25
  "ENABLE_ADVANTAGE_CAMPAIGN_BUDGET",
@@ -53,6 +53,7 @@ module FacebookAds
53
53
  ]
54
54
 
55
55
  OPTIMIZATION_GOAL = [
56
+ "ADVERTISER_SILOED_VALUE",
56
57
  "AD_RECALL_LIFT",
57
58
  "APP_INSTALLS",
58
59
  "APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
@@ -72,6 +73,7 @@ module FacebookAds
72
73
  "OFFSITE_CONVERSIONS",
73
74
  "PAGE_LIKES",
74
75
  "POST_ENGAGEMENT",
76
+ "PROFILE_AND_PAGE_ENGAGEMENT",
75
77
  "PROFILE_VISIT",
76
78
  "QUALITY_CALL",
77
79
  "QUALITY_LEAD",
@@ -172,6 +174,8 @@ module FacebookAds
172
174
  "1",
173
175
  "2",
174
176
  "3",
177
+ "4",
178
+ "5",
175
179
  ]
176
180
 
177
181
  TUNE_FOR_CATEGORY = [
@@ -228,7 +232,8 @@ module FacebookAds
228
232
  field :frequency_control_specs, { list: 'AdCampaignFrequencyControlSpecs' }
229
233
  field :full_funnel_exploration_mode, 'string'
230
234
  field :id, 'string'
231
- field :instagram_actor_id, 'string'
235
+ field :instagram_user_id, 'string'
236
+ field :is_ba_skip_delayed_eligible, 'bool'
232
237
  field :is_budget_schedule_enabled, 'bool'
233
238
  field :is_dynamic_creative, 'bool'
234
239
  field :issues_info, { list: 'AdCampaignIssuesInfo' }
@@ -265,6 +270,7 @@ module FacebookAds
265
270
  field :daily_imps, 'int'
266
271
  field :date_format, 'string'
267
272
  field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
273
+ field :is_sac_cfca_terms_certified, 'bool'
268
274
  field :line_number, 'int'
269
275
  field :rb_prediction_id, 'string'
270
276
  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",
@@ -44,6 +41,7 @@ module FacebookAds
44
41
  "COPYRIGHT_REFERENCE_IG_XPOST_VIDEO",
45
42
  "COPYRIGHT_REFERENCE_VIDEO",
46
43
  "CREATION_ML_PRECREATION",
44
+ "CREATOR_FAN_CHALLENGE",
47
45
  "CREATOR_STOREFRONT_PERSONALIZED_VIDEO",
48
46
  "DATAGENIX_VIDEO",
49
47
  "DCO_AD_ASSET_FEED",
@@ -64,7 +62,6 @@ module FacebookAds
64
62
  "FB_COLLECTIBLE_VIDEO",
65
63
  "FB_SHORTS",
66
64
  "FB_SHORTS_CONTENT_REMIXABLE",
67
- "FB_SHORTS_CROSS_META_POST",
68
65
  "FB_SHORTS_GROUP_POST",
69
66
  "FB_SHORTS_LINKED_PRODUCT",
70
67
  "FB_SHORTS_PMV_POST",
@@ -73,7 +70,6 @@ module FacebookAds
73
70
  "FB_SHORTS_REMIX_POST",
74
71
  "FUNDRAISER_COVER_VIDEO",
75
72
  "GAME_CLIP",
76
- "GEMSTONE",
77
73
  "GIF_TO_VIDEO",
78
74
  "GOODWILL_ANNIVERSARY_DEPRECATED",
79
75
  "GOODWILL_ANNIVERSARY_PROMOTION_DEPRECATED",
@@ -82,7 +78,6 @@ module FacebookAds
82
78
  "GOODWILL_VIDEO_SHARE",
83
79
  "GOODWILL_VIDEO_TOKEN_REQUIRED",
84
80
  "GROUP_POST",
85
- "HACK_TV",
86
81
  "HEURISTIC_CLUSTER_VIDEO",
87
82
  "HIGHLIGHT_CLIP_VIDEO",
88
83
  "HUDDLE_BROADCAST",
@@ -93,13 +88,7 @@ module FacebookAds
93
88
  "INSTAGRAM_VIDEO_COPY",
94
89
  "INSTANT_APPLICATION_PREVIEW",
95
90
  "INSTANT_ARTICLE",
96
- "INSTANT_GAMES_PROMO",
97
- "INSTANT_GAME_CLIP",
98
91
  "ISSUE_MODULE",
99
- "JOBS_CAREERS",
100
- "JOBS_VISUAL_INTRO_ENTRY",
101
- "JOB_APPLICATION_VIDEO",
102
- "JOB_OPENING_VIDEO",
103
92
  "LEARN",
104
93
  "LEGACY",
105
94
  "LEGACY_CONTAINED_POST_BROADCAST",
@@ -111,10 +100,8 @@ module FacebookAds
111
100
  "LOOK_NOW_DEPRECATED",
112
101
  "MARKETPLACE_LISTING_VIDEO",
113
102
  "MARKETPLACE_PRE_RECORDED_VIDEO",
114
- "MESSENGER_WATCH_TOGETHER",
115
103
  "MOMENTS_VIDEO",
116
104
  "MUSIC_CLIP",
117
- "MUSIC_CLIP_IN_AUDIO_DIGEST",
118
105
  "MUSIC_CLIP_IN_COMMENT",
119
106
  "MUSIC_CLIP_IN_LIGHTWEIGHT_STATUS",
120
107
  "MUSIC_CLIP_IN_MSGR_NOTE",
@@ -123,11 +110,9 @@ module FacebookAds
123
110
  "NEO_ASYNC_GAME_VIDEO",
124
111
  "NEW_CONTAINED_POST_BROADCAST",
125
112
  "NO_STORY",
126
- "NO_STORY_WITH_ENTPOST",
127
113
  "NPE_COLLAB_COPYRIGHT_CHECK",
128
114
  "OCULUS_CREATOR_PORTAL",
129
115
  "OCULUS_VENUES_BROADCAST",
130
- "OFFERS_VIDEO",
131
116
  "ORIGINALITY_SELF_ADVOCACY",
132
117
  "PAGES_COVER_VIDEO",
133
118
  "PAGE_REVIEW_SCREENCAST",
@@ -161,7 +146,6 @@ module FacebookAds
161
146
  "QUICK_PROMOTION",
162
147
  "REPLACE_VIDEO",
163
148
  "SALES_CLIENT_INTERACTION",
164
- "SAY_THANKS_DEPRECATED",
165
149
  "SHOWREEL_NATIVE_DUMMY_VIDEO",
166
150
  "SLIDESHOW_ANIMOTO",
167
151
  "SLIDESHOW_SHAKR",
@@ -179,6 +163,7 @@ module FacebookAds
179
163
  "TAROT_DIGEST",
180
164
  "TEMPORARY_UNLISTED",
181
165
  "TEMP_MULTIMEDIA_POST",
166
+ "TEMP_VIDEO_COPYRIGHT_SCAN",
182
167
  "UNLISTED",
183
168
  "UNLISTED_HORIZON",
184
169
  "UNLISTED_OCULUS",
@@ -246,6 +231,12 @@ module FacebookAds
246
231
  "transfer",
247
232
  ]
248
233
 
234
+ VIDEO_STATE = [
235
+ "DRAFT",
236
+ "PUBLISHED",
237
+ "SCHEDULED",
238
+ ]
239
+
249
240
  VALIDATION_AD_PLACEMENTS = [
250
241
  "AUDIENCE_NETWORK_INSTREAM_VIDEO",
251
242
  "AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE",
@@ -277,12 +268,6 @@ module FacebookAds
277
268
  "uploaded",
278
269
  ]
279
270
 
280
- VIDEO_STATE = [
281
- "DRAFT",
282
- "PUBLISHED",
283
- "SCHEDULED",
284
- ]
285
-
286
271
  BACKDATED_TIME_GRANULARITY = [
287
272
  "day",
288
273
  "hour",
@@ -298,6 +283,7 @@ module FacebookAds
298
283
  field :audio_isrc, 'AudioIsrc'
299
284
  field :backdated_time, 'datetime'
300
285
  field :backdated_time_granularity, 'string'
286
+ field :boost_eligibility_info, 'object'
301
287
  field :content_category, 'string'
302
288
  field :content_tags, { list: 'string' }
303
289
  field :copyright, 'VideoCopyright'
@@ -398,10 +384,16 @@ module FacebookAds
398
384
  field :video_id_original, 'string'
399
385
  field :video_start_time_ms, 'int'
400
386
  field :waterfall_id, 'string'
387
+ field :video_id, 'string'
388
+ field :video_state, { enum: -> { VIDEO_STATE }}
401
389
  field :ad_placements_validation_only, 'bool'
402
390
  field :creative_folder_id, 'string'
403
391
  field :validation_ad_placements, { list: { enum: -> { VALIDATION_AD_PLACEMENTS }} }
404
392
 
393
+ has_edge :boost_ads_list do |edge|
394
+ edge.get
395
+ end
396
+
405
397
  has_edge :captions do |edge|
406
398
  edge.get
407
399
  edge.post 'AdVideo' do |api|
@@ -20,6 +20,7 @@ module FacebookAds
20
20
  field :error_summary, 'string'
21
21
  field :error_type, 'string'
22
22
  field :level, 'string'
23
+ field :mid, 'string'
23
24
  has_no_id
24
25
  has_no_get
25
26
  has_no_post
@@ -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
@@ -29,7 +29,11 @@ module FacebookAds
29
29
  "dda",
30
30
  "default",
31
31
  "skan_click",
32
+ "skan_click_second_postback",
33
+ "skan_click_third_postback",
32
34
  "skan_view",
35
+ "skan_view_second_postback",
36
+ "skan_view_third_postback",
33
37
  ]
34
38
 
35
39
  ACTION_BREAKDOWNS = [
@@ -61,6 +65,7 @@ module FacebookAds
61
65
  "age",
62
66
  "app_id",
63
67
  "body_asset",
68
+ "breakdown_ad_objective",
64
69
  "breakdown_reporting_ad_id",
65
70
  "call_to_action_asset",
66
71
  "coarse_conversion_value",
@@ -77,6 +82,7 @@ module FacebookAds
77
82
  "hsid",
78
83
  "image_asset",
79
84
  "impression_device",
85
+ "impression_view_time_advertiser_hour_v2",
80
86
  "is_conversion_id_modeled",
81
87
  "is_rendered_as_delayed_skip_ad",
82
88
  "landing_destination",
@@ -193,16 +199,21 @@ module FacebookAds
193
199
  field :catalog_segment_value_omni_purchase_roas, { list: 'AdsActionStats' }
194
200
  field :catalog_segment_value_website_purchase_roas, { list: 'AdsActionStats' }
195
201
  field :clicks, 'string'
202
+ field :conversion_lead_rate, { list: 'AdsActionStats' }
203
+ field :conversion_leads, { list: 'AdsActionStats' }
196
204
  field :conversion_rate_ranking, 'string'
197
205
  field :conversion_values, { list: 'AdsActionStats' }
198
206
  field :conversions, { list: 'AdsActionStats' }
199
207
  field :converted_product_quantity, { list: 'AdsActionStats' }
200
208
  field :converted_product_value, { list: 'AdsActionStats' }
209
+ field :converted_promoted_product_quantity, { list: 'AdsActionStats' }
210
+ field :converted_promoted_product_value, { list: 'AdsActionStats' }
201
211
  field :cost_per_15_sec_video_view, { list: 'AdsActionStats' }
202
212
  field :cost_per_2_sec_continuous_video_view, { list: 'AdsActionStats' }
203
213
  field :cost_per_action_type, { list: 'AdsActionStats' }
204
214
  field :cost_per_ad_click, { list: 'AdsActionStats' }
205
215
  field :cost_per_conversion, { list: 'AdsActionStats' }
216
+ field :cost_per_conversion_lead, { list: 'AdsActionStats' }
206
217
  field :cost_per_dda_countby_convs, 'string'
207
218
  field :cost_per_estimated_ad_recallers, 'string'
208
219
  field :cost_per_inline_link_click, 'string'
@@ -246,16 +257,27 @@ module FacebookAds
246
257
  field :instant_experience_outbound_clicks, { list: 'AdsActionStats' }
247
258
  field :interactive_component_tap, { list: 'AdsActionStats' }
248
259
  field :labels, 'string'
260
+ field :landing_page_view_actions_per_link_click, 'string'
261
+ field :landing_page_view_per_purchase_rate, 'string'
249
262
  field :location, 'string'
250
263
  field :marketing_messages_cost_per_delivered, 'string'
251
264
  field :marketing_messages_cost_per_link_btn_click, 'string'
265
+ field :marketing_messages_delivered, 'string'
252
266
  field :marketing_messages_delivery_rate, 'string'
267
+ field :marketing_messages_link_btn_click, 'string'
253
268
  field :marketing_messages_link_btn_click_rate, 'string'
254
269
  field :marketing_messages_media_view_rate, 'string'
255
270
  field :marketing_messages_phone_call_btn_click_rate, 'string'
271
+ field :marketing_messages_quick_reply_btn_click, 'string'
256
272
  field :marketing_messages_quick_reply_btn_click_rate, 'string'
273
+ field :marketing_messages_read, 'string'
257
274
  field :marketing_messages_read_rate, 'string'
275
+ field :marketing_messages_sent, 'string'
258
276
  field :marketing_messages_spend, 'string'
277
+ field :marketing_messages_spend_currency, 'string'
278
+ field :marketing_messages_website_add_to_cart, 'string'
279
+ field :marketing_messages_website_initiate_checkout, 'string'
280
+ field :marketing_messages_website_purchase, 'string'
259
281
  field :marketing_messages_website_purchase_values, 'string'
260
282
  field :mobile_app_purchase_roas, { list: 'AdsActionStats' }
261
283
  field :objective, 'string'
@@ -265,9 +287,11 @@ module FacebookAds
265
287
  field :outbound_clicks_ctr, { list: 'AdsActionStats' }
266
288
  field :place_page_name, 'string'
267
289
  field :purchase_roas, { list: 'AdsActionStats' }
290
+ field :purchases_per_link_click, 'string'
268
291
  field :qualifying_question_qualify_answer_rate, 'string'
269
292
  field :quality_ranking, 'string'
270
293
  field :reach, 'string'
294
+ field :result_values_performance_indicator, 'string'
271
295
  field :shops_assisted_purchases, 'string'
272
296
  field :social_spend, 'string'
273
297
  field :spend, 'string'
@@ -302,6 +326,7 @@ module FacebookAds
302
326
  field :video_play_retention_graph_actions, { list: 'AdsHistogramStats' }
303
327
  field :video_thruplay_watched_actions, { list: 'AdsActionStats' }
304
328
  field :video_time_watched_actions, { list: 'AdsActionStats' }
329
+ field :video_view_per_impression, { list: 'AdsActionStats' }
305
330
  field :website_ctr, { list: 'AdsActionStats' }
306
331
  field :website_purchase_roas, { list: 'AdsActionStats' }
307
332
  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
 
@@ -13,7 +13,7 @@ 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 AdsPixelCapiSetupQuality < AdObject
16
+ class AdsPixelCapiIntegrationQuality < AdObject
17
17
 
18
18
  field :event_match_quality, 'object'
19
19
  field :event_name, 'string'
@@ -21,7 +21,9 @@ module FacebookAds
21
21
  field :description, 'string'
22
22
  field :id, 'string'
23
23
  field :name, 'string'
24
+ field :owner, 'Profile'
24
25
  field :permission, 'string'
26
+ field :quick_view_type, 'string'
25
27
  field :sort, { list: 'object' }
26
28
  has_no_post
27
29
  has_no_delete
@@ -22,8 +22,11 @@ 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' }
29
+ field :aplusc_videofilter_opt_in_status, 'string'
27
30
  field :autoflow_lite_opt_in_status, 'string'
28
31
  field :autoflow_lite_should_opt_in, 'bool'
29
32
  field :blended_ads_creation_defaulting_opt_in_status, 'string'
@@ -34,6 +37,7 @@ module FacebookAds
34
37
  field :carousel_to_video_opt_in_status, 'string'
35
38
  field :connected_sources_catalog_opt_in_status, 'string'
36
39
  field :default_creation_mode, 'string'
40
+ field :dynamic_partnership_ads_opt_in_status, 'string'
37
41
  field :enhance_cta_text_extraction_opt_in_status, 'string'
38
42
  field :export_format_default, 'string'
39
43
  field :focus_mode_default, 'string'
@@ -52,6 +56,8 @@ module FacebookAds
52
56
  field :open_tabs, { list: 'string' }
53
57
  field :previously_seen_recommendations, { list: 'string' }
54
58
  field :product_extensions_opt_in, 'string'
59
+ field :sa_off_conv_loc_seen, 'string'
60
+ field :saon_migr_l1_seen_status, 'string'
55
61
  field :selected_ad_account, 'AdAccount'
56
62
  field :selected_comparison_timerange, 'object'
57
63
  field :selected_metric_cic, 'string'
@@ -14,11 +14,18 @@ module FacebookAds
14
14
  # pull request for this class.
15
15
 
16
16
  class AdsValueAdjustmentRuleCollection < AdObject
17
+ PRODUCT_TYPE = [
18
+ "AUDIENCE",
19
+ "LEADGEN_ADS",
20
+ "OMNI_CHANNEL",
21
+ ]
22
+
17
23
 
18
24
  field :id, 'string'
19
25
  field :is_default_setting, 'bool'
20
26
  field :name, 'string'
21
- has_no_post
27
+ field :product_type, 'string'
28
+ field :rules, { list: 'hash' }
22
29
  has_no_delete
23
30
 
24
31
  has_edge :rules do |edge|
@@ -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'
@@ -227,6 +227,8 @@ module FacebookAds
227
227
  api.has_param :app_user_id, 'string'
228
228
  api.has_param :application_tracking_enabled, 'bool'
229
229
  api.has_param :attribution, 'string'
230
+ api.has_param :attribution_referrer, 'string'
231
+ api.has_param :attribution_sources, { list: 'hash' }
230
232
  api.has_param :auto_publish, 'bool'
231
233
  api.has_param :bundle_id, 'string'
232
234
  api.has_param :bundle_short_version, 'string'
@@ -243,13 +245,18 @@ module FacebookAds
243
245
  api.has_param :event, { enum: %w{CUSTOM_APP_EVENTS DEFERRED_APP_LINK MOBILE_APP_INSTALL }}
244
246
  api.has_param :event_id, 'string'
245
247
  api.has_param :extinfo, 'object'
248
+ api.has_param :google_install_referrer, 'string'
246
249
  api.has_param :include_dwell_data, 'bool'
247
250
  api.has_param :include_video_data, 'bool'
251
+ api.has_param :install_id, 'string'
248
252
  api.has_param :install_referrer, 'string'
249
253
  api.has_param :install_timestamp, 'int'
250
254
  api.has_param :installer_package, 'string'
255
+ api.has_param :is_fb, 'bool'
251
256
  api.has_param :limited_data_use, 'bool'
257
+ api.has_param :meta_install_referrer, 'string'
252
258
  api.has_param :migration_bundle, 'string'
259
+ api.has_param :operational_parameters, { list: 'hash' }
253
260
  api.has_param :page_id, 'int'
254
261
  api.has_param :page_scoped_user_id, 'int'
255
262
  api.has_param :receipt_data, 'string'
@@ -473,18 +480,27 @@ module FacebookAds
473
480
  edge.post do |api|
474
481
  api.has_param :advertiser_id, 'string'
475
482
  api.has_param :attribution, 'string'
483
+ api.has_param :attribution_method, 'string'
476
484
  api.has_param :attribution_model, 'string'
485
+ api.has_param :attribution_referrer, 'string'
477
486
  api.has_param :auditing_token, 'string'
478
487
  api.has_param :click_attr_window, 'int'
479
488
  api.has_param :custom_events, { list: 'object' }
480
489
  api.has_param :decline_reason, 'string'
490
+ api.has_param :device_os, 'string'
481
491
  api.has_param :engagement_type, 'string'
482
492
  api.has_param :event, 'string'
493
+ api.has_param :event_id, 'string'
483
494
  api.has_param :event_reported_time, 'int'
484
495
  api.has_param :fb_ad_id, 'int'
496
+ api.has_param :fb_adgroup_id, 'int'
485
497
  api.has_param :fb_click_time, 'int'
486
498
  api.has_param :fb_view_time, 'int'
499
+ api.has_param :google_install_referrer, 'string'
500
+ api.has_param :inactivity_window_hours, 'int'
501
+ api.has_param :install_id, 'string'
487
502
  api.has_param :is_fb, 'bool'
503
+ api.has_param :meta_install_referrer, 'string'
488
504
  api.has_param :used_install_referrer, 'bool'
489
505
  api.has_param :view_attr_window, 'int'
490
506
  end
@@ -523,12 +539,6 @@ module FacebookAds
523
539
  end
524
540
  end
525
541
 
526
- has_edge :payment_currencies do |edge|
527
- edge.post 'Application' do |api|
528
- api.has_param :currency_url, 'string'
529
- end
530
- end
531
-
532
542
  has_edge :permissions do |edge|
533
543
  edge.get do |api|
534
544
  api.has_param :android_key_hash, 'string'
@@ -18,6 +18,7 @@ module FacebookAds
18
18
  field :audio_conflicting_segments, { list: 'object' }
19
19
  field :audio_current_conflict_resolved_segments, { list: 'object' }
20
20
  field :audio_segment_resolution_history, { list: 'object' }
21
+ field :conflict_status, 'string'
21
22
  field :conflict_type, 'string'
22
23
  field :conflicting_countries, { list: 'string' }
23
24
  field :country_resolution_history, { list: 'map<string, list<Object>>' }
@@ -36,6 +36,15 @@ module FacebookAds
36
36
  field :category_specific_fields, 'CatalogSubVerticalList'
37
37
  field :currency, 'string'
38
38
  field :custom_label_0, 'string'
39
+ field :custom_label_1, 'string'
40
+ field :custom_label_2, 'string'
41
+ field :custom_label_3, 'string'
42
+ field :custom_label_4, 'string'
43
+ field :custom_number_0, 'int'
44
+ field :custom_number_1, 'int'
45
+ field :custom_number_2, 'int'
46
+ field :custom_number_3, 'int'
47
+ field :custom_number_4, 'int'
39
48
  field :description, 'string'
40
49
  field :drivetrain, 'string'
41
50
  field :exterior_color, 'string'
@@ -20,6 +20,7 @@ module FacebookAds
20
20
  field :id, 'string'
21
21
  field :owner_id, 'string'
22
22
  field :permalink, 'string'
23
+ field :recommended_campaign_objectives, { list: 'string' }
23
24
  has_no_get
24
25
  has_no_post
25
26
  has_no_delete