facebookbusiness 16.0.2 → 17.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad.rb +7 -0
  3. data/lib/facebook_ads/ad_objects/ad_account.rb +35 -4
  4. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +22 -0
  5. data/lib/facebook_ads/ad_objects/{instant_article_insights_query_result.rb → ad_account_business_constraints.rb} +2 -26
  6. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +2 -1
  7. data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb +2 -0
  8. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +259 -0
  9. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +3 -0
  10. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +2 -1
  11. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_stats_unsupported_reasons.rb +1 -1
  12. data/lib/facebook_ads/ad_objects/ad_creative.rb +6 -0
  13. data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads.rb +41 -0
  14. data/lib/facebook_ads/ad_objects/ad_creative_facebook_branded_content.rb +39 -0
  15. data/lib/facebook_ads/ad_objects/ad_creative_insights.rb +1 -1
  16. data/lib/facebook_ads/ad_objects/{commerce_merchant_tos_acceptance.rb → ad_creative_instagram_branded_content.rb} +4 -3
  17. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +2 -0
  18. data/lib/facebook_ads/ad_objects/ad_creative_link_data_template_video_spec.rb +1 -1
  19. data/lib/facebook_ads/ad_objects/ad_preview.rb +6 -1
  20. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +2 -0
  21. data/lib/facebook_ads/ad_objects/ad_rule.rb +4 -0
  22. data/lib/facebook_ads/ad_objects/ad_set.rb +4 -2
  23. data/lib/facebook_ads/ad_objects/ad_study_objective.rb +8 -0
  24. data/lib/facebook_ads/ad_objects/ad_video.rb +8 -0
  25. data/lib/facebook_ads/ad_objects/ads_insights.rb +8 -2
  26. data/lib/facebook_ads/ad_objects/ads_optimal_delivery_growth_opportunity.rb +1 -1
  27. data/lib/facebook_ads/ad_objects/ads_pixel.rb +4 -0
  28. data/lib/facebook_ads/ad_objects/application.rb +7 -1
  29. data/lib/facebook_ads/ad_objects/brand_request.rb +55 -0
  30. data/lib/facebook_ads/ad_objects/business.rb +25 -0
  31. data/lib/facebook_ads/ad_objects/campaign.rb +0 -3
  32. data/lib/facebook_ads/ad_objects/catalog_item_appeal_status.rb +9 -1
  33. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +2 -2
  34. data/lib/facebook_ads/ad_objects/cpas_business_setup_config.rb +2 -2
  35. data/lib/facebook_ads/ad_objects/cpas_merchant_config.rb +2 -2
  36. data/lib/facebook_ads/ad_objects/custom_audience.rb +3 -0
  37. data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +2 -0
  38. data/lib/facebook_ads/ad_objects/{ad_account_custom_audience.rb → custom_audience_group.rb} +1 -1
  39. data/lib/facebook_ads/ad_objects/extended_credit_invoice_group.rb +0 -1
  40. data/lib/facebook_ads/ad_objects/group.rb +0 -7
  41. data/lib/facebook_ads/ad_objects/ig_user.rb +1 -0
  42. data/lib/facebook_ads/ad_objects/instant_articles_stats.rb +3 -3
  43. data/lib/facebook_ads/ad_objects/job_opening.rb +91 -0
  44. data/lib/facebook_ads/ad_objects/lead.rb +1 -0
  45. data/lib/facebook_ads/ad_objects/leadgen_form.rb +1 -1
  46. data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +0 -11
  47. data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +39 -0
  48. data/lib/facebook_ads/ad_objects/page.rb +24 -42
  49. data/lib/facebook_ads/ad_objects/page_post_experiment.rb +1 -1
  50. data/lib/facebook_ads/ad_objects/product_catalog.rb +3 -22
  51. data/lib/facebook_ads/ad_objects/product_catalog_category.rb +1 -1
  52. data/lib/facebook_ads/ad_objects/product_feed_rule.rb +1 -1
  53. data/lib/facebook_ads/ad_objects/product_feed_rule_suggestion.rb +1 -1
  54. data/lib/facebook_ads/ad_objects/product_feed_schedule.rb +1 -11
  55. data/lib/facebook_ads/ad_objects/product_item.rb +10 -5
  56. data/lib/facebook_ads/ad_objects/reach_frequency_estimates_placement_breakdown.rb +3 -0
  57. data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +4 -4
  58. data/lib/facebook_ads/ad_objects/saved_audience.rb +0 -1
  59. data/lib/facebook_ads/ad_objects/server_side/event.rb +23 -3
  60. data/lib/facebook_ads/ad_objects/split_test_winner.rb +1 -1
  61. data/lib/facebook_ads/ad_objects/targeting_geo_location_electoral_district.rb +1 -0
  62. data/lib/facebook_ads/ad_objects/unified_thread.rb +1 -0
  63. data/lib/facebook_ads/ad_objects/url.rb +0 -2
  64. data/lib/facebook_ads/ad_objects/user.rb +3 -2
  65. data/lib/facebook_ads/ad_objects/vehicle_offer.rb +8 -0
  66. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +18 -0
  67. data/lib/facebook_ads/ad_objects/{instant_article.rb → whats_app_business_pre_verified_phone_number.rb} +21 -16
  68. data/lib/facebook_ads/field_types/datetime.rb +1 -1
  69. data/lib/facebook_ads/helpers/shortcuts.rb +1 -1
  70. data/lib/facebook_ads/version.rb +2 -2
  71. metadata +11 -7
  72. data/lib/facebook_ads/ad_objects/jobs_job.rb +0 -85
@@ -51,9 +51,11 @@ module FacebookAds
51
51
  "GET_DIRECTIONS",
52
52
  "GET_OFFER",
53
53
  "GET_OFFER_VIEW",
54
+ "GET_PROMOTIONS",
54
55
  "GET_QUOTE",
55
56
  "GET_SHOWTIMES",
56
57
  "GET_STARTED",
58
+ "INQUIRE_NOW",
57
59
  "INSTALL_APP",
58
60
  "INSTALL_MOBILE_APP",
59
61
  "LEARN_MORE",
@@ -168,6 +170,7 @@ module FacebookAds
168
170
  field :authorization_category, 'string'
169
171
  field :auto_update, 'bool'
170
172
  field :body, 'string'
173
+ field :branded_content, 'AdCreativeBrandedContentAds'
171
174
  field :branded_content_sponsor_page_id, 'string'
172
175
  field :bundle_folder_id, 'string'
173
176
  field :call_to_action_type, { enum: -> { CALL_TO_ACTION_TYPE }}
@@ -183,11 +186,13 @@ module FacebookAds
183
186
  field :effective_object_story_id, 'string'
184
187
  field :enable_direct_install, 'bool'
185
188
  field :enable_launch_instant_app, 'bool'
189
+ field :facebook_branded_content, 'AdCreativeFacebookBrandedContent'
186
190
  field :id, 'string'
187
191
  field :image_crops, 'AdsImageCrops'
188
192
  field :image_hash, 'string'
189
193
  field :image_url, 'string'
190
194
  field :instagram_actor_id, 'string'
195
+ field :instagram_branded_content, 'AdCreativeInstagramBrandedContent'
191
196
  field :instagram_permalink_url, 'string'
192
197
  field :instagram_story_id, 'string'
193
198
  field :instagram_user_id, 'string'
@@ -238,6 +243,7 @@ module FacebookAds
238
243
  has_edge :previews do |edge|
239
244
  edge.get 'AdPreview' do |api|
240
245
  api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
246
+ api.has_param :creative_feature, { enum: -> { AdPreview::CREATIVE_FEATURE }}
241
247
  api.has_param :dynamic_asset_label, 'string'
242
248
  api.has_param :dynamic_creative_spec, 'object'
243
249
  api.has_param :dynamic_customization, 'object'
@@ -0,0 +1,41 @@
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 AdCreativeBrandedContentAds < AdObject
29
+
30
+ field :ad_format, 'int'
31
+ field :creator_ad_permission_type, 'string'
32
+ field :instagram_boost_post_access_token, 'string'
33
+ field :partners, { list: 'object' }
34
+ field :ui_version, 'int'
35
+ has_no_id
36
+ has_no_get
37
+ has_no_post
38
+ has_no_delete
39
+
40
+ end
41
+ end
@@ -0,0 +1,39 @@
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 AdCreativeFacebookBrandedContent < AdObject
29
+
30
+ field :shared_to_sponsor_status, 'string'
31
+ field :sponsor_page_id, 'string'
32
+ field :sponsor_relationship, 'string'
33
+ has_no_id
34
+ has_no_get
35
+ has_no_post
36
+ has_no_delete
37
+
38
+ end
39
+ end
@@ -27,7 +27,7 @@ module FacebookAds
27
27
 
28
28
  class AdCreativeInsights < AdObject
29
29
 
30
- field :aesthetics, 'hash'
30
+ field :aesthetics, { list: 'hash' }
31
31
  has_no_id
32
32
  has_no_get
33
33
  has_no_post
@@ -25,10 +25,11 @@ 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 CommerceMerchantTosAcceptance < AdObject
28
+ class AdCreativeInstagramBrandedContent < AdObject
29
29
 
30
- field :business, 'Business'
31
- field :id, 'string'
30
+ field :sponsor_id, 'string'
31
+ has_no_id
32
+ has_no_get
32
33
  has_no_post
33
34
  has_no_delete
34
35
 
@@ -51,9 +51,11 @@ module FacebookAds
51
51
  "GET_DIRECTIONS",
52
52
  "GET_OFFER",
53
53
  "GET_OFFER_VIEW",
54
+ "GET_PROMOTIONS",
54
55
  "GET_QUOTE",
55
56
  "GET_SHOWTIMES",
56
57
  "GET_STARTED",
58
+ "INQUIRE_NOW",
57
59
  "INSTALL_APP",
58
60
  "INSTALL_MOBILE_APP",
59
61
  "LEARN_MORE",
@@ -28,7 +28,7 @@ module FacebookAds
28
28
  class AdCreativeLinkDataTemplateVideoSpec < AdObject
29
29
 
30
30
  field :categorization_criteria, 'string'
31
- field :customization, 'hash'
31
+ field :customization, { list: 'hash' }
32
32
  field :template_id, 'string'
33
33
  has_no_id
34
34
  has_no_get
@@ -50,9 +50,9 @@ module FacebookAds
50
50
  "INSTAGRAM_REELS_OVERLAY",
51
51
  "INSTAGRAM_SEARCH_CHAIN",
52
52
  "INSTAGRAM_SEARCH_GRID",
53
- "INSTAGRAM_SHOP",
54
53
  "INSTAGRAM_STANDARD",
55
54
  "INSTAGRAM_STORY",
55
+ "INSTAGRAM_STORY_CAMERA_TRAY",
56
56
  "INSTAGRAM_STORY_WEB",
57
57
  "INSTAGRAM_STORY_WEB_M_SITE",
58
58
  "INSTANT_ARTICLE_RECIRCULATION_AD",
@@ -81,12 +81,17 @@ module FacebookAds
81
81
  "WATCH_FEED_MOBILE",
82
82
  ]
83
83
 
84
+ CREATIVE_FEATURE = [
85
+ "profile_card",
86
+ ]
87
+
84
88
  RENDER_TYPE = [
85
89
  "FALLBACK",
86
90
  ]
87
91
 
88
92
 
89
93
  field :body, 'string'
94
+ field :transformation_spec, 'object'
90
95
  has_no_id
91
96
  has_no_get
92
97
  has_no_post
@@ -59,6 +59,7 @@ module FacebookAds
59
59
 
60
60
 
61
61
  field :application_id, 'string'
62
+ field :conversion_goal_id, 'string'
62
63
  field :custom_conversion_id, 'string'
63
64
  field :custom_event_str, 'string'
64
65
  field :custom_event_type, { enum: -> { CUSTOM_EVENT_TYPE }}
@@ -73,6 +74,7 @@ module FacebookAds
73
74
  field :pixel_aggregation_rule, 'string'
74
75
  field :pixel_id, 'string'
75
76
  field :pixel_rule, 'string'
77
+ field :place_page_set, 'AdPlacePageSet'
76
78
  field :place_page_set_id, 'string'
77
79
  field :product_catalog_id, 'string'
78
80
  field :product_item_id, 'string'
@@ -38,12 +38,16 @@ module FacebookAds
38
38
  "AM_ACTIVITY_HISTORY_TABLE",
39
39
  "AM_AD_OBJECT_NAME_CARD",
40
40
  "AM_AMFE_L3_RECOMMENDATION",
41
+ "AM_AUTOFLOW_GUIDANCE_CARD",
41
42
  "AM_AUTO_APPLY_WIDGET",
42
43
  "AM_EDITOR_CARD",
43
44
  "AM_INFO_CARD",
44
45
  "AM_NAME_CELL_DROPDOWN",
46
+ "AM_OPTIMIZATION_TIP_GUIDANCE_CARD",
45
47
  "AM_PERFORMANCE_SUMMARY",
46
48
  "AM_RULE_LANDING_PAGE_BANNER",
49
+ "AM_SYD_RESOLUTION_FLOW",
50
+ "AM_SYD_RESOLUTION_FLOW_MODAL",
47
51
  "AM_TOOLBAR_CREATE_RULE_DROPDOWN",
48
52
  "PE_CAMPAIGN_STRUCTURE_MENU",
49
53
  "PE_EDITOR_CARD",
@@ -85,6 +85,7 @@ module FacebookAds
85
85
  "QUALITY_CALL",
86
86
  "QUALITY_LEAD",
87
87
  "REACH",
88
+ "SUBSCRIBERS",
88
89
  "THRUPLAY",
89
90
  "VALUE",
90
91
  "VISIT_INSTAGRAM_PROFILE",
@@ -203,6 +204,8 @@ module FacebookAds
203
204
  field :daily_min_spend_target, 'string'
204
205
  field :daily_spend_cap, 'string'
205
206
  field :destination_type, 'string'
207
+ field :dsa_beneficiary, 'string'
208
+ field :dsa_payor, 'string'
206
209
  field :effective_status, { enum: -> { EFFECTIVE_STATUS }}
207
210
  field :end_time, 'datetime'
208
211
  field :existing_customer_budget_percentage, 'int'
@@ -232,7 +235,7 @@ module FacebookAds
232
235
  field :start_time, 'datetime'
233
236
  field :status, { enum: -> { STATUS }}
234
237
  field :targeting, 'Targeting'
235
- field :targeting_optimization_types, 'hash'
238
+ field :targeting_optimization_types, { list: 'hash' }
236
239
  field :time_based_ad_rotation_id_blocks, { list: { list: 'int' } }
237
240
  field :time_based_ad_rotation_intervals, { list: 'int' }
238
241
  field :updated_time, 'datetime'
@@ -247,7 +250,6 @@ module FacebookAds
247
250
  field :time_stop, 'datetime'
248
251
  field :topline_id, 'string'
249
252
  field :tune_for_category, { enum: -> { TUNE_FOR_CATEGORY }}
250
- field :upstream_events, 'hash'
251
253
 
252
254
  has_edge :activities do |edge|
253
255
  edge.get 'AdActivity' do |api|
@@ -57,6 +57,10 @@ module FacebookAds
57
57
  edge.get 'Application'
58
58
  end
59
59
 
60
+ has_edge :brand_requests do |edge|
61
+ edge.get 'BrandRequest'
62
+ end
63
+
60
64
  has_edge :customconversions do |edge|
61
65
  edge.get 'CustomConversion'
62
66
  end
@@ -65,6 +69,10 @@ module FacebookAds
65
69
  edge.get 'OfflineConversionDataSet'
66
70
  end
67
71
 
72
+ has_edge :partner_private_studies do |edge|
73
+ edge.get 'Business'
74
+ end
75
+
68
76
  has_edge :partnerstudies do |edge|
69
77
  edge.get 'PartnerStudy'
70
78
  end
@@ -70,6 +70,7 @@ module FacebookAds
70
70
  "EVENT_COVER_VIDEO",
71
71
  "EVENT_TOUR",
72
72
  "FACECAST_DVR",
73
+ "FB_AVATAR_ANIMATED_SATP",
73
74
  "FB_COLLECTIBLE_VIDEO",
74
75
  "FB_SHORTS",
75
76
  "FB_SHORTS_CONTENT_REMIXABLE",
@@ -396,6 +397,13 @@ module FacebookAds
396
397
  end
397
398
  end
398
399
 
400
+ has_edge :collaborators do |edge|
401
+ edge.get
402
+ edge.post 'AdVideo' do |api|
403
+ api.has_param :target_id, 'string'
404
+ end
405
+ end
406
+
399
407
  has_edge :comments do |edge|
400
408
  edge.get 'Comment' do |api|
401
409
  api.has_param :filter, { enum: -> { Comment::FILTER }}
@@ -64,14 +64,17 @@ module FacebookAds
64
64
  "app_id",
65
65
  "body_asset",
66
66
  "call_to_action_asset",
67
+ "coarse_conversion_value",
67
68
  "country",
68
69
  "description_asset",
69
70
  "device_platform",
70
71
  "dma",
72
+ "fidelity_type",
71
73
  "frequency_value",
72
74
  "gender",
73
75
  "hourly_stats_aggregated_by_advertiser_time_zone",
74
76
  "hourly_stats_aggregated_by_audience_time_zone",
77
+ "hsid",
75
78
  "image_asset",
76
79
  "impression_device",
77
80
  "is_conversion_id_modeled",
@@ -79,8 +82,10 @@ module FacebookAds
79
82
  "mmm",
80
83
  "place_page_id",
81
84
  "platform_position",
85
+ "postback_sequence_index",
82
86
  "product_id",
83
87
  "publisher_platform",
88
+ "redownload",
84
89
  "region",
85
90
  "skan_campaign_id",
86
91
  "skan_conversion_id",
@@ -137,12 +142,10 @@ module FacebookAds
137
142
  field :account_name, 'string'
138
143
  field :action_values, { list: 'AdsActionStats' }
139
144
  field :actions, { list: 'AdsActionStats' }
140
- field :ad_bid_value, 'string'
141
145
  field :ad_click_actions, { list: 'AdsActionStats' }
142
146
  field :ad_id, 'string'
143
147
  field :ad_impression_actions, { list: 'AdsActionStats' }
144
148
  field :ad_name, 'string'
145
- field :adset_bid_value, 'string'
146
149
  field :adset_end, 'string'
147
150
  field :adset_id, 'string'
148
151
  field :adset_name, 'string'
@@ -189,6 +192,7 @@ module FacebookAds
189
192
  field :cpm, 'string'
190
193
  field :cpp, 'string'
191
194
  field :created_time, 'string'
195
+ field :creative_media_type, 'string'
192
196
  field :ctr, 'string'
193
197
  field :date_start, 'string'
194
198
  field :date_stop, 'string'
@@ -209,6 +213,7 @@ module FacebookAds
209
213
  field :inline_link_click_ctr, 'string'
210
214
  field :inline_link_clicks, 'string'
211
215
  field :inline_post_engagement, 'string'
216
+ field :instagram_upcoming_event_reminders_set, 'string'
212
217
  field :instant_experience_clicks_to_open, 'string'
213
218
  field :instant_experience_clicks_to_start, 'string'
214
219
  field :instant_experience_outbound_clicks, { list: 'AdsActionStats' }
@@ -232,6 +237,7 @@ module FacebookAds
232
237
  field :spend, 'string'
233
238
  field :total_postbacks, 'string'
234
239
  field :total_postbacks_detailed, { list: 'AdsActionStats' }
240
+ field :total_postbacks_detailed_v4, 'string'
235
241
  field :unique_actions, { list: 'AdsActionStats' }
236
242
  field :unique_clicks, 'string'
237
243
  field :unique_conversions, { list: 'AdsActionStats' }
@@ -27,7 +27,7 @@ module FacebookAds
27
27
 
28
28
  class AdsOptimalDeliveryGrowthOpportunity < AdObject
29
29
 
30
- field :child_metadata, 'hash'
30
+ field :child_metadata, { list: 'hash' }
31
31
  field :metadata, 'object'
32
32
  field :optimization_type, 'string'
33
33
  has_no_id
@@ -155,6 +155,10 @@ module FacebookAds
155
155
  end
156
156
  end
157
157
 
158
+ has_edge :openbridge_configurations do |edge|
159
+ edge.get 'OpenBridgeConfiguration'
160
+ end
161
+
158
162
  has_edge :shadowtraffichelper do |edge|
159
163
  edge.post
160
164
  end
@@ -78,6 +78,7 @@ module FacebookAds
78
78
  ]
79
79
 
80
80
  LOGGING_SOURCE = [
81
+ "DETECTION",
81
82
  "MESSENGER_BOT",
82
83
  ]
83
84
 
@@ -323,8 +324,9 @@ module FacebookAds
323
324
  edge.post do |api|
324
325
  api.has_param :app_id, 'int'
325
326
  api.has_param :is_aem_ready, 'bool'
326
- api.has_param :is_aem_v2_ready, 'bool'
327
+ api.has_param :is_app_aem_ready, 'bool'
327
328
  api.has_param :is_skan_ready, 'bool'
329
+ api.has_param :message, 'string'
328
330
  end
329
331
  end
330
332
 
@@ -444,6 +446,10 @@ module FacebookAds
444
446
  edge.get
445
447
  end
446
448
 
449
+ has_edge :linked_dataset do |edge|
450
+ edge.get
451
+ end
452
+
447
453
  has_edge :mmp_auditing do |edge|
448
454
  edge.post do |api|
449
455
  api.has_param :advertiser_id, 'string'
@@ -0,0 +1,55 @@
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 BrandRequest < AdObject
29
+
30
+ field :ad_countries, { list: 'string' }
31
+ field :additional_contacts, { list: 'string' }
32
+ field :approval_level, 'int'
33
+ field :cells, { list: 'object' }
34
+ field :countries, { list: 'string' }
35
+ field :deny_reason, 'string'
36
+ field :end_time, 'datetime'
37
+ field :estimated_reach, 'int'
38
+ field :id, 'string'
39
+ field :is_multicell, 'bool'
40
+ field :locale, 'string'
41
+ field :max_age, 'int'
42
+ field :min_age, 'int'
43
+ field :questions, { list: 'object' }
44
+ field :region, 'string'
45
+ field :request_status, 'string'
46
+ field :review_date, 'datetime'
47
+ field :start_time, 'datetime'
48
+ field :status, 'string'
49
+ field :submit_date, 'datetime'
50
+ field :total_budget, 'int'
51
+ has_no_post
52
+ has_no_delete
53
+
54
+ end
55
+ end
@@ -400,6 +400,12 @@ module FacebookAds
400
400
  end
401
401
  end
402
402
 
403
+ has_edge :add_phone_numbers do |edge|
404
+ edge.post 'Business' do |api|
405
+ api.has_param :phone_number, 'string'
406
+ end
407
+ end
408
+
403
409
  has_edge :adnetwork_applications do |edge|
404
410
  edge.post 'Application' do |api|
405
411
  api.has_param :name, 'string'
@@ -724,6 +730,18 @@ module FacebookAds
724
730
  end
725
731
  end
726
732
 
733
+ has_edge :openbridge_configurations do |edge|
734
+ edge.get 'OpenBridgeConfiguration'
735
+ edge.post 'OpenBridgeConfiguration' do |api|
736
+ api.has_param :access_key, 'string'
737
+ api.has_param :active, 'bool'
738
+ api.has_param :endpoint, 'string'
739
+ api.has_param :host_business_id, 'int'
740
+ api.has_param :host_external_id, 'string'
741
+ api.has_param :pixel_id, 'int'
742
+ end
743
+ end
744
+
727
745
  has_edge :owned_ad_accounts do |edge|
728
746
  edge.get 'AdAccount' do |api|
729
747
  api.has_param :search_query, 'string'
@@ -863,6 +881,13 @@ module FacebookAds
863
881
  edge.post
864
882
  end
865
883
 
884
+ has_edge :preverified_numbers do |edge|
885
+ edge.get 'WhatsAppBusinessPreVerifiedPhoneNumber' do |api|
886
+ api.has_param :code_verification_status, { enum: -> { WhatsAppBusinessPreVerifiedPhoneNumber::CODE_VERIFICATION_STATUS }}
887
+ api.has_param :phone_number, 'string'
888
+ end
889
+ end
890
+
866
891
  has_edge :received_audience_sharing_requests do |edge|
867
892
  edge.get 'BusinessAssetSharingAgreement' do |api|
868
893
  api.has_param :initiator_id, 'string'
@@ -397,8 +397,6 @@ module FacebookAds
397
397
 
398
398
 
399
399
  field :account_id, 'string'
400
- field :ad_strategy_group_id, 'string'
401
- field :ad_strategy_id, 'string'
402
400
  field :adlabels, { list: 'AdLabel' }
403
401
  field :bid_strategy, { enum: -> { BID_STRATEGY }}
404
402
  field :boosted_object_id, 'string'
@@ -439,7 +437,6 @@ module FacebookAds
439
437
  field :adbatch, { list: 'object' }
440
438
  field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
441
439
  field :iterative_split_test_configs, { list: 'object' }
442
- field :upstream_events, 'hash'
443
440
 
444
441
  has_edge :ad_studies do |edge|
445
442
  edge.get 'AdStudy'
@@ -26,10 +26,18 @@ module FacebookAds
26
26
  # pull request for this class.
27
27
 
28
28
  class CatalogItemAppealStatus < AdObject
29
+ STATUS = [
30
+ "This item cannot be appealed as it is either approved or already has an appeal",
31
+ "This item is not rejected for any of channels",
32
+ "We&#39;ve encountered unexpected error while processing this request. Please try again later !",
33
+ "You&#39;ve reached the maximum number of item requests you can make this week. You&#39;ll be able to request item reviews again within the next 7 days.",
34
+ "Your request was received. See information below to learn more.",
35
+ ]
36
+
29
37
 
30
38
  field :handle, 'string'
31
39
  field :item_id, 'int'
32
- field :status, 'string'
40
+ field :status, { enum: -> { STATUS }}
33
41
  field :use_cases, { list: 'object' }
34
42
  has_no_id
35
43
  has_no_get
@@ -46,12 +46,12 @@ module FacebookAds
46
46
  field :merchant_status, 'string'
47
47
  field :onsite_commerce_merchant, 'object'
48
48
  field :payment_provider, 'string'
49
- field :privacy_url_by_locale, 'hash'
49
+ field :privacy_url_by_locale, { list: 'hash' }
50
50
  field :review_rejection_messages, { list: 'string' }
51
51
  field :review_rejection_reasons, { list: 'string' }
52
52
  field :supported_card_types, { list: 'string' }
53
53
  field :terms, 'string'
54
- field :terms_url_by_locale, 'hash'
54
+ field :terms_url_by_locale, { list: 'hash' }
55
55
  field :whatsapp_channel, 'object'
56
56
  has_no_post
57
57
  has_no_delete
@@ -29,8 +29,8 @@ module FacebookAds
29
29
 
30
30
  field :accepted_collab_ads_tos, 'bool'
31
31
  field :business, 'Business'
32
- field :business_capabilities_status, 'hash'
33
- field :capabilities_compliance_status, 'hash'
32
+ field :business_capabilities_status, { list: 'hash' }
33
+ field :capabilities_compliance_status, { list: 'hash' }
34
34
  field :id, 'string'
35
35
  field :ad_accounts, { list: 'string' }
36
36
  has_no_post
@@ -29,10 +29,10 @@ module FacebookAds
29
29
 
30
30
  field :accepted_tos, 'bool'
31
31
  field :beta_features, { list: 'string' }
32
- field :business_outcomes_status, 'hash'
32
+ field :business_outcomes_status, { list: 'hash' }
33
33
  field :id, 'string'
34
34
  field :is_test_merchant, 'bool'
35
- field :outcomes_compliance_status, 'hash'
35
+ field :outcomes_compliance_status, { list: 'hash' }
36
36
  field :qualified_to_onboard, 'bool'
37
37
  has_no_post
38
38
  has_no_delete
@@ -63,6 +63,7 @@ module FacebookAds
63
63
  SUBTYPE = [
64
64
  "APP",
65
65
  "BAG_OF_ACCOUNTS",
66
+ "BIDDING",
66
67
  "CLAIM",
67
68
  "CUSTOM",
68
69
  "ENGAGEMENT",
@@ -72,6 +73,7 @@ module FacebookAds
72
73
  "MEASUREMENT",
73
74
  "OFFLINE_CONVERSION",
74
75
  "PARTNER",
76
+ "PRIMARY",
75
77
  "REGULATED_CATEGORIES_AUDIENCE",
76
78
  "STUDY_RULE_AUDIENCE",
77
79
  "VIDEO",
@@ -141,6 +143,7 @@ module FacebookAds
141
143
  field :partner_reference_key, 'string'
142
144
  field :prefill, 'bool'
143
145
  field :product_set_id, 'string'
146
+ field :use_in_campaigns, 'bool'
144
147
  field :video_group_ids, { list: 'string' }
145
148
 
146
149
  has_edge :adaccounts do |edge|
@@ -29,6 +29,7 @@ module FacebookAds
29
29
  SUB_TYPE = [
30
30
  "ANYTHING",
31
31
  "APP_USERS",
32
+ "AR_EFFECTS_EVENTS",
32
33
  "AR_EXPERIENCE_EVENTS",
33
34
  "CAMPAIGN_CONVERSIONS",
34
35
  "COMBINATION_CUSTOM_AUDIENCE_USERS",
@@ -75,6 +76,7 @@ module FacebookAds
75
76
  "SIGNAL_SOURCE",
76
77
  "SMART_AUDIENCE",
77
78
  "STORE_VISIT_EVENTS",
79
+ "SUBSCRIBER_LIST",
78
80
  "S_EXPR",
79
81
  "TOKENS",
80
82
  "USER_IDS",
@@ -25,7 +25,7 @@ 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 AdAccountCustomAudience < AdObject
28
+ class CustomAudienceGroup < AdObject
29
29
 
30
30
  field :audience_type_param_name, 'string'
31
31
  field :existing_customer_tag, 'string'