facebookbusiness 20.0.4 → 21.0.2
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.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account.rb +26 -7
- data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +4 -0
- data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +25 -0
- data/lib/facebook_ads/ad_objects/{external_event_source_da_stats_result.rb → ad_account_live_video_advertiser.rb} +4 -7
- data/lib/facebook_ads/ad_objects/ad_account_recommendations.rb +5 -0
- data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_activity.rb +3 -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 +3 -0
- data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads_partners.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_feature_customizations.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_features_spec.rb +11 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb +2 -1
- data/lib/facebook_ads/ad_objects/{analytics_cohort_query_result.rb → ad_creative_product_data.rb} +3 -5
- 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_preview.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_report_run.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_rule.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_rule_history.rb +4 -0
- data/lib/facebook_ads/ad_objects/ad_set.rb +5 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +1 -4
- data/lib/facebook_ads/ad_objects/ads_insights.rb +14 -4
- data/lib/facebook_ads/ad_objects/{panel_api_report.rb → ads_quick_views.rb} +7 -9
- data/lib/facebook_ads/ad_objects/ads_user_settings.rb +5 -0
- data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +2 -1
- data/lib/facebook_ads/ad_objects/alm_ad_account_info.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 +9 -23
- data/lib/facebook_ads/ad_objects/business.rb +69 -5
- data/lib/facebook_ads/ad_objects/campaign.rb +2 -0
- data/lib/facebook_ads/ad_objects/catalog_advertiser_insight.rb +26 -0
- data/lib/facebook_ads/ad_objects/catalog_item_rejection_reasons.rb +1 -10
- 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/ctwa_whats_app_numbers_info.rb +1 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +15 -0
- data/lib/facebook_ads/ad_objects/custom_audience_salts.rb +2 -0
- data/lib/facebook_ads/ad_objects/destination.rb +6 -0
- data/lib/facebook_ads/ad_objects/event.rb +1 -0
- data/lib/facebook_ads/ad_objects/extended_credit.rb +14 -1
- data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +1 -0
- data/lib/facebook_ads/ad_objects/group.rb +3 -23
- data/lib/facebook_ads/ad_objects/hotel.rb +5 -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 +8 -0
- data/lib/facebook_ads/ad_objects/ig_user.rb +10 -0
- data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +6 -0
- data/lib/facebook_ads/ad_objects/ig_user_subscribed_apps_data.rb +26 -0
- data/lib/facebook_ads/ad_objects/insights_result.rb +43 -19
- data/lib/facebook_ads/ad_objects/instagram_carousel.rb +1 -0
- data/lib/facebook_ads/ad_objects/instagram_comment.rb +1 -0
- data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +0 -5
- data/lib/facebook_ads/ad_objects/instagram_media.rb +1 -0
- data/lib/facebook_ads/ad_objects/instagram_user.rb +1 -0
- data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +2 -0
- data/lib/facebook_ads/ad_objects/{dog_notification_settings.rb → live_video_ad_campaign_config.rb} +2 -3
- data/lib/facebook_ads/ad_objects/messenger_business_template.rb +45 -0
- data/lib/facebook_ads/ad_objects/messenger_call_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +7 -0
- data/lib/facebook_ads/ad_objects/page.rb +38 -60
- data/lib/facebook_ads/ad_objects/partnership_ad_content_search_media.rb +3 -0
- data/lib/facebook_ads/ad_objects/partnership_ads_identity.rb +1 -0
- data/lib/facebook_ads/ad_objects/placement.rb +52 -0
- data/lib/facebook_ads/ad_objects/product_catalog.rb +6 -0
- data/lib/facebook_ads/ad_objects/product_catalog_diagnostic_group.rb +18 -18
- data/lib/facebook_ads/ad_objects/product_feed.rb +1 -0
- data/lib/facebook_ads/ad_objects/product_item.rb +17 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +1 -0
- data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb +2 -0
- data/lib/facebook_ads/ad_objects/saved_message_response.rb +0 -1
- data/lib/facebook_ads/ad_objects/user.rb +7 -11
- data/lib/facebook_ads/ad_objects/vehicle.rb +5 -0
- data/lib/facebook_ads/ad_objects/vehicle_offer.rb +5 -0
- data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +36 -2
- data/lib/facebook_ads/ad_objects/whats_app_business_partner_client_verification_submission.rb +1 -0
- data/lib/facebook_ads/version.rb +2 -2
- metadata +10 -6
@@ -360,11 +360,10 @@ module FacebookAds
|
|
360
360
|
field :formatting, { enum: -> { FORMATTING }}
|
361
361
|
field :fov, 'int'
|
362
362
|
field :front_z_rotation, 'double'
|
363
|
-
field :fun_fact_prompt_id, '
|
363
|
+
field :fun_fact_prompt_id, 'string'
|
364
364
|
field :fun_fact_toastee_id, 'int'
|
365
365
|
field :guide, { list: { list: 'int' } }
|
366
366
|
field :guide_enabled, 'bool'
|
367
|
-
field :holiday_card, 'string'
|
368
367
|
field :initial_heading, 'int'
|
369
368
|
field :initial_pitch, 'int'
|
370
369
|
field :instant_game_entry_point_data, 'string'
|
@@ -373,7 +372,6 @@ module FacebookAds
|
|
373
372
|
field :is_voice_clip, 'bool'
|
374
373
|
field :location_source_id, 'string'
|
375
374
|
field :name, 'string'
|
376
|
-
field :offer_like_post_id, 'int'
|
377
375
|
field :og_action_type_id, 'string'
|
378
376
|
field :og_icon_id, 'string'
|
379
377
|
field :og_object_id, 'string'
|
@@ -389,7 +387,6 @@ module FacebookAds
|
|
389
387
|
field :start_offset, 'int'
|
390
388
|
field :swap_mode, { enum: -> { SWAP_MODE }}
|
391
389
|
field :text_format_metadata, 'string'
|
392
|
-
field :throwback_camera_roll_media, 'string'
|
393
390
|
field :thumb, 'file'
|
394
391
|
field :time_since_original_post, 'int'
|
395
392
|
field :transcode_setting_properties, 'string'
|
@@ -61,6 +61,7 @@ module FacebookAds
|
|
61
61
|
"age",
|
62
62
|
"app_id",
|
63
63
|
"body_asset",
|
64
|
+
"breakdown_reporting_ad_id",
|
64
65
|
"call_to_action_asset",
|
65
66
|
"coarse_conversion_value",
|
66
67
|
"conversion_destination",
|
@@ -88,6 +89,7 @@ module FacebookAds
|
|
88
89
|
"media_format",
|
89
90
|
"media_origin_url",
|
90
91
|
"media_text_content",
|
92
|
+
"media_type",
|
91
93
|
"mmm",
|
92
94
|
"place_page_id",
|
93
95
|
"platform_position",
|
@@ -100,6 +102,11 @@ module FacebookAds
|
|
100
102
|
"skan_campaign_id",
|
101
103
|
"skan_conversion_id",
|
102
104
|
"skan_version",
|
105
|
+
"sot_attribution_model_type",
|
106
|
+
"sot_attribution_window",
|
107
|
+
"sot_channel",
|
108
|
+
"sot_event_type",
|
109
|
+
"sot_source",
|
103
110
|
"standard_event_content_type",
|
104
111
|
"title_asset",
|
105
112
|
"user_persona_id",
|
@@ -174,6 +181,7 @@ module FacebookAds
|
|
174
181
|
field :auction_bid, 'string'
|
175
182
|
field :auction_competitiveness, 'string'
|
176
183
|
field :auction_max_competitor_bid, 'string'
|
184
|
+
field :average_purchases_conversion_value, { list: 'AdsActionStats' }
|
177
185
|
field :buying_type, 'string'
|
178
186
|
field :campaign_id, 'string'
|
179
187
|
field :campaign_name, 'string'
|
@@ -238,12 +246,15 @@ module FacebookAds
|
|
238
246
|
field :instant_experience_outbound_clicks, { list: 'AdsActionStats' }
|
239
247
|
field :interactive_component_tap, { list: 'AdsActionStats' }
|
240
248
|
field :labels, 'string'
|
241
|
-
field :landing_page_view_actions_per_link_click, { list: 'AdsActionStats' }
|
242
|
-
field :landing_page_view_per_purchase_rate, { list: 'AdsActionStats' }
|
243
|
-
field :link_clicks_per_results, { list: 'AdsActionStats' }
|
244
249
|
field :location, 'string'
|
245
250
|
field :marketing_messages_cost_per_delivered, 'string'
|
246
251
|
field :marketing_messages_cost_per_link_btn_click, 'string'
|
252
|
+
field :marketing_messages_delivery_rate, 'string'
|
253
|
+
field :marketing_messages_link_btn_click_rate, 'string'
|
254
|
+
field :marketing_messages_media_view_rate, 'string'
|
255
|
+
field :marketing_messages_phone_call_btn_click_rate, 'string'
|
256
|
+
field :marketing_messages_quick_reply_btn_click_rate, 'string'
|
257
|
+
field :marketing_messages_read_rate, 'string'
|
247
258
|
field :marketing_messages_spend, 'string'
|
248
259
|
field :marketing_messages_website_purchase_values, 'string'
|
249
260
|
field :mobile_app_purchase_roas, { list: 'AdsActionStats' }
|
@@ -254,7 +265,6 @@ module FacebookAds
|
|
254
265
|
field :outbound_clicks_ctr, { list: 'AdsActionStats' }
|
255
266
|
field :place_page_name, 'string'
|
256
267
|
field :purchase_roas, { list: 'AdsActionStats' }
|
257
|
-
field :purchases_per_link_click, { list: 'AdsActionStats' }
|
258
268
|
field :qualifying_question_qualify_answer_rate, 'string'
|
259
269
|
field :quality_ranking, 'string'
|
260
270
|
field :reach, 'string'
|
@@ -13,18 +13,16 @@ 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 AdsQuickViews < AdObject
|
17
17
|
|
18
|
-
field :
|
19
|
-
field :
|
20
|
-
field :
|
21
|
-
field :
|
18
|
+
field :attribution_windows, { list: 'string' }
|
19
|
+
field :breakdowns, { list: 'string' }
|
20
|
+
field :column_fields, { list: 'string' }
|
21
|
+
field :description, 'string'
|
22
22
|
field :id, 'string'
|
23
|
-
field :index, 'int'
|
24
23
|
field :name, 'string'
|
25
|
-
field :
|
26
|
-
field :
|
27
|
-
field :upload_date, 'datetime'
|
24
|
+
field :permission, 'string'
|
25
|
+
field :sort, { list: 'object' }
|
28
26
|
has_no_post
|
29
27
|
has_no_delete
|
30
28
|
|
@@ -16,6 +16,7 @@ module FacebookAds
|
|
16
16
|
class AdsUserSettings < AdObject
|
17
17
|
|
18
18
|
field :a_plus_c_survey_seen, 'bool'
|
19
|
+
field :add_overlays_opt_in_status, 'string'
|
19
20
|
field :adgroup_name_template, 'object'
|
20
21
|
field :ads_cs_catalog_opt_out_timestamp, { list: 'hash' }
|
21
22
|
field :ads_tool_visits, { list: 'object' }
|
@@ -33,10 +34,12 @@ module FacebookAds
|
|
33
34
|
field :carousel_to_video_opt_in_status, 'string'
|
34
35
|
field :connected_sources_catalog_opt_in_status, 'string'
|
35
36
|
field :default_creation_mode, 'string'
|
37
|
+
field :enhance_cta_text_extraction_opt_in_status, 'string'
|
36
38
|
field :export_format_default, 'string'
|
37
39
|
field :focus_mode_default, 'string'
|
38
40
|
field :gen_ai_alpha_test_status, 'int'
|
39
41
|
field :id, 'string'
|
42
|
+
field :image_background_generation_opt_in_status, 'string'
|
40
43
|
field :image_expansion_opt_in_status, 'string'
|
41
44
|
field :is_ads_ai_consented, 'bool'
|
42
45
|
field :is_cbo_default_on, 'bool'
|
@@ -66,6 +69,8 @@ module FacebookAds
|
|
66
69
|
field :static_ad_product_extensions_opt_in, 'string'
|
67
70
|
field :sticky_setting_after_default_on, 'string'
|
68
71
|
field :syd_campaign_trends_metric, 'string'
|
72
|
+
field :text_optimizations_text_extraction_opt_in_status, 'string'
|
73
|
+
field :text_variations_sticky_opt_in_status, 'string'
|
69
74
|
field :total_coupon_syd_dismissals, 'int'
|
70
75
|
field :total_coupon_upsell_dismissals, 'int'
|
71
76
|
field :url_prefill_removal_timestamp, 'int'
|
@@ -16,11 +16,12 @@ module FacebookAds
|
|
16
16
|
class AdsValueAdjustmentRuleCollection < AdObject
|
17
17
|
|
18
18
|
field :id, 'string'
|
19
|
+
field :is_default_setting, 'bool'
|
19
20
|
field :name, 'string'
|
20
21
|
has_no_post
|
21
22
|
has_no_delete
|
22
23
|
|
23
|
-
has_edge :
|
24
|
+
has_edge :rules do |edge|
|
24
25
|
edge.get
|
25
26
|
end
|
26
27
|
|
@@ -65,17 +65,6 @@ module FacebookAds
|
|
65
65
|
"EYMT",
|
66
66
|
]
|
67
67
|
|
68
|
-
LOGGING_SOURCE = [
|
69
|
-
"DETECTION",
|
70
|
-
"MESSENGER_BOT",
|
71
|
-
]
|
72
|
-
|
73
|
-
LOGGING_TARGET = [
|
74
|
-
"APP",
|
75
|
-
"APP_AND_PAGE",
|
76
|
-
"PAGE",
|
77
|
-
]
|
78
|
-
|
79
68
|
OWNER_PERMISSIONS = [
|
80
69
|
"DEVELOP",
|
81
70
|
"MANAGE",
|
@@ -146,6 +135,7 @@ module FacebookAds
|
|
146
135
|
field :deauth_callback_url, 'string'
|
147
136
|
field :default_share_mode, 'string'
|
148
137
|
field :description, 'string'
|
138
|
+
field :enigma_config, 'object'
|
149
139
|
field :financial_id, 'string'
|
150
140
|
field :gdpv4_chrome_custom_tabs_enabled, 'bool'
|
151
141
|
field :gdpv4_enabled, 'bool'
|
@@ -251,6 +241,7 @@ module FacebookAds
|
|
251
241
|
api.has_param :data_processing_options_state, 'int'
|
252
242
|
api.has_param :device_token, 'string'
|
253
243
|
api.has_param :event, { enum: %w{CUSTOM_APP_EVENTS DEFERRED_APP_LINK MOBILE_APP_INSTALL }}
|
244
|
+
api.has_param :event_id, 'string'
|
254
245
|
api.has_param :extinfo, 'object'
|
255
246
|
api.has_param :include_dwell_data, 'bool'
|
256
247
|
api.has_param :include_video_data, 'bool'
|
@@ -291,6 +282,7 @@ module FacebookAds
|
|
291
282
|
api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
|
292
283
|
api.has_param :ordering_column, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_COLUMN }}
|
293
284
|
api.has_param :ordering_type, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_TYPE }}
|
285
|
+
api.has_param :should_include_until, 'bool'
|
294
286
|
api.has_param :since, 'datetime'
|
295
287
|
api.has_param :until, 'datetime'
|
296
288
|
end
|
@@ -471,6 +463,12 @@ module FacebookAds
|
|
471
463
|
edge.get 'AdsDataset'
|
472
464
|
end
|
473
465
|
|
466
|
+
has_edge :message_templates do |edge|
|
467
|
+
edge.get do |api|
|
468
|
+
api.has_param :template_id, 'string'
|
469
|
+
end
|
470
|
+
end
|
471
|
+
|
474
472
|
has_edge :mmp_auditing do |edge|
|
475
473
|
edge.post do |api|
|
476
474
|
api.has_param :advertiser_id, 'string'
|
@@ -525,18 +523,6 @@ module FacebookAds
|
|
525
523
|
end
|
526
524
|
end
|
527
525
|
|
528
|
-
has_edge :page_activities do |edge|
|
529
|
-
edge.post 'Application' do |api|
|
530
|
-
api.has_param :advertiser_tracking_enabled, 'bool'
|
531
|
-
api.has_param :application_tracking_enabled, 'bool'
|
532
|
-
api.has_param :custom_events, { list: 'object' }
|
533
|
-
api.has_param :logging_source, { enum: -> { Application::LOGGING_SOURCE }}
|
534
|
-
api.has_param :logging_target, { enum: -> { Application::LOGGING_TARGET }}
|
535
|
-
api.has_param :page_id, 'int'
|
536
|
-
api.has_param :page_scoped_user_id, 'int'
|
537
|
-
end
|
538
|
-
end
|
539
|
-
|
540
526
|
has_edge :payment_currencies do |edge|
|
541
527
|
edge.post 'Application' do |api|
|
542
528
|
api.has_param :currency_url, '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,19 @@ 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
1293
|
api.has_param :fallback_domain_enabled, 'bool'
|
1294
|
+
api.has_param :first_party_domain, 'string'
|
1245
1295
|
api.has_param :host_business_id, 'int'
|
1246
1296
|
api.has_param :host_external_id, 'string'
|
1247
1297
|
api.has_param :instance_id, 'string'
|
1298
|
+
api.has_param :instance_version, 'string'
|
1299
|
+
api.has_param :is_sgw_instance, 'bool'
|
1300
|
+
api.has_param :partner_name, 'string'
|
1248
1301
|
api.has_param :pixel_id, 'int'
|
1249
1302
|
end
|
1250
1303
|
end
|
@@ -1418,6 +1471,20 @@ module FacebookAds
|
|
1418
1471
|
end
|
1419
1472
|
end
|
1420
1473
|
|
1474
|
+
has_edge :self_certify_whatsapp_business do |edge|
|
1475
|
+
edge.post 'Business' do |api|
|
1476
|
+
api.has_param :average_monthly_revenue_spend_with_partner, 'hash'
|
1477
|
+
api.has_param :business_documents, { list: 'file' }
|
1478
|
+
api.has_param :business_vertical, { enum: -> { Business::BUSINESS_VERTICAL }}
|
1479
|
+
api.has_param :end_business_address, 'hash'
|
1480
|
+
api.has_param :end_business_id, 'string'
|
1481
|
+
api.has_param :end_business_legal_name, 'string'
|
1482
|
+
api.has_param :end_business_trade_names, { list: 'string' }
|
1483
|
+
api.has_param :end_business_website, 'string'
|
1484
|
+
api.has_param :num_billing_cycles_with_partner, 'int'
|
1485
|
+
end
|
1486
|
+
end
|
1487
|
+
|
1421
1488
|
has_edge :setup_managed_partner_adaccounts do |edge|
|
1422
1489
|
edge.post 'Business' do |api|
|
1423
1490
|
api.has_param :credit_line_id, 'string'
|
@@ -1490,11 +1557,10 @@ module FacebookAds
|
|
1490
1557
|
api.has_param :formatting, { enum: -> { AdVideo::FORMATTING }}
|
1491
1558
|
api.has_param :fov, 'int'
|
1492
1559
|
api.has_param :front_z_rotation, 'double'
|
1493
|
-
api.has_param :fun_fact_prompt_id, '
|
1560
|
+
api.has_param :fun_fact_prompt_id, 'string'
|
1494
1561
|
api.has_param :fun_fact_toastee_id, 'int'
|
1495
1562
|
api.has_param :guide, { list: { list: 'int' } }
|
1496
1563
|
api.has_param :guide_enabled, 'bool'
|
1497
|
-
api.has_param :holiday_card, 'string'
|
1498
1564
|
api.has_param :initial_heading, 'int'
|
1499
1565
|
api.has_param :initial_pitch, 'int'
|
1500
1566
|
api.has_param :instant_game_entry_point_data, 'string'
|
@@ -1502,7 +1568,6 @@ module FacebookAds
|
|
1502
1568
|
api.has_param :is_group_linking_post, 'bool'
|
1503
1569
|
api.has_param :is_voice_clip, 'bool'
|
1504
1570
|
api.has_param :location_source_id, 'string'
|
1505
|
-
api.has_param :offer_like_post_id, 'int'
|
1506
1571
|
api.has_param :og_action_type_id, 'string'
|
1507
1572
|
api.has_param :og_icon_id, 'string'
|
1508
1573
|
api.has_param :og_object_id, 'string'
|
@@ -1520,7 +1585,6 @@ module FacebookAds
|
|
1520
1585
|
api.has_param :start_offset, 'int'
|
1521
1586
|
api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
|
1522
1587
|
api.has_param :text_format_metadata, 'string'
|
1523
|
-
api.has_param :throwback_camera_roll_media, 'string'
|
1524
1588
|
api.has_param :thumb, 'file'
|
1525
1589
|
api.has_param :time_since_original_post, 'int'
|
1526
1590
|
api.has_param :title, 'string'
|
@@ -104,6 +104,7 @@ module FacebookAds
|
|
104
104
|
SPECIAL_AD_CATEGORIES = [
|
105
105
|
"CREDIT",
|
106
106
|
"EMPLOYMENT",
|
107
|
+
"FINANCIAL_PRODUCTS_SERVICES",
|
107
108
|
"HOUSING",
|
108
109
|
"ISSUES_ELECTIONS_POLITICS",
|
109
110
|
"NONE",
|
@@ -372,6 +373,7 @@ module FacebookAds
|
|
372
373
|
SPECIAL_AD_CATEGORY = [
|
373
374
|
"CREDIT",
|
374
375
|
"EMPLOYMENT",
|
376
|
+
"FINANCIAL_PRODUCTS_SERVICES",
|
375
377
|
"HOUSING",
|
376
378
|
"ISSUES_ELECTIONS_POLITICS",
|
377
379
|
"NONE",
|
@@ -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 CatalogAdvertiserInsight < AdObject
|
17
|
+
|
18
|
+
field :category, 'string'
|
19
|
+
field :country, 'string'
|
20
|
+
has_no_id
|
21
|
+
has_no_get
|
22
|
+
has_no_post
|
23
|
+
has_no_delete
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -14,17 +14,8 @@ module FacebookAds
|
|
14
14
|
# pull request for this class.
|
15
15
|
|
16
16
|
class CatalogItemRejectionReasons < AdObject
|
17
|
-
CAPABILITY = [
|
18
|
-
"business_inbox_in_messenger",
|
19
|
-
"shops",
|
20
|
-
"test_capability",
|
21
|
-
"universal_checkout",
|
22
|
-
"us_marketplace",
|
23
|
-
"whatsapp_marketing_message",
|
24
|
-
]
|
25
17
|
|
26
|
-
|
27
|
-
field :capability, { enum: -> { CAPABILITY }}
|
18
|
+
field :capability, 'string'
|
28
19
|
field :rejection_information, { list: 'object' }
|
29
20
|
has_no_id
|
30
21
|
has_no_get
|
@@ -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
|
@@ -18,6 +18,7 @@ module FacebookAds
|
|
18
18
|
field :can_manage_wa_flows, 'bool'
|
19
19
|
field :formatted_whatsapp_number, 'string'
|
20
20
|
field :is_business_number, 'bool'
|
21
|
+
field :number_country_prefix, 'string'
|
21
22
|
field :page_whatsapp_number_id, 'string'
|
22
23
|
field :waba_id, 'string'
|
23
24
|
field :whatsapp_number, 'string'
|
@@ -48,6 +48,11 @@ module FacebookAds
|
|
48
48
|
"USER_PROVIDED_ONLY",
|
49
49
|
]
|
50
50
|
|
51
|
+
SUBSCRIPTION_INFO = [
|
52
|
+
"MESSENGER",
|
53
|
+
"WHATSAPP",
|
54
|
+
]
|
55
|
+
|
51
56
|
SUBTYPE = [
|
52
57
|
"APP",
|
53
58
|
"BAG_OF_ACCOUNTS",
|
@@ -60,6 +65,7 @@ module FacebookAds
|
|
60
65
|
"LOOKALIKE",
|
61
66
|
"MANAGED",
|
62
67
|
"MEASUREMENT",
|
68
|
+
"MESSENGER_SUBSCRIBER_LIST",
|
63
69
|
"OFFLINE_CONVERSION",
|
64
70
|
"PARTNER",
|
65
71
|
"PRIMARY",
|
@@ -70,6 +76,11 @@ module FacebookAds
|
|
70
76
|
"WEBSITE",
|
71
77
|
]
|
72
78
|
|
79
|
+
USE_FOR_PRODUCTS = [
|
80
|
+
"ADS",
|
81
|
+
"MARKETING_MESSAGES",
|
82
|
+
]
|
83
|
+
|
73
84
|
ACTION_SOURCE = [
|
74
85
|
"PHYSICAL_STORE",
|
75
86
|
"WEBSITE",
|
@@ -126,13 +137,17 @@ module FacebookAds
|
|
126
137
|
field :event_source_group, 'string'
|
127
138
|
field :event_sources, { list: 'hash' }
|
128
139
|
field :exclusions, { list: 'object' }
|
140
|
+
field :facebook_page_id, 'string'
|
129
141
|
field :inclusions, { list: 'object' }
|
130
142
|
field :list_of_accounts, { list: 'int' }
|
143
|
+
field :marketing_message_channels, 'object'
|
131
144
|
field :origin_audience_id, 'string'
|
132
145
|
field :parent_audience_id, 'int'
|
133
146
|
field :partner_reference_key, 'string'
|
134
147
|
field :prefill, 'bool'
|
135
148
|
field :product_set_id, 'string'
|
149
|
+
field :subscription_info, { list: { enum: -> { SUBSCRIPTION_INFO }} }
|
150
|
+
field :use_for_products, { list: { enum: -> { USE_FOR_PRODUCTS }} }
|
136
151
|
field :use_in_campaigns, 'bool'
|
137
152
|
field :video_group_ids, { list: 'string' }
|
138
153
|
field :whats_app_business_phone_number_id, 'string'
|
@@ -33,6 +33,12 @@ 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_number_0, 'int'
|
40
|
+
field :custom_number_1, 'int'
|
41
|
+
field :custom_number_2, 'int'
|
36
42
|
field :description, 'string'
|
37
43
|
field :destination_id, 'string'
|
38
44
|
field :id, 'string'
|
@@ -58,8 +58,21 @@ module FacebookAds
|
|
58
58
|
end
|
59
59
|
end
|
60
60
|
|
61
|
-
has_edge :
|
61
|
+
has_edge :whatsapp_credit_attach do |edge|
|
62
|
+
edge.post do |api|
|
63
|
+
api.has_param :waba_currency, 'string'
|
64
|
+
api.has_param :waba_id, 'string'
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
has_edge :whatsapp_credit_sharing do |edge|
|
62
69
|
edge.post do |api|
|
70
|
+
api.has_param :receiving_business_id, 'string'
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
has_edge :whatsapp_credit_sharing_and_attach do |edge|
|
75
|
+
edge.post 'ExtendedCreditAllocationConfig' do |api|
|
63
76
|
api.has_param :waba_currency, 'string'
|
64
77
|
api.has_param :waba_id, 'string'
|
65
78
|
end
|