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
@@ -0,0 +1,52 @@
|
|
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 Placement < AdObject
|
17
|
+
DEVICE_PLATFORMS = [
|
18
|
+
"desktop",
|
19
|
+
"mobile",
|
20
|
+
]
|
21
|
+
|
22
|
+
EFFECTIVE_DEVICE_PLATFORMS = [
|
23
|
+
"desktop",
|
24
|
+
"mobile",
|
25
|
+
]
|
26
|
+
|
27
|
+
|
28
|
+
field :audience_network_positions, { list: 'string' }
|
29
|
+
field :device_platforms, { list: { enum: -> { DEVICE_PLATFORMS }} }
|
30
|
+
field :effective_audience_network_positions, { list: 'string' }
|
31
|
+
field :effective_device_platforms, { list: { enum: -> { EFFECTIVE_DEVICE_PLATFORMS }} }
|
32
|
+
field :effective_facebook_positions, { list: 'string' }
|
33
|
+
field :effective_instagram_positions, { list: 'string' }
|
34
|
+
field :effective_messenger_positions, { list: 'string' }
|
35
|
+
field :effective_oculus_positions, { list: 'string' }
|
36
|
+
field :effective_publisher_platforms, { list: 'string' }
|
37
|
+
field :effective_threads_positions, { list: 'string' }
|
38
|
+
field :effective_whatsapp_positions, { list: 'string' }
|
39
|
+
field :facebook_positions, { list: 'string' }
|
40
|
+
field :instagram_positions, { list: 'string' }
|
41
|
+
field :messenger_positions, { list: 'string' }
|
42
|
+
field :oculus_positions, { list: 'string' }
|
43
|
+
field :publisher_platforms, { list: 'string' }
|
44
|
+
field :threads_positions, { list: 'string' }
|
45
|
+
field :whatsapp_positions, { list: 'string' }
|
46
|
+
has_no_id
|
47
|
+
has_no_get
|
48
|
+
has_no_post
|
49
|
+
has_no_delete
|
50
|
+
|
51
|
+
end
|
52
|
+
end
|
@@ -329,6 +329,12 @@ module FacebookAds
|
|
329
329
|
end
|
330
330
|
end
|
331
331
|
|
332
|
+
has_edge :marketplace_partner_sellers_details do |edge|
|
333
|
+
edge.post 'ProductCatalog' do |api|
|
334
|
+
api.has_param :requests, 'hash'
|
335
|
+
end
|
336
|
+
end
|
337
|
+
|
332
338
|
has_edge :pricing_variables_batch do |edge|
|
333
339
|
edge.get 'ProductCatalogPricingVariablesBatch' do |api|
|
334
340
|
api.has_param :handle, 'string'
|
@@ -14,23 +14,6 @@ module FacebookAds
|
|
14
14
|
# pull request for this class.
|
15
15
|
|
16
16
|
class ProductCatalogDiagnosticGroup < AdObject
|
17
|
-
AFFECTED_CHANNELS = [
|
18
|
-
"b2c_marketplace",
|
19
|
-
"c2c_marketplace",
|
20
|
-
"da",
|
21
|
-
"daily_deals",
|
22
|
-
"daily_deals_legacy",
|
23
|
-
"ig_product_tagging",
|
24
|
-
"marketplace",
|
25
|
-
"marketplace_ads_deprecated",
|
26
|
-
"marketplace_shops",
|
27
|
-
"mini_shops",
|
28
|
-
"offline_conversions",
|
29
|
-
"shops",
|
30
|
-
"universal_checkout",
|
31
|
-
"whatsapp",
|
32
|
-
]
|
33
|
-
|
34
17
|
AFFECTED_ENTITY = [
|
35
18
|
"product_catalog",
|
36
19
|
"product_event",
|
@@ -62,6 +45,23 @@ module FacebookAds
|
|
62
45
|
"SHOPS_VISIBILITY_ISSUES",
|
63
46
|
]
|
64
47
|
|
48
|
+
AFFECTED_CHANNELS = [
|
49
|
+
"b2c_marketplace",
|
50
|
+
"c2c_marketplace",
|
51
|
+
"da",
|
52
|
+
"daily_deals",
|
53
|
+
"daily_deals_legacy",
|
54
|
+
"ig_product_tagging",
|
55
|
+
"marketplace",
|
56
|
+
"marketplace_ads_deprecated",
|
57
|
+
"marketplace_shops",
|
58
|
+
"mini_shops",
|
59
|
+
"offline_conversions",
|
60
|
+
"shops",
|
61
|
+
"universal_checkout",
|
62
|
+
"whatsapp",
|
63
|
+
]
|
64
|
+
|
65
65
|
AFFECTED_ENTITIES = [
|
66
66
|
"product_catalog",
|
67
67
|
"product_event",
|
@@ -89,7 +89,7 @@ module FacebookAds
|
|
89
89
|
]
|
90
90
|
|
91
91
|
|
92
|
-
field :affected_channels, { list:
|
92
|
+
field :affected_channels, { list: 'string' }
|
93
93
|
field :affected_entity, { enum: -> { AFFECTED_ENTITY }}
|
94
94
|
field :affected_features, { list: { enum: -> { AFFECTED_FEATURES }} }
|
95
95
|
field :diagnostics, { list: 'object' }
|
@@ -34,6 +34,14 @@ module FacebookAds
|
|
34
34
|
"preorder",
|
35
35
|
]
|
36
36
|
|
37
|
+
CAPABILITY_TO_REVIEW_STATUS = [
|
38
|
+
"APPROVED",
|
39
|
+
"NO_REVIEW",
|
40
|
+
"OUTDATED",
|
41
|
+
"PENDING",
|
42
|
+
"REJECTED",
|
43
|
+
]
|
44
|
+
|
37
45
|
CONDITION = [
|
38
46
|
"cpo",
|
39
47
|
"new",
|
@@ -369,6 +377,7 @@ module FacebookAds
|
|
369
377
|
"INVALID_SUBSCRIPTION_DISABLE_PARAMS",
|
370
378
|
"INVALID_SUBSCRIPTION_ENABLE_PARAMS",
|
371
379
|
"INVALID_SUBSCRIPTION_PARAMS",
|
380
|
+
"INVALID_TAX_EXTENSION_STATE",
|
372
381
|
"INVALID_VEHICLE_STATE",
|
373
382
|
"INVALID_VIRTUAL_TOUR_URL_DOMAIN",
|
374
383
|
"INVENTORY_ZERO_AVAILABILITY_IN_STOCK",
|
@@ -381,6 +390,13 @@ module FacebookAds
|
|
381
390
|
"ITEM_PRICE_NOT_POSITIVE",
|
382
391
|
"ITEM_STALE_OUT_OF_STOCK",
|
383
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",
|
384
400
|
"MINI_SHOPS_DISABLED_BY_USER",
|
385
401
|
"MISSING_CHECKOUT",
|
386
402
|
"MISSING_CHECKOUT_CURRENCY",
|
@@ -792,6 +808,7 @@ module FacebookAds
|
|
792
808
|
field :start_date, 'string'
|
793
809
|
field :tags, { list: 'string' }
|
794
810
|
field :url, 'string'
|
811
|
+
field :vendor_id, 'string'
|
795
812
|
field :video_fetch_status, { enum: -> { VIDEO_FETCH_STATUS }}
|
796
813
|
field :visibility, { enum: -> { VISIBILITY }}
|
797
814
|
field :wa_compliance_category, 'string'
|
@@ -114,6 +114,7 @@ module FacebookAds
|
|
114
114
|
field :optimization_goal, 'int'
|
115
115
|
field :optimization_goal_name, 'string'
|
116
116
|
field :pause_periods, { list: 'object' }
|
117
|
+
field :percent_reach_at_target_frequency, 'int'
|
117
118
|
field :placement_breakdown, 'ReachFrequencyEstimatesPlacementBreakdown'
|
118
119
|
field :placement_breakdown_map, { list: 'map<unsigned int, ReachFrequencyEstimatesPlacementBreakdown>' }
|
119
120
|
field :plan_name, 'string'
|
@@ -15,6 +15,8 @@ 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'
|
20
22
|
has_no_id
|
@@ -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'
|
@@ -89,9 +91,9 @@ module FacebookAds
|
|
89
91
|
has_edge :access_tokens do |edge|
|
90
92
|
edge.delete
|
91
93
|
edge.post 'User' do |api|
|
92
|
-
api.has_param :business_app, '
|
94
|
+
api.has_param :business_app, 'string'
|
93
95
|
api.has_param :page_id, 'string'
|
94
|
-
api.has_param :scope, { list: '
|
96
|
+
api.has_param :scope, { list: 'string' }
|
95
97
|
api.has_param :set_token_expires_in_60_days, 'bool'
|
96
98
|
end
|
97
99
|
end
|
@@ -248,7 +250,7 @@ module FacebookAds
|
|
248
250
|
api.has_param :android_key_hash, 'string'
|
249
251
|
api.has_param :application_id, 'string'
|
250
252
|
api.has_param :asked_fun_fact_prompt_id, 'int'
|
251
|
-
api.has_param :asset3d_id, '
|
253
|
+
api.has_param :asset3d_id, 'string'
|
252
254
|
api.has_param :associated_id, 'string'
|
253
255
|
api.has_param :attach_place_suggestion, 'bool'
|
254
256
|
api.has_param :attached_media, { list: 'object' }
|
@@ -279,10 +281,9 @@ module FacebookAds
|
|
279
281
|
api.has_param :expanded_width, 'int'
|
280
282
|
api.has_param :feed_targeting, 'object'
|
281
283
|
api.has_param :formatting, { enum: -> { Post::FORMATTING }}
|
282
|
-
api.has_param :fun_fact_prompt_id, '
|
284
|
+
api.has_param :fun_fact_prompt_id, 'string'
|
283
285
|
api.has_param :fun_fact_toastee_id, 'int'
|
284
286
|
api.has_param :height, 'int'
|
285
|
-
api.has_param :holiday_card, 'string'
|
286
287
|
api.has_param :home_checkin_city_id, 'object'
|
287
288
|
api.has_param :image_crops, 'hash'
|
288
289
|
api.has_param :implicit_with_tags, { list: 'int' }
|
@@ -303,7 +304,6 @@ module FacebookAds
|
|
303
304
|
api.has_param :name, 'string'
|
304
305
|
api.has_param :nectar_module, 'string'
|
305
306
|
api.has_param :object_attachment, 'string'
|
306
|
-
api.has_param :offer_like_post_id, 'int'
|
307
307
|
api.has_param :og_action_type_id, 'string'
|
308
308
|
api.has_param :og_hide_object_attachment, 'bool'
|
309
309
|
api.has_param :og_icon_id, 'string'
|
@@ -341,7 +341,6 @@ module FacebookAds
|
|
341
341
|
api.has_param :text_format_metadata, 'string'
|
342
342
|
api.has_param :text_format_preset_id, 'string'
|
343
343
|
api.has_param :text_only_place, 'string'
|
344
|
-
api.has_param :throwback_camera_roll_media, 'string'
|
345
344
|
api.has_param :thumbnail, 'file'
|
346
345
|
api.has_param :time_since_original_post, 'int'
|
347
346
|
api.has_param :title, 'string'
|
@@ -605,11 +604,10 @@ module FacebookAds
|
|
605
604
|
api.has_param :formatting, { enum: -> { AdVideo::FORMATTING }}
|
606
605
|
api.has_param :fov, 'int'
|
607
606
|
api.has_param :front_z_rotation, 'double'
|
608
|
-
api.has_param :fun_fact_prompt_id, '
|
607
|
+
api.has_param :fun_fact_prompt_id, 'string'
|
609
608
|
api.has_param :fun_fact_toastee_id, 'int'
|
610
609
|
api.has_param :guide, { list: { list: 'int' } }
|
611
610
|
api.has_param :guide_enabled, 'bool'
|
612
|
-
api.has_param :holiday_card, 'string'
|
613
611
|
api.has_param :initial_heading, 'int'
|
614
612
|
api.has_param :initial_pitch, 'int'
|
615
613
|
api.has_param :instant_game_entry_point_data, 'string'
|
@@ -620,7 +618,6 @@ module FacebookAds
|
|
620
618
|
api.has_param :location_source_id, 'string'
|
621
619
|
api.has_param :manual_privacy, 'bool'
|
622
620
|
api.has_param :no_story, 'bool'
|
623
|
-
api.has_param :offer_like_post_id, 'int'
|
624
621
|
api.has_param :og_action_type_id, 'string'
|
625
622
|
api.has_param :og_icon_id, 'string'
|
626
623
|
api.has_param :og_object_id, 'string'
|
@@ -640,7 +637,6 @@ module FacebookAds
|
|
640
637
|
api.has_param :start_offset, 'int'
|
641
638
|
api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
|
642
639
|
api.has_param :text_format_metadata, 'string'
|
643
|
-
api.has_param :throwback_camera_roll_media, 'string'
|
644
640
|
api.has_param :thumb, 'file'
|
645
641
|
api.has_param :time_since_original_post, 'int'
|
646
642
|
api.has_param :title, 'string'
|
@@ -149,6 +149,11 @@ module FacebookAds
|
|
149
149
|
field :previous_currency, 'string'
|
150
150
|
field :previous_price, 'string'
|
151
151
|
field :price, 'string'
|
152
|
+
field :product_priority_0, 'double'
|
153
|
+
field :product_priority_1, 'double'
|
154
|
+
field :product_priority_2, 'double'
|
155
|
+
field :product_priority_3, 'double'
|
156
|
+
field :product_priority_4, 'double'
|
152
157
|
field :sale_currency, 'string'
|
153
158
|
field :sale_price, 'string'
|
154
159
|
field :sanitized_images, { list: 'string' }
|
@@ -61,6 +61,11 @@ module FacebookAds
|
|
61
61
|
field :offer_disclaimer, 'string'
|
62
62
|
field :offer_type, 'string'
|
63
63
|
field :price, 'string'
|
64
|
+
field :product_priority_0, 'double'
|
65
|
+
field :product_priority_1, 'double'
|
66
|
+
field :product_priority_2, 'double'
|
67
|
+
field :product_priority_3, 'double'
|
68
|
+
field :product_priority_4, 'double'
|
64
69
|
field :sanitized_images, { list: 'string' }
|
65
70
|
field :start_date, 'string'
|
66
71
|
field :start_time, 'int'
|
@@ -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,12 +50,18 @@ 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",
|
43
61
|
]
|
44
62
|
|
45
63
|
PROVIDER_NAME = [
|
64
|
+
"BILLDESK",
|
46
65
|
"PAYU",
|
47
66
|
"RAZORPAY",
|
48
67
|
"UPI_VPA",
|
@@ -53,7 +72,7 @@ module FacebookAds
|
|
53
72
|
field :account_review_status, 'string'
|
54
73
|
field :analytics, 'object'
|
55
74
|
field :auth_international_rate_eligibility, 'object'
|
56
|
-
field :business_verification_status,
|
75
|
+
field :business_verification_status, { enum: -> { BUSINESS_VERIFICATION_STATUS }}
|
57
76
|
field :country, 'string'
|
58
77
|
field :creation_time, 'int'
|
59
78
|
field :currency, 'string'
|
@@ -95,9 +114,22 @@ module FacebookAds
|
|
95
114
|
edge.get
|
96
115
|
end
|
97
116
|
|
117
|
+
has_edge :call_analytics do |edge|
|
118
|
+
edge.get do |api|
|
119
|
+
api.has_param :country_codes, { list: 'string' }
|
120
|
+
api.has_param :dimensions, { list: { enum: %w{COUNTRY DIRECTION PHONE UNKNOWN }} }
|
121
|
+
api.has_param :directions, { list: { enum: %w{BUSINESS_INITIATED UNKNOWN USER_INITIATED }} }
|
122
|
+
api.has_param :end, 'int'
|
123
|
+
api.has_param :granularity, { enum: %w{DAILY HALF_HOUR MONTHLY }}
|
124
|
+
api.has_param :metric_types, { list: { enum: %w{AVERAGE_DURATION COST COUNT UNKNOWN }} }
|
125
|
+
api.has_param :phone_numbers, { list: 'string' }
|
126
|
+
api.has_param :start, 'int'
|
127
|
+
end
|
128
|
+
end
|
129
|
+
|
98
130
|
has_edge :conversation_analytics do |edge|
|
99
131
|
edge.get do |api|
|
100
|
-
api.has_param :conversation_categories, { list: { enum: %w{AUTHENTICATION AUTHENTICATION_INTERNATIONAL MARKETING
|
132
|
+
api.has_param :conversation_categories, { list: { enum: %w{AUTHENTICATION AUTHENTICATION_INTERNATIONAL MARKETING MARKETING_LITE SERVICE UTILITY }} }
|
101
133
|
api.has_param :conversation_directions, { list: { enum: %w{BUSINESS_INITIATED UNKNOWN USER_INITIATED }} }
|
102
134
|
api.has_param :conversation_types, { list: { enum: %w{FREE_ENTRY_POINT FREE_TIER REGULAR UNKNOWN }} }
|
103
135
|
api.has_param :country_codes, { list: 'string' }
|
@@ -173,10 +205,12 @@ module FacebookAds
|
|
173
205
|
api.has_param :cta_url_link_tracking_opted_out, 'bool'
|
174
206
|
api.has_param :display_format, { enum: -> { WhatsAppBusinessAccount::DISPLAY_FORMAT }}
|
175
207
|
api.has_param :language, 'string'
|
208
|
+
api.has_param :library_template_body_inputs, 'hash'
|
176
209
|
api.has_param :library_template_button_inputs, { list: 'hash' }
|
177
210
|
api.has_param :library_template_name, 'string'
|
178
211
|
api.has_param :message_send_ttl_seconds, 'int'
|
179
212
|
api.has_param :name, 'string'
|
213
|
+
api.has_param :parameter_format, { enum: -> { WhatsAppBusinessAccount::PARAMETER_FORMAT }}
|
180
214
|
api.has_param :sub_category, { enum: -> { WhatsAppBusinessAccount::SUB_CATEGORY }}
|
181
215
|
end
|
182
216
|
end
|
data/lib/facebook_ads/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: facebookbusiness
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 21.0.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Facebook
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-11-16 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: concurrent-ruby
|
@@ -274,6 +274,7 @@ files:
|
|
274
274
|
- lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb
|
275
275
|
- lib/facebook_ads/ad_objects/ad_account_dsa_recommendations.rb
|
276
276
|
- lib/facebook_ads/ad_objects/ad_account_ios_fourteen_campaign_limits.rb
|
277
|
+
- lib/facebook_ads/ad_objects/ad_account_live_video_advertiser.rb
|
277
278
|
- lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb
|
278
279
|
- lib/facebook_ads/ad_objects/ad_account_max_bid.rb
|
279
280
|
- lib/facebook_ads/ad_objects/ad_account_optimization_goals_aemv2_eligibility.rb
|
@@ -393,6 +394,7 @@ files:
|
|
393
394
|
- lib/facebook_ads/ad_objects/ad_creative_platform_customization.rb
|
394
395
|
- lib/facebook_ads/ad_objects/ad_creative_portrait_customizations.rb
|
395
396
|
- lib/facebook_ads/ad_objects/ad_creative_post_click_configuration.rb
|
397
|
+
- lib/facebook_ads/ad_objects/ad_creative_product_data.rb
|
396
398
|
- lib/facebook_ads/ad_objects/ad_creative_promotion_metadata_spec.rb
|
397
399
|
- lib/facebook_ads/ad_objects/ad_creative_recommender_settings.rb
|
398
400
|
- lib/facebook_ads/ad_objects/ad_creative_regional_regulation_disclaimer.rb
|
@@ -500,6 +502,7 @@ files:
|
|
500
502
|
- lib/facebook_ads/ad_objects/ads_pixel_signals_iwl_nux.rb
|
501
503
|
- lib/facebook_ads/ad_objects/ads_pixel_stats.rb
|
502
504
|
- lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb
|
505
|
+
- lib/facebook_ads/ad_objects/ads_quick_views.rb
|
503
506
|
- lib/facebook_ads/ad_objects/ads_report_builder.rb
|
504
507
|
- lib/facebook_ads/ad_objects/ads_report_builder_export_core.rb
|
505
508
|
- lib/facebook_ads/ad_objects/ads_report_builder_mmm_report.rb
|
@@ -526,7 +529,6 @@ files:
|
|
526
529
|
- lib/facebook_ads/ad_objects/alm_guidance_metrics.rb
|
527
530
|
- lib/facebook_ads/ad_objects/am_oneshop_settings.rb
|
528
531
|
- lib/facebook_ads/ad_objects/an_blocked_bi_category.rb
|
529
|
-
- lib/facebook_ads/ad_objects/analytics_cohort_query_result.rb
|
530
532
|
- lib/facebook_ads/ad_objects/analytics_config.rb
|
531
533
|
- lib/facebook_ads/ad_objects/analytics_entity_user_config.rb
|
532
534
|
- lib/facebook_ads/ad_objects/analytics_funnel_query_result.rb
|
@@ -624,6 +626,7 @@ files:
|
|
624
626
|
- lib/facebook_ads/ad_objects/canvas_preview.rb
|
625
627
|
- lib/facebook_ads/ad_objects/canvas_template.rb
|
626
628
|
- lib/facebook_ads/ad_objects/cass_setup_offline_event_set_progress.rb
|
629
|
+
- lib/facebook_ads/ad_objects/catalog_advertiser_insight.rb
|
627
630
|
- lib/facebook_ads/ad_objects/catalog_based_targeting.rb
|
628
631
|
- lib/facebook_ads/ad_objects/catalog_item_app_links.rb
|
629
632
|
- lib/facebook_ads/ad_objects/catalog_item_channels_to_integrity_status.rb
|
@@ -710,7 +713,6 @@ files:
|
|
710
713
|
- lib/facebook_ads/ad_objects/delivery_window.rb
|
711
714
|
- lib/facebook_ads/ad_objects/destination.rb
|
712
715
|
- lib/facebook_ads/ad_objects/direct_debit.rb
|
713
|
-
- lib/facebook_ads/ad_objects/dog_notification_settings.rb
|
714
716
|
- lib/facebook_ads/ad_objects/domain.rb
|
715
717
|
- lib/facebook_ads/ad_objects/draft_post.rb
|
716
718
|
- lib/facebook_ads/ad_objects/dynamic_ar_metadata.rb
|
@@ -743,7 +745,6 @@ files:
|
|
743
745
|
- lib/facebook_ads/ad_objects/external_event_source.rb
|
744
746
|
- lib/facebook_ads/ad_objects/external_event_source_cpas_events_debugging.rb
|
745
747
|
- lib/facebook_ads/ad_objects/external_event_source_cpas_events_debugging_info.rb
|
746
|
-
- lib/facebook_ads/ad_objects/external_event_source_da_stats_result.rb
|
747
748
|
- lib/facebook_ads/ad_objects/external_merchant_settings.rb
|
748
749
|
- lib/facebook_ads/ad_objects/fame_kumo.rb
|
749
750
|
- lib/facebook_ads/ad_objects/fantasy_game.rb
|
@@ -789,6 +790,7 @@ files:
|
|
789
790
|
- lib/facebook_ads/ad_objects/ig_user.rb
|
790
791
|
- lib/facebook_ads/ad_objects/ig_user_export_for_cam.rb
|
791
792
|
- lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb
|
793
|
+
- lib/facebook_ads/ad_objects/ig_user_subscribed_apps_data.rb
|
792
794
|
- lib/facebook_ads/ad_objects/ig_video_copyright_check_matches_information.rb
|
793
795
|
- lib/facebook_ads/ad_objects/ig_video_copyright_check_status.rb
|
794
796
|
- lib/facebook_ads/ad_objects/igbc_ads_permission.rb
|
@@ -842,6 +844,7 @@ files:
|
|
842
844
|
- lib/facebook_ads/ad_objects/linked_instagram_account_data.rb
|
843
845
|
- lib/facebook_ads/ad_objects/live_video.rb
|
844
846
|
- lib/facebook_ads/ad_objects/live_video_ad_break_config.rb
|
847
|
+
- lib/facebook_ads/ad_objects/live_video_ad_campaign_config.rb
|
845
848
|
- lib/facebook_ads/ad_objects/live_video_error.rb
|
846
849
|
- lib/facebook_ads/ad_objects/live_video_input_stream.rb
|
847
850
|
- lib/facebook_ads/ad_objects/live_video_recommended_encoder_settings.rb
|
@@ -873,6 +876,7 @@ files:
|
|
873
876
|
- lib/facebook_ads/ad_objects/messaging_feature_review.rb
|
874
877
|
- lib/facebook_ads/ad_objects/messaging_feature_status.rb
|
875
878
|
- lib/facebook_ads/ad_objects/messenger_ads_partial_automated_step_list.rb
|
879
|
+
- lib/facebook_ads/ad_objects/messenger_business_template.rb
|
876
880
|
- lib/facebook_ads/ad_objects/messenger_call_settings.rb
|
877
881
|
- lib/facebook_ads/ad_objects/messenger_destination_page_welcome_message.rb
|
878
882
|
- lib/facebook_ads/ad_objects/messenger_profile.rb
|
@@ -937,7 +941,6 @@ files:
|
|
937
941
|
- lib/facebook_ads/ad_objects/page_user_message_thread_label.rb
|
938
942
|
- lib/facebook_ads/ad_objects/page_user_permissions.rb
|
939
943
|
- lib/facebook_ads/ad_objects/page_user_with_leads_access.rb
|
940
|
-
- lib/facebook_ads/ad_objects/panel_api_report.rb
|
941
944
|
- lib/facebook_ads/ad_objects/parent_catalog_report.rb
|
942
945
|
- lib/facebook_ads/ad_objects/partner_account_linking.rb
|
943
946
|
- lib/facebook_ads/ad_objects/partner_category.rb
|
@@ -957,6 +960,7 @@ files:
|
|
957
960
|
- lib/facebook_ads/ad_objects/place.rb
|
958
961
|
- lib/facebook_ads/ad_objects/place_tag.rb
|
959
962
|
- lib/facebook_ads/ad_objects/place_topic.rb
|
963
|
+
- lib/facebook_ads/ad_objects/placement.rb
|
960
964
|
- lib/facebook_ads/ad_objects/platform_image_source.rb
|
961
965
|
- lib/facebook_ads/ad_objects/platform_session_key.rb
|
962
966
|
- lib/facebook_ads/ad_objects/playable_content.rb
|