facebookbusiness 21.0.2 → 22.0.1

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 (102) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad_account.rb +33 -3
  3. data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +1 -0
  4. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +35 -0
  5. data/lib/facebook_ads/ad_objects/ad_account_amount_spent_history.rb +28 -0
  6. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +2 -0
  7. data/lib/facebook_ads/ad_objects/ad_account_live_video_advertiser.rb +2 -0
  8. data/lib/facebook_ads/ad_objects/ad_account_optimization_goals_aemv2_eligibility.rb +2 -0
  9. data/lib/facebook_ads/ad_objects/ad_account_spend_cap_change_history.rb +28 -0
  10. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +3 -1
  11. data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb +6 -0
  12. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +5 -0
  13. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +2 -0
  14. data/lib/facebook_ads/ad_objects/ad_campaign_group_advantage_state.rb +28 -0
  15. data/lib/facebook_ads/ad_objects/ad_campaign_issues_info.rb +1 -0
  16. data/lib/facebook_ads/ad_objects/ad_creative.rb +5 -4
  17. data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads.rb +1 -0
  18. data/lib/facebook_ads/ad_objects/ad_creative_feature_customizations.rb +5 -0
  19. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +3 -0
  20. data/lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb +1 -2
  21. data/lib/facebook_ads/ad_objects/ad_creative_regional_regulation_disclaimer.rb +5 -0
  22. data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +1 -0
  23. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +35 -0
  24. data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +1 -0
  25. data/lib/facebook_ads/ad_objects/ad_rule_history.rb +1 -0
  26. data/lib/facebook_ads/ad_objects/ad_set.rb +7 -1
  27. data/lib/facebook_ads/ad_objects/ad_video.rb +15 -23
  28. data/lib/facebook_ads/ad_objects/adgroup_issues_info.rb +1 -0
  29. data/lib/facebook_ads/ad_objects/{parent_catalog_report.rb → ads_eligibility.rb} +2 -3
  30. data/lib/facebook_ads/ad_objects/ads_insights.rb +25 -0
  31. data/lib/facebook_ads/ad_objects/{ads_data_partner.rb → ads_mcme_conversion.rb} +6 -2
  32. data/lib/facebook_ads/ad_objects/{ads_pixel_capi_setup_quality.rb → ads_pixel_capi_integration_quality.rb} +1 -1
  33. data/lib/facebook_ads/ad_objects/ads_quick_views.rb +2 -0
  34. data/lib/facebook_ads/ad_objects/ads_user_settings.rb +6 -0
  35. data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +8 -1
  36. data/lib/facebook_ads/ad_objects/album.rb +1 -0
  37. data/lib/facebook_ads/ad_objects/application.rb +16 -6
  38. data/lib/facebook_ads/ad_objects/audio_visual_reference_match.rb +1 -0
  39. data/lib/facebook_ads/ad_objects/automotive_model.rb +9 -0
  40. data/lib/facebook_ads/ad_objects/branded_content_shadow_ig_media_id.rb +1 -0
  41. data/lib/facebook_ads/ad_objects/business.rb +20 -10
  42. data/lib/facebook_ads/ad_objects/business_agreement.rb +1 -0
  43. data/lib/facebook_ads/ad_objects/business_asset_group.rb +1 -0
  44. data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb +1 -0
  45. data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +1 -0
  46. data/lib/facebook_ads/ad_objects/campaign.rb +1 -0
  47. data/lib/facebook_ads/ad_objects/catalog_collection.rb +27 -0
  48. data/lib/facebook_ads/ad_objects/{domain.rb → catalog_content_version_config.rb} +2 -2
  49. data/lib/facebook_ads/ad_objects/copyright_reference_container.rb +1 -0
  50. data/lib/facebook_ads/ad_objects/{instagram_boostable_media_for_access_token.rb → creative_multicell_test_config.rb} +3 -3
  51. data/lib/facebook_ads/ad_objects/{instagram_video_metadata.rb → ctx_default_optimization_config.rb} +3 -4
  52. data/lib/facebook_ads/ad_objects/custom_audience.rb +11 -1
  53. data/lib/facebook_ads/ad_objects/custom_audience_health.rb +25 -0
  54. data/lib/facebook_ads/ad_objects/destination.rb +4 -0
  55. data/lib/facebook_ads/ad_objects/event.rb +1 -0
  56. data/lib/facebook_ads/ad_objects/fb_image_copyright_match.rb +1 -0
  57. data/lib/facebook_ads/ad_objects/flight.rb +15 -0
  58. data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +1 -0
  59. data/lib/facebook_ads/ad_objects/funding_source_details_coupon_tiering.rb +26 -0
  60. data/lib/facebook_ads/ad_objects/group.rb +1 -0
  61. data/lib/facebook_ads/ad_objects/home_listing.rb +11 -0
  62. data/lib/facebook_ads/ad_objects/hotel.rb +10 -0
  63. data/lib/facebook_ads/ad_objects/ig_media_for_ig_only_api.rb +1 -0
  64. data/lib/facebook_ads/ad_objects/ig_user.rb +28 -0
  65. data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +17 -1
  66. data/lib/facebook_ads/ad_objects/insights_result.rb +17 -0
  67. data/lib/facebook_ads/ad_objects/insights_value.rb +2 -0
  68. data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +1 -0
  69. data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +5 -0
  70. data/lib/facebook_ads/ad_objects/message_delivery_estimate.rb +2 -0
  71. data/lib/facebook_ads/ad_objects/messenger_business_template.rb +2 -0
  72. data/lib/facebook_ads/ad_objects/music_work_copyright.rb +2 -0
  73. data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +0 -2
  74. data/lib/facebook_ads/ad_objects/page.rb +35 -29
  75. data/lib/facebook_ads/ad_objects/page_call_to_action.rb +1 -0
  76. data/lib/facebook_ads/ad_objects/page_change_proposal.rb +0 -2
  77. data/lib/facebook_ads/ad_objects/product_catalog.rb +5 -0
  78. data/lib/facebook_ads/ad_objects/product_item.rb +2 -0
  79. data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +3 -3
  80. data/lib/facebook_ads/ad_objects/recommended_ig_media.rb +0 -1
  81. data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb +6 -0
  82. data/lib/facebook_ads/ad_objects/{private_computation_environment.rb → store_location.rb} +8 -6
  83. data/lib/facebook_ads/ad_objects/targeting_subscriber_universe.rb +27 -0
  84. data/lib/facebook_ads/ad_objects/third_party_partner_lift_request.rb +3 -0
  85. data/lib/facebook_ads/ad_objects/threads_user.rb +26 -0
  86. data/lib/facebook_ads/ad_objects/user.rb +9 -2
  87. data/lib/facebook_ads/ad_objects/vehicle.rb +10 -0
  88. data/lib/facebook_ads/ad_objects/vehicle_offer.rb +11 -0
  89. data/lib/facebook_ads/ad_objects/video_copyright_match.rb +1 -0
  90. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +40 -7
  91. data/lib/facebook_ads/ad_objects/whats_app_business_partner_client_verification_submission.rb +1 -0
  92. data/lib/facebook_ads/version.rb +2 -2
  93. data/lib/facebook_ads.rb +2 -2
  94. metadata +21 -21
  95. data/lib/facebook_ads/ad_objects/instagram_carousel.rb +0 -41
  96. data/lib/facebook_ads/ad_objects/instagram_comment.rb +0 -37
  97. data/lib/facebook_ads/ad_objects/instagram_media.rb +0 -46
  98. data/lib/facebook_ads/ad_objects/marketing_message_targeting.rb +0 -29
  99. data/lib/facebook_ads/ad_objects/merchant_report.rb +0 -39
  100. data/lib/facebook_ads/ad_objects/negative_keyword_list.rb +0 -33
  101. data/lib/facebook_ads/ad_objects/product_catalog_user_permissions.rb +0 -34
  102. data/lib/facebook_ads/ad_objects/video_metrics_report.rb +0 -33
@@ -64,6 +64,7 @@ module FacebookAds
64
64
  "ANALYZE",
65
65
  "CASHIER_ROLE",
66
66
  "CREATE_CONTENT",
67
+ "GLOBAL_STRUCTURE_MANAGEMENT",
67
68
  "MANAGE",
68
69
  "MANAGE_JOBS",
69
70
  "MANAGE_LEADS",
@@ -583,6 +584,7 @@ module FacebookAds
583
584
  "ANALYZE",
584
585
  "CASHIER_ROLE",
585
586
  "CREATE_CONTENT",
587
+ "GLOBAL_STRUCTURE_MANAGEMENT",
586
588
  "MANAGE",
587
589
  "MANAGE_JOBS",
588
590
  "MANAGE_LEADS",
@@ -977,6 +979,15 @@ module FacebookAds
977
979
  end
978
980
  end
979
981
 
982
+ has_edge :ads_dataset do |edge|
983
+ edge.post 'Business' do |api|
984
+ api.has_param :ad_account_id, 'string'
985
+ api.has_param :app_id, 'string'
986
+ api.has_param :is_crm, 'bool'
987
+ api.has_param :name, 'string'
988
+ end
989
+ end
990
+
980
991
  has_edge :ads_reporting_mmm_reports do |edge|
981
992
  edge.get 'AdsReportBuilderMmmReport' do |api|
982
993
  api.has_param :filtering, { list: 'hash' }
@@ -1164,12 +1175,6 @@ module FacebookAds
1164
1175
  end
1165
1176
  end
1166
1177
 
1167
- has_edge :draft_negative_keyword_lists do |edge|
1168
- edge.post do |api|
1169
- api.has_param :negative_keyword_list_file, 'file'
1170
- end
1171
- end
1172
-
1173
1178
  has_edge :event_source_groups do |edge|
1174
1179
  edge.get 'EventSourceGroup'
1175
1180
  edge.post 'EventSourceGroup' do |api|
@@ -1277,8 +1282,10 @@ module FacebookAds
1277
1282
  end
1278
1283
  end
1279
1284
 
1280
- has_edge :negative_keyword_lists do |edge|
1281
- edge.get 'NegativeKeywordList'
1285
+ has_edge :onboard_partners_to_mm_lite do |edge|
1286
+ edge.post do |api|
1287
+ api.has_param :solution_id, 'string'
1288
+ end
1282
1289
  end
1283
1290
 
1284
1291
  has_edge :openbridge_configurations do |edge|
@@ -1290,10 +1297,8 @@ module FacebookAds
1290
1297
  api.has_param :destination_id, 'string'
1291
1298
  api.has_param :endpoint, 'string'
1292
1299
  api.has_param :fallback_domain, 'string'
1293
- api.has_param :fallback_domain_enabled, 'bool'
1294
1300
  api.has_param :first_party_domain, 'string'
1295
1301
  api.has_param :host_business_id, 'int'
1296
- api.has_param :host_external_id, 'string'
1297
1302
  api.has_param :instance_id, 'string'
1298
1303
  api.has_param :instance_version, 'string'
1299
1304
  api.has_param :is_sgw_instance, 'bool'
@@ -1366,6 +1371,7 @@ module FacebookAds
1366
1371
  edge.get 'ProductCatalog'
1367
1372
  edge.post 'ProductCatalog' do |api|
1368
1373
  api.has_param :additional_vertical_option, { enum: -> { ProductCatalog::ADDITIONAL_VERTICAL_OPTION }}
1374
+ api.has_param :business_metadata, 'hash'
1369
1375
  api.has_param :catalog_segment_filter, 'object'
1370
1376
  api.has_param :catalog_segment_product_set_id, 'string'
1371
1377
  api.has_param :da_display_settings, 'object'
@@ -1404,6 +1410,10 @@ module FacebookAds
1404
1410
  end
1405
1411
  end
1406
1412
 
1413
+ has_edge :passback_attribution_metadata_configs do |edge|
1414
+ edge.get
1415
+ end
1416
+
1407
1417
  has_edge :pending_client_ad_accounts do |edge|
1408
1418
  edge.get 'BusinessAdAccountRequest'
1409
1419
  end
@@ -16,6 +16,7 @@ module FacebookAds
16
16
  class BusinessAgreement < AdObject
17
17
  REQUEST_STATUS = [
18
18
  "APPROVE",
19
+ "CANCELED",
19
20
  "DECLINE",
20
21
  "EXPIRED",
21
22
  "IN_PROGRESS",
@@ -35,6 +35,7 @@ module FacebookAds
35
35
  "ANALYZE",
36
36
  "CASHIER_ROLE",
37
37
  "CREATE_CONTENT",
38
+ "GLOBAL_STRUCTURE_MANAGEMENT",
38
39
  "MANAGE",
39
40
  "MANAGE_JOBS",
40
41
  "MANAGE_LEADS",
@@ -16,6 +16,7 @@ module FacebookAds
16
16
  class BusinessAssetSharingAgreement < AdObject
17
17
  REQUEST_STATUS = [
18
18
  "APPROVE",
19
+ "CANCELED",
19
20
  "DECLINE",
20
21
  "EXPIRED",
21
22
  "IN_PROGRESS",
@@ -16,6 +16,7 @@ module FacebookAds
16
16
  class BusinessOwnedObjectOnBehalfOfRequest < AdObject
17
17
  STATUS = [
18
18
  "APPROVE",
19
+ "CANCELED",
19
20
  "DECLINE",
20
21
  "EXPIRED",
21
22
  "IN_PROGRESS",
@@ -389,6 +389,7 @@ module FacebookAds
389
389
 
390
390
  field :account_id, 'string'
391
391
  field :adlabels, { list: 'AdLabel' }
392
+ field :advantage_state_info, 'AdCampaignGroupAdvantageState'
392
393
  field :bid_strategy, { enum: -> { BID_STRATEGY }}
393
394
  field :boosted_object_id, 'string'
394
395
  field :brand_lift_studies, { list: 'AdStudy' }
@@ -0,0 +1,27 @@
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 CatalogCollection < AdObject
17
+
18
+ field :description, 'string'
19
+ field :title, 'string'
20
+ field :url, 'string'
21
+ has_no_id
22
+ has_no_get
23
+ has_no_post
24
+ has_no_delete
25
+
26
+ end
27
+ end
@@ -13,11 +13,11 @@ module FacebookAds
13
13
  # on github and we'll fix in our codegen framework. We'll not be able to accept
14
14
  # pull request for this class.
15
15
 
16
- class Domain < AdObject
16
+ class CatalogContentVersionConfig < AdObject
17
17
 
18
18
  field :id, 'string'
19
19
  field :name, 'string'
20
- field :url, 'string'
20
+ field :version, 'string'
21
21
  has_no_post
22
22
  has_no_delete
23
23
 
@@ -22,6 +22,7 @@ module FacebookAds
22
22
  field :id, 'string'
23
23
  field :iswc, 'string'
24
24
  field :metadata, 'object'
25
+ field :playable_video_uri, 'string'
25
26
  field :published_time, 'datetime'
26
27
  field :thumbnail_url, 'string'
27
28
  field :title, 'string'
@@ -13,10 +13,10 @@ module FacebookAds
13
13
  # on github and we'll fix in our codegen framework. We'll not be able to accept
14
14
  # pull request for this class.
15
15
 
16
- class InstagramBoostableMediaForAccessToken < AdObject
16
+ class CreativeMulticellTestConfig < AdObject
17
17
 
18
- field :has_product_tags, 'bool'
19
- field :media, 'IgMedia'
18
+ field :daily_budget, 'int'
19
+ field :lifetime_budget, 'int'
20
20
  has_no_id
21
21
  has_no_get
22
22
  has_no_post
@@ -13,11 +13,10 @@ module FacebookAds
13
13
  # on github and we'll fix in our codegen framework. We'll not be able to accept
14
14
  # pull request for this class.
15
15
 
16
- class InstagramVideoMetadata < AdObject
16
+ class CtxDefaultOptimizationConfig < AdObject
17
17
 
18
- field :duration, 'double'
19
- field :height, 'double'
20
- field :width, 'double'
18
+ field :objective, 'string'
19
+ field :optimization_goal, 'string'
21
20
  has_no_id
22
21
  has_no_get
23
22
  has_no_post
@@ -71,7 +71,6 @@ module FacebookAds
71
71
  "PRIMARY",
72
72
  "REGULATED_CATEGORIES_AUDIENCE",
73
73
  "STUDY_RULE_AUDIENCE",
74
- "SUBSCRIBER_SEGMENT",
75
74
  "VIDEO",
76
75
  "WEBSITE",
77
76
  ]
@@ -102,6 +101,7 @@ module FacebookAds
102
101
  field :household_audience, 'int'
103
102
  field :id, 'string'
104
103
  field :included_custom_audiences, { list: 'CustomAudience' }
104
+ field :is_eligible_for_sac_campaigns, 'bool'
105
105
  field :is_household, 'bool'
106
106
  field :is_snapshot, 'bool'
107
107
  field :is_value_based, 'bool'
@@ -174,6 +174,16 @@ module FacebookAds
174
174
  end
175
175
  end
176
176
 
177
+ has_edge :health do |edge|
178
+ edge.get 'CustomAudienceHealth' do |api|
179
+ api.has_param :calculated_date, 'string'
180
+ api.has_param :processed_date, 'string'
181
+ api.has_param :value_aggregation_duration, 'int'
182
+ api.has_param :value_currency, 'string'
183
+ api.has_param :value_version, 'int'
184
+ end
185
+ end
186
+
177
187
  has_edge :salts do |edge|
178
188
  edge.get 'CustomAudienceSalts' do |api|
179
189
  api.has_param :params, { list: 'string' }
@@ -0,0 +1,25 @@
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 CustomAudienceHealth < AdObject
17
+
18
+ field :health, { list: 'object' }
19
+ has_no_id
20
+ has_no_get
21
+ has_no_post
22
+ has_no_delete
23
+
24
+ end
25
+ end
@@ -36,9 +36,13 @@ module FacebookAds
36
36
  field :custom_label_0, 'string'
37
37
  field :custom_label_1, 'string'
38
38
  field :custom_label_2, 'string'
39
+ field :custom_label_3, 'string'
40
+ field :custom_label_4, 'string'
39
41
  field :custom_number_0, 'int'
40
42
  field :custom_number_1, 'int'
41
43
  field :custom_number_2, 'int'
44
+ field :custom_number_3, 'int'
45
+ field :custom_number_4, 'int'
42
46
  field :description, 'string'
43
47
  field :destination_id, 'string'
44
48
  field :id, 'string'
@@ -52,6 +52,7 @@ module FacebookAds
52
52
  "community",
53
53
  "friends",
54
54
  "group",
55
+ "messenger_community",
55
56
  "private",
56
57
  "public",
57
58
  "work_company",
@@ -20,6 +20,7 @@ module FacebookAds
20
20
  field :audit_log, { list: 'object' }
21
21
  field :available_ui_actions, { list: 'string' }
22
22
  field :expiration_days, 'int'
23
+ field :generic_match_data, { list: 'object' }
23
24
  field :id, 'string'
24
25
  field :is_business_page_match, 'bool'
25
26
  field :last_modified_time, 'datetime'
@@ -32,6 +32,16 @@ module FacebookAds
32
32
  field :applinks, 'CatalogItemAppLinks'
33
33
  field :category_specific_fields, 'CatalogSubVerticalList'
34
34
  field :currency, 'string'
35
+ field :custom_label_0, 'string'
36
+ field :custom_label_1, 'string'
37
+ field :custom_label_2, 'string'
38
+ field :custom_label_3, 'string'
39
+ field :custom_label_4, 'string'
40
+ field :custom_number_0, 'int'
41
+ field :custom_number_1, 'int'
42
+ field :custom_number_2, 'int'
43
+ field :custom_number_3, 'int'
44
+ field :custom_number_4, 'int'
35
45
  field :description, 'string'
36
46
  field :destination_airport, 'string'
37
47
  field :destination_city, 'string'
@@ -44,6 +54,11 @@ module FacebookAds
44
54
  field :origin_airport, 'string'
45
55
  field :origin_city, 'string'
46
56
  field :price, 'string'
57
+ field :product_priority_0, 'double'
58
+ field :product_priority_1, 'double'
59
+ field :product_priority_2, 'double'
60
+ field :product_priority_3, 'double'
61
+ field :product_priority_4, 'double'
47
62
  field :sanitized_images, { list: 'string' }
48
63
  field :tags, { list: 'string' }
49
64
  field :unit_price, 'object'
@@ -18,6 +18,7 @@ module FacebookAds
18
18
  field :amount, 'int'
19
19
  field :campaign_ids, { list: 'int' }
20
20
  field :coupon_id, 'string'
21
+ field :coupon_tiering, 'FundingSourceDetailsCouponTiering'
21
22
  field :currency, 'string'
22
23
  field :display_amount, 'string'
23
24
  field :expiration, 'datetime'
@@ -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 FundingSourceDetailsCouponTiering < AdObject
17
+
18
+ field :coupon_tiering_new, 'object'
19
+ field :coupon_tiering_reactivation, 'object'
20
+ has_no_id
21
+ has_no_get
22
+ has_no_post
23
+ has_no_delete
24
+
25
+ end
26
+ end
@@ -354,6 +354,7 @@ module FacebookAds
354
354
  api.has_param :place, 'object'
355
355
  api.has_param :privacy, 'string'
356
356
  api.has_param :profile_id, 'int'
357
+ api.has_param :provenance_info, 'hash'
357
358
  api.has_param :proxied_app_id, 'string'
358
359
  api.has_param :published, 'bool'
359
360
  api.has_param :qn, 'string'
@@ -44,6 +44,16 @@ module FacebookAds
44
44
  field :category_specific_fields, 'CatalogSubVerticalList'
45
45
  field :co_2_emission_rating_eu, 'object'
46
46
  field :currency, 'string'
47
+ field :custom_label_0, 'string'
48
+ field :custom_label_1, 'string'
49
+ field :custom_label_2, 'string'
50
+ field :custom_label_3, 'string'
51
+ field :custom_label_4, 'string'
52
+ field :custom_number_0, 'int'
53
+ field :custom_number_1, 'int'
54
+ field :custom_number_2, 'int'
55
+ field :custom_number_3, 'int'
56
+ field :custom_number_4, 'int'
47
57
  field :days_on_market, 'int'
48
58
  field :description, 'string'
49
59
  field :energy_rating_eu, 'object'
@@ -71,6 +81,7 @@ module FacebookAds
71
81
  field :price, 'string'
72
82
  field :property_type, 'string'
73
83
  field :sanitized_images, { list: 'string' }
84
+ field :tags, { list: 'string' }
74
85
  field :unit_price, 'object'
75
86
  field :url, 'string'
76
87
  field :visibility, { enum: -> { VISIBILITY }}
@@ -35,6 +35,16 @@ module FacebookAds
35
35
  field :category, 'string'
36
36
  field :category_specific_fields, 'CatalogSubVerticalList'
37
37
  field :currency, 'string'
38
+ field :custom_label_0, 'string'
39
+ field :custom_label_1, 'string'
40
+ field :custom_label_2, 'string'
41
+ field :custom_label_3, 'string'
42
+ field :custom_label_4, 'string'
43
+ field :custom_number_0, 'int'
44
+ field :custom_number_1, 'int'
45
+ field :custom_number_2, 'int'
46
+ field :custom_number_3, 'int'
47
+ field :custom_number_4, 'int'
38
48
  field :description, 'string'
39
49
  field :guest_ratings, 'string'
40
50
  field :hotel_id, 'string'
@@ -15,6 +15,7 @@ module FacebookAds
15
15
 
16
16
  class IgMediaForIgOnlyApi < AdObject
17
17
 
18
+ field :alt_text, 'string'
18
19
  field :caption, 'string'
19
20
  field :comments_count, 'int'
20
21
  field :id, 'string'
@@ -19,8 +19,10 @@ module FacebookAds
19
19
  field :business_discovery, 'IgUser'
20
20
  field :followers_count, 'int'
21
21
  field :follows_count, 'int'
22
+ field :has_profile_pic, 'bool'
22
23
  field :id, 'string'
23
24
  field :ig_id, 'int'
25
+ field :is_published, 'bool'
24
26
  field :legacy_instagram_user_id, 'string'
25
27
  field :media_count, 'int'
26
28
  field :mentioned_comment, 'IgComment'
@@ -35,6 +37,20 @@ module FacebookAds
35
37
  has_no_post
36
38
  has_no_delete
37
39
 
40
+ has_edge :agencies do |edge|
41
+ edge.get 'Business'
42
+ end
43
+
44
+ has_edge :authorized_adaccounts do |edge|
45
+ edge.get 'AdAccount' do |api|
46
+ api.has_param :business, 'string'
47
+ end
48
+ edge.post 'IgUser' do |api|
49
+ api.has_param :account_id, 'string'
50
+ api.has_param :business, 'string'
51
+ end
52
+ end
53
+
38
54
  has_edge :available_catalogs do |edge|
39
55
  edge.get 'UserAvailableCatalogs'
40
56
  end
@@ -53,6 +69,7 @@ module FacebookAds
53
69
  api.has_param :ad_code, 'string'
54
70
  api.has_param :creator_username, 'string'
55
71
  api.has_param :only_fetch_allowlisted, 'bool'
72
+ api.has_param :only_fetch_recommended_content, 'bool'
56
73
  api.has_param :permalinks, { list: 'string' }
57
74
  end
58
75
  end
@@ -76,6 +93,10 @@ module FacebookAds
76
93
  end
77
94
  end
78
95
 
96
+ has_edge :connected_threads_user do |edge|
97
+ edge.get 'ThreadsUser'
98
+ end
99
+
79
100
  has_edge :content_publishing_limit do |edge|
80
101
  edge.get 'ContentPublishingLimitResponse' do |api|
81
102
  api.has_param :since, 'datetime'
@@ -101,6 +122,11 @@ module FacebookAds
101
122
  end
102
123
  end
103
124
 
125
+ has_edge :instagram_backed_threads_user do |edge|
126
+ edge.get 'ThreadsUser'
127
+ edge.post 'ThreadsUser'
128
+ end
129
+
104
130
  has_edge :live_media do |edge|
105
131
  edge.get 'IgMedia' do |api|
106
132
  api.has_param :since, 'datetime'
@@ -114,6 +140,7 @@ module FacebookAds
114
140
  api.has_param :until, 'datetime'
115
141
  end
116
142
  edge.post 'IgMedia' do |api|
143
+ api.has_param :alt_text, 'string'
117
144
  api.has_param :audio_name, 'string'
118
145
  api.has_param :caption, 'string'
119
146
  api.has_param :children, { list: 'string' }
@@ -173,6 +200,7 @@ module FacebookAds
173
200
  end
174
201
 
175
202
  has_edge :upcoming_events do |edge|
203
+ edge.get 'IgUpcomingEvent'
176
204
  edge.post do |api|
177
205
  api.has_param :end_time, 'datetime'
178
206
  api.has_param :notification_subtypes, { list: { enum: %w{AFTER_EVENT_1DAY AFTER_EVENT_2DAY AFTER_EVENT_3DAY AFTER_EVENT_4DAY AFTER_EVENT_5DAY AFTER_EVENT_6DAY AFTER_EVENT_7DAY BEFORE_EVENT_15MIN BEFORE_EVENT_1DAY BEFORE_EVENT_1HOUR BEFORE_EVENT_2DAY EVENT_START RESCHEDULED }} }
@@ -44,6 +44,18 @@ module FacebookAds
44
44
  end
45
45
  end
46
46
 
47
+ has_edge :insights do |edge|
48
+ edge.get 'InsightsResult' do |api|
49
+ api.has_param :breakdown, { list: { enum: -> { InsightsResult::BREAKDOWN }} }
50
+ api.has_param :metric, { list: { enum: -> { InsightsResult::METRIC }} }
51
+ api.has_param :metric_type, { enum: -> { InsightsResult::METRIC_TYPE }}
52
+ api.has_param :period, { list: { enum: -> { InsightsResult::PERIOD }} }
53
+ api.has_param :since, 'datetime'
54
+ api.has_param :timeframe, { enum: -> { InsightsResult::TIMEFRAME }}
55
+ api.has_param :until, 'datetime'
56
+ end
57
+ end
58
+
47
59
  has_edge :live_media do |edge|
48
60
  edge.get
49
61
  end
@@ -54,6 +66,7 @@ module FacebookAds
54
66
  api.has_param :until, 'datetime'
55
67
  end
56
68
  edge.post do |api|
69
+ api.has_param :alt_text, 'string'
57
70
  api.has_param :audio_name, 'string'
58
71
  api.has_param :caption, 'string'
59
72
  api.has_param :children, { list: 'string' }
@@ -123,7 +136,7 @@ module FacebookAds
123
136
  edge.delete
124
137
  edge.get
125
138
  edge.post do |api|
126
- api.has_param :subscribed_fields, { list: { enum: %w{comments creator_marketplace_invited_creator_onboarding creator_marketplace_projects delta live_comments mentions message_reactions messages messaging_handover messaging_optins messaging_postbacks messaging_referral messaging_seen standby story_insights }} }
139
+ api.has_param :subscribed_fields, { list: { enum: %w{comments creator_marketplace_invited_creator_onboarding creator_marketplace_projects delta live_comments mentions message_reactions messages messaging_handover messaging_optins messaging_postbacks messaging_referral messaging_seen onboarding_welcome_message_series standby story_insights story_reactions }} }
127
140
  end
128
141
  end
129
142
 
@@ -132,6 +145,9 @@ module FacebookAds
132
145
  end
133
146
 
134
147
  has_edge :welcome_message_flows do |edge|
148
+ edge.delete do |api|
149
+ api.has_param :flow_id, 'string'
150
+ end
135
151
  edge.get 'CtxPartnerAppWelcomeMessageFlow' do |api|
136
152
  api.has_param :app_id, 'string'
137
153
  api.has_param :flow_id, 'string'
@@ -24,6 +24,7 @@ module FacebookAds
24
24
  METRIC = [
25
25
  "clips_replays_count",
26
26
  "comments",
27
+ "content_views",
27
28
  "follows",
28
29
  "ig_reels_aggregated_all_plays_count",
29
30
  "ig_reels_avg_watch_time",
@@ -43,6 +44,7 @@ module FacebookAds
43
44
  "shares",
44
45
  "thread_replies",
45
46
  "thread_shares",
47
+ "threads_views",
46
48
  "total_interactions",
47
49
  "video_views",
48
50
  "views",
@@ -80,6 +82,21 @@ module FacebookAds
80
82
  "yesterday",
81
83
  ]
82
84
 
85
+ METRIC_TYPE = [
86
+ "default",
87
+ "time_series",
88
+ "total_value",
89
+ ]
90
+
91
+ TIMEFRAME = [
92
+ "last_14_days",
93
+ "last_30_days",
94
+ "last_90_days",
95
+ "prev_month",
96
+ "this_month",
97
+ "this_week",
98
+ ]
99
+
83
100
 
84
101
  field :description, 'string'
85
102
  field :description_from_api_doc, 'string'
@@ -16,10 +16,12 @@ module FacebookAds
16
16
  class InsightsValue < AdObject
17
17
 
18
18
  field :campaign_id, 'string'
19
+ field :earning_source, 'string'
19
20
  field :end_time, 'datetime'
20
21
  field :engagement_source, 'string'
21
22
  field :message_type, 'string'
22
23
  field :messaging_channel, 'string'
24
+ field :monetization_tool, 'string'
23
25
  field :recurring_notifications_entry_point, 'string'
24
26
  field :recurring_notifications_frequency, 'string'
25
27
  field :recurring_notifications_topic, 'string'
@@ -40,6 +40,7 @@ module FacebookAds
40
40
  "shares",
41
41
  "total_interactions",
42
42
  "video_views",
43
+ "views",
43
44
  ]
44
45
 
45
46
  PERIOD = [
@@ -21,6 +21,8 @@ module FacebookAds
21
21
  field :chat_on_whatsapp_text, 'string'
22
22
  field :contact_information_text, 'string'
23
23
  field :creatives_overview_default_text, 'string'
24
+ field :custom_disclaimer_editor_state, 'string'
25
+ field :custom_disclaimer_title, 'string'
24
26
  field :data_privacy_policy_setting_description, 'string'
25
27
  field :default_appointment_scheduling_inline_context, 'string'
26
28
  field :default_disqualified_end_component, 'object'
@@ -43,13 +45,16 @@ module FacebookAds
43
45
  field :personal_info_text, 'string'
44
46
  field :phone_number_inline_context_text, 'string'
45
47
  field :privacy_policy_link_text, 'string'
48
+ field :privacy_policy_link_text_for_optional_privacy_policy, 'string'
46
49
  field :privacy_policy_title_section_title_text, 'string'
47
50
  field :privacy_setting_description, 'string'
48
51
  field :products_section_headers, { list: 'hash' }
49
52
  field :qualified_thank_you_card_transparency_info_text, 'string'
50
53
  field :redeem_promo_code_text, 'string'
54
+ field :return_to_facebook_text, 'string'
51
55
  field :review_your_info_text, 'string'
52
56
  field :secure_sharing_text, 'string'
57
+ field :secure_sharing_text_for_optional_privacy_policy, 'string'
53
58
  field :slide_to_submit_text, 'string'
54
59
  field :social_proof_section_headers, { list: 'hash' }
55
60
  field :submit_button_text, 'string'
@@ -15,6 +15,7 @@ module FacebookAds
15
15
 
16
16
  class MessageDeliveryEstimate < AdObject
17
17
  OPTIMIZATION_GOAL = [
18
+ "ADVERTISER_SILOED_VALUE",
18
19
  "AD_RECALL_LIFT",
19
20
  "APP_INSTALLS",
20
21
  "APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
@@ -34,6 +35,7 @@ module FacebookAds
34
35
  "OFFSITE_CONVERSIONS",
35
36
  "PAGE_LIKES",
36
37
  "POST_ENGAGEMENT",
38
+ "PROFILE_AND_PAGE_ENGAGEMENT",
37
39
  "PROFILE_VISIT",
38
40
  "QUALITY_CALL",
39
41
  "QUALITY_LEAD",