facebookbusiness 0.12.0.0 → 0.14.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) 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 +4 -8
  4. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +6 -0
  5. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +6 -9
  6. data/lib/facebook_ads/ad_objects/ad_account_reach_estimate.rb +2 -1
  7. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +3 -1
  8. data/lib/facebook_ads/ad_objects/ad_activity.rb +2 -0
  9. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +2 -3
  10. data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +8 -16
  11. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +6 -9
  12. data/lib/facebook_ads/ad_objects/ad_creative.rb +5 -0
  13. data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +1 -0
  14. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +2 -0
  15. data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +1 -0
  16. data/lib/facebook_ads/ad_objects/ad_image.rb +1 -0
  17. data/lib/facebook_ads/ad_objects/ad_placement.rb +1 -0
  18. data/lib/facebook_ads/ad_objects/ad_preview.rb +9 -0
  19. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +2 -0
  20. data/lib/facebook_ads/ad_objects/ad_rule.rb +27 -0
  21. data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +1 -0
  22. data/lib/facebook_ads/ad_objects/ad_set.rb +6 -8
  23. data/lib/facebook_ads/ad_objects/ad_video.rb +28 -5
  24. data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +1 -0
  25. data/lib/facebook_ads/ad_objects/ads_action_stats.rb +2 -0
  26. data/lib/facebook_ads/ad_objects/ads_insights.rb +3 -0
  27. data/lib/facebook_ads/ad_objects/ads_pixel.rb +5 -0
  28. data/lib/facebook_ads/ad_objects/album.rb +0 -1
  29. data/lib/facebook_ads/ad_objects/application.rb +37 -27
  30. data/lib/facebook_ads/ad_objects/automotive_model.rb +0 -25
  31. data/lib/facebook_ads/ad_objects/broad_targeting_categories.rb +2 -1
  32. data/lib/facebook_ads/ad_objects/business.rb +46 -34
  33. data/lib/facebook_ads/ad_objects/business_asset_group.rb +1 -0
  34. data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb +1 -0
  35. data/lib/facebook_ads/ad_objects/business_image.rb +44 -0
  36. data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +1 -0
  37. data/lib/facebook_ads/ad_objects/campaign.rb +4 -0
  38. data/lib/facebook_ads/ad_objects/canvas.rb +1 -10
  39. data/lib/facebook_ads/ad_objects/check_batch_request_status.rb +6 -0
  40. data/lib/facebook_ads/ad_objects/comment.rb +2 -0
  41. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +6 -0
  42. data/lib/facebook_ads/ad_objects/commerce_order.rb +15 -0
  43. data/lib/facebook_ads/ad_objects/content_delivery_report.rb +3 -0
  44. data/lib/facebook_ads/ad_objects/{business_agreement.rb → copyright_audio_asset.rb} +6 -10
  45. data/lib/facebook_ads/ad_objects/cpas_business_setup_config.rb +43 -0
  46. data/lib/facebook_ads/ad_objects/cpas_merchant_config.rb +41 -0
  47. data/lib/facebook_ads/ad_objects/{oracle_transaction.rb → credit_card.rb} +20 -21
  48. data/lib/facebook_ads/ad_objects/custom_audience.rb +7 -1
  49. data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +1 -0
  50. data/lib/facebook_ads/ad_objects/event.rb +4 -1
  51. data/lib/facebook_ads/ad_objects/{adoptable_pet.rb → fundraiser_person_to_charity.rb} +32 -39
  52. data/lib/facebook_ads/ad_objects/game_item.rb +48 -0
  53. data/lib/facebook_ads/ad_objects/group.rb +37 -4
  54. data/lib/facebook_ads/ad_objects/ig_comment.rb +2 -0
  55. data/lib/facebook_ads/ad_objects/ig_media.rb +13 -1
  56. data/lib/facebook_ads/ad_objects/ig_user.rb +33 -0
  57. data/lib/facebook_ads/ad_objects/insights_result.rb +1 -0
  58. data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +9 -0
  59. data/lib/facebook_ads/ad_objects/instagram_user.rb +1 -0
  60. data/lib/facebook_ads/ad_objects/{native_offer_discount.rb → instant_articles_stats.rb} +6 -7
  61. data/lib/facebook_ads/ad_objects/jobs_job.rb +7 -0
  62. data/lib/facebook_ads/ad_objects/life_event.rb +0 -9
  63. data/lib/facebook_ads/ad_objects/live_video.rb +1 -1
  64. data/lib/facebook_ads/ad_objects/live_video_input_stream.rb +0 -1
  65. data/lib/facebook_ads/ad_objects/live_video_recommended_encoder_settings.rb +39 -0
  66. data/lib/facebook_ads/ad_objects/local_service_business.rb +38 -0
  67. data/lib/facebook_ads/ad_objects/media_fingerprint.rb +1 -0
  68. data/lib/facebook_ads/ad_objects/{page_admin_note.rb → messaging_feature_status.rb} +4 -6
  69. data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +6 -5
  70. data/lib/facebook_ads/ad_objects/offline_conversion_data_set_permissions.rb +40 -0
  71. data/lib/facebook_ads/ad_objects/{native_offer_view.rb → offline_conversion_data_set_upload.rb} +34 -16
  72. data/lib/facebook_ads/ad_objects/{billed_amount_details.rb → offline_conversion_data_set_usage.rb} +2 -5
  73. data/lib/facebook_ads/ad_objects/omega_customer_trx.rb +2 -3
  74. data/lib/facebook_ads/ad_objects/page.rb +38 -76
  75. data/lib/facebook_ads/ad_objects/{invoice_campaign.rb → page_post_experiment.rb} +13 -11
  76. data/lib/facebook_ads/ad_objects/partner_study.rb +0 -4
  77. data/lib/facebook_ads/ad_objects/payment_engine_payment.rb +1 -0
  78. data/lib/facebook_ads/ad_objects/private_lift_study_instance.rb +3 -0
  79. data/lib/facebook_ads/ad_objects/product_catalog.rb +56 -20
  80. data/lib/facebook_ads/ad_objects/product_catalog_data_source.rb +46 -0
  81. data/lib/facebook_ads/ad_objects/product_catalog_diagnostic_group.rb +16 -0
  82. data/lib/facebook_ads/ad_objects/product_feed.rb +17 -11
  83. data/lib/facebook_ads/ad_objects/product_feed_missing_feed_item_replacement.rb +0 -1
  84. data/lib/facebook_ads/ad_objects/product_feed_upload.rb +3 -1
  85. data/lib/facebook_ads/ad_objects/product_feed_upload_error.rb +6 -0
  86. data/lib/facebook_ads/ad_objects/product_group.rb +12 -7
  87. data/lib/facebook_ads/ad_objects/{domain.rb → product_image.rb} +2 -3
  88. data/lib/facebook_ads/ad_objects/product_item.rb +346 -0
  89. data/lib/facebook_ads/ad_objects/{adgroup_relevance_score.rb → product_item_error.rb} +5 -5
  90. data/lib/facebook_ads/ad_objects/product_item_importer_address.rb +42 -0
  91. data/lib/facebook_ads/ad_objects/product_set.rb +3 -7
  92. data/lib/facebook_ads/ad_objects/profile.rb +2 -0
  93. data/lib/facebook_ads/ad_objects/reach_frequency_estimates_placement_breakdown.rb +1 -0
  94. data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +6 -1
  95. data/lib/facebook_ads/ad_objects/saved_audience.rb +2 -2
  96. data/lib/facebook_ads/ad_objects/{audience_insights_study_spec.rb → shadow_ig_media_product_tags.rb} +12 -9
  97. data/lib/facebook_ads/ad_objects/{dynamic_content_set.rb → shop.rb} +3 -3
  98. data/lib/facebook_ads/ad_objects/unified_thread.rb +1 -0
  99. data/lib/facebook_ads/ad_objects/user.rb +31 -20
  100. data/lib/facebook_ads/ad_objects/vehicle.rb +10 -0
  101. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +19 -12
  102. data/lib/facebook_ads/version.rb +2 -2
  103. metadata +22 -22
  104. data/lib/facebook_ads/ad_objects/ad_account_activity.rb +0 -63
  105. data/lib/facebook_ads/ad_objects/ad_campaign_group_activity.rb +0 -99
  106. data/lib/facebook_ads/ad_objects/ad_report_spec.rb +0 -51
  107. data/lib/facebook_ads/ad_objects/adgroup_activity.rb +0 -128
  108. data/lib/facebook_ads/ad_objects/atlas_campaign.rb +0 -153
  109. data/lib/facebook_ads/ad_objects/business_unit.rb +0 -132
  110. data/lib/facebook_ads/ad_objects/live_encoder.rb +0 -100
  111. data/lib/facebook_ads/ad_objects/native_offer.rb +0 -122
@@ -126,6 +126,7 @@ module FacebookAds
126
126
  "PROFILE_PLUS_MANAGE",
127
127
  "PROFILE_PLUS_MESSAGING",
128
128
  "PROFILE_PLUS_MODERATE",
129
+ "PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY",
129
130
  "PROFILE_PLUS_REVENUE",
130
131
  "READ_PAGE_MAILBOXES",
131
132
  "VIEW_MONETIZATION_INSIGHTS",
@@ -152,6 +153,7 @@ module FacebookAds
152
153
  "PROFILE_PLUS_MANAGE",
153
154
  "PROFILE_PLUS_MESSAGING",
154
155
  "PROFILE_PLUS_MODERATE",
156
+ "PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY",
155
157
  "PROFILE_PLUS_REVENUE",
156
158
  "READ_PAGE_MAILBOXES",
157
159
  "VIEW_MONETIZATION_INSIGHTS",
@@ -274,6 +276,7 @@ module FacebookAds
274
276
  PLATFORM = [
275
277
  "INSTAGRAM",
276
278
  "MESSENGER",
279
+ "WHATSAPP",
277
280
  ]
278
281
 
279
282
  MODEL = [
@@ -302,13 +305,17 @@ module FacebookAds
302
305
  "VIETNAMESE",
303
306
  ]
304
307
 
308
+ DEVELOPER_ACTION = [
309
+ "ENABLE_FOLLOWUP_MESSAGE",
310
+ "SEND_RE_OPTIN",
311
+ ]
312
+
305
313
  SUBSCRIBED_FIELDS = [
306
314
  "affiliation",
307
315
  "attire",
308
316
  "awards",
309
317
  "bio",
310
318
  "birthday",
311
- "branded_camera",
312
319
  "category",
313
320
  "checkins",
314
321
  "company_overview",
@@ -353,7 +360,6 @@ module FacebookAds
353
360
  "messaging_handovers",
354
361
  "messaging_optins",
355
362
  "messaging_optouts",
356
- "messaging_page_feedback",
357
363
  "messaging_payments",
358
364
  "messaging_policy_enforcement",
359
365
  "messaging_postbacks",
@@ -467,10 +473,12 @@ module FacebookAds
467
473
  field :members, 'string'
468
474
  field :merchant_id, 'string'
469
475
  field :merchant_review_status, 'string'
476
+ field :messaging_feature_status, 'MessagingFeatureStatus'
470
477
  field :messenger_ads_default_icebreakers, { list: 'string' }
471
478
  field :messenger_ads_default_page_welcome_message, 'MessengerDestinationPageWelcomeMessage'
472
479
  field :messenger_ads_default_quick_replies, { list: 'string' }
473
480
  field :messenger_ads_quick_replies_type, 'string'
481
+ field :mini_shop_storefront, 'Shop'
474
482
  field :mission, 'string'
475
483
  field :mpg, 'string'
476
484
  field :name, 'string'
@@ -538,10 +546,6 @@ module FacebookAds
538
546
  end
539
547
  end
540
548
 
541
- has_edge :admin_notes do |edge|
542
- edge.get 'PageAdminNote'
543
- end
544
-
545
549
  has_edge :ads_posts do |edge|
546
550
  edge.get 'PagePost' do |api|
547
551
  api.has_param :exclude_dynamic_ads, 'bool'
@@ -599,15 +603,10 @@ module FacebookAds
599
603
  end
600
604
 
601
605
  has_edge :business_data do |edge|
602
- edge.post 'Page' do |api|
606
+ edge.post do |api|
603
607
  api.has_param :data, { list: 'string' }
604
608
  api.has_param :partner_agent, 'string'
605
- end
606
- end
607
-
608
- has_edge :businessprojects do |edge|
609
- edge.get do |api|
610
- api.has_param :business, 'string'
609
+ api.has_param :processing_type, 'string'
611
610
  end
612
611
  end
613
612
 
@@ -714,7 +713,7 @@ module FacebookAds
714
713
  has_edge :copyright_manual_claims do |edge|
715
714
  edge.post do |api|
716
715
  api.has_param :action, { enum: %w{BLOCK CLAIM_AD_EARNINGS MANUAL_REVIEW MONITOR REQUEST_TAKEDOWN }}
717
- api.has_param :action_reason, { enum: %w{ARTIST_OBJECTION OBJECTIONABLE_CONTENT PREMIUM_MUSIC_VIDEO PRERELEASE_CONTENT PRODUCT_PARAMETERS RESTRICTED_CONTENT UNAUTHORIZED_COMMERCIAL_USE }}
716
+ api.has_param :action_reason, { enum: %w{ARTICLE_17_PREFLAGGING ARTIST_OBJECTION OBJECTIONABLE_CONTENT PREMIUM_MUSIC_VIDEO PRERELEASE_CONTENT PRODUCT_PARAMETERS RESTRICTED_CONTENT UNAUTHORIZED_COMMERCIAL_USE }}
718
717
  api.has_param :countries, 'object'
719
718
  api.has_param :match_content_type, { enum: %w{AUDIO_ONLY VIDEO_AND_AUDIO VIDEO_ONLY }}
720
719
  api.has_param :matched_asset_id, 'string'
@@ -867,7 +866,6 @@ module FacebookAds
867
866
  api.has_param :ref, { list: 'string' }
868
867
  api.has_param :referenceable_image_ids, { list: 'string' }
869
868
  api.has_param :referral_id, 'string'
870
- api.has_param :sales_promo_id, 'int'
871
869
  api.has_param :scheduled_publish_time, 'datetime'
872
870
  api.has_param :source, 'string'
873
871
  api.has_param :sponsor_id, 'string'
@@ -933,13 +931,6 @@ module FacebookAds
933
931
  end
934
932
  end
935
933
 
936
- has_edge :insights_exports do |edge|
937
- edge.get do |api|
938
- api.has_param :data_level, { list: 'string' }
939
- api.has_param :from_creation_date, 'datetime'
940
- end
941
- end
942
-
943
934
  has_edge :instagram_accounts do |edge|
944
935
  edge.get 'InstagramUser'
945
936
  end
@@ -973,6 +964,19 @@ module FacebookAds
973
964
  end
974
965
  end
975
966
 
967
+ has_edge :instant_articles_stats do |edge|
968
+ edge.get 'InstantArticlesStats' do |api|
969
+ api.has_param :metrics_list, { list: 'hash' }
970
+ api.has_param :page_list, { list: 'string' }
971
+ api.has_param :since, 'datetime'
972
+ api.has_param :until, 'datetime'
973
+ end
974
+ end
975
+
976
+ has_edge :invoice_access_bank_account do |edge|
977
+ edge.get
978
+ end
979
+
976
980
  has_edge :leadgen_forms do |edge|
977
981
  edge.get 'LeadgenForm'
978
982
  edge.post 'LeadgenForm' do |api|
@@ -1000,17 +1004,6 @@ module FacebookAds
1000
1004
  end
1001
1005
  end
1002
1006
 
1003
- has_edge :live_encoders do |edge|
1004
- edge.get 'LiveEncoder'
1005
- edge.post 'LiveEncoder' do |api|
1006
- api.has_param :brand, 'string'
1007
- api.has_param :device_id, 'string'
1008
- api.has_param :model, 'string'
1009
- api.has_param :name, 'string'
1010
- api.has_param :version, 'string'
1011
- end
1012
- end
1013
-
1014
1007
  has_edge :live_videos do |edge|
1015
1008
  edge.get 'LiveVideo' do |api|
1016
1009
  api.has_param :broadcast_status, { list: { enum: -> { LiveVideo::BROADCAST_STATUS }} }
@@ -1023,13 +1016,14 @@ module FacebookAds
1023
1016
  api.has_param :description, 'string'
1024
1017
  api.has_param :enable_backup_ingest, 'bool'
1025
1018
  api.has_param :encoding_settings, 'string'
1019
+ api.has_param :event_params, 'object'
1026
1020
  api.has_param :fisheye_video_cropped, 'bool'
1027
1021
  api.has_param :front_z_rotation, 'double'
1028
1022
  api.has_param :game_show, 'hash'
1029
1023
  api.has_param :is_audio_only, 'bool'
1030
1024
  api.has_param :is_spherical, 'bool'
1031
- api.has_param :live_encoders, { list: 'string' }
1032
1025
  api.has_param :original_fov, 'int'
1026
+ api.has_param :planned_start_time, 'int'
1033
1027
  api.has_param :privacy, 'string'
1034
1028
  api.has_param :projection, { enum: -> { LiveVideo::PROJECTION }}
1035
1029
  api.has_param :published, 'bool'
@@ -1131,33 +1125,6 @@ module FacebookAds
1131
1125
  end
1132
1126
  end
1133
1127
 
1134
- has_edge :nativeoffers do |edge|
1135
- edge.get 'NativeOffer'
1136
- edge.post 'NativeOffer' do |api|
1137
- api.has_param :barcode_photo, 'int'
1138
- api.has_param :barcode_type, { enum: -> { NativeOffer::BARCODE_TYPE }}
1139
- api.has_param :barcode_value, 'string'
1140
- api.has_param :block_reshares, 'bool'
1141
- api.has_param :commerce_product_item, 'string'
1142
- api.has_param :commerce_store, 'string'
1143
- api.has_param :commerce_store_collection, 'string'
1144
- api.has_param :details, 'string'
1145
- api.has_param :disable_location, 'bool'
1146
- api.has_param :discounts, { list: 'object' }
1147
- api.has_param :expiration_time, 'datetime'
1148
- api.has_param :instore_code, 'string'
1149
- api.has_param :location_type, { enum: -> { NativeOffer::LOCATION_TYPE }}
1150
- api.has_param :max_save_count, 'int'
1151
- api.has_param :online_code, 'string'
1152
- api.has_param :page_set_id, 'string'
1153
- api.has_param :redemption_code, 'string'
1154
- api.has_param :redemption_link, 'string'
1155
- api.has_param :terms, 'string'
1156
- api.has_param :unique_barcodes, 'int'
1157
- api.has_param :unique_codes, 'int'
1158
- end
1159
- end
1160
-
1161
1128
  has_edge :nlp_configs do |edge|
1162
1129
  edge.post 'Page' do |api|
1163
1130
  api.has_param :api_version, 'object'
@@ -1170,6 +1137,13 @@ module FacebookAds
1170
1137
  end
1171
1138
  end
1172
1139
 
1140
+ has_edge :notification_messages_dev_support do |edge|
1141
+ edge.post 'Page' do |api|
1142
+ api.has_param :developer_action, { enum: -> { Page::DEVELOPER_ACTION }}
1143
+ api.has_param :recipient, 'object'
1144
+ end
1145
+ end
1146
+
1173
1147
  has_edge :page_backed_instagram_accounts do |edge|
1174
1148
  edge.get 'InstagramUser'
1175
1149
  edge.post 'InstagramUser'
@@ -1234,7 +1208,6 @@ module FacebookAds
1234
1208
  api.has_param :ios_bundle_id, 'string'
1235
1209
  api.has_param :is_explicit_location, 'bool'
1236
1210
  api.has_param :is_explicit_place, 'bool'
1237
- api.has_param :is_visual_search, 'bool'
1238
1211
  api.has_param :location_source_id, 'string'
1239
1212
  api.has_param :manual_privacy, 'bool'
1240
1213
  api.has_param :message, 'string'
@@ -1541,7 +1514,6 @@ module FacebookAds
1541
1514
  api.has_param :reference_only, 'bool'
1542
1515
  api.has_param :referenced_sticker_id, 'string'
1543
1516
  api.has_param :replace_video_id, 'string'
1544
- api.has_param :sales_promo_id, 'int'
1545
1517
  api.has_param :scheduled_publish_time, 'int'
1546
1518
  api.has_param :secret, 'bool'
1547
1519
  api.has_param :slideshow_spec, 'hash'
@@ -1577,19 +1549,9 @@ module FacebookAds
1577
1549
  has_edge :visitor_posts do |edge|
1578
1550
  edge.get 'PagePost' do |api|
1579
1551
  api.has_param :include_hidden, 'bool'
1580
- end
1581
- end
1582
-
1583
- has_edge :workpagemessages do |edge|
1584
- edge.post 'Page' do |api|
1585
- api.has_param :message, 'object'
1586
- api.has_param :messaging_type, { enum: -> { Page::MESSAGING_TYPE }}
1587
- api.has_param :notification_type, { enum: -> { Page::NOTIFICATION_TYPE }}
1588
- api.has_param :payload, 'string'
1589
- api.has_param :persona_id, 'string'
1590
- api.has_param :recipient, 'object'
1591
- api.has_param :sender_action, { enum: -> { Page::SENDER_ACTION }}
1592
- api.has_param :tag, 'object'
1552
+ api.has_param :limit, 'int'
1553
+ api.has_param :show_expired, 'bool'
1554
+ api.has_param :with, { enum: -> { PagePost::WITH }}
1593
1555
  end
1594
1556
  end
1595
1557
 
@@ -25,19 +25,21 @@ module FacebookAds
25
25
  # on github and we'll fix in our codegen framework. We'll not be able to accept
26
26
  # pull request for this class.
27
27
 
28
- class InvoiceCampaign < AdObject
28
+ class PagePostExperiment < AdObject
29
29
 
30
- field :ad_account_id, 'string'
31
- field :billed_amount_details, 'BilledAmountDetails'
32
- field :campaign_id, 'string'
33
- field :campaign_name, 'string'
34
- field :clicks, 'int'
35
- field :conversions, 'int'
30
+ field :auto_resolve_settings, 'object'
31
+ field :creation_time, 'datetime'
32
+ field :creator, 'User'
33
+ field :declared_winning_time, 'datetime'
36
34
  field :description, 'string'
37
- field :impressions, 'int'
38
- field :tags, { list: 'string' }
39
- has_no_id
40
- has_no_get
35
+ field :id, 'string'
36
+ field :insight_snapshots, 'map<datetime, map<int, Object>>'
37
+ field :name, 'string'
38
+ field :optimization_goal, 'string'
39
+ field :publish_status, 'string'
40
+ field :publish_time, 'datetime'
41
+ field :scheduled_experiment_timestamp, 'datetime'
42
+ field :updated_time, 'datetime'
41
43
  has_no_post
42
44
  has_no_delete
43
45
 
@@ -48,9 +48,5 @@ module FacebookAds
48
48
  has_no_post
49
49
  has_no_delete
50
50
 
51
- has_edge :partners do |edge|
52
- edge.get
53
- end
54
-
55
51
  end
56
52
  end
@@ -46,6 +46,7 @@ module FacebookAds
46
46
  field :items, { list: 'object' }
47
47
  field :payout_foreign_exchange_rate, 'double'
48
48
  field :phone_support_eligible, 'bool'
49
+ field :platform, 'string'
49
50
  field :refundable_amount, 'CurrencyAmount'
50
51
  field :request_id, 'string'
51
52
  field :tax, 'string'
@@ -30,16 +30,19 @@ module FacebookAds
30
30
  "AGGREGATE",
31
31
  "COMPUTE",
32
32
  "ID_MATCH",
33
+ "NEXT",
33
34
  "NONE",
34
35
  ]
35
36
 
36
37
 
37
38
  field :breakdown_key, 'string'
38
39
  field :created_time, 'datetime'
40
+ field :feature_list, { list: 'string' }
39
41
  field :id, 'string'
40
42
  field :latest_status_update_time, 'datetime'
41
43
  field :server_ips, { list: 'string' }
42
44
  field :status, 'string'
45
+ field :tier, 'string'
43
46
  has_no_delete
44
47
 
45
48
  end
@@ -103,6 +103,7 @@ module FacebookAds
103
103
  field :feed_count, 'int'
104
104
  field :id, 'string'
105
105
  field :is_catalog_segment, 'bool'
106
+ field :latest_feed_upload_session, 'ProductFeedUpload'
106
107
  field :name, 'string'
107
108
  field :product_count, 'int'
108
109
  field :store_catalog_settings, 'StoreCatalogSettings'
@@ -146,28 +147,11 @@ module FacebookAds
146
147
  end
147
148
  end
148
149
 
149
- has_edge :auto_markets do |edge|
150
- edge.get
151
- end
152
-
153
150
  has_edge :automotive_models do |edge|
154
151
  edge.get 'AutomotiveModel' do |api|
155
152
  api.has_param :bulk_pagination, 'bool'
156
153
  api.has_param :filter, 'object'
157
154
  end
158
- edge.post 'AutomotiveModel' do |api|
159
- api.has_param :automotive_model_id, 'string'
160
- api.has_param :body_style, { enum: -> { AutomotiveModel::BODY_STYLE }}
161
- api.has_param :currency, 'string'
162
- api.has_param :description, 'string'
163
- api.has_param :images, { list: 'object' }
164
- api.has_param :make, 'string'
165
- api.has_param :model, 'string'
166
- api.has_param :price, 'int'
167
- api.has_param :title, 'string'
168
- api.has_param :url, 'string'
169
- api.has_param :year, 'int'
170
- end
171
155
  end
172
156
 
173
157
  has_edge :batch do |edge|
@@ -178,6 +162,12 @@ module FacebookAds
178
162
  end
179
163
  end
180
164
 
165
+ has_edge :catalog_website_settings do |edge|
166
+ edge.post do |api|
167
+ api.has_param :is_allowed_to_crawl, 'bool'
168
+ end
169
+ end
170
+
181
171
  has_edge :categories do |edge|
182
172
  edge.get 'ProductCatalogCategory' do |api|
183
173
  api.has_param :categorization_criteria, { enum: -> { ProductCatalogCategory::CATEGORIZATION_CRITERIA }}
@@ -190,15 +180,34 @@ module FacebookAds
190
180
 
191
181
  has_edge :check_batch_request_status do |edge|
192
182
  edge.get 'CheckBatchRequestStatus' do |api|
183
+ api.has_param :error_priority, { enum: -> { CheckBatchRequestStatus::ERROR_PRIORITY }}
193
184
  api.has_param :handle, 'string'
194
185
  api.has_param :load_ids_of_invalid_requests, 'bool'
195
186
  end
196
187
  end
197
188
 
189
+ has_edge :collaborative_ads_lsb_image_bank do |edge|
190
+ edge.get
191
+ end
192
+
198
193
  has_edge :collaborative_ads_share_settings do |edge|
199
194
  edge.get 'CollaborativeAdsShareSettings'
200
195
  end
201
196
 
197
+ has_edge :cpas_lsb_image_bank do |edge|
198
+ edge.post do |api|
199
+ api.has_param :ad_group_id, 'int'
200
+ api.has_param :agency_business_id, 'int'
201
+ api.has_param :backup_image_urls, { list: 'string' }
202
+ end
203
+ end
204
+
205
+ has_edge :data_sources do |edge|
206
+ edge.get 'ProductCatalogDataSource' do |api|
207
+ api.has_param :ingestion_source_type, { enum: -> { ProductCatalogDataSource::INGESTION_SOURCE_TYPE }}
208
+ end
209
+ end
210
+
202
211
  has_edge :destinations do |edge|
203
212
  edge.get 'Destination' do |api|
204
213
  api.has_param :bulk_pagination, 'bool'
@@ -209,6 +218,7 @@ module FacebookAds
209
218
  has_edge :diagnostics do |edge|
210
219
  edge.get 'ProductCatalogDiagnosticGroup' do |api|
211
220
  api.has_param :affected_channels, { list: { enum: -> { ProductCatalogDiagnosticGroup::AFFECTED_CHANNELS }} }
221
+ api.has_param :affected_entities, { list: { enum: -> { ProductCatalogDiagnosticGroup::AFFECTED_ENTITIES }} }
212
222
  api.has_param :affected_features, { list: { enum: -> { ProductCatalogDiagnosticGroup::AFFECTED_FEATURES }} }
213
223
  api.has_param :severities, { list: { enum: -> { ProductCatalogDiagnosticGroup::SEVERITIES }} }
214
224
  api.has_param :types, { list: { enum: -> { ProductCatalogDiagnosticGroup::TYPES }} }
@@ -316,9 +326,20 @@ module FacebookAds
316
326
  end
317
327
 
318
328
  has_edge :media_titles do |edge|
319
- edge.get do |api|
320
- api.has_param :bulk_pagination, 'bool'
321
- api.has_param :filter, 'object'
329
+ edge.post do |api|
330
+ api.has_param :applinks, 'object'
331
+ api.has_param :content_category, { enum: %w{MOVIE MUSIC TV_SHOW }}
332
+ api.has_param :currency, 'string'
333
+ api.has_param :description, 'string'
334
+ api.has_param :fb_page_id, 'string'
335
+ api.has_param :genres, { list: 'string' }
336
+ api.has_param :images, { list: 'object' }
337
+ api.has_param :kg_fb_id, 'string'
338
+ api.has_param :media_title_id, 'string'
339
+ api.has_param :price, 'int'
340
+ api.has_param :title, 'string'
341
+ api.has_param :title_display_name, 'string'
342
+ api.has_param :url, 'string'
322
343
  end
323
344
  end
324
345
 
@@ -346,11 +367,13 @@ module FacebookAds
346
367
  api.has_param :encoding, { enum: -> { ProductFeed::ENCODING }}
347
368
  api.has_param :feed_type, { enum: -> { ProductFeed::FEED_TYPE }}
348
369
  api.has_param :file_name, 'string'
370
+ api.has_param :ingestion_source_type, { enum: -> { ProductFeed::INGESTION_SOURCE_TYPE }}
349
371
  api.has_param :item_sub_type, { enum: -> { ProductFeed::ITEM_SUB_TYPE }}
350
372
  api.has_param :migrated_from_feed_id, 'string'
351
373
  api.has_param :name, 'string'
352
374
  api.has_param :override_type, { enum: -> { ProductFeed::OVERRIDE_TYPE }}
353
375
  api.has_param :override_value, 'string'
376
+ api.has_param :primary_feed_ids, { list: 'string' }
354
377
  api.has_param :quoted_fields_mode, { enum: -> { ProductFeed::QUOTED_FIELDS_MODE }}
355
378
  api.has_param :rules, { list: 'string' }
356
379
  api.has_param :schedule, 'string'
@@ -379,6 +402,7 @@ module FacebookAds
379
402
  api.has_param :metadata, 'hash'
380
403
  api.has_param :name, 'string'
381
404
  api.has_param :ordering_info, { list: 'int' }
405
+ api.has_param :publish_to_shops, { list: 'hash' }
382
406
  api.has_param :retailer_id, 'string'
383
407
  end
384
408
  end
@@ -392,6 +416,8 @@ module FacebookAds
392
416
  has_edge :products do |edge|
393
417
  edge.get 'ProductItem' do |api|
394
418
  api.has_param :bulk_pagination, 'bool'
419
+ api.has_param :error_priority, { enum: -> { ProductItem::ERROR_PRIORITY }}
420
+ api.has_param :error_type, { enum: -> { ProductItem::ERROR_TYPE }}
395
421
  api.has_param :filter, 'object'
396
422
  api.has_param :return_only_approved_products, 'bool'
397
423
  end
@@ -418,12 +444,19 @@ module FacebookAds
418
444
  api.has_param :custom_label_2, 'string'
419
445
  api.has_param :custom_label_3, 'string'
420
446
  api.has_param :custom_label_4, 'string'
447
+ api.has_param :custom_number_0, 'int'
448
+ api.has_param :custom_number_1, 'int'
449
+ api.has_param :custom_number_2, 'int'
450
+ api.has_param :custom_number_3, 'int'
451
+ api.has_param :custom_number_4, 'int'
421
452
  api.has_param :description, 'string'
422
453
  api.has_param :expiration_date, 'string'
423
454
  api.has_param :fb_product_category, 'string'
424
455
  api.has_param :gender, { enum: -> { ProductItem::GENDER }}
425
456
  api.has_param :gtin, 'string'
426
457
  api.has_param :image_url, 'string'
458
+ api.has_param :importer_address, 'hash'
459
+ api.has_param :importer_name, 'string'
427
460
  api.has_param :inventory, 'int'
428
461
  api.has_param :ios_app_name, 'string'
429
462
  api.has_param :ios_app_store_id, 'int'
@@ -435,6 +468,7 @@ module FacebookAds
435
468
  api.has_param :iphone_app_store_id, 'int'
436
469
  api.has_param :iphone_url, 'string'
437
470
  api.has_param :launch_date, 'string'
471
+ api.has_param :manufacturer_info, 'string'
438
472
  api.has_param :manufacturer_part_number, 'string'
439
473
  api.has_param :marked_for_product_launch, { enum: -> { ProductItem::MARKED_FOR_PRODUCT_LAUNCH }}
440
474
  api.has_param :material, 'string'
@@ -444,6 +478,7 @@ module FacebookAds
444
478
  api.has_param :offer_price_end_date, 'datetime'
445
479
  api.has_param :offer_price_start_date, 'datetime'
446
480
  api.has_param :ordering_index, 'int'
481
+ api.has_param :origin_country, { enum: -> { ProductItem::ORIGIN_COUNTRY }}
447
482
  api.has_param :pattern, 'string'
448
483
  api.has_param :price, 'int'
449
484
  api.has_param :product_type, 'string'
@@ -459,6 +494,7 @@ module FacebookAds
459
494
  api.has_param :start_date, 'string'
460
495
  api.has_param :url, 'string'
461
496
  api.has_param :visibility, { enum: -> { ProductItem::VISIBILITY }}
497
+ api.has_param :wa_compliance_category, { enum: -> { ProductItem::WA_COMPLIANCE_CATEGORY }}
462
498
  api.has_param :windows_phone_app_id, 'string'
463
499
  api.has_param :windows_phone_app_name, 'string'
464
500
  api.has_param :windows_phone_url, 'string'
@@ -0,0 +1,46 @@
1
+ # Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
2
+ #
3
+ # You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
4
+ # copy, modify, and distribute this software in source code or binary form for use
5
+ # in connection with the web services and APIs provided by Facebook.
6
+ #
7
+ # As with any software that integrates with the Facebook platform, your use of
8
+ # this software is subject to the Facebook Platform Policy
9
+ # [http://developers.facebook.com/policy/]. This copyright notice shall be
10
+ # included in all copies or substantial portions of the software.
11
+ #
12
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
14
+ # FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
15
+ # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
16
+ # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
17
+ # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
18
+
19
+ # FB:AUTOGEN
20
+
21
+ module FacebookAds
22
+ # This class is auto-generated.
23
+
24
+ # For any issues or feature requests related to this class, please let us know
25
+ # on github and we'll fix in our codegen framework. We'll not be able to accept
26
+ # pull request for this class.
27
+
28
+ class ProductCatalogDataSource < AdObject
29
+ INGESTION_SOURCE_TYPE = [
30
+ "ALL",
31
+ "PRIMARY",
32
+ "SUPPLEMENTARY",
33
+ ]
34
+
35
+
36
+ field :app_id, 'string'
37
+ field :id, 'string'
38
+ field :ingestion_source_type, 'string'
39
+ field :name, 'string'
40
+ field :upload_type, 'string'
41
+ has_no_get
42
+ has_no_post
43
+ has_no_delete
44
+
45
+ end
46
+ end
@@ -34,6 +34,12 @@ module FacebookAds
34
34
  "us_marketplace",
35
35
  ]
36
36
 
37
+ AFFECTED_ENTITY = [
38
+ "product_catalog",
39
+ "product_item",
40
+ "product_set",
41
+ ]
42
+
37
43
  AFFECTED_FEATURES = [
38
44
  "augmented_reality",
39
45
  "checkout",
@@ -45,6 +51,7 @@ module FacebookAds
45
51
  ]
46
52
 
47
53
  TYPE = [
54
+ "AR_VISIBILITY_ISSUES",
48
55
  "ATTRIBUTES_INVALID",
49
56
  "ATTRIBUTES_MISSING",
50
57
  "CATEGORY",
@@ -55,12 +62,19 @@ module FacebookAds
55
62
  "SHOPS_VISIBILITY_ISSUES",
56
63
  ]
57
64
 
65
+ AFFECTED_ENTITIES = [
66
+ "product_catalog",
67
+ "product_item",
68
+ "product_set",
69
+ ]
70
+
58
71
  SEVERITIES = [
59
72
  "MUST_FIX",
60
73
  "OPPORTUNITY",
61
74
  ]
62
75
 
63
76
  TYPES = [
77
+ "AR_VISIBILITY_ISSUES",
64
78
  "ATTRIBUTES_INVALID",
65
79
  "ATTRIBUTES_MISSING",
66
80
  "CATEGORY",
@@ -73,9 +87,11 @@ module FacebookAds
73
87
 
74
88
 
75
89
  field :affected_channels, { list: { enum: -> { AFFECTED_CHANNELS }} }
90
+ field :affected_entity, { enum: -> { AFFECTED_ENTITY }}
76
91
  field :affected_features, { list: { enum: -> { AFFECTED_FEATURES }} }
77
92
  field :diagnostics, { list: 'object' }
78
93
  field :error_code, 'int'
94
+ field :number_of_affected_entities, 'int'
79
95
  field :number_of_affected_items, 'int'
80
96
  field :severity, { enum: -> { SEVERITY }}
81
97
  field :subtitle, 'string'