facebookbusiness 21.0.0 → 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.
- checksums.yaml +4 -4
- data/lib/facebook_ads/ad_objects/ad_account.rb +27 -3
- data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +19 -0
- data/lib/facebook_ads/ad_objects/ad_account_recommendations.rb +5 -0
- data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +1 -1
- data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb +4 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +4 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_link_url.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +5 -3
- data/lib/facebook_ads/ad_objects/ad_creative_feature_customizations.rb +6 -0
- data/lib/facebook_ads/ad_objects/ad_creative_features_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb +1 -1
- data/lib/facebook_ads/ad_objects/ad_creative_regional_regulation_disclaimer.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_monetization_property.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_network_analytics_async_query_export.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_network_analytics_async_query_result.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +35 -0
- data/lib/facebook_ads/ad_objects/ad_report_run.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_rule.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_set.rb +4 -1
- data/lib/facebook_ads/ad_objects/ad_video.rb +13 -18
- data/lib/facebook_ads/ad_objects/{parent_catalog_report.rb → ads_eligibility.rb} +2 -3
- data/lib/facebook_ads/ad_objects/ads_insights.rb +21 -0
- data/lib/facebook_ads/ad_objects/{private_computation_environment.rb → ads_mcme_conversion.rb} +7 -6
- data/lib/facebook_ads/ad_objects/ads_quick_views.rb +1 -0
- data/lib/facebook_ads/ad_objects/ads_user_settings.rb +6 -0
- data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +1 -0
- data/lib/facebook_ads/ad_objects/album.rb +1 -0
- data/lib/facebook_ads/ad_objects/analytics_funnel_query_result.rb +0 -2
- data/lib/facebook_ads/ad_objects/analytics_query_result.rb +0 -3
- data/lib/facebook_ads/ad_objects/application.rb +14 -6
- data/lib/facebook_ads/ad_objects/audio_visual_reference_match.rb +1 -0
- data/lib/facebook_ads/ad_objects/automotive_model.rb +9 -0
- data/lib/facebook_ads/ad_objects/business.rb +68 -4
- data/lib/facebook_ads/ad_objects/{instagram_boostable_media_for_access_token.rb → catalog_advertiser_insight.rb} +3 -3
- data/lib/facebook_ads/ad_objects/{domain.rb → catalog_content_version_config.rb} +2 -2
- data/lib/facebook_ads/ad_objects/catalog_website_onboarding_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/commerce_order.rb +0 -10
- data/lib/facebook_ads/ad_objects/copyright_reference_container.rb +1 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -1
- data/lib/facebook_ads/ad_objects/custom_audience_salts.rb +2 -0
- data/lib/facebook_ads/ad_objects/destination.rb +10 -0
- data/lib/facebook_ads/ad_objects/event.rb +1 -0
- data/lib/facebook_ads/ad_objects/extended_credit.rb +1 -1
- data/lib/facebook_ads/ad_objects/fb_image_copyright_match.rb +1 -0
- data/lib/facebook_ads/ad_objects/flight.rb +15 -0
- data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +2 -0
- data/lib/facebook_ads/ad_objects/{analytics_cohort_query_result.rb → funding_source_details_coupon_tiering.rb} +3 -5
- data/lib/facebook_ads/ad_objects/group.rb +1 -2
- data/lib/facebook_ads/ad_objects/home_listing.rb +10 -0
- data/lib/facebook_ads/ad_objects/hotel.rb +10 -0
- data/lib/facebook_ads/ad_objects/ig_comment.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_media.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_media_for_ig_only_api.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_user.rb +28 -0
- data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +14 -1
- data/lib/facebook_ads/ad_objects/{instagram_video_metadata.rb → ig_user_subscribed_apps_data.rb} +3 -4
- data/lib/facebook_ads/ad_objects/insights_result.rb +17 -0
- data/lib/facebook_ads/ad_objects/insights_value.rb +1 -0
- data/lib/facebook_ads/ad_objects/instagram_carousel.rb +1 -8
- data/lib/facebook_ads/ad_objects/instagram_comment.rb +2 -8
- data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +0 -5
- data/lib/facebook_ads/ad_objects/instagram_media.rb +1 -8
- data/lib/facebook_ads/ad_objects/instagram_user.rb +1 -0
- data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +3 -0
- data/lib/facebook_ads/ad_objects/{ads_data_partner.rb → live_video_ad_campaign_config.rb} +2 -3
- data/lib/facebook_ads/ad_objects/messenger_business_template.rb +15 -1
- data/lib/facebook_ads/ad_objects/messenger_call_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/music_work_copyright.rb +2 -0
- data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +7 -2
- data/lib/facebook_ads/ad_objects/page.rb +44 -73
- data/lib/facebook_ads/ad_objects/page_change_proposal.rb +0 -2
- data/lib/facebook_ads/ad_objects/partnership_ads_identity.rb +1 -0
- data/lib/facebook_ads/ad_objects/product_catalog.rb +4 -0
- data/lib/facebook_ads/ad_objects/product_item.rb +8 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +4 -3
- data/lib/facebook_ads/ad_objects/recommended_ig_media.rb +0 -1
- data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb +4 -0
- data/lib/facebook_ads/ad_objects/targeting_subscriber_universe.rb +26 -0
- data/lib/facebook_ads/ad_objects/third_party_partner_lift_request.rb +3 -0
- data/lib/facebook_ads/ad_objects/user.rb +9 -2
- data/lib/facebook_ads/ad_objects/vehicle.rb +9 -0
- data/lib/facebook_ads/ad_objects/vehicle_offer.rb +10 -0
- data/lib/facebook_ads/ad_objects/video_copyright_match.rb +1 -0
- data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +61 -9
- data/lib/facebook_ads/ad_objects/whats_app_business_partner_client_verification_submission.rb +2 -0
- data/lib/facebook_ads/version.rb +2 -2
- data/lib/facebook_ads.rb +2 -2
- metadata +14 -17
- data/lib/facebook_ads/ad_objects/marketing_message_targeting.rb +0 -29
- data/lib/facebook_ads/ad_objects/merchant_report.rb +0 -39
- data/lib/facebook_ads/ad_objects/product_catalog_user_permissions.rb +0 -34
- data/lib/facebook_ads/ad_objects/video_metrics_report.rb +0 -33
@@ -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'
|
@@ -387,7 +377,6 @@ module FacebookAds
|
|
387
377
|
field :start_offset, 'int'
|
388
378
|
field :swap_mode, { enum: -> { SWAP_MODE }}
|
389
379
|
field :text_format_metadata, 'string'
|
390
|
-
field :throwback_camera_roll_media, 'string'
|
391
380
|
field :thumb, 'file'
|
392
381
|
field :time_since_original_post, 'int'
|
393
382
|
field :transcode_setting_properties, 'string'
|
@@ -399,10 +388,16 @@ module FacebookAds
|
|
399
388
|
field :video_id_original, 'string'
|
400
389
|
field :video_start_time_ms, 'int'
|
401
390
|
field :waterfall_id, 'string'
|
391
|
+
field :video_id, 'string'
|
392
|
+
field :video_state, { enum: -> { VIDEO_STATE }}
|
402
393
|
field :ad_placements_validation_only, 'bool'
|
403
394
|
field :creative_folder_id, 'string'
|
404
395
|
field :validation_ad_placements, { list: { enum: -> { VALIDATION_AD_PLACEMENTS }} }
|
405
396
|
|
397
|
+
has_edge :boost_ads_list do |edge|
|
398
|
+
edge.get
|
399
|
+
end
|
400
|
+
|
406
401
|
has_edge :captions do |edge|
|
407
402
|
edge.get
|
408
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
|
16
|
+
class AdsEligibility < AdObject
|
17
17
|
|
18
|
-
field :
|
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",
|
@@ -102,6 +104,11 @@ module FacebookAds
|
|
102
104
|
"skan_campaign_id",
|
103
105
|
"skan_conversion_id",
|
104
106
|
"skan_version",
|
107
|
+
"sot_attribution_model_type",
|
108
|
+
"sot_attribution_window",
|
109
|
+
"sot_channel",
|
110
|
+
"sot_event_type",
|
111
|
+
"sot_source",
|
105
112
|
"standard_event_content_type",
|
106
113
|
"title_asset",
|
107
114
|
"user_persona_id",
|
@@ -188,6 +195,8 @@ module FacebookAds
|
|
188
195
|
field :catalog_segment_value_omni_purchase_roas, { list: 'AdsActionStats' }
|
189
196
|
field :catalog_segment_value_website_purchase_roas, { list: 'AdsActionStats' }
|
190
197
|
field :clicks, 'string'
|
198
|
+
field :conversion_lead_rate, { list: 'AdsActionStats' }
|
199
|
+
field :conversion_leads, { list: 'AdsActionStats' }
|
191
200
|
field :conversion_rate_ranking, 'string'
|
192
201
|
field :conversion_values, { list: 'AdsActionStats' }
|
193
202
|
field :conversions, { list: 'AdsActionStats' }
|
@@ -198,6 +207,7 @@ module FacebookAds
|
|
198
207
|
field :cost_per_action_type, { list: 'AdsActionStats' }
|
199
208
|
field :cost_per_ad_click, { list: 'AdsActionStats' }
|
200
209
|
field :cost_per_conversion, { list: 'AdsActionStats' }
|
210
|
+
field :cost_per_conversion_lead, { list: 'AdsActionStats' }
|
201
211
|
field :cost_per_dda_countby_convs, 'string'
|
202
212
|
field :cost_per_estimated_ad_recallers, 'string'
|
203
213
|
field :cost_per_inline_link_click, 'string'
|
@@ -241,9 +251,17 @@ module FacebookAds
|
|
241
251
|
field :instant_experience_outbound_clicks, { list: 'AdsActionStats' }
|
242
252
|
field :interactive_component_tap, { list: 'AdsActionStats' }
|
243
253
|
field :labels, 'string'
|
254
|
+
field :landing_page_view_actions_per_link_click, 'string'
|
255
|
+
field :landing_page_view_per_purchase_rate, 'string'
|
244
256
|
field :location, 'string'
|
245
257
|
field :marketing_messages_cost_per_delivered, 'string'
|
246
258
|
field :marketing_messages_cost_per_link_btn_click, 'string'
|
259
|
+
field :marketing_messages_delivery_rate, 'string'
|
260
|
+
field :marketing_messages_link_btn_click_rate, 'string'
|
261
|
+
field :marketing_messages_media_view_rate, 'string'
|
262
|
+
field :marketing_messages_phone_call_btn_click_rate, 'string'
|
263
|
+
field :marketing_messages_quick_reply_btn_click_rate, 'string'
|
264
|
+
field :marketing_messages_read_rate, 'string'
|
247
265
|
field :marketing_messages_spend, 'string'
|
248
266
|
field :marketing_messages_website_purchase_values, 'string'
|
249
267
|
field :mobile_app_purchase_roas, { list: 'AdsActionStats' }
|
@@ -254,9 +272,11 @@ module FacebookAds
|
|
254
272
|
field :outbound_clicks_ctr, { list: 'AdsActionStats' }
|
255
273
|
field :place_page_name, 'string'
|
256
274
|
field :purchase_roas, { list: 'AdsActionStats' }
|
275
|
+
field :purchases_per_link_click, 'string'
|
257
276
|
field :qualifying_question_qualify_answer_rate, 'string'
|
258
277
|
field :quality_ranking, 'string'
|
259
278
|
field :reach, 'string'
|
279
|
+
field :result_values_performance_indicator, 'string'
|
260
280
|
field :shops_assisted_purchases, 'string'
|
261
281
|
field :social_spend, 'string'
|
262
282
|
field :spend, 'string'
|
@@ -291,6 +311,7 @@ module FacebookAds
|
|
291
311
|
field :video_play_retention_graph_actions, { list: 'AdsHistogramStats' }
|
292
312
|
field :video_thruplay_watched_actions, { list: 'AdsActionStats' }
|
293
313
|
field :video_time_watched_actions, { list: 'AdsActionStats' }
|
314
|
+
field :video_view_per_impression, { list: 'AdsActionStats' }
|
294
315
|
field :website_ctr, { list: 'AdsActionStats' }
|
295
316
|
field :website_purchase_roas, { list: 'AdsActionStats' }
|
296
317
|
field :wish_bid, 'string'
|
data/lib/facebook_ads/ad_objects/{private_computation_environment.rb → ads_mcme_conversion.rb}
RENAMED
@@ -13,14 +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
|
16
|
+
class AdsMcmeConversion < AdObject
|
17
17
|
|
18
|
-
field :
|
19
|
-
field :
|
20
|
-
field :publisher_pce_id, 'string'
|
21
|
-
field :publisher_region, 'string'
|
22
|
-
field :publisher_vpc_id, 'string'
|
18
|
+
field :creation_time, 'datetime'
|
19
|
+
field :description, 'string'
|
23
20
|
field :id, 'string'
|
21
|
+
field :is_archived, 'bool'
|
22
|
+
field :mcme_conversion_type, 'string'
|
23
|
+
field :name, 'string'
|
24
|
+
field :omnichannel_object_id, 'string'
|
24
25
|
has_no_post
|
25
26
|
has_no_delete
|
26
27
|
|
@@ -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,8 @@ 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'
|
40
|
+
field :enhance_cta_text_extraction_opt_in_status, 'string'
|
37
41
|
field :export_format_default, 'string'
|
38
42
|
field :focus_mode_default, 'string'
|
39
43
|
field :gen_ai_alpha_test_status, 'int'
|
@@ -68,6 +72,8 @@ module FacebookAds
|
|
68
72
|
field :static_ad_product_extensions_opt_in, 'string'
|
69
73
|
field :sticky_setting_after_default_on, 'string'
|
70
74
|
field :syd_campaign_trends_metric, 'string'
|
75
|
+
field :text_optimizations_text_extraction_opt_in_status, 'string'
|
76
|
+
field :text_variations_sticky_opt_in_status, 'string'
|
71
77
|
field :total_coupon_syd_dismissals, 'int'
|
72
78
|
field :total_coupon_upsell_dismissals, 'int'
|
73
79
|
field :url_prefill_removal_timestamp, 'int'
|
@@ -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'
|
@@ -135,6 +135,7 @@ module FacebookAds
|
|
135
135
|
field :deauth_callback_url, 'string'
|
136
136
|
field :default_share_mode, 'string'
|
137
137
|
field :description, 'string'
|
138
|
+
field :enigma_config, 'object'
|
138
139
|
field :financial_id, 'string'
|
139
140
|
field :gdpv4_chrome_custom_tabs_enabled, 'bool'
|
140
141
|
field :gdpv4_enabled, 'bool'
|
@@ -226,6 +227,7 @@ module FacebookAds
|
|
226
227
|
api.has_param :app_user_id, 'string'
|
227
228
|
api.has_param :application_tracking_enabled, 'bool'
|
228
229
|
api.has_param :attribution, 'string'
|
230
|
+
api.has_param :attribution_sources, { list: 'hash' }
|
229
231
|
api.has_param :auto_publish, 'bool'
|
230
232
|
api.has_param :bundle_id, 'string'
|
231
233
|
api.has_param :bundle_short_version, 'string'
|
@@ -247,8 +249,10 @@ module FacebookAds
|
|
247
249
|
api.has_param :install_referrer, 'string'
|
248
250
|
api.has_param :install_timestamp, 'int'
|
249
251
|
api.has_param :installer_package, 'string'
|
252
|
+
api.has_param :is_fb, 'bool'
|
250
253
|
api.has_param :limited_data_use, 'bool'
|
251
254
|
api.has_param :migration_bundle, 'string'
|
255
|
+
api.has_param :operational_parameters, { list: 'hash' }
|
252
256
|
api.has_param :page_id, 'int'
|
253
257
|
api.has_param :page_scoped_user_id, 'int'
|
254
258
|
api.has_param :receipt_data, 'string'
|
@@ -281,6 +285,7 @@ module FacebookAds
|
|
281
285
|
api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
|
282
286
|
api.has_param :ordering_column, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_COLUMN }}
|
283
287
|
api.has_param :ordering_type, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_TYPE }}
|
288
|
+
api.has_param :should_include_until, 'bool'
|
284
289
|
api.has_param :since, 'datetime'
|
285
290
|
api.has_param :until, 'datetime'
|
286
291
|
end
|
@@ -471,18 +476,27 @@ module FacebookAds
|
|
471
476
|
edge.post do |api|
|
472
477
|
api.has_param :advertiser_id, 'string'
|
473
478
|
api.has_param :attribution, 'string'
|
479
|
+
api.has_param :attribution_method, 'string'
|
474
480
|
api.has_param :attribution_model, 'string'
|
481
|
+
api.has_param :attribution_referrer, 'string'
|
475
482
|
api.has_param :auditing_token, 'string'
|
476
483
|
api.has_param :click_attr_window, 'int'
|
477
484
|
api.has_param :custom_events, { list: 'object' }
|
478
485
|
api.has_param :decline_reason, 'string'
|
486
|
+
api.has_param :device_os, 'string'
|
479
487
|
api.has_param :engagement_type, 'string'
|
480
488
|
api.has_param :event, 'string'
|
489
|
+
api.has_param :event_id, 'string'
|
481
490
|
api.has_param :event_reported_time, 'int'
|
482
491
|
api.has_param :fb_ad_id, 'int'
|
492
|
+
api.has_param :fb_adgroup_id, 'int'
|
483
493
|
api.has_param :fb_click_time, 'int'
|
484
494
|
api.has_param :fb_view_time, 'int'
|
495
|
+
api.has_param :google_install_referrer, 'string'
|
496
|
+
api.has_param :inactivity_window_hours, 'int'
|
497
|
+
api.has_param :install_id, 'string'
|
485
498
|
api.has_param :is_fb, 'bool'
|
499
|
+
api.has_param :meta_install_referrer, 'string'
|
486
500
|
api.has_param :used_install_referrer, 'bool'
|
487
501
|
api.has_param :view_attr_window, 'int'
|
488
502
|
end
|
@@ -521,12 +535,6 @@ module FacebookAds
|
|
521
535
|
end
|
522
536
|
end
|
523
537
|
|
524
|
-
has_edge :payment_currencies do |edge|
|
525
|
-
edge.post 'Application' do |api|
|
526
|
-
api.has_param :currency_url, 'string'
|
527
|
-
end
|
528
|
-
end
|
529
|
-
|
530
538
|
has_edge :permissions do |edge|
|
531
539
|
edge.get do |api|
|
532
540
|
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'
|
@@ -14,6 +14,19 @@ module FacebookAds
|
|
14
14
|
# pull request for this class.
|
15
15
|
|
16
16
|
class Business < AdObject
|
17
|
+
VERIFICATION_STATUS = [
|
18
|
+
"expired",
|
19
|
+
"failed",
|
20
|
+
"ineligible",
|
21
|
+
"not_verified",
|
22
|
+
"pending",
|
23
|
+
"pending_need_more_info",
|
24
|
+
"pending_submission",
|
25
|
+
"rejected",
|
26
|
+
"revoked",
|
27
|
+
"verified",
|
28
|
+
]
|
29
|
+
|
17
30
|
TWO_FACTOR_TYPE = [
|
18
31
|
"admin_required",
|
19
32
|
"all_required",
|
@@ -593,6 +606,38 @@ module FacebookAds
|
|
593
606
|
"VIEW_MONETIZATION_INSIGHTS",
|
594
607
|
]
|
595
608
|
|
609
|
+
BUSINESS_VERTICAL = [
|
610
|
+
"ADULT_PRODUCTS_AND_SERVICES",
|
611
|
+
"ALCOHOL_AND_TOBACCO",
|
612
|
+
"AUTOMOTIVE_DEALERS",
|
613
|
+
"BODY_PARTS_FLUIDS",
|
614
|
+
"BUSINESS_AND_UTILITY",
|
615
|
+
"CONTENT_AND_APPS",
|
616
|
+
"CREATORS_AND_CELEBRITIES",
|
617
|
+
"DATING",
|
618
|
+
"DRUGS",
|
619
|
+
"ENDANGERED_SPECIES",
|
620
|
+
"FIREARMS",
|
621
|
+
"FRAUDULENT_MISLEADING_OFFENSIVE",
|
622
|
+
"GAMBLING",
|
623
|
+
"GROCERY_AND_CONVENIENCE_STORE",
|
624
|
+
"HAZARDOUS_GOODS_AND_MATERIALS",
|
625
|
+
"HOME",
|
626
|
+
"HOME_AND_AUTO_MANUFACTURING",
|
627
|
+
"LIFESTYLE",
|
628
|
+
"LIVE_NON_ENDANGERED_SPECIES",
|
629
|
+
"LOANS_DEBT_COLLECTION_BAIL_BONDS",
|
630
|
+
"LOCAL_EVENTS",
|
631
|
+
"MEDICAL_HEALTHCARE",
|
632
|
+
"MULTILEVEL_MARKETING",
|
633
|
+
"NON_PROFIT_AND_RELIGIOUS_ORGS",
|
634
|
+
"PROFESSIONAL",
|
635
|
+
"REAL_VIRTUAL_FAKE_CURRENCY",
|
636
|
+
"RESTAURANTS",
|
637
|
+
"RETAIL",
|
638
|
+
"TRANSPORTATION_AND_ACCOMMODATION",
|
639
|
+
]
|
640
|
+
|
596
641
|
SUBVERTICAL_V2 = [
|
597
642
|
"ACCOUNTING_AND_TAX",
|
598
643
|
"ACTIVITIES_AND_LEISURE",
|
@@ -818,7 +863,7 @@ module FacebookAds
|
|
818
863
|
field :updated_by, 'object'
|
819
864
|
field :updated_time, 'datetime'
|
820
865
|
field :user_access_expire_time, 'datetime'
|
821
|
-
field :verification_status,
|
866
|
+
field :verification_status, { enum: -> { VERIFICATION_STATUS }}
|
822
867
|
field :vertical, 'string'
|
823
868
|
field :vertical_id, 'int'
|
824
869
|
has_no_delete
|
@@ -909,6 +954,7 @@ module FacebookAds
|
|
909
954
|
api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
|
910
955
|
api.has_param :ordering_column, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_COLUMN }}
|
911
956
|
api.has_param :ordering_type, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_TYPE }}
|
957
|
+
api.has_param :should_include_until, 'bool'
|
912
958
|
api.has_param :since, 'datetime'
|
913
959
|
api.has_param :until, 'datetime'
|
914
960
|
end
|
@@ -1239,12 +1285,17 @@ module FacebookAds
|
|
1239
1285
|
edge.get 'OpenBridgeConfiguration'
|
1240
1286
|
edge.post 'OpenBridgeConfiguration' do |api|
|
1241
1287
|
api.has_param :active, 'bool'
|
1288
|
+
api.has_param :cloud_provider, 'string'
|
1289
|
+
api.has_param :cloud_region, 'string'
|
1290
|
+
api.has_param :destination_id, 'string'
|
1242
1291
|
api.has_param :endpoint, 'string'
|
1243
1292
|
api.has_param :fallback_domain, 'string'
|
1244
|
-
api.has_param :
|
1293
|
+
api.has_param :first_party_domain, 'string'
|
1245
1294
|
api.has_param :host_business_id, 'int'
|
1246
|
-
api.has_param :host_external_id, 'string'
|
1247
1295
|
api.has_param :instance_id, 'string'
|
1296
|
+
api.has_param :instance_version, 'string'
|
1297
|
+
api.has_param :is_sgw_instance, 'bool'
|
1298
|
+
api.has_param :partner_name, 'string'
|
1248
1299
|
api.has_param :pixel_id, 'int'
|
1249
1300
|
end
|
1250
1301
|
end
|
@@ -1418,6 +1469,20 @@ module FacebookAds
|
|
1418
1469
|
end
|
1419
1470
|
end
|
1420
1471
|
|
1472
|
+
has_edge :self_certify_whatsapp_business do |edge|
|
1473
|
+
edge.post 'Business' do |api|
|
1474
|
+
api.has_param :average_monthly_revenue_spend_with_partner, 'hash'
|
1475
|
+
api.has_param :business_documents, { list: 'file' }
|
1476
|
+
api.has_param :business_vertical, { enum: -> { Business::BUSINESS_VERTICAL }}
|
1477
|
+
api.has_param :end_business_address, 'hash'
|
1478
|
+
api.has_param :end_business_id, 'string'
|
1479
|
+
api.has_param :end_business_legal_name, 'string'
|
1480
|
+
api.has_param :end_business_trade_names, { list: 'string' }
|
1481
|
+
api.has_param :end_business_website, 'string'
|
1482
|
+
api.has_param :num_billing_cycles_with_partner, 'int'
|
1483
|
+
end
|
1484
|
+
end
|
1485
|
+
|
1421
1486
|
has_edge :setup_managed_partner_adaccounts do |edge|
|
1422
1487
|
edge.post 'Business' do |api|
|
1423
1488
|
api.has_param :credit_line_id, 'string'
|
@@ -1518,7 +1583,6 @@ module FacebookAds
|
|
1518
1583
|
api.has_param :start_offset, 'int'
|
1519
1584
|
api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
|
1520
1585
|
api.has_param :text_format_metadata, 'string'
|
1521
|
-
api.has_param :throwback_camera_roll_media, 'string'
|
1522
1586
|
api.has_param :thumb, 'file'
|
1523
1587
|
api.has_param :time_since_original_post, 'int'
|
1524
1588
|
api.has_param :title, 'string'
|
@@ -13,10 +13,10 @@ 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
|
16
|
+
class CatalogAdvertiserInsight < AdObject
|
17
17
|
|
18
|
-
field :
|
19
|
-
field :
|
18
|
+
field :category, 'string'
|
19
|
+
field :country, 'string'
|
20
20
|
has_no_id
|
21
21
|
has_no_get
|
22
22
|
has_no_post
|
@@ -13,11 +13,11 @@ 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
|
16
|
+
class CatalogContentVersionConfig < AdObject
|
17
17
|
|
18
18
|
field :id, 'string'
|
19
19
|
field :name, 'string'
|
20
|
-
field :
|
20
|
+
field :version, 'string'
|
21
21
|
has_no_post
|
22
22
|
has_no_delete
|
23
23
|
|
@@ -156,15 +156,5 @@ module FacebookAds
|
|
156
156
|
end
|
157
157
|
end
|
158
158
|
|
159
|
-
has_edge :updates do |edge|
|
160
|
-
edge.post 'CommerceOrder' do |api|
|
161
|
-
api.has_param :cancel_amount, 'hash'
|
162
|
-
api.has_param :fulfill_amount, 'hash'
|
163
|
-
api.has_param :merchant_order_reference, 'string'
|
164
|
-
api.has_param :refund_amount, 'hash'
|
165
|
-
api.has_param :total_amount, 'hash'
|
166
|
-
end
|
167
|
-
end
|
168
|
-
|
169
159
|
end
|
170
160
|
end
|
@@ -71,7 +71,6 @@ module FacebookAds
|
|
71
71
|
"PRIMARY",
|
72
72
|
"REGULATED_CATEGORIES_AUDIENCE",
|
73
73
|
"STUDY_RULE_AUDIENCE",
|
74
|
-
"SUBSCRIBER_SEGMENT",
|
75
74
|
"VIDEO",
|
76
75
|
"WEBSITE",
|
77
76
|
]
|
@@ -102,6 +101,7 @@ module FacebookAds
|
|
102
101
|
field :household_audience, 'int'
|
103
102
|
field :id, 'string'
|
104
103
|
field :included_custom_audiences, { list: 'CustomAudience' }
|
104
|
+
field :is_eligible_for_sac_campaigns, 'bool'
|
105
105
|
field :is_household, 'bool'
|
106
106
|
field :is_snapshot, 'bool'
|
107
107
|
field :is_value_based, 'bool'
|
@@ -33,6 +33,16 @@ module FacebookAds
|
|
33
33
|
field :applinks, 'CatalogItemAppLinks'
|
34
34
|
field :category_specific_fields, 'CatalogSubVerticalList'
|
35
35
|
field :currency, 'string'
|
36
|
+
field :custom_label_0, 'string'
|
37
|
+
field :custom_label_1, 'string'
|
38
|
+
field :custom_label_2, 'string'
|
39
|
+
field :custom_label_3, 'string'
|
40
|
+
field :custom_label_4, 'string'
|
41
|
+
field :custom_number_0, 'int'
|
42
|
+
field :custom_number_1, 'int'
|
43
|
+
field :custom_number_2, 'int'
|
44
|
+
field :custom_number_3, 'int'
|
45
|
+
field :custom_number_4, 'int'
|
36
46
|
field :description, 'string'
|
37
47
|
field :destination_id, 'string'
|
38
48
|
field :id, 'string'
|