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
@@ -80,6 +80,17 @@ module FacebookAds
|
|
80
80
|
"Vietnamese",
|
81
81
|
]
|
82
82
|
|
83
|
+
GEN_AI_PROVENANCE_TYPE = [
|
84
|
+
"C2PA",
|
85
|
+
"C2PA_METADATA_EDITED",
|
86
|
+
"EXPLICIT",
|
87
|
+
"EXPLICIT_IMAGINE",
|
88
|
+
"EXPLICIT_IMAGINE_ME",
|
89
|
+
"INVISIBLE_WATERMARK",
|
90
|
+
"IPTC",
|
91
|
+
"IPTC_METADATA_EDITED",
|
92
|
+
]
|
93
|
+
|
83
94
|
PICKUP_OPTIONS = [
|
84
95
|
"CURBSIDE",
|
85
96
|
"IN_STORE",
|
@@ -149,41 +160,6 @@ module FacebookAds
|
|
149
160
|
"VIEW_MONETIZATION_INSIGHTS",
|
150
161
|
]
|
151
162
|
|
152
|
-
ALIGNMENT = [
|
153
|
-
"LEFT",
|
154
|
-
"RIGHT",
|
155
|
-
]
|
156
|
-
|
157
|
-
ENTRY_POINT_ICON = [
|
158
|
-
"CHAT_ANGULAR_ICON",
|
159
|
-
"CHAT_ROUND_ICON",
|
160
|
-
"MESSENGER_ICON",
|
161
|
-
"NONE",
|
162
|
-
]
|
163
|
-
|
164
|
-
ENTRY_POINT_LABEL = [
|
165
|
-
"ASK_US",
|
166
|
-
"CHAT",
|
167
|
-
"HELP",
|
168
|
-
"NONE",
|
169
|
-
]
|
170
|
-
|
171
|
-
GREETING_DIALOG_DISPLAY = [
|
172
|
-
"HIDE",
|
173
|
-
"SHOW",
|
174
|
-
"WELCOME_MESSAGE",
|
175
|
-
]
|
176
|
-
|
177
|
-
GUEST_CHAT_MODE = [
|
178
|
-
"DISABLED",
|
179
|
-
"ENABLED",
|
180
|
-
]
|
181
|
-
|
182
|
-
MOBILE_CHAT_DISPLAY = [
|
183
|
-
"APP_SWITCH",
|
184
|
-
"CHAT_TAB",
|
185
|
-
]
|
186
|
-
|
187
163
|
BACKDATED_TIME_GRANULARITY = [
|
188
164
|
"day",
|
189
165
|
"hour",
|
@@ -231,6 +207,10 @@ module FacebookAds
|
|
231
207
|
"SCHEDULED_RECURRING",
|
232
208
|
]
|
233
209
|
|
210
|
+
CATEGORY = [
|
211
|
+
"UTILITY",
|
212
|
+
]
|
213
|
+
|
234
214
|
MESSAGING_TYPE = [
|
235
215
|
"MESSAGE_TAG",
|
236
216
|
"RESPONSE",
|
@@ -328,6 +308,7 @@ module FacebookAds
|
|
328
308
|
"live_videos",
|
329
309
|
"local_delivery",
|
330
310
|
"location",
|
311
|
+
"marketing_message_delivery_failed",
|
331
312
|
"mcom_invoice_change",
|
332
313
|
"members",
|
333
314
|
"mention",
|
@@ -339,6 +320,7 @@ module FacebookAds
|
|
339
320
|
"message_mention",
|
340
321
|
"message_reactions",
|
341
322
|
"message_reads",
|
323
|
+
"message_template_status_update",
|
342
324
|
"messages",
|
343
325
|
"messaging_account_linking",
|
344
326
|
"messaging_appointments",
|
@@ -360,7 +342,6 @@ module FacebookAds
|
|
360
342
|
"messaging_referrals",
|
361
343
|
"mission",
|
362
344
|
"name",
|
363
|
-
"otp_verification",
|
364
345
|
"page_about_story",
|
365
346
|
"page_change_proposal",
|
366
347
|
"page_upcoming_change",
|
@@ -387,14 +368,6 @@ module FacebookAds
|
|
387
368
|
"website",
|
388
369
|
]
|
389
370
|
|
390
|
-
ACTION = [
|
391
|
-
"SPAM",
|
392
|
-
]
|
393
|
-
|
394
|
-
ACTION_TYPE = [
|
395
|
-
"REPORT_THREAD",
|
396
|
-
]
|
397
|
-
|
398
371
|
|
399
372
|
field :about, 'string'
|
400
373
|
field :access_token, 'string'
|
@@ -649,7 +622,7 @@ module FacebookAds
|
|
649
622
|
|
650
623
|
has_edge :calls do |edge|
|
651
624
|
edge.post do |api|
|
652
|
-
api.has_param :action, { enum: %w{ACCEPT REJECT TERMINATE }}
|
625
|
+
api.has_param :action, { enum: %w{ACCEPT CONNECT REJECT TERMINATE }}
|
653
626
|
api.has_param :call_id, 'string'
|
654
627
|
api.has_param :platform, { enum: %w{INSTAGRAM MESSENGER }}
|
655
628
|
api.has_param :session, 'hash'
|
@@ -693,20 +666,6 @@ module FacebookAds
|
|
693
666
|
|
694
667
|
has_edge :chat_plugin do |edge|
|
695
668
|
edge.get 'ChatPlugin'
|
696
|
-
edge.post 'Page' do |api|
|
697
|
-
api.has_param :alignment, { enum: -> { Page::ALIGNMENT }}
|
698
|
-
api.has_param :desktop_bottom_spacing, 'int'
|
699
|
-
api.has_param :desktop_side_spacing, 'int'
|
700
|
-
api.has_param :entry_point_icon, { enum: -> { Page::ENTRY_POINT_ICON }}
|
701
|
-
api.has_param :entry_point_label, { enum: -> { Page::ENTRY_POINT_LABEL }}
|
702
|
-
api.has_param :greeting_dialog_display, { enum: -> { Page::GREETING_DIALOG_DISPLAY }}
|
703
|
-
api.has_param :guest_chat_mode, { enum: -> { Page::GUEST_CHAT_MODE }}
|
704
|
-
api.has_param :mobile_bottom_spacing, 'int'
|
705
|
-
api.has_param :mobile_chat_display, { enum: -> { Page::MOBILE_CHAT_DISPLAY }}
|
706
|
-
api.has_param :mobile_side_spacing, 'int'
|
707
|
-
api.has_param :theme_color, 'string'
|
708
|
-
api.has_param :welcome_screen_greeting, 'string'
|
709
|
-
end
|
710
669
|
end
|
711
670
|
|
712
671
|
has_edge :commerce_merchant_settings do |edge|
|
@@ -920,7 +879,6 @@ module FacebookAds
|
|
920
879
|
api.has_param :text_format_metadata, 'string'
|
921
880
|
api.has_param :text_format_preset_id, 'string'
|
922
881
|
api.has_param :text_only_place, 'string'
|
923
|
-
api.has_param :throwback_camera_roll_media, 'string'
|
924
882
|
api.has_param :thumbnail, 'file'
|
925
883
|
api.has_param :time_since_original_post, 'int'
|
926
884
|
api.has_param :title, 'string'
|
@@ -991,6 +949,7 @@ module FacebookAds
|
|
991
949
|
api.has_param :questions, { list: 'object' }
|
992
950
|
api.has_param :thank_you_page, 'object'
|
993
951
|
api.has_param :tracking_parameters, 'hash'
|
952
|
+
api.has_param :upload_gated_file, 'file'
|
994
953
|
end
|
995
954
|
end
|
996
955
|
|
@@ -1083,6 +1042,29 @@ module FacebookAds
|
|
1083
1042
|
end
|
1084
1043
|
end
|
1085
1044
|
|
1045
|
+
has_edge :message_templates do |edge|
|
1046
|
+
edge.delete do |api|
|
1047
|
+
api.has_param :name, 'string'
|
1048
|
+
api.has_param :template_id, 'string'
|
1049
|
+
end
|
1050
|
+
edge.get 'MessengerBusinessTemplate' do |api|
|
1051
|
+
api.has_param :category, { list: { enum: -> { Page::CATEGORY }} }
|
1052
|
+
api.has_param :content, 'string'
|
1053
|
+
api.has_param :language, { list: 'string' }
|
1054
|
+
api.has_param :name, 'string'
|
1055
|
+
api.has_param :name_or_content, 'string'
|
1056
|
+
api.has_param :status, { list: { enum: -> { MessengerBusinessTemplate::STATUS }} }
|
1057
|
+
end
|
1058
|
+
edge.post 'Page' do |api|
|
1059
|
+
api.has_param :category, { enum: -> { Page::CATEGORY }}
|
1060
|
+
api.has_param :components, { list: 'hash' }
|
1061
|
+
api.has_param :language, 'string'
|
1062
|
+
api.has_param :library_template_button_inputs, { list: 'hash' }
|
1063
|
+
api.has_param :library_template_name, 'string'
|
1064
|
+
api.has_param :name, 'string'
|
1065
|
+
end
|
1066
|
+
end
|
1067
|
+
|
1086
1068
|
has_edge :messages do |edge|
|
1087
1069
|
edge.post 'Page' do |api|
|
1088
1070
|
api.has_param :message, 'object'
|
@@ -1106,6 +1088,7 @@ module FacebookAds
|
|
1106
1088
|
edge.get 'MessengerCallSettings'
|
1107
1089
|
edge.post 'Page' do |api|
|
1108
1090
|
api.has_param :audio_enabled, 'bool'
|
1091
|
+
api.has_param :icon_enabled, 'bool'
|
1109
1092
|
end
|
1110
1093
|
end
|
1111
1094
|
|
@@ -1260,6 +1243,7 @@ module FacebookAds
|
|
1260
1243
|
api.has_param :place, 'object'
|
1261
1244
|
api.has_param :privacy, 'string'
|
1262
1245
|
api.has_param :profile_id, 'int'
|
1246
|
+
api.has_param :provenance_info, 'hash'
|
1263
1247
|
api.has_param :proxied_app_id, 'string'
|
1264
1248
|
api.has_param :published, 'bool'
|
1265
1249
|
api.has_param :qn, 'string'
|
@@ -1340,10 +1324,6 @@ module FacebookAds
|
|
1340
1324
|
end
|
1341
1325
|
end
|
1342
1326
|
|
1343
|
-
has_edge :ratings do |edge|
|
1344
|
-
edge.get 'Recommendation'
|
1345
|
-
end
|
1346
|
-
|
1347
1327
|
has_edge :release_thread_control do |edge|
|
1348
1328
|
edge.post 'Page' do |api|
|
1349
1329
|
api.has_param :recipient, 'object'
|
@@ -1422,14 +1402,6 @@ module FacebookAds
|
|
1422
1402
|
end
|
1423
1403
|
end
|
1424
1404
|
|
1425
|
-
has_edge :thread_action do |edge|
|
1426
|
-
edge.post 'Page' do |api|
|
1427
|
-
api.has_param :action, { enum: -> { Page::ACTION }}
|
1428
|
-
api.has_param :action_type, { enum: -> { Page::ACTION_TYPE }}
|
1429
|
-
api.has_param :user_id, 'hash'
|
1430
|
-
end
|
1431
|
-
end
|
1432
|
-
|
1433
1405
|
has_edge :thread_owner do |edge|
|
1434
1406
|
edge.get 'PageThreadOwner' do |api|
|
1435
1407
|
api.has_param :recipient, 'string'
|
@@ -1594,7 +1566,6 @@ module FacebookAds
|
|
1594
1566
|
api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
|
1595
1567
|
api.has_param :targeting, 'object'
|
1596
1568
|
api.has_param :text_format_metadata, 'string'
|
1597
|
-
api.has_param :throwback_camera_roll_media, 'string'
|
1598
1569
|
api.has_param :thumb, 'file'
|
1599
1570
|
api.has_param :time_since_original_post, 'int'
|
1600
1571
|
api.has_param :title, 'string'
|
@@ -17,9 +17,7 @@ module FacebookAds
|
|
17
17
|
|
18
18
|
field :acceptance_status, 'string'
|
19
19
|
field :category, 'string'
|
20
|
-
field :current_value, 'string'
|
21
20
|
field :id, 'string'
|
22
|
-
field :proposed_value, 'string'
|
23
21
|
field :upcoming_change_info, 'PageUpcomingChange'
|
24
22
|
has_no_get
|
25
23
|
has_no_post
|
@@ -540,6 +540,10 @@ module FacebookAds
|
|
540
540
|
end
|
541
541
|
end
|
542
542
|
|
543
|
+
has_edge :version_configs do |edge|
|
544
|
+
edge.get 'CatalogContentVersionConfig'
|
545
|
+
end
|
546
|
+
|
543
547
|
has_edge :version_items_batch do |edge|
|
544
548
|
edge.post 'ProductCatalog' do |api|
|
545
549
|
api.has_param :allow_upsert, 'bool'
|
@@ -390,6 +390,13 @@ module FacebookAds
|
|
390
390
|
"ITEM_PRICE_NOT_POSITIVE",
|
391
391
|
"ITEM_STALE_OUT_OF_STOCK",
|
392
392
|
"MARKETPLACE_DISABLED_BY_USER",
|
393
|
+
"MARKETPLACE_PARTNER_LISTING_LIMIT_EXCEEDED",
|
394
|
+
"MARKETPLACE_PARTNER_NOT_LOCAL_ITEM",
|
395
|
+
"MARKETPLACE_PARTNER_NOT_SHIPPED_ITEM",
|
396
|
+
"MARKETPLACE_PARTNER_POLICY_VIOLATION",
|
397
|
+
"MARKETPLACE_PARTNER_RULE_LISTING_LIMIT_EXCEEDED",
|
398
|
+
"MARKETPLACE_PARTNER_SELLER_BANNED",
|
399
|
+
"MARKETPLACE_PARTNER_SELLER_NOT_VALID",
|
393
400
|
"MINI_SHOPS_DISABLED_BY_USER",
|
394
401
|
"MISSING_CHECKOUT",
|
395
402
|
"MISSING_CHECKOUT_CURRENCY",
|
@@ -801,6 +808,7 @@ module FacebookAds
|
|
801
808
|
field :start_date, 'string'
|
802
809
|
field :tags, { list: 'string' }
|
803
810
|
field :url, 'string'
|
811
|
+
field :vendor_id, 'string'
|
804
812
|
field :video_fetch_status, { enum: -> { VIDEO_FETCH_STATUS }}
|
805
813
|
field :visibility, { enum: -> { VISIBILITY }}
|
806
814
|
field :wa_compliance_category, 'string'
|
@@ -100,6 +100,7 @@ module FacebookAds
|
|
100
100
|
field :instream_packages, { list: 'string' }
|
101
101
|
field :interval_frequency_cap, 'int'
|
102
102
|
field :interval_frequency_cap_reset_period, 'int'
|
103
|
+
field :is_balanced_frequency, 'bool'
|
103
104
|
field :is_bonus_media, 'int'
|
104
105
|
field :is_conversion_goal, 'int'
|
105
106
|
field :is_higher_average_frequency, 'bool'
|
@@ -114,6 +115,7 @@ module FacebookAds
|
|
114
115
|
field :optimization_goal, 'int'
|
115
116
|
field :optimization_goal_name, 'string'
|
116
117
|
field :pause_periods, { list: 'object' }
|
118
|
+
field :percent_reach_at_target_frequency, 'int'
|
117
119
|
field :placement_breakdown, 'ReachFrequencyEstimatesPlacementBreakdown'
|
118
120
|
field :placement_breakdown_map, { list: 'map<unsigned int, ReachFrequencyEstimatesPlacementBreakdown>' }
|
119
121
|
field :plan_name, 'string'
|
@@ -126,6 +128,8 @@ module FacebookAds
|
|
126
128
|
field :status, 'int'
|
127
129
|
field :story_event_type, 'int'
|
128
130
|
field :target_cpm, 'int'
|
131
|
+
field :target_frequency, 'int'
|
132
|
+
field :target_frequency_reset_period, 'int'
|
129
133
|
field :target_spec, 'Targeting'
|
130
134
|
field :time_created, 'datetime'
|
131
135
|
field :time_updated, 'datetime'
|
@@ -142,7 +146,6 @@ module FacebookAds
|
|
142
146
|
field :existing_campaign_id, 'string'
|
143
147
|
field :grp_buying, 'bool'
|
144
148
|
field :impression, 'int'
|
145
|
-
field :is_balanced_frequency, 'bool'
|
146
149
|
field :is_full_view, 'bool'
|
147
150
|
field :is_reach_and_frequency_io_buying, 'bool'
|
148
151
|
field :num_curve_points, 'int'
|
@@ -151,8 +154,6 @@ module FacebookAds
|
|
151
154
|
field :rf_prediction_id_to_release, 'string'
|
152
155
|
field :rf_prediction_id_to_share, 'string'
|
153
156
|
field :stop_time, 'int'
|
154
|
-
field :target_frequency, 'int'
|
155
|
-
field :target_frequency_reset_period, 'int'
|
156
157
|
has_no_post
|
157
158
|
has_no_delete
|
158
159
|
|
@@ -15,8 +15,12 @@ module FacebookAds
|
|
15
15
|
|
16
16
|
class RegionalRegulationIdentities < AdObject
|
17
17
|
|
18
|
+
field :australia_finserv_beneficiary, 'string'
|
19
|
+
field :australia_finserv_payer, 'string'
|
18
20
|
field :taiwan_finserv_beneficiary, 'string'
|
19
21
|
field :taiwan_finserv_payer, 'string'
|
22
|
+
field :taiwan_universal_beneficiary, 'string'
|
23
|
+
field :taiwan_universal_payer, 'string'
|
20
24
|
has_no_id
|
21
25
|
has_no_get
|
22
26
|
has_no_post
|
@@ -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 TargetingSubscriberUniverse < AdObject
|
17
|
+
|
18
|
+
field :messenger_subscriber_source, 'IdName'
|
19
|
+
field :whatsapp_subscriber_source, 'IdName'
|
20
|
+
has_no_id
|
21
|
+
has_no_get
|
22
|
+
has_no_post
|
23
|
+
has_no_delete
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -29,8 +29,11 @@ module FacebookAds
|
|
29
29
|
field :description, 'string'
|
30
30
|
field :holdout_size, 'double'
|
31
31
|
field :id, 'string'
|
32
|
+
field :legacy_ads_data_partner_id, 'string'
|
33
|
+
field :legacy_ads_data_partner_name, 'string'
|
32
34
|
field :modified_time, 'datetime'
|
33
35
|
field :owner_instance_id, 'string'
|
36
|
+
field :partner_household_graph_dataset_id, 'string'
|
34
37
|
field :region, 'string'
|
35
38
|
field :status, { enum: -> { STATUS }}
|
36
39
|
field :study_cells, { list: 'string' }
|
@@ -53,6 +53,7 @@ module FacebookAds
|
|
53
53
|
field :id, 'string'
|
54
54
|
field :id_for_avatars, 'string'
|
55
55
|
field :inspirational_people, { list: 'Experience' }
|
56
|
+
field :instagram_user_self_asset, 'InstagramUser'
|
56
57
|
field :install_type, 'string'
|
57
58
|
field :installed, 'bool'
|
58
59
|
field :is_guest_user, 'bool'
|
@@ -73,6 +74,7 @@ module FacebookAds
|
|
73
74
|
field :profile_pic, 'string'
|
74
75
|
field :quotes, 'string'
|
75
76
|
field :relationship_status, 'string'
|
77
|
+
field :religion, 'string'
|
76
78
|
field :shared_login_upgrade_required_by, 'datetime'
|
77
79
|
field :short_name, 'string'
|
78
80
|
field :significant_other, 'User'
|
@@ -339,7 +341,6 @@ module FacebookAds
|
|
339
341
|
api.has_param :text_format_metadata, 'string'
|
340
342
|
api.has_param :text_format_preset_id, 'string'
|
341
343
|
api.has_param :text_only_place, 'string'
|
342
|
-
api.has_param :throwback_camera_roll_media, 'string'
|
343
344
|
api.has_param :thumbnail, 'file'
|
344
345
|
api.has_param :time_since_original_post, 'int'
|
345
346
|
api.has_param :title, 'string'
|
@@ -442,6 +443,12 @@ module FacebookAds
|
|
442
443
|
edge.post 'User'
|
443
444
|
end
|
444
445
|
|
446
|
+
has_edge :messenger_kids_accounts_unread_badge do |edge|
|
447
|
+
edge.post 'User' do |api|
|
448
|
+
api.has_param :proxied_app_id, 'int'
|
449
|
+
end
|
450
|
+
end
|
451
|
+
|
445
452
|
has_edge :music do |edge|
|
446
453
|
edge.get 'Page' do |api|
|
447
454
|
api.has_param :target_id, 'string'
|
@@ -524,6 +531,7 @@ module FacebookAds
|
|
524
531
|
api.has_param :place, 'object'
|
525
532
|
api.has_param :privacy, 'string'
|
526
533
|
api.has_param :profile_id, 'int'
|
534
|
+
api.has_param :provenance_info, 'hash'
|
527
535
|
api.has_param :proxied_app_id, 'string'
|
528
536
|
api.has_param :published, 'bool'
|
529
537
|
api.has_param :qn, 'string'
|
@@ -636,7 +644,6 @@ module FacebookAds
|
|
636
644
|
api.has_param :start_offset, 'int'
|
637
645
|
api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
|
638
646
|
api.has_param :text_format_metadata, 'string'
|
639
|
-
api.has_param :throwback_camera_roll_media, 'string'
|
640
647
|
api.has_param :thumb, 'file'
|
641
648
|
api.has_param :time_since_original_post, 'int'
|
642
649
|
api.has_param :title, 'string'
|
@@ -125,6 +125,15 @@ module FacebookAds
|
|
125
125
|
field :condition, 'string'
|
126
126
|
field :currency, 'string'
|
127
127
|
field :custom_label_0, 'string'
|
128
|
+
field :custom_label_1, 'string'
|
129
|
+
field :custom_label_2, 'string'
|
130
|
+
field :custom_label_3, 'string'
|
131
|
+
field :custom_label_4, 'string'
|
132
|
+
field :custom_number_0, 'int'
|
133
|
+
field :custom_number_1, 'int'
|
134
|
+
field :custom_number_2, 'int'
|
135
|
+
field :custom_number_3, 'int'
|
136
|
+
field :custom_number_4, 'int'
|
128
137
|
field :date_first_on_lot, 'string'
|
129
138
|
field :dealer_communication_channel, 'string'
|
130
139
|
field :dealer_email, 'string'
|
@@ -40,6 +40,16 @@ module FacebookAds
|
|
40
40
|
field :cashback_price, 'string'
|
41
41
|
field :category_specific_fields, 'CatalogSubVerticalList'
|
42
42
|
field :currency, 'string'
|
43
|
+
field :custom_label_0, 'string'
|
44
|
+
field :custom_label_1, 'string'
|
45
|
+
field :custom_label_2, 'string'
|
46
|
+
field :custom_label_3, 'string'
|
47
|
+
field :custom_label_4, 'string'
|
48
|
+
field :custom_number_0, 'int'
|
49
|
+
field :custom_number_1, 'int'
|
50
|
+
field :custom_number_2, 'int'
|
51
|
+
field :custom_number_3, 'int'
|
52
|
+
field :custom_number_4, 'int'
|
43
53
|
field :dma_codes, { list: 'string' }
|
44
54
|
field :downpayment_currency, 'string'
|
45
55
|
field :downpayment_price, 'string'
|
@@ -14,6 +14,19 @@ module FacebookAds
|
|
14
14
|
# pull request for this class.
|
15
15
|
|
16
16
|
class WhatsAppBusinessAccount < AdObject
|
17
|
+
BUSINESS_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
|
TASKS = [
|
18
31
|
"DEVELOP",
|
19
32
|
"MANAGE",
|
@@ -37,6 +50,11 @@ module FacebookAds
|
|
37
50
|
"ORDER_DETAILS",
|
38
51
|
]
|
39
52
|
|
53
|
+
PARAMETER_FORMAT = [
|
54
|
+
"NAMED",
|
55
|
+
"POSITIONAL",
|
56
|
+
]
|
57
|
+
|
40
58
|
SUB_CATEGORY = [
|
41
59
|
"ORDER_DETAILS",
|
42
60
|
"ORDER_STATUS",
|
@@ -54,7 +72,7 @@ module FacebookAds
|
|
54
72
|
field :account_review_status, 'string'
|
55
73
|
field :analytics, 'object'
|
56
74
|
field :auth_international_rate_eligibility, 'object'
|
57
|
-
field :business_verification_status,
|
75
|
+
field :business_verification_status, { enum: -> { BUSINESS_VERIFICATION_STATUS }}
|
58
76
|
field :country, 'string'
|
59
77
|
field :creation_time, 'int'
|
60
78
|
field :currency, 'string'
|
@@ -62,6 +80,7 @@ module FacebookAds
|
|
62
80
|
field :id, 'string'
|
63
81
|
field :is_enabled_for_insights, 'bool'
|
64
82
|
field :linked_commerce_account, 'CommerceMerchantSettings'
|
83
|
+
field :marketing_messages_lite_api_status, 'string'
|
65
84
|
field :message_template_namespace, 'string'
|
66
85
|
field :name, 'string'
|
67
86
|
field :on_behalf_of_business_info, 'object'
|
@@ -111,7 +130,7 @@ module FacebookAds
|
|
111
130
|
|
112
131
|
has_edge :conversation_analytics do |edge|
|
113
132
|
edge.get do |api|
|
114
|
-
api.has_param :conversation_categories, { list: { enum: %w{AUTHENTICATION AUTHENTICATION_INTERNATIONAL MARKETING
|
133
|
+
api.has_param :conversation_categories, { list: { enum: %w{AUTHENTICATION AUTHENTICATION_INTERNATIONAL MARKETING MARKETING_LITE SERVICE UTILITY }} }
|
115
134
|
api.has_param :conversation_directions, { list: { enum: %w{BUSINESS_INITIATED UNKNOWN USER_INITIATED }} }
|
116
135
|
api.has_param :conversation_types, { list: { enum: %w{FREE_ENTRY_POINT FREE_TIER REGULAR UNKNOWN }} }
|
117
136
|
api.has_param :country_codes, { list: 'string' }
|
@@ -131,17 +150,15 @@ module FacebookAds
|
|
131
150
|
end
|
132
151
|
end
|
133
152
|
|
134
|
-
has_edge :dcc_config do |edge|
|
135
|
-
edge.get
|
136
|
-
end
|
137
|
-
|
138
153
|
has_edge :flows do |edge|
|
139
154
|
edge.get
|
140
155
|
edge.post do |api|
|
141
156
|
api.has_param :categories, { list: { enum: %w{APPOINTMENT_BOOKING CONTACT_US CUSTOMER_SUPPORT LEAD_GENERATION OTHER SHOPPING SIGN_IN SIGN_UP SURVEY }} }
|
142
157
|
api.has_param :clone_flow_id, 'string'
|
143
158
|
api.has_param :endpoint_uri, 'string'
|
159
|
+
api.has_param :flow_json, 'string'
|
144
160
|
api.has_param :name, 'string'
|
161
|
+
api.has_param :publish, 'bool'
|
145
162
|
end
|
146
163
|
end
|
147
164
|
|
@@ -192,14 +209,14 @@ module FacebookAds
|
|
192
209
|
api.has_param :library_template_name, 'string'
|
193
210
|
api.has_param :message_send_ttl_seconds, 'int'
|
194
211
|
api.has_param :name, 'string'
|
212
|
+
api.has_param :parameter_format, { enum: -> { WhatsAppBusinessAccount::PARAMETER_FORMAT }}
|
195
213
|
api.has_param :sub_category, { enum: -> { WhatsAppBusinessAccount::SUB_CATEGORY }}
|
196
214
|
end
|
197
215
|
end
|
198
216
|
|
199
217
|
has_edge :migrate_flows do |edge|
|
200
218
|
edge.post 'WhatsAppBusinessAccount' do |api|
|
201
|
-
api.has_param :
|
202
|
-
api.has_param :source_flow_ids, { list: 'string' }
|
219
|
+
api.has_param :source_flow_names, { list: 'string' }
|
203
220
|
api.has_param :source_waba_id, 'string'
|
204
221
|
end
|
205
222
|
end
|
@@ -220,6 +237,7 @@ module FacebookAds
|
|
220
237
|
end
|
221
238
|
edge.post 'WhatsAppBusinessAccount' do |api|
|
222
239
|
api.has_param :configuration_name, 'string'
|
240
|
+
api.has_param :data_endpoint_url, 'string'
|
223
241
|
api.has_param :merchant_category_code, 'string'
|
224
242
|
api.has_param :merchant_vpa, 'string'
|
225
243
|
api.has_param :provider_name, { enum: -> { WhatsAppBusinessAccount::PROVIDER_NAME }}
|
@@ -243,6 +261,20 @@ module FacebookAds
|
|
243
261
|
end
|
244
262
|
end
|
245
263
|
|
264
|
+
has_edge :pricing_analytics do |edge|
|
265
|
+
edge.get do |api|
|
266
|
+
api.has_param :country_codes, { list: 'string' }
|
267
|
+
api.has_param :dimensions, { list: { enum: %w{COUNTRY PHONE PRICING_CATEGORY PRICING_TYPE }} }
|
268
|
+
api.has_param :end, 'int'
|
269
|
+
api.has_param :granularity, { enum: %w{DAILY HALF_HOUR MONTHLY }}
|
270
|
+
api.has_param :metric_types, { list: { enum: %w{COST VOLUME }} }
|
271
|
+
api.has_param :phone_numbers, { list: 'string' }
|
272
|
+
api.has_param :pricing_categories, { list: { enum: %w{AUTHENTICATION AUTHENTICATION_INTERNATIONAL MARKETING MARKETING_LITE SERVICE UTILITY }} }
|
273
|
+
api.has_param :pricing_types, { list: { enum: %w{FREE_CUSTOMER_SERVICE FREE_ENTRY_POINT REGULAR }} }
|
274
|
+
api.has_param :start, 'int'
|
275
|
+
end
|
276
|
+
end
|
277
|
+
|
246
278
|
has_edge :product_catalogs do |edge|
|
247
279
|
edge.delete do |api|
|
248
280
|
api.has_param :catalog_id, 'string'
|
@@ -265,6 +297,7 @@ module FacebookAds
|
|
265
297
|
|
266
298
|
has_edge :set_solution_migration_intent do |edge|
|
267
299
|
edge.post do |api|
|
300
|
+
api.has_param :app_id, 'string'
|
268
301
|
api.has_param :solution_id, 'string'
|
269
302
|
end
|
270
303
|
end
|
@@ -286,13 +319,32 @@ module FacebookAds
|
|
286
319
|
edge.get do |api|
|
287
320
|
api.has_param :end, 'datetime'
|
288
321
|
api.has_param :granularity, { enum: %w{DAILY }}
|
289
|
-
api.has_param :metric_types, { list: { enum: %w{CLICKED COST DELIVERED READ SENT }} }
|
322
|
+
api.has_param :metric_types, { list: { enum: %w{CLICKED COST DELIVERED READ REPLIED SENT }} }
|
290
323
|
api.has_param :product_type, { enum: %w{CLOUD_API MARKETING_MESSAGES_LITE_API }}
|
291
324
|
api.has_param :start, 'datetime'
|
292
325
|
api.has_param :template_ids, { list: 'string' }
|
293
326
|
end
|
294
327
|
end
|
295
328
|
|
329
|
+
has_edge :template_group_analytics do |edge|
|
330
|
+
edge.get do |api|
|
331
|
+
api.has_param :end, 'datetime'
|
332
|
+
api.has_param :granularity, { enum: %w{DAILY }}
|
333
|
+
api.has_param :metric_types, { list: { enum: %w{CLICKED COST DELIVERED READ REPLIED SENT }} }
|
334
|
+
api.has_param :start, 'datetime'
|
335
|
+
api.has_param :template_group_ids, { list: 'string' }
|
336
|
+
end
|
337
|
+
end
|
338
|
+
|
339
|
+
has_edge :template_groups do |edge|
|
340
|
+
edge.get
|
341
|
+
edge.post do |api|
|
342
|
+
api.has_param :description, 'string'
|
343
|
+
api.has_param :name, 'string'
|
344
|
+
api.has_param :whatsapp_business_templates, { list: 'string' }
|
345
|
+
end
|
346
|
+
end
|
347
|
+
|
296
348
|
has_edge :template_performance_metrics do |edge|
|
297
349
|
edge.get do |api|
|
298
350
|
api.has_param :name, 'string'
|
data/lib/facebook_ads/ad_objects/whats_app_business_partner_client_verification_submission.rb
CHANGED
@@ -19,12 +19,14 @@ module FacebookAds
|
|
19
19
|
"BUSINESS_NOT_ELIGIBLE",
|
20
20
|
"LEGAL_NAME_NOT_FOUND_IN_DOCUMENTS",
|
21
21
|
"LEGAL_NAME_NOT_MATCHING",
|
22
|
+
"MALFORMED_DOCUMENTS",
|
22
23
|
"NONE",
|
23
24
|
"WEBSITE_NOT_MATCHING",
|
24
25
|
]
|
25
26
|
|
26
27
|
VERIFICATION_STATUS = [
|
27
28
|
"APPROVED",
|
29
|
+
"DISCARDED",
|
28
30
|
"FAILED",
|
29
31
|
"PENDING",
|
30
32
|
"REVOKED",
|
data/lib/facebook_ads/version.rb
CHANGED