facebookbusiness 20.0.3 → 21.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.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad.rb +1 -0
  3. data/lib/facebook_ads/ad_objects/ad_account.rb +18 -6
  4. data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +4 -0
  5. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +21 -0
  6. data/lib/facebook_ads/ad_objects/{external_event_source_da_stats_result.rb → ad_account_live_video_advertiser.rb} +4 -7
  7. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +1 -0
  8. data/lib/facebook_ads/ad_objects/ad_activity.rb +3 -0
  9. data/lib/facebook_ads/ad_objects/ad_creative.rb +1 -0
  10. data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads.rb +2 -0
  11. data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads_partners.rb +1 -0
  12. data/lib/facebook_ads/ad_objects/ad_creative_features_spec.rb +10 -0
  13. data/lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb +2 -1
  14. data/lib/facebook_ads/ad_objects/{dog_notification_settings.rb → ad_creative_product_data.rb} +5 -4
  15. data/lib/facebook_ads/ad_objects/ad_preview.rb +1 -0
  16. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +3 -0
  17. data/lib/facebook_ads/ad_objects/ad_rule.rb +1 -0
  18. data/lib/facebook_ads/ad_objects/ad_rule_history.rb +4 -0
  19. data/lib/facebook_ads/ad_objects/ad_set.rb +4 -0
  20. data/lib/facebook_ads/ad_objects/ad_video.rb +1 -3
  21. data/lib/facebook_ads/ad_objects/ads_insights.rb +3 -4
  22. data/lib/facebook_ads/ad_objects/{panel_api_report.rb → ads_quick_views.rb} +7 -9
  23. data/lib/facebook_ads/ad_objects/ads_user_settings.rb +2 -0
  24. data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +1 -1
  25. data/lib/facebook_ads/ad_objects/alm_ad_account_info.rb +1 -0
  26. data/lib/facebook_ads/ad_objects/application.rb +7 -23
  27. data/lib/facebook_ads/ad_objects/business.rb +1 -3
  28. data/lib/facebook_ads/ad_objects/campaign.rb +2 -0
  29. data/lib/facebook_ads/ad_objects/catalog_item_rejection_reasons.rb +1 -10
  30. data/lib/facebook_ads/ad_objects/ctwa_whats_app_numbers_info.rb +1 -0
  31. data/lib/facebook_ads/ad_objects/custom_audience.rb +15 -0
  32. data/lib/facebook_ads/ad_objects/extended_credit.rb +13 -0
  33. data/lib/facebook_ads/ad_objects/group.rb +3 -21
  34. data/lib/facebook_ads/ad_objects/hotel.rb +5 -0
  35. data/lib/facebook_ads/ad_objects/ig_media_for_ig_only_api.rb +8 -0
  36. data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +6 -0
  37. data/lib/facebook_ads/ad_objects/insights_result.rb +43 -19
  38. data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +1 -0
  39. data/lib/facebook_ads/ad_objects/messenger_business_template.rb +33 -0
  40. data/lib/facebook_ads/ad_objects/page.rb +7 -7
  41. data/lib/facebook_ads/ad_objects/partnership_ad_content_search_media.rb +3 -0
  42. data/lib/facebook_ads/ad_objects/placement.rb +52 -0
  43. data/lib/facebook_ads/ad_objects/product_catalog.rb +6 -0
  44. data/lib/facebook_ads/ad_objects/product_catalog_diagnostic_group.rb +18 -18
  45. data/lib/facebook_ads/ad_objects/product_feed.rb +1 -0
  46. data/lib/facebook_ads/ad_objects/product_item.rb +9 -0
  47. data/lib/facebook_ads/ad_objects/saved_message_response.rb +0 -1
  48. data/lib/facebook_ads/ad_objects/server_side/app_data.rb +23 -3
  49. data/lib/facebook_ads/ad_objects/user.rb +5 -9
  50. data/lib/facebook_ads/ad_objects/vehicle.rb +5 -0
  51. data/lib/facebook_ads/ad_objects/vehicle_offer.rb +5 -0
  52. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +15 -0
  53. data/lib/facebook_ads/version.rb +2 -2
  54. metadata +7 -5
@@ -50,6 +50,9 @@ module FacebookAds
50
50
  # Attribution token used for Windows 10.
51
51
  attr_accessor :windows_attribution_id
52
52
 
53
+ # An encrypted string and non-user metadata appended to the outbound URL (for example, ad_destination_url) or deep link (for App Aggregated Event Manager) when a user clicked on a link from Facebook.
54
+ attr_accessor :campaign_ids
55
+
53
56
  # @param [Boolean] application_tracking_enabled
54
57
  # @param [Boolean] advertiser_tracking_enabled
55
58
  # @param [Boolean] consider_views
@@ -60,6 +63,7 @@ module FacebookAds
60
63
  # @param [String] installer_package
61
64
  # @param [Array<String>] url_schemes
62
65
  # @param [String] windows_attribution_id
66
+ # @param [String] campaign_ids
63
67
  def initialize(application_tracking_enabled: nil,
64
68
  advertiser_tracking_enabled: nil,
65
69
  consider_views: nil,
@@ -69,7 +73,8 @@ module FacebookAds
69
73
  install_referrer: nil,
70
74
  installer_package: nil,
71
75
  url_schemes: nil,
72
- windows_attribution_id: nil)
76
+ windows_attribution_id: nil,
77
+ campaign_ids: nil)
73
78
 
74
79
  unless application_tracking_enabled.nil?
75
80
  self.application_tracking_enabled = application_tracking_enabled
@@ -101,6 +106,9 @@ module FacebookAds
101
106
  unless windows_attribution_id.nil?
102
107
  self.windows_attribution_id = windows_attribution_id
103
108
  end
109
+ unless campaign_ids.nil?
110
+ self.campaign_ids = campaign_ids
111
+ end
104
112
  end
105
113
 
106
114
  # build the object using the input hash
@@ -151,6 +159,10 @@ module FacebookAds
151
159
  if attributes.has_key?(:'windows_attribution_id')
152
160
  self.windows_attribution_id = attributes[:'windows_attribution_id']
153
161
  end
162
+
163
+ if attributes.has_key?(:'campaign_ids')
164
+ self.campaign_ids = attributes[:'campaign_ids']
165
+ end
154
166
  end
155
167
 
156
168
  # Checks equality by comparing each attribute.
@@ -166,7 +178,8 @@ module FacebookAds
166
178
  install_referrer == o.install_referrer &&
167
179
  installer_package == o.installer_package &&
168
180
  url_schemes == o.url_schemes &&
169
- windows_attribution_id == o.windows_attribution_id
181
+ windows_attribution_id == o.windows_attribution_id &&
182
+ campaign_ids == o.campaign_ids
170
183
  end
171
184
 
172
185
  # @see the `==` method
@@ -187,7 +200,8 @@ module FacebookAds
187
200
  install_referrer,
188
201
  installer_package,
189
202
  url_schemes,
190
- windows_attribution_id
203
+ windows_attribution_id,
204
+ campaign_ids
191
205
  ].hash
192
206
  end
193
207
 
@@ -225,6 +239,9 @@ module FacebookAds
225
239
  unless windows_attribution_id.nil?
226
240
  hash['windows_attribution_id'] = windows_attribution_id
227
241
  end
242
+ unless campaign_ids.nil?
243
+ hash['campaign_ids'] = campaign_ids
244
+ end
228
245
  hash.to_s
229
246
  end
230
247
 
@@ -258,6 +275,9 @@ module FacebookAds
258
275
  unless windows_attribution_id.nil?
259
276
  hash['windows_attribution_id'] = windows_attribution_id
260
277
  end
278
+ unless campaign_ids.nil?
279
+ hash['campaign_ids'] = campaign_ids
280
+ end
261
281
 
262
282
  unless extinfo.nil?
263
283
  hash['extinfo'] = extinfo.normalize
@@ -89,9 +89,9 @@ module FacebookAds
89
89
  has_edge :access_tokens do |edge|
90
90
  edge.delete
91
91
  edge.post 'User' do |api|
92
- api.has_param :business_app, 'int'
92
+ api.has_param :business_app, 'string'
93
93
  api.has_param :page_id, 'string'
94
- api.has_param :scope, { list: 'Permission' }
94
+ api.has_param :scope, { list: 'string' }
95
95
  api.has_param :set_token_expires_in_60_days, 'bool'
96
96
  end
97
97
  end
@@ -248,7 +248,7 @@ module FacebookAds
248
248
  api.has_param :android_key_hash, 'string'
249
249
  api.has_param :application_id, 'string'
250
250
  api.has_param :asked_fun_fact_prompt_id, 'int'
251
- api.has_param :asset3d_id, 'int'
251
+ api.has_param :asset3d_id, 'string'
252
252
  api.has_param :associated_id, 'string'
253
253
  api.has_param :attach_place_suggestion, 'bool'
254
254
  api.has_param :attached_media, { list: 'object' }
@@ -279,10 +279,9 @@ module FacebookAds
279
279
  api.has_param :expanded_width, 'int'
280
280
  api.has_param :feed_targeting, 'object'
281
281
  api.has_param :formatting, { enum: -> { Post::FORMATTING }}
282
- api.has_param :fun_fact_prompt_id, 'int'
282
+ api.has_param :fun_fact_prompt_id, 'string'
283
283
  api.has_param :fun_fact_toastee_id, 'int'
284
284
  api.has_param :height, 'int'
285
- api.has_param :holiday_card, 'string'
286
285
  api.has_param :home_checkin_city_id, 'object'
287
286
  api.has_param :image_crops, 'hash'
288
287
  api.has_param :implicit_with_tags, { list: 'int' }
@@ -303,7 +302,6 @@ module FacebookAds
303
302
  api.has_param :name, 'string'
304
303
  api.has_param :nectar_module, 'string'
305
304
  api.has_param :object_attachment, 'string'
306
- api.has_param :offer_like_post_id, 'int'
307
305
  api.has_param :og_action_type_id, 'string'
308
306
  api.has_param :og_hide_object_attachment, 'bool'
309
307
  api.has_param :og_icon_id, 'string'
@@ -605,11 +603,10 @@ module FacebookAds
605
603
  api.has_param :formatting, { enum: -> { AdVideo::FORMATTING }}
606
604
  api.has_param :fov, 'int'
607
605
  api.has_param :front_z_rotation, 'double'
608
- api.has_param :fun_fact_prompt_id, 'int'
606
+ api.has_param :fun_fact_prompt_id, 'string'
609
607
  api.has_param :fun_fact_toastee_id, 'int'
610
608
  api.has_param :guide, { list: { list: 'int' } }
611
609
  api.has_param :guide_enabled, 'bool'
612
- api.has_param :holiday_card, 'string'
613
610
  api.has_param :initial_heading, 'int'
614
611
  api.has_param :initial_pitch, 'int'
615
612
  api.has_param :instant_game_entry_point_data, 'string'
@@ -620,7 +617,6 @@ module FacebookAds
620
617
  api.has_param :location_source_id, 'string'
621
618
  api.has_param :manual_privacy, 'bool'
622
619
  api.has_param :no_story, 'bool'
623
- api.has_param :offer_like_post_id, 'int'
624
620
  api.has_param :og_action_type_id, 'string'
625
621
  api.has_param :og_icon_id, 'string'
626
622
  api.has_param :og_object_id, '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'
@@ -43,6 +43,7 @@ module FacebookAds
43
43
  ]
44
44
 
45
45
  PROVIDER_NAME = [
46
+ "BILLDESK",
46
47
  "PAYU",
47
48
  "RAZORPAY",
48
49
  "UPI_VPA",
@@ -95,6 +96,19 @@ module FacebookAds
95
96
  edge.get
96
97
  end
97
98
 
99
+ has_edge :call_analytics do |edge|
100
+ edge.get do |api|
101
+ api.has_param :country_codes, { list: 'string' }
102
+ api.has_param :dimensions, { list: { enum: %w{COUNTRY DIRECTION PHONE UNKNOWN }} }
103
+ api.has_param :directions, { list: { enum: %w{BUSINESS_INITIATED UNKNOWN USER_INITIATED }} }
104
+ api.has_param :end, 'int'
105
+ api.has_param :granularity, { enum: %w{DAILY HALF_HOUR MONTHLY }}
106
+ api.has_param :metric_types, { list: { enum: %w{AVERAGE_DURATION COST COUNT UNKNOWN }} }
107
+ api.has_param :phone_numbers, { list: 'string' }
108
+ api.has_param :start, 'int'
109
+ end
110
+ end
111
+
98
112
  has_edge :conversation_analytics do |edge|
99
113
  edge.get do |api|
100
114
  api.has_param :conversation_categories, { list: { enum: %w{AUTHENTICATION AUTHENTICATION_INTERNATIONAL MARKETING MARKETING_OPTIMIZED_DELIVERY SERVICE UNKNOWN UTILITY UTILITY_FIXED_TEMPLATE }} }
@@ -173,6 +187,7 @@ module FacebookAds
173
187
  api.has_param :cta_url_link_tracking_opted_out, 'bool'
174
188
  api.has_param :display_format, { enum: -> { WhatsAppBusinessAccount::DISPLAY_FORMAT }}
175
189
  api.has_param :language, 'string'
190
+ api.has_param :library_template_body_inputs, 'hash'
176
191
  api.has_param :library_template_button_inputs, { list: 'hash' }
177
192
  api.has_param :library_template_name, 'string'
178
193
  api.has_param :message_send_ttl_seconds, 'int'
@@ -7,6 +7,6 @@
7
7
  # FB:AUTOGEN
8
8
 
9
9
  module FacebookAds
10
- VERSION = '20.0.3'
11
- API_VERSION = '20.0'
10
+ VERSION = '21.0.0'
11
+ API_VERSION = '21.0'
12
12
  end
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: 20.0.3
4
+ version: 21.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Facebook
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-09-18 00:00:00.000000000 Z
11
+ date: 2024-10-09 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
@@ -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
@@ -873,6 +874,7 @@ files:
873
874
  - lib/facebook_ads/ad_objects/messaging_feature_review.rb
874
875
  - lib/facebook_ads/ad_objects/messaging_feature_status.rb
875
876
  - lib/facebook_ads/ad_objects/messenger_ads_partial_automated_step_list.rb
877
+ - lib/facebook_ads/ad_objects/messenger_business_template.rb
876
878
  - lib/facebook_ads/ad_objects/messenger_call_settings.rb
877
879
  - lib/facebook_ads/ad_objects/messenger_destination_page_welcome_message.rb
878
880
  - lib/facebook_ads/ad_objects/messenger_profile.rb
@@ -937,7 +939,6 @@ files:
937
939
  - lib/facebook_ads/ad_objects/page_user_message_thread_label.rb
938
940
  - lib/facebook_ads/ad_objects/page_user_permissions.rb
939
941
  - lib/facebook_ads/ad_objects/page_user_with_leads_access.rb
940
- - lib/facebook_ads/ad_objects/panel_api_report.rb
941
942
  - lib/facebook_ads/ad_objects/parent_catalog_report.rb
942
943
  - lib/facebook_ads/ad_objects/partner_account_linking.rb
943
944
  - lib/facebook_ads/ad_objects/partner_category.rb
@@ -957,6 +958,7 @@ files:
957
958
  - lib/facebook_ads/ad_objects/place.rb
958
959
  - lib/facebook_ads/ad_objects/place_tag.rb
959
960
  - lib/facebook_ads/ad_objects/place_topic.rb
961
+ - lib/facebook_ads/ad_objects/placement.rb
960
962
  - lib/facebook_ads/ad_objects/platform_image_source.rb
961
963
  - lib/facebook_ads/ad_objects/platform_session_key.rb
962
964
  - lib/facebook_ads/ad_objects/playable_content.rb