facebookbusiness 22.0.2 → 23.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 (97) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad.rb +3 -0
  3. data/lib/facebook_ads/ad_objects/ad_account.rb +23 -40
  4. data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +1 -0
  5. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +31 -1
  6. data/lib/facebook_ads/ad_objects/ad_account_agency_fee_config.rb +34 -0
  7. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +1 -0
  8. data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb +4 -0
  9. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +2 -0
  10. data/lib/facebook_ads/ad_objects/ad_asset_onsite_destinations.rb +1 -0
  11. data/lib/facebook_ads/ad_objects/ad_asset_target_rule_targeting.rb +1 -0
  12. data/lib/facebook_ads/ad_objects/ad_async_request_set.rb +1 -0
  13. data/lib/facebook_ads/ad_objects/{shadow_ig_media_boosted_insights_result.rb → ad_campaign_group_agency_fee_config_for_api.rb} +4 -7
  14. data/lib/facebook_ads/ad_objects/ad_creative.rb +2 -0
  15. data/lib/facebook_ads/ad_objects/ad_creative_feature_customizations.rb +1 -0
  16. data/lib/facebook_ads/ad_objects/ad_creative_features_spec.rb +7 -0
  17. data/lib/facebook_ads/ad_objects/ad_creative_format_transformation_spec.rb +26 -0
  18. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +1 -0
  19. data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +1 -0
  20. data/lib/facebook_ads/ad_objects/{ad_account_suggested_tag.rb → ad_creative_media_sourcing_spec.rb} +1 -4
  21. data/lib/facebook_ads/ad_objects/ad_creative_site_links_spec.rb +3 -0
  22. data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +1 -0
  23. data/lib/facebook_ads/ad_objects/ad_preview.rb +4 -0
  24. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +2 -0
  25. data/lib/facebook_ads/ad_objects/ad_report_run.rb +2 -0
  26. data/lib/facebook_ads/ad_objects/ad_rule_history.rb +1 -0
  27. data/lib/facebook_ads/ad_objects/ad_set.rb +22 -0
  28. data/lib/facebook_ads/ad_objects/ad_video.rb +3 -13
  29. data/lib/facebook_ads/ad_objects/ads_action_stats.rb +3 -0
  30. data/lib/facebook_ads/ad_objects/ads_dataset.rb +5 -0
  31. data/lib/facebook_ads/ad_objects/ads_histogram_stats.rb +3 -0
  32. data/lib/facebook_ads/ad_objects/ads_insights.rb +47 -0
  33. data/lib/facebook_ads/ad_objects/ads_naming_template.rb +1 -0
  34. data/lib/facebook_ads/ad_objects/ads_pixel_capi_integration_quality.rb +5 -0
  35. data/lib/facebook_ads/ad_objects/ads_user_settings.rb +10 -0
  36. data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +10 -0
  37. data/lib/facebook_ads/ad_objects/ai_generated_product_image.rb +26 -0
  38. data/lib/facebook_ads/ad_objects/alm_guidance.rb +1 -0
  39. data/lib/facebook_ads/ad_objects/alm_guidance_metrics.rb +9 -0
  40. data/lib/facebook_ads/ad_objects/apac_mon_seller_status_api_container.rb +24 -0
  41. data/lib/facebook_ads/ad_objects/application.rb +17 -0
  42. data/lib/facebook_ads/ad_objects/audio_sub_label.rb +29 -0
  43. data/lib/facebook_ads/ad_objects/business.rb +25 -7
  44. data/lib/facebook_ads/ad_objects/business_role_request.rb +19 -0
  45. data/lib/facebook_ads/ad_objects/business_user.rb +19 -0
  46. data/lib/facebook_ads/ad_objects/campaign.rb +2 -0
  47. data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb +0 -1
  48. data/lib/facebook_ads/ad_objects/china_business_onboarding_vetting_request.rb +3 -0
  49. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +4 -0
  50. data/lib/facebook_ads/ad_objects/content_delivery_report.rb +2 -0
  51. data/lib/facebook_ads/ad_objects/copyright_ownership_transfer.rb +28 -0
  52. data/lib/facebook_ads/ad_objects/creative_multicell_test_config.rb +4 -0
  53. data/lib/facebook_ads/ad_objects/ctwa_whats_app_numbers_info.rb +1 -0
  54. data/lib/facebook_ads/ad_objects/ctx_default_optimization_config.rb +1 -0
  55. data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -1
  56. data/lib/facebook_ads/ad_objects/custom_audience_integrity_flags_and_appeal_status.rb +29 -0
  57. data/lib/facebook_ads/ad_objects/event.rb +3 -0
  58. data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +3 -0
  59. data/lib/facebook_ads/ad_objects/group.rb +2 -0
  60. data/lib/facebook_ads/ad_objects/home_listing.rb +2 -0
  61. data/lib/facebook_ads/ad_objects/ig_comment_from_user.rb +1 -0
  62. data/lib/facebook_ads/ad_objects/ig_media.rb +3 -0
  63. data/lib/facebook_ads/ad_objects/ig_user.rb +7 -1
  64. data/lib/facebook_ads/ad_objects/ig_user_export_for_cam.rb +23 -0
  65. data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +8 -2
  66. data/lib/facebook_ads/ad_objects/ig_user_messenger_profile.rb +26 -0
  67. data/lib/facebook_ads/ad_objects/insights_result.rb +1 -2
  68. data/lib/facebook_ads/ad_objects/{ads_value_adjustment_rule.rb → instagram_business_asset.rb} +3 -6
  69. data/lib/facebook_ads/ad_objects/{bespoke_partner_guidance_laser.rb → instagram_thread.rb} +4 -6
  70. data/lib/facebook_ads/ad_objects/instagram_user.rb +0 -11
  71. data/lib/facebook_ads/ad_objects/lead_gen_client_validation_rules.rb +27 -0
  72. data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +2 -0
  73. data/lib/facebook_ads/ad_objects/lead_gen_thank_you_page.rb +1 -0
  74. data/lib/facebook_ads/ad_objects/managed_partner_business.rb +544 -0
  75. data/lib/facebook_ads/ad_objects/management_site_link.rb +31 -0
  76. data/lib/facebook_ads/ad_objects/messenger_call_settings.rb +2 -0
  77. data/lib/facebook_ads/ad_objects/messenger_profile.rb +0 -2
  78. data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +4 -0
  79. data/lib/facebook_ads/ad_objects/organization.rb +0 -2
  80. data/lib/facebook_ads/ad_objects/page.rb +11 -7
  81. data/lib/facebook_ads/ad_objects/product_catalog.rb +38 -1
  82. data/lib/facebook_ads/ad_objects/product_catalog_check_marketplace_partner_sellers_status.rb +27 -0
  83. data/lib/facebook_ads/ad_objects/product_feed.rb +1 -0
  84. data/lib/facebook_ads/ad_objects/product_group.rb +1 -0
  85. data/lib/facebook_ads/ad_objects/product_item.rb +8 -0
  86. data/lib/facebook_ads/ad_objects/product_item_video_data.rb +26 -0
  87. data/lib/facebook_ads/ad_objects/shadow_ig_user_ctx_partner_app_welcome_message_flow.rb +31 -0
  88. data/lib/facebook_ads/ad_objects/targeting.rb +2 -0
  89. data/lib/facebook_ads/ad_objects/third_party_partner_viewability_request.rb +1 -0
  90. data/lib/facebook_ads/ad_objects/user.rb +4 -1
  91. data/lib/facebook_ads/ad_objects/vehicle.rb +3 -0
  92. data/lib/facebook_ads/ad_objects/{split_test_config.rb → website_creative_info.rb} +3 -7
  93. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +6 -3
  94. data/lib/facebook_ads/ad_objects/whats_app_business_pre_verified_phone_number.rb +1 -1
  95. data/lib/facebook_ads/version.rb +2 -2
  96. metadata +20 -8
  97. data/lib/facebook_ads/ad_objects/keyword_delivery_report.rb +0 -33
@@ -980,6 +980,11 @@ module FacebookAds
980
980
  end
981
981
 
982
982
  has_edge :ads_dataset do |edge|
983
+ edge.get 'AdsDataset' do |api|
984
+ api.has_param :id_filter, 'string'
985
+ api.has_param :name_filter, 'string'
986
+ api.has_param :sort_by, { enum: -> { AdsDataset::SORT_BY }}
987
+ end
983
988
  edge.post 'Business' do |api|
984
989
  api.has_param :ad_account_id, 'string'
985
990
  api.has_param :app_id, 'string'
@@ -1055,6 +1060,7 @@ module FacebookAds
1055
1060
  api.has_param :email, 'string'
1056
1061
  api.has_param :invited_user_type, { list: { enum: -> { BusinessUser::INVITED_USER_TYPE }} }
1057
1062
  api.has_param :role, { enum: -> { BusinessUser::ROLE }}
1063
+ api.has_param :tasks, { list: { enum: -> { BusinessUser::TASKS }} }
1058
1064
  end
1059
1065
  end
1060
1066
 
@@ -1216,7 +1222,7 @@ module FacebookAds
1216
1222
  edge.delete do |api|
1217
1223
  api.has_param :instagram_account, 'string'
1218
1224
  end
1219
- edge.get 'InstagramUser'
1225
+ edge.get 'IgUser'
1220
1226
  end
1221
1227
 
1222
1228
  has_edge :instagram_business_accounts do |edge|
@@ -1240,6 +1246,12 @@ module FacebookAds
1240
1246
  end
1241
1247
  end
1242
1248
 
1249
+ has_edge :managed_partner_ads_funding_source_details do |edge|
1250
+ edge.get 'FundingSourceDetailsCoupon' do |api|
1251
+ api.has_param :year_quarter, 'string'
1252
+ end
1253
+ end
1254
+
1243
1255
  has_edge :managed_partner_business_setup do |edge|
1244
1256
  edge.post 'Business' do |api|
1245
1257
  api.has_param :active_ad_account_id, 'string'
@@ -1257,7 +1269,7 @@ module FacebookAds
1257
1269
  api.has_param :child_business_external_id, 'string'
1258
1270
  api.has_param :child_business_id, 'string'
1259
1271
  end
1260
- edge.post do |api|
1272
+ edge.post 'ManagedPartnerBusiness' do |api|
1261
1273
  api.has_param :ad_account_currency, 'string'
1262
1274
  api.has_param :catalog_id, 'string'
1263
1275
  api.has_param :child_business_external_id, 'string'
@@ -1267,18 +1279,18 @@ module FacebookAds
1267
1279
  api.has_param :no_ad_account, 'bool'
1268
1280
  api.has_param :page_name, 'string'
1269
1281
  api.has_param :page_profile_image_url, 'string'
1270
- api.has_param :partition_type, { enum: %w{AUTH FIXED FIXED_WITHOUT_PARTITION }}
1282
+ api.has_param :partition_type, { enum: -> { ManagedPartnerBusiness::PARTITION_TYPE }}
1271
1283
  api.has_param :partner_facebook_page_url, 'string'
1272
1284
  api.has_param :partner_registration_countries, { list: 'string' }
1273
1285
  api.has_param :sales_rep_email, 'string'
1274
1286
  api.has_param :seller_external_website_url, 'string'
1275
1287
  api.has_param :seller_targeting_countries, { list: 'string' }
1276
1288
  api.has_param :skip_partner_page_creation, 'bool'
1277
- api.has_param :survey_business_type, { enum: %w{ADVERTISER AGENCY APP_DEVELOPER PUBLISHER }}
1289
+ api.has_param :survey_business_type, { enum: -> { ManagedPartnerBusiness::SURVEY_BUSINESS_TYPE }}
1278
1290
  api.has_param :survey_num_assets, 'int'
1279
1291
  api.has_param :survey_num_people, 'int'
1280
- api.has_param :timezone_id, { enum: %w{0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 }}
1281
- api.has_param :vertical, { enum: %w{ADVERTISING AUTOMOTIVE CONSUMER_PACKAGED_GOODS ECOMMERCE EDUCATION ENERGY_AND_UTILITIES ENTERTAINMENT_AND_MEDIA FINANCIAL_SERVICES GAMING GOVERNMENT_AND_POLITICS HEALTH LUXURY MARKETING NON_PROFIT NOT_SET ORGANIZATIONS_AND_ASSOCIATIONS OTHER PROFESSIONAL_SERVICES RESTAURANT RETAIL TECHNOLOGY TELECOM TRAVEL }}
1292
+ api.has_param :timezone_id, { enum: -> { ManagedPartnerBusiness::TIMEZONE_ID }}
1293
+ api.has_param :vertical, { enum: -> { ManagedPartnerBusiness::VERTICAL }}
1282
1294
  end
1283
1295
  end
1284
1296
 
@@ -1302,8 +1314,12 @@ module FacebookAds
1302
1314
  api.has_param :instance_id, 'string'
1303
1315
  api.has_param :instance_version, 'string'
1304
1316
  api.has_param :is_sgw_instance, 'bool'
1317
+ api.has_param :is_sgw_pixel_from_meta_pixel, 'bool'
1305
1318
  api.has_param :partner_name, 'string'
1306
1319
  api.has_param :pixel_id, 'int'
1320
+ api.has_param :sgw_account_id, 'string'
1321
+ api.has_param :sgw_instance_url, 'string'
1322
+ api.has_param :sgw_pixel_id, 'int'
1307
1323
  end
1308
1324
  end
1309
1325
 
@@ -1347,7 +1363,7 @@ module FacebookAds
1347
1363
  end
1348
1364
 
1349
1365
  has_edge :owned_instagram_accounts do |edge|
1350
- edge.get 'InstagramUser'
1366
+ edge.get 'IgUser'
1351
1367
  end
1352
1368
 
1353
1369
  has_edge :owned_offsite_signal_container_business_objects do |edge|
@@ -1576,6 +1592,7 @@ module FacebookAds
1576
1592
  api.has_param :instant_game_entry_point_data, 'string'
1577
1593
  api.has_param :is_boost_intended, 'bool'
1578
1594
  api.has_param :is_group_linking_post, 'bool'
1595
+ api.has_param :is_partnership_ad, 'bool'
1579
1596
  api.has_param :is_voice_clip, 'bool'
1580
1597
  api.has_param :location_source_id, 'string'
1581
1598
  api.has_param :og_action_type_id, 'string'
@@ -1585,6 +1602,7 @@ module FacebookAds
1585
1602
  api.has_param :og_suggestion_mechanism, 'string'
1586
1603
  api.has_param :original_fov, 'int'
1587
1604
  api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
1605
+ api.has_param :partnership_ad_ad_code, 'string'
1588
1606
  api.has_param :publish_event_id, 'int'
1589
1607
  api.has_param :referenced_sticker_id, 'string'
1590
1608
  api.has_param :replace_video_id, 'string'
@@ -32,6 +32,24 @@ module FacebookAds
32
32
  "PARTNER_CENTER_OPERATIONS",
33
33
  ]
34
34
 
35
+ TASKS = [
36
+ "ADMIN",
37
+ "ADS_RIGHTS_REVIEWER",
38
+ "DEFAULT",
39
+ "DEVELOPER",
40
+ "EMPLOYEE",
41
+ "FINANCE_ANALYST",
42
+ "FINANCE_EDIT",
43
+ "FINANCE_EDITOR",
44
+ "FINANCE_VIEW",
45
+ "MANAGE",
46
+ "PARTNER_CENTER_ADMIN",
47
+ "PARTNER_CENTER_ANALYST",
48
+ "PARTNER_CENTER_EDUCATION",
49
+ "PARTNER_CENTER_MARKETING",
50
+ "PARTNER_CENTER_OPERATIONS",
51
+ ]
52
+
35
53
 
36
54
  field :created_by, 'object'
37
55
  field :created_time, 'datetime'
@@ -46,6 +64,7 @@ module FacebookAds
46
64
  field :owner, 'Business'
47
65
  field :role, 'string'
48
66
  field :status, 'string'
67
+ field :tasks, { list: 'string' }
49
68
  field :updated_by, 'object'
50
69
  field :updated_time, 'datetime'
51
70
 
@@ -37,6 +37,24 @@ module FacebookAds
37
37
  "PARTNER_CENTER_OPERATIONS",
38
38
  ]
39
39
 
40
+ TASKS = [
41
+ "ADMIN",
42
+ "ADS_RIGHTS_REVIEWER",
43
+ "DEFAULT",
44
+ "DEVELOPER",
45
+ "EMPLOYEE",
46
+ "FINANCE_ANALYST",
47
+ "FINANCE_EDIT",
48
+ "FINANCE_EDITOR",
49
+ "FINANCE_VIEW",
50
+ "MANAGE",
51
+ "PARTNER_CENTER_ADMIN",
52
+ "PARTNER_CENTER_ANALYST",
53
+ "PARTNER_CENTER_EDUCATION",
54
+ "PARTNER_CENTER_MARKETING",
55
+ "PARTNER_CENTER_OPERATIONS",
56
+ ]
57
+
40
58
 
41
59
  field :business, 'Business'
42
60
  field :business_role_request, 'BusinessRoleRequest'
@@ -50,6 +68,7 @@ module FacebookAds
50
68
  field :name, 'string'
51
69
  field :pending_email, 'string'
52
70
  field :role, 'string'
71
+ field :tasks, { list: 'string' }
53
72
  field :title, 'string'
54
73
  field :two_fac_status, 'string'
55
74
  field :invited_user_type, { list: { enum: -> { INVITED_USER_TYPE }} }
@@ -507,6 +507,7 @@ module FacebookAds
507
507
  api.has_param :fields, { list: 'string' }
508
508
  api.has_param :filtering, { list: 'object' }
509
509
  api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
510
+ api.has_param :limit, 'int'
510
511
  api.has_param :product_id_limit, 'int'
511
512
  api.has_param :sort, { list: 'string' }
512
513
  api.has_param :summary, { list: 'string' }
@@ -530,6 +531,7 @@ module FacebookAds
530
531
  api.has_param :fields, { list: 'string' }
531
532
  api.has_param :filtering, { list: 'object' }
532
533
  api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
534
+ api.has_param :limit, 'int'
533
535
  api.has_param :product_id_limit, 'int'
534
536
  api.has_param :sort, { list: 'string' }
535
537
  api.has_param :summary, { list: 'string' }
@@ -31,7 +31,6 @@ module FacebookAds
31
31
  field :computers_and_tablets, 'object'
32
32
  field :computers_laptops_and_tablets, 'object'
33
33
  field :diapering_and_potty_training, 'object'
34
- field :digital_product_offer, 'object'
35
34
  field :electronic_accessories_and_cables, 'object'
36
35
  field :electronics_accessories, 'object'
37
36
  field :furniture, 'object'
@@ -19,9 +19,12 @@ module FacebookAds
19
19
  field :ad_account_limit, 'int'
20
20
  field :ad_account_number, 'string'
21
21
  field :ad_accounts_info, { list: 'object' }
22
+ field :advertiser_business_id, 'string'
23
+ field :advertiser_business_name, 'string'
22
24
  field :business_manager_id, 'string'
23
25
  field :business_registration, 'string'
24
26
  field :business_registration_id, 'string'
27
+ field :business_verification_status, 'string'
25
28
  field :chinese_address, 'string'
26
29
  field :chinese_legal_entity_name, 'string'
27
30
  field :city, 'string'
@@ -15,6 +15,7 @@ module FacebookAds
15
15
 
16
16
  class CommerceMerchantSettings < AdObject
17
17
 
18
+ field :checkout_config, 'string'
18
19
  field :checkout_message, 'string'
19
20
  field :contact_email, 'string'
20
21
  field :cta, 'string'
@@ -22,10 +23,13 @@ module FacebookAds
22
23
  field :facebook_channel, 'object'
23
24
  field :id, 'string'
24
25
  field :instagram_channel, 'object'
26
+ field :korea_ftc_listing, 'string'
25
27
  field :merchant_page, 'Profile'
26
28
  field :merchant_status, 'string'
27
29
  field :onsite_commerce_merchant, 'object'
28
30
  field :payment_provider, 'string'
31
+ field :privacy_policy_localized, 'string'
32
+ field :return_policy_localized, 'string'
29
33
  field :review_rejection_messages, { list: 'string' }
30
34
  field :review_rejection_reasons, { list: 'string' }
31
35
  field :terms, 'string'
@@ -15,8 +15,10 @@ module FacebookAds
15
15
 
16
16
  class ContentDeliveryReport < AdObject
17
17
 
18
+ field :content_id, 'string'
18
19
  field :content_name, 'string'
19
20
  field :content_url, 'string'
21
+ field :creator_id, 'string'
20
22
  field :creator_name, 'string'
21
23
  field :creator_url, 'string'
22
24
  field :estimated_impressions, 'int'
@@ -0,0 +1,28 @@
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 CopyrightOwnershipTransfer < AdObject
17
+
18
+ field :id, 'string'
19
+ field :receiving_rights_holder, 'Profile'
20
+ field :sending_rights_holder, 'Profile'
21
+ field :status, 'string'
22
+ field :transfer_territories, { list: 'string' }
23
+ field :transfer_time, 'datetime'
24
+ has_no_post
25
+ has_no_delete
26
+
27
+ end
28
+ end
@@ -15,8 +15,12 @@ module FacebookAds
15
15
 
16
16
  class CreativeMulticellTestConfig < AdObject
17
17
 
18
+ field :budget_percentage, 'int'
19
+ field :configured_cell_count, 'int'
18
20
  field :daily_budget, 'int'
21
+ field :entry_source, 'string'
19
22
  field :lifetime_budget, 'int'
23
+ field :use_existing_daily_budget, 'bool'
20
24
  has_no_id
21
25
  has_no_get
22
26
  has_no_post
@@ -18,6 +18,7 @@ module FacebookAds
18
18
  field :can_manage_wa_flows, 'bool'
19
19
  field :formatted_whatsapp_number, 'string'
20
20
  field :is_business_number, 'bool'
21
+ field :is_calling_enabled, 'bool'
21
22
  field :number_country_prefix, 'string'
22
23
  field :page_whatsapp_number_id, 'string'
23
24
  field :waba_id, 'string'
@@ -15,6 +15,7 @@ module FacebookAds
15
15
 
16
16
  class CtxDefaultOptimizationConfig < AdObject
17
17
 
18
+ field :destination_type, 'string'
18
19
  field :objective, 'string'
19
20
  field :optimization_goal, 'string'
20
21
  has_no_id
@@ -33,7 +33,6 @@ module FacebookAds
33
33
  "GENERIC",
34
34
  "HOME_LISTING",
35
35
  "HOTEL",
36
- "JOB",
37
36
  "LOCAL_SERVICE_BUSINESS",
38
37
  "MEDIA_TITLE",
39
38
  "OFFLINE_PRODUCT",
@@ -179,6 +178,7 @@ module FacebookAds
179
178
  api.has_param :calculated_date, 'string'
180
179
  api.has_param :processed_date, 'string'
181
180
  api.has_param :value_aggregation_duration, 'int'
181
+ api.has_param :value_country, 'string'
182
182
  api.has_param :value_currency, 'string'
183
183
  api.has_param :value_version, 'int'
184
184
  end
@@ -0,0 +1,29 @@
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 CustomAudienceIntegrityFlagsAndAppealStatus < AdObject
17
+
18
+ field :closeout_time, 'int'
19
+ field :flagged_fields, { list: 'string' }
20
+ field :latest_appeal_requestor, 'string'
21
+ field :latest_appeal_time, 'int'
22
+ field :restriction_status, 'string'
23
+ has_no_id
24
+ has_no_get
25
+ has_no_post
26
+ has_no_delete
27
+
28
+ end
29
+ end
@@ -41,6 +41,7 @@ module FacebookAds
41
41
 
42
42
  ONLINE_EVENT_FORMAT = [
43
43
  "fb_live",
44
+ "horizon_event",
44
45
  "horizon_world",
45
46
  "messenger_room",
46
47
  "none",
@@ -99,6 +100,8 @@ module FacebookAds
99
100
  field :registration_setting, 'EventRegistrationSetting'
100
101
  field :scheduled_publish_time, 'string'
101
102
  field :start_time, 'string'
103
+ field :sub_categories, { list: 'string' }
104
+ field :ticket_selling_status, 'string'
102
105
  field :ticket_setting, 'EventTicketSetting'
103
106
  field :ticket_uri, 'string'
104
107
  field :ticket_uri_start_sales_time, 'string'
@@ -17,6 +17,8 @@ module FacebookAds
17
17
 
18
18
  field :amount, 'int'
19
19
  field :campaign_ids, { list: 'int' }
20
+ field :child_ad_account_id, 'string'
21
+ field :child_bm_id, 'string'
20
22
  field :coupon_id, 'string'
21
23
  field :coupon_tiering, 'FundingSourceDetailsCouponTiering'
22
24
  field :currency, 'string'
@@ -25,6 +27,7 @@ module FacebookAds
25
27
  field :original_amount, 'int'
26
28
  field :original_display_amount, 'string'
27
29
  field :start_date, 'datetime'
30
+ field :vendor_id, 'string'
28
31
  has_no_id
29
32
  has_no_get
30
33
  has_no_post
@@ -420,6 +420,7 @@ module FacebookAds
420
420
  api.has_param :is_boost_intended, 'bool'
421
421
  api.has_param :is_explicit_share, 'bool'
422
422
  api.has_param :is_group_linking_post, 'bool'
423
+ api.has_param :is_partnership_ad, 'bool'
423
424
  api.has_param :is_voice_clip, 'bool'
424
425
  api.has_param :location_source_id, 'string'
425
426
  api.has_param :manual_privacy, 'bool'
@@ -430,6 +431,7 @@ module FacebookAds
430
431
  api.has_param :og_suggestion_mechanism, 'string'
431
432
  api.has_param :original_fov, 'int'
432
433
  api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
434
+ api.has_param :partnership_ad_ad_code, 'string'
433
435
  api.has_param :publish_event_id, 'int'
434
436
  api.has_param :published, 'bool'
435
437
  api.has_param :referenced_sticker_id, 'string'
@@ -81,6 +81,8 @@ module FacebookAds
81
81
  field :price, 'string'
82
82
  field :property_type, 'string'
83
83
  field :sanitized_images, { list: 'string' }
84
+ field :securitydeposit_currency, 'string'
85
+ field :securitydeposit_price, 'string'
84
86
  field :tags, { list: 'string' }
85
87
  field :unit_price, 'object'
86
88
  field :url, 'string'
@@ -16,6 +16,7 @@ module FacebookAds
16
16
  class IgCommentFromUser < AdObject
17
17
 
18
18
  field :id, 'string'
19
+ field :self_ig_scoped_id, 'string'
19
20
  field :username, 'string'
20
21
  has_no_get
21
22
  has_no_post
@@ -15,6 +15,7 @@ module FacebookAds
15
15
 
16
16
  class IgMedia < AdObject
17
17
 
18
+ field :alt_text, 'string'
18
19
  field :boost_eligibility_info, 'IgMediaBoostEligibilityInfo'
19
20
  field :caption, 'string'
20
21
  field :comments_count, 'int'
@@ -34,6 +35,7 @@ module FacebookAds
34
35
  field :thumbnail_url, 'string'
35
36
  field :timestamp, 'datetime'
36
37
  field :username, 'string'
38
+ field :view_count, 'int'
37
39
  has_no_delete
38
40
 
39
41
  has_edge :boost_ads_list do |edge|
@@ -59,6 +61,7 @@ module FacebookAds
59
61
  has_edge :comments do |edge|
60
62
  edge.get 'IgComment'
61
63
  edge.post 'IgComment' do |api|
64
+ api.has_param :ad_id, 'string'
62
65
  api.has_param :message, 'string'
63
66
  end
64
67
  end
@@ -124,7 +124,6 @@ module FacebookAds
124
124
 
125
125
  has_edge :instagram_backed_threads_user do |edge|
126
126
  edge.get 'ThreadsUser'
127
- edge.post 'ThreadsUser'
128
127
  end
129
128
 
130
129
  has_edge :live_media do |edge|
@@ -209,5 +208,12 @@ module FacebookAds
209
208
  end
210
209
  end
211
210
 
211
+ has_edge :welcome_message_flows do |edge|
212
+ edge.get 'ShadowIgUserCtxPartnerAppWelcomeMessageFlow' do |api|
213
+ api.has_param :app_id, 'string'
214
+ api.has_param :flow_id, 'string'
215
+ end
216
+ end
217
+
212
218
  end
213
219
  end
@@ -15,14 +15,37 @@ module FacebookAds
15
15
 
16
16
  class IgUserExportForCam < AdObject
17
17
 
18
+ field :age_bucket, 'string'
19
+ field :biography, 'string'
20
+ field :country, 'string'
18
21
  field :email, 'string'
22
+ field :gender, 'string'
19
23
  field :id, 'string'
24
+ field :is_account_verified, 'bool'
20
25
  field :is_paid_partnership_messages_enabled, 'bool'
21
26
  field :messaging_id, 'string'
27
+ field :onboarded_status, 'bool'
22
28
  field :portfolio_url, 'string'
23
29
  field :username, 'string'
24
30
  has_no_post
25
31
  has_no_delete
26
32
 
33
+ has_edge :branded_content_media do |edge|
34
+ edge.get
35
+ end
36
+
37
+ has_edge :insights do |edge|
38
+ edge.get do |api|
39
+ api.has_param :breakdown, { enum: %w{AGE FOLLOW_TYPE GENDER MEDIA_TYPE TOP_CITIES TOP_COUNTRIES }}
40
+ api.has_param :metrics, { list: { enum: %w{CREATOR_ENGAGED_ACCOUNTS CREATOR_REACH REELS_HOOK_RATE REELS_INTERACTION_RATE TOTAL_FOLLOWERS }} }
41
+ api.has_param :period, { enum: %w{DAY OVERALL }}
42
+ api.has_param :time_range, { enum: %w{LAST_14_DAYS LAST_90_DAYS LIFETIME THIS_MONTH THIS_WEEK }}
43
+ end
44
+ end
45
+
46
+ has_edge :recent_media do |edge|
47
+ edge.get
48
+ end
49
+
27
50
  end
28
51
  end
@@ -29,6 +29,12 @@ module FacebookAds
29
29
  has_no_post
30
30
  has_no_delete
31
31
 
32
+ has_edge :business_messaging_feature_status do |edge|
33
+ edge.get do |api|
34
+ api.has_param :feature, 'string'
35
+ end
36
+ end
37
+
32
38
  has_edge :content_publishing_limit do |edge|
33
39
  edge.get 'ContentPublishingLimitResponse' do |api|
34
40
  api.has_param :since, 'datetime'
@@ -119,7 +125,7 @@ module FacebookAds
119
125
 
120
126
  has_edge :messenger_profile do |edge|
121
127
  edge.delete do |api|
122
- api.has_param :fields, { list: { enum: %w{ACCOUNT_LINKING_URL COMMANDS DESCRIPTION GET_STARTED GREETING HOME_URL ICE_BREAKERS PAYMENT_SETTINGS PERSISTENT_MENU PLATFORM SUBJECT_TO_NEW_EU_PRIVACY_RULES TARGET_AUDIENCE TITLE WHITELISTED_DOMAINS }} }
128
+ api.has_param :fields, { list: { enum: %w{ACCOUNT_LINKING_URL COMMANDS DESCRIPTION GET_STARTED GREETING HOME_URL ICE_BREAKERS PERSISTENT_MENU PLATFORM SUBJECT_TO_NEW_EU_PRIVACY_RULES TITLE WHITELISTED_DOMAINS }} }
123
129
  end
124
130
  edge.get
125
131
  edge.post do |api|
@@ -136,7 +142,7 @@ module FacebookAds
136
142
  edge.delete
137
143
  edge.get
138
144
  edge.post do |api|
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 }} }
145
+ api.has_param :subscribed_fields, { list: { enum: %w{comment_poll_response comments creator_marketplace_invited_creator_onboarding creator_marketplace_projects delta follow live_comments mentions message_reactions messages messaging_handover messaging_optins messaging_postbacks messaging_referral messaging_seen onboarding_welcome_message_series standby story_insights story_poll_response story_reactions story_share }} }
140
146
  end
141
147
  end
142
148
 
@@ -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 IgUserMessengerProfile < AdObject
17
+
18
+ field :ice_breakers, { list: 'object' }
19
+ field :persistent_menu, { list: 'object' }
20
+ has_no_id
21
+ has_no_get
22
+ has_no_post
23
+ has_no_delete
24
+
25
+ end
26
+ end
@@ -32,7 +32,6 @@ module FacebookAds
32
32
  "impressions",
33
33
  "likes",
34
34
  "navigation",
35
- "peak_concurrent_viewers",
36
35
  "plays",
37
36
  "profile_activity",
38
37
  "profile_visits",
@@ -44,9 +43,9 @@ module FacebookAds
44
43
  "shares",
45
44
  "thread_replies",
46
45
  "thread_shares",
46
+ "threads_media_clicks",
47
47
  "threads_views",
48
48
  "total_interactions",
49
- "video_views",
50
49
  "views",
51
50
  ]
52
51
 
@@ -13,16 +13,13 @@ 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 AdsValueAdjustmentRule < AdObject
16
+ class InstagramBusinessAsset < AdObject
17
17
 
18
- field :base_value, 'int'
19
18
  field :id, 'string'
19
+ field :ig_user_id, 'string'
20
+ field :ig_username, 'string'
20
21
  has_no_post
21
22
  has_no_delete
22
23
 
23
- has_edge :criterias do |edge|
24
- edge.get
25
- end
26
-
27
24
  end
28
25
  end
@@ -13,14 +13,12 @@ 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 BespokePartnerGuidanceLaser < AdObject
16
+ class InstagramThread < AdObject
17
17
 
18
- field :business, 'Business'
19
- field :campaign_group, 'Campaign'
20
- field :cpa_improvement, 'double'
21
- field :guidance_type, 'string'
18
+ field :folder, 'string'
22
19
  field :id, 'string'
23
- has_no_get
20
+ field :participants, 'object'
21
+ field :updated_time, 'datetime'
24
22
  has_no_post
25
23
  has_no_delete
26
24
 
@@ -42,21 +42,10 @@ module FacebookAds
42
42
  edge.get 'AdAccount' do |api|
43
43
  api.has_param :business, 'string'
44
44
  end
45
- edge.post 'InstagramUser' do |api|
46
- api.has_param :account_id, 'string'
47
- api.has_param :business, 'string'
48
- end
49
45
  end
50
46
 
51
47
  has_edge :upcoming_events do |edge|
52
48
  edge.get 'IgUpcomingEvent'
53
- edge.post 'IgUpcomingEvent' do |api|
54
- api.has_param :end_time, 'datetime'
55
- api.has_param :notification_subtypes, { list: { enum: -> { IgUpcomingEvent::NOTIFICATION_SUBTYPES }} }
56
- api.has_param :notification_target_time, { enum: -> { IgUpcomingEvent::NOTIFICATION_TARGET_TIME }}
57
- api.has_param :start_time, 'datetime'
58
- api.has_param :title, 'string'
59
- end
60
49
  end
61
50
 
62
51
  end