facebookbusiness 0.14.0.0 → 0.15.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 (64) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad_account.rb +14 -20
  3. data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +1 -0
  4. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +8 -0
  5. data/lib/facebook_ads/ad_objects/{content_delivery_report.rb → ad_account_custom_audience.rb} +4 -58
  6. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +1 -0
  7. data/lib/facebook_ads/ad_objects/ad_activity.rb +1 -0
  8. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +2 -0
  9. data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +1 -0
  10. data/lib/facebook_ads/ad_objects/ad_creative.rb +2 -6
  11. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +2 -0
  12. data/lib/facebook_ads/ad_objects/ad_image.rb +1 -0
  13. data/lib/facebook_ads/ad_objects/ad_monetization_property.rb +1 -0
  14. data/lib/facebook_ads/ad_objects/ad_network_analytics_async_query_result.rb +1 -0
  15. data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +1 -0
  16. data/lib/facebook_ads/ad_objects/ad_preview.rb +4 -0
  17. data/lib/facebook_ads/ad_objects/ad_rule.rb +1 -1
  18. data/lib/facebook_ads/ad_objects/ad_rule_history.rb +1 -0
  19. data/lib/facebook_ads/ad_objects/ad_set.rb +0 -10
  20. data/lib/facebook_ads/ad_objects/ad_study.rb +14 -1
  21. data/lib/facebook_ads/ad_objects/ad_video.rb +12 -0
  22. data/lib/facebook_ads/ad_objects/adgroup_metadata.rb +41 -0
  23. data/lib/facebook_ads/ad_objects/ads_insights.rb +4 -0
  24. data/lib/facebook_ads/ad_objects/ads_pixel.rb +5 -1
  25. data/lib/facebook_ads/ad_objects/application.rb +10 -0
  26. data/lib/facebook_ads/ad_objects/business.rb +27 -25
  27. data/lib/facebook_ads/ad_objects/business_asset_group.rb +1 -0
  28. data/lib/facebook_ads/ad_objects/business_partner_premium_options.rb +39 -0
  29. data/lib/facebook_ads/ad_objects/business_user.rb +1 -0
  30. data/lib/facebook_ads/ad_objects/campaign.rb +3 -11
  31. data/lib/facebook_ads/ad_objects/canvas.rb +2 -1
  32. data/lib/facebook_ads/ad_objects/{third_party_measurement_report_dataset.rb → canvas_dynamic_setting.rb} +4 -5
  33. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +11 -0
  34. data/lib/facebook_ads/ad_objects/crm_address.rb +48 -0
  35. data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -0
  36. data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +1 -0
  37. data/lib/facebook_ads/ad_objects/event.rb +22 -26
  38. data/lib/facebook_ads/ad_objects/event_source_group.rb +1 -0
  39. data/lib/facebook_ads/ad_objects/experience.rb +1 -1
  40. data/lib/facebook_ads/ad_objects/extended_credit.rb +3 -0
  41. data/lib/facebook_ads/ad_objects/extended_credit_invoice_group.rb +3 -0
  42. data/lib/facebook_ads/ad_objects/group.rb +0 -70
  43. data/lib/facebook_ads/ad_objects/ig_user.rb +1 -0
  44. data/lib/facebook_ads/ad_objects/{canvas_template.rb → igbc_ads_permission.rb} +2 -13
  45. data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +3 -3
  46. data/lib/facebook_ads/ad_objects/instagram_user.rb +1 -0
  47. data/lib/facebook_ads/ad_objects/leadgen_form.rb +1 -0
  48. data/lib/facebook_ads/ad_objects/media_title.rb +79 -0
  49. data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +2 -0
  50. data/lib/facebook_ads/ad_objects/page.rb +39 -12
  51. data/lib/facebook_ads/ad_objects/private_lift_study_instance.rb +2 -0
  52. data/lib/facebook_ads/ad_objects/product_catalog.rb +9 -3
  53. data/lib/facebook_ads/ad_objects/product_feed.rb +8 -2
  54. data/lib/facebook_ads/ad_objects/product_item.rb +10 -0
  55. data/lib/facebook_ads/ad_objects/product_set.rb +7 -0
  56. data/lib/facebook_ads/ad_objects/saved_audience.rb +1 -0
  57. data/lib/facebook_ads/ad_objects/shop.rb +1 -0
  58. data/lib/facebook_ads/ad_objects/user.rb +9 -9
  59. data/lib/facebook_ads/ad_objects/user_page_one_time_opt_in_token_settings.rb +44 -0
  60. data/lib/facebook_ads/ad_objects/vehicle.rb +1 -0
  61. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +11 -2
  62. data/lib/facebook_ads/ad_objects/whats_app_business_pre_verified_phone_number.rb +37 -0
  63. data/lib/facebook_ads/version.rb +2 -2
  64. metadata +11 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cfeeae322f41c46f8eede6ac5d68e8e18f78b03ab3bdb6b71beb94df2e7918e3
4
- data.tar.gz: 98bba522d56d2cd44601fdd5a303cce5477c1e1e2e17b3d11784aebf133eb8df
3
+ metadata.gz: cac806d93783e96b40037e8b767584c7b525c53928354af5b47610a0ea660b8f
4
+ data.tar.gz: ce451ff0c8a61b4e9c819a2fceaab5966b6fa00e89740db5455e11b549733157
5
5
  SHA512:
6
- metadata.gz: 988d0881bfe4de308bd6bd47fcfc787d6f78faab73964e10f62e24b12aefc1eeadef5724be44c2e44aab3b7e96c4c92205d3b6db3b22c83bf3f0e37b9d0aa63c
7
- data.tar.gz: bf1748a3533538d22c34dbf34609b64eefcf553fefecf866da87e67ddb76df8c5f9ea27056bd4e5a91f0b2f63e80d138ee0feb526e5585772d469650b40c514a
6
+ metadata.gz: ce584a597621a7c5cedad21fe540dbbcdf4b76cc7c96eb851dbf63275e2ead7ead28b9a4b1d25182f49ad126ff10454d98f83d6bbe3931961ea774443c8fee21
7
+ data.tar.gz: 327a7d8b1aa2a6df2243aeb8fbf18d0f013ea2f9f5138a95ac3816c9b6ea0daa779823d67930faf3c843a0ab881de4d8181cdc15f2d2a751b814a87160c0c611
@@ -158,6 +158,7 @@ module FacebookAds
158
158
  field :capabilities, { list: 'string' }
159
159
  field :created_time, 'datetime'
160
160
  field :currency, 'string'
161
+ field :custom_audience_info, 'AdAccountCustomAudience'
161
162
  field :disable_reason, 'int'
162
163
  field :end_advertiser, 'string'
163
164
  field :end_advertiser_name, 'string'
@@ -179,6 +180,7 @@ module FacebookAds
179
180
  field :is_personal, 'int'
180
181
  field :is_prepay_account, 'bool'
181
182
  field :is_tax_id_required, 'bool'
183
+ field :liable_address, 'CrmAddress'
182
184
  field :line_numbers, { list: 'int' }
183
185
  field :media_agency, 'string'
184
186
  field :min_campaign_group_spend_cap, 'string'
@@ -186,9 +188,12 @@ module FacebookAds
186
188
  field :name, 'string'
187
189
  field :offsite_pixels_tos_accepted, 'bool'
188
190
  field :owner, 'string'
191
+ field :owner_business, 'Business'
189
192
  field :partner, 'string'
190
193
  field :rf_spec, 'ReachFrequencySpec'
194
+ field :send_bill_to_address, 'CrmAddress'
191
195
  field :show_checkout_experience, 'bool'
196
+ field :sold_to_address, 'CrmAddress'
192
197
  field :spend_cap, 'string'
193
198
  field :tax_id, 'string'
194
199
  field :tax_id_status, 'int'
@@ -199,6 +204,7 @@ module FacebookAds
199
204
  field :tos_accepted, 'hash'
200
205
  field :user_tasks, { list: 'string' }
201
206
  field :user_tos_accepted, 'hash'
207
+ field :viewable_business, 'Business'
202
208
  has_no_delete
203
209
 
204
210
  has_edge :activities do |edge|
@@ -274,7 +280,6 @@ module FacebookAds
274
280
  api.has_param :instagram_actor_id, 'string'
275
281
  api.has_param :instagram_permalink_url, 'string'
276
282
  api.has_param :instagram_user_id, 'string'
277
- api.has_param :instant_checkout_setting, { enum: -> { AdCreative::INSTANT_CHECKOUT_SETTING }}
278
283
  api.has_param :interactive_components_spec, 'hash'
279
284
  api.has_param :is_dco_internal, 'bool'
280
285
  api.has_param :link_og_id, 'string'
@@ -321,6 +326,7 @@ module FacebookAds
321
326
  api.has_param :minheight, 'int'
322
327
  api.has_param :minwidth, 'int'
323
328
  api.has_param :name, 'string'
329
+ api.has_param :selected_hashes, { list: 'string' }
324
330
  end
325
331
  edge.post list: 'AdImage' do |api|
326
332
  api.has_param :bytes, 'object'
@@ -400,6 +406,12 @@ module FacebookAds
400
406
  end
401
407
  end
402
408
 
409
+ has_edge :ads_reporting_mmm_reports do |edge|
410
+ edge.get do |api|
411
+ api.has_param :filtering, { list: 'hash' }
412
+ end
413
+ end
414
+
403
415
  has_edge :ads_volume do |edge|
404
416
  edge.get 'AdAccountAdVolume' do |api|
405
417
  api.has_param :page_id, 'int'
@@ -704,25 +716,6 @@ module FacebookAds
704
716
  edge.get 'IgUser'
705
717
  end
706
718
 
707
- has_edge :content_delivery_report do |edge|
708
- edge.get 'ContentDeliveryReport' do |api|
709
- api.has_param :end_date, 'datetime'
710
- api.has_param :page_id, 'int'
711
- api.has_param :platform, { enum: -> { ContentDeliveryReport::PLATFORM }}
712
- api.has_param :position, { enum: -> { ContentDeliveryReport::POSITION }}
713
- api.has_param :start_date, 'datetime'
714
- api.has_param :summary, 'bool'
715
- end
716
- end
717
-
718
- has_edge :create_and_apply_publisher_block_list do |edge|
719
- edge.post do |api|
720
- api.has_param :is_auto_blocking_on, 'bool'
721
- api.has_param :name, 'string'
722
- api.has_param :publisher_urls, { list: 'string' }
723
- end
724
- end
725
-
726
719
  has_edge :customaudiences do |edge|
727
720
  edge.get 'CustomAudience' do |api|
728
721
  api.has_param :business_id, 'string'
@@ -889,6 +882,7 @@ module FacebookAds
889
882
  api.has_param :campaign_group_id, 'int'
890
883
  api.has_param :campaign_group_status, { enum: %w{ACTIVE ADSET_PAUSED ARCHIVED CAMPAIGN_PAUSED DELETED DISAPPROVED IN_PROCESS PAUSED PENDING_BILLING_INFO PENDING_REVIEW PREAPPROVED WITH_ISSUES }}
891
884
  api.has_param :conversion_domain, 'string'
885
+ api.has_param :custom_event_type, { enum: %w{ADD_TO_CART CONTENT_VIEW PURCHASE }}
892
886
  api.has_param :end_time, 'int'
893
887
  api.has_param :lifetime_budget, 'int'
894
888
  api.has_param :override_creative_text, 'string'
@@ -31,6 +31,7 @@ module FacebookAds
31
31
  "CHANGED_BID",
32
32
  "CHANGED_BUDGET",
33
33
  "EMAIL",
34
+ "ENABLE_AUTOFLOW",
34
35
  "ENDPOINT_PINGED",
35
36
  "ERROR",
36
37
  "FACEBOOK_NOTIFICATION_SENT",
@@ -35,6 +35,8 @@ module FacebookAds
35
35
  "AUCTION_OVERLAP_CONSOLIDATION",
36
36
  "AUDIENCE_EXPANSION",
37
37
  "AUTOFLOW_OPT_IN",
38
+ "AUTOMATIC_PLACEMENTS",
39
+ "CAPI",
38
40
  "CREATIVE_BADGE",
39
41
  "CREATIVE_FATIGUE",
40
42
  "CREATIVE_LIMITED",
@@ -42,10 +44,16 @@ module FacebookAds
42
44
  "ECOSYSTEM_BID_REDUCE_L1_CARDINALITY",
43
45
  "FRAGMENTATION",
44
46
  "LEARNING_LIMITED",
47
+ "LOW_OUTCOME",
48
+ "MULTI_TEXT",
49
+ "MUSIC",
50
+ "PREDICTIVE_CREATIVE_LIMITED",
51
+ "REVERT",
45
52
  "SYD_TEST_MODE",
46
53
  "TOP_ADSETS_WITH_ADS_UNDER_CAP",
47
54
  "TOP_CAMPAIGNS_WITH_ADS_UNDER_CAP",
48
55
  "UNECONOMICAL_ADS_THROTTLING",
56
+ "UNUSED_BUDGET",
49
57
  "ZERO_IMPRESSION",
50
58
  ]
51
59
 
@@ -25,65 +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 ContentDeliveryReport < AdObject
29
- PLATFORM = [
30
- "AUDIENCE_NETWORK",
31
- "FACEBOOK",
32
- "HIDDEN_AAA",
33
- "INSTAGRAM",
34
- "MESSENGER",
35
- "OCULUS",
36
- "UNKNOWN",
37
- "WHATSAPP",
38
- ]
28
+ class AdAccountCustomAudience < AdObject
39
29
 
40
- POSITION = [
41
- "ALL_PLACEMENTS",
42
- "AN_CLASSIC",
43
- "BIZ_DISCO_FEED",
44
- "FACEBOOK_GROUPS_FEED",
45
- "FACEBOOK_REELS",
46
- "FACEBOOK_REELS_OVERLAY",
47
- "FACEBOOK_STORIES",
48
- "FEED",
49
- "GROUPS",
50
- "HIDDEN_AAA",
51
- "INSTAGRAM_EXPLORE",
52
- "INSTAGRAM_IGTV",
53
- "INSTAGRAM_REELS",
54
- "INSTAGRAM_REELS_OVERLAY",
55
- "INSTAGRAM_SHOP",
56
- "INSTAGRAM_STORIES",
57
- "INSTANT_ARTICLE",
58
- "INSTREAM_VIDEO",
59
- "JOBS_BROWSER",
60
- "MARKETPLACE",
61
- "MESSENGER_INBOX",
62
- "MESSENGER_STORIES",
63
- "OCULUS_REWARDED_VIDEO",
64
- "OCULUS_TWILIGHT_DEVELOPER_UPDATE",
65
- "OCULUS_TWILIGHT_FEED",
66
- "OCULUS_TWILIGHT_FEED_SPOTLIGHT",
67
- "OCULUS_TWILIGHT_SEARCH",
68
- "OCULUS_TWILIGHT_SEARCH_NULL_STATE",
69
- "OCULUS_VR_APPS",
70
- "OTHERS",
71
- "REWARDED_VIDEO",
72
- "RIGHT_HAND_COLUMN",
73
- "SEARCH",
74
- "STATUS",
75
- "STICKERS",
76
- "SUGGESTED_VIDEO",
77
- "UNKNOWN",
78
- "VIDEO_FEEDS",
79
- ]
80
-
81
-
82
- field :content_name, 'string'
83
- field :content_url, 'string'
84
- field :creator_name, 'string'
85
- field :creator_url, 'string'
86
- field :estimated_impressions, 'int'
30
+ field :audience_type_param_name, 'string'
31
+ field :existing_customer_tag, 'string'
32
+ field :new_customer_tag, 'string'
87
33
  has_no_id
88
34
  has_no_get
89
35
  has_no_post
@@ -170,6 +170,7 @@ module FacebookAds
170
170
  "relationship_statuses",
171
171
  "rtb_flag",
172
172
  "site_category",
173
+ "targeting_automation",
173
174
  "targeting_optimization",
174
175
  "targeting_relaxation_types",
175
176
  "timezones",
@@ -63,6 +63,7 @@ module FacebookAds
63
63
  "funding_event_initiated",
64
64
  "funding_event_successful",
65
65
  "lifetime_budget_spent",
66
+ "merge_campaigns",
66
67
  "receive_audience",
67
68
  "remove_funding_source",
68
69
  "remove_shared_audience",
@@ -63,12 +63,14 @@ module FacebookAds
63
63
  "MOBILE_DOWNLOAD",
64
64
  "MOMENTS",
65
65
  "NO_BUTTON",
66
+ "OPEN_INSTANT_APP",
66
67
  "OPEN_LINK",
67
68
  "ORDER_NOW",
68
69
  "PAY_TO_ACCESS",
69
70
  "PLAY_GAME",
70
71
  "PLAY_GAME_ON_FACEBOOK",
71
72
  "PURCHASE_GIFT_CARDS",
73
+ "RAISE_MONEY",
72
74
  "RECORD_NOW",
73
75
  "REFER_FRIENDS",
74
76
  "REQUEST_TIME",
@@ -177,6 +177,7 @@ module FacebookAds
177
177
  field :targeting_old, 'object'
178
178
  field :updated_time_new, 'datetime'
179
179
  field :updated_time_old, 'datetime'
180
+ field :user, 'User'
180
181
  has_no_post
181
182
  has_no_delete
182
183
 
@@ -63,12 +63,14 @@ module FacebookAds
63
63
  "MOBILE_DOWNLOAD",
64
64
  "MOMENTS",
65
65
  "NO_BUTTON",
66
+ "OPEN_INSTANT_APP",
66
67
  "OPEN_LINK",
67
68
  "ORDER_NOW",
68
69
  "PAY_TO_ACCESS",
69
70
  "PLAY_GAME",
70
71
  "PLAY_GAME_ON_FACEBOOK",
71
72
  "PURCHASE_GIFT_CARDS",
73
+ "RAISE_MONEY",
72
74
  "RECORD_NOW",
73
75
  "REFER_FRIENDS",
74
76
  "REQUEST_TIME",
@@ -150,11 +152,6 @@ module FacebookAds
150
152
  "STORY_OWNER",
151
153
  ]
152
154
 
153
- INSTANT_CHECKOUT_SETTING = [
154
- "off",
155
- "on",
156
- ]
157
-
158
155
  OPERATOR = [
159
156
  "ALL",
160
157
  "ANY",
@@ -223,7 +220,6 @@ module FacebookAds
223
220
  field :video_id, 'string'
224
221
  field :call_to_action, 'object'
225
222
  field :image_file, 'string'
226
- field :instant_checkout_setting, { enum: -> { INSTANT_CHECKOUT_SETTING }}
227
223
  field :is_dco_internal, 'bool'
228
224
 
229
225
  has_edge :adlabels do |edge|
@@ -63,12 +63,14 @@ module FacebookAds
63
63
  "MOBILE_DOWNLOAD",
64
64
  "MOMENTS",
65
65
  "NO_BUTTON",
66
+ "OPEN_INSTANT_APP",
66
67
  "OPEN_LINK",
67
68
  "ORDER_NOW",
68
69
  "PAY_TO_ACCESS",
69
70
  "PLAY_GAME",
70
71
  "PLAY_GAME_ON_FACEBOOK",
71
72
  "PURCHASE_GIFT_CARDS",
73
+ "RAISE_MONEY",
72
74
  "RECORD_NOW",
73
75
  "REFER_FRIENDS",
74
76
  "REQUEST_TIME",
@@ -43,6 +43,7 @@ module FacebookAds
43
43
  field :name, 'string'
44
44
  field :original_height, 'int'
45
45
  field :original_width, 'int'
46
+ field :owner_business, 'Business'
46
47
  field :permalink_url, 'string'
47
48
  field :status, { enum: -> { STATUS }}
48
49
  field :updated_time, 'datetime'
@@ -27,6 +27,7 @@ module FacebookAds
27
27
 
28
28
  class AdMonetizationProperty < AdObject
29
29
 
30
+ field :owner_business, 'Business'
30
31
  field :id, 'string'
31
32
  has_no_post
32
33
  has_no_delete
@@ -29,6 +29,7 @@ module FacebookAds
29
29
 
30
30
  field :data, 'object'
31
31
  field :error, 'object'
32
+ field :omitted_results, { list: 'object' }
32
33
  field :query_id, 'string'
33
34
  field :results, { list: 'object' }
34
35
  field :status, 'string'
@@ -90,6 +90,7 @@ module FacebookAds
90
90
  ]
91
91
 
92
92
 
93
+ field :omitted_results, { list: 'object' }
93
94
  field :query_id, 'string'
94
95
  field :results, { list: 'object' }
95
96
  has_no_id
@@ -48,9 +48,13 @@ module FacebookAds
48
48
  "INSTAGRAM_PROFILE_FEED",
49
49
  "INSTAGRAM_REELS",
50
50
  "INSTAGRAM_REELS_OVERLAY",
51
+ "INSTAGRAM_SEARCH_CHAIN",
52
+ "INSTAGRAM_SEARCH_GRID",
51
53
  "INSTAGRAM_SHOP",
52
54
  "INSTAGRAM_STANDARD",
53
55
  "INSTAGRAM_STORY",
56
+ "INSTAGRAM_STORY_WEB",
57
+ "INSTAGRAM_STORY_WEB_M_SITE",
54
58
  "INSTANT_ARTICLE_RECIRCULATION_AD",
55
59
  "INSTANT_ARTICLE_STANDARD",
56
60
  "INSTREAM_BANNER_DESKTOP",
@@ -38,9 +38,9 @@ module FacebookAds
38
38
  "AM_ACTIVITY_HISTORY_TABLE",
39
39
  "AM_AD_OBJECT_NAME_CARD",
40
40
  "AM_AMFE_L3_RECOMMENDATION",
41
+ "AM_AUTO_APPLY_WIDGET",
41
42
  "AM_EDITOR_CARD",
42
43
  "AM_INFO_CARD",
43
- "AM_MID_FLIGHT_RESOLUTION_CARD",
44
44
  "AM_NAME_CELL_DROPDOWN",
45
45
  "AM_PERFORMANCE_SUMMARY",
46
46
  "AM_RULE_LANDING_PAGE_BANNER",
@@ -31,6 +31,7 @@ module FacebookAds
31
31
  "CHANGED_BID",
32
32
  "CHANGED_BUDGET",
33
33
  "EMAIL",
34
+ "ENABLE_AUTOFLOW",
34
35
  "ENDPOINT_PINGED",
35
36
  "ERROR",
36
37
  "FACEBOOK_NOTIFICATION_SENT",
@@ -299,16 +299,6 @@ module FacebookAds
299
299
  end
300
300
  end
301
301
 
302
- has_edge :content_delivery_report do |edge|
303
- edge.get 'ContentDeliveryReport' do |api|
304
- api.has_param :end_date, 'datetime'
305
- api.has_param :platform, { enum: -> { ContentDeliveryReport::PLATFORM }}
306
- api.has_param :position, { enum: -> { ContentDeliveryReport::POSITION }}
307
- api.has_param :start_date, 'datetime'
308
- api.has_param :summary, 'bool'
309
- end
310
- end
311
-
312
302
  has_edge :copies do |edge|
313
303
  edge.get 'AdSet' do |api|
314
304
  api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
@@ -36,21 +36,23 @@ module FacebookAds
36
36
 
37
37
  field :business, 'Business'
38
38
  field :canceled_time, 'datetime'
39
+ field :client_business, 'Business'
39
40
  field :cooldown_start_time, 'datetime'
40
41
  field :created_by, 'User'
41
42
  field :created_time, 'datetime'
42
43
  field :description, 'string'
43
44
  field :end_time, 'datetime'
44
45
  field :id, 'string'
46
+ field :measurement_contact, 'User'
45
47
  field :name, 'string'
46
48
  field :observation_end_time, 'datetime'
47
49
  field :results_first_available_date, 'string'
50
+ field :sales_contact, 'User'
48
51
  field :start_time, 'datetime'
49
52
  field :type, 'string'
50
53
  field :updated_by, 'User'
51
54
  field :updated_time, 'datetime'
52
55
  field :cells, { list: 'object' }
53
- field :client_business, 'string'
54
56
  field :confidence_level, 'double'
55
57
  field :objectives, { list: 'object' }
56
58
  field :viewers, { list: 'int' }
@@ -59,10 +61,21 @@ module FacebookAds
59
61
  edge.get 'AdStudyCell'
60
62
  end
61
63
 
64
+ has_edge :checkpoint do |edge|
65
+ edge.post 'AdStudy' do |api|
66
+ api.has_param :checkpoint_data, 'string'
67
+ api.has_param :checkpoint_name, 'string'
68
+ api.has_param :component, 'string'
69
+ api.has_param :instance_id, 'string'
70
+ api.has_param :run_id, 'string'
71
+ end
72
+ end
73
+
62
74
  has_edge :instances do |edge|
63
75
  edge.get 'PrivateLiftStudyInstance'
64
76
  edge.post 'PrivateLiftStudyInstance' do |api|
65
77
  api.has_param :breakdown_key, 'hash'
78
+ api.has_param :run_id, 'string'
66
79
  end
67
80
  end
68
81
 
@@ -45,6 +45,7 @@ module FacebookAds
45
45
  "AUDIO_COMMENT",
46
46
  "BROADCAST",
47
47
  "BULLETIN_ARTICLE_AUDIO",
48
+ "CANDIDATE_VIDEOS_DELETED",
48
49
  "CANVAS",
49
50
  "CFC_VIDEO",
50
51
  "CMS_MEDIA_MANAGER",
@@ -61,6 +62,7 @@ module FacebookAds
61
62
  "DIRECTED_POST_ATTACHMENT",
62
63
  "DIRECT_INBOX",
63
64
  "DIRECT_INBOX_REACTION",
65
+ "DROPS_SHOPPING_EVENT_PAGE",
64
66
  "DYNAMIC_ITEM_DISPLAY_BUNDLE",
65
67
  "DYNAMIC_ITEM_VIDEO",
66
68
  "DYNAMIC_TEMPLATE_VIDEO",
@@ -73,6 +75,7 @@ module FacebookAds
73
75
  "FB_SHORTS_CROSS_META_POST",
74
76
  "FB_SHORTS_GROUP_POST",
75
77
  "FB_SHORTS_PMV_POST",
78
+ "FB_SHORTS_PMV_POST_NO_NEWSFEED_NOR_TIMELINE",
76
79
  "FB_SHORTS_POST",
77
80
  "FB_SHORTS_REMIX_POST",
78
81
  "FUNDRAISER_COVER_VIDEO",
@@ -137,6 +140,8 @@ module FacebookAds
137
140
  "PAID_CONTENT_PREVIEW",
138
141
  "PAID_CONTENT_VIDEO",
139
142
  "PAID_CONTENT_VIDEO__POST",
143
+ "PAPER_DOCUMENT_AUDIO",
144
+ "PAPER_DOCUMENT_VIDEO",
140
145
  "PIXELCLOUD",
141
146
  "PODCAST_HIGHLIGHT",
142
147
  "PODCAST_ML_PREVIEW",
@@ -253,6 +258,12 @@ module FacebookAds
253
258
  "uploaded",
254
259
  ]
255
260
 
261
+ VIDEO_STATE = [
262
+ "DRAFT",
263
+ "PUBLISHED",
264
+ "SCHEDULED",
265
+ ]
266
+
256
267
  BACKDATED_TIME_GRANULARITY = [
257
268
  "day",
258
269
  "hour",
@@ -264,6 +275,7 @@ module FacebookAds
264
275
 
265
276
 
266
277
  field :ad_breaks, { list: 'int' }
278
+ field :admin_creator, 'User'
267
279
  field :audio_isrc, 'object'
268
280
  field :backdated_time, 'datetime'
269
281
  field :backdated_time_granularity, 'string'
@@ -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 AdgroupMetadata < AdObject
29
+
30
+ field :ad_standard_enhancements_edit_source, 'int'
31
+ field :adgroup_creation_source, 'string'
32
+ field :adgroup_edit_source, 'string'
33
+ field :carousel_style, 'string'
34
+ field :carousel_with_static_card_style, 'string'
35
+ has_no_id
36
+ has_no_get
37
+ has_no_post
38
+ has_no_delete
39
+
40
+ end
41
+ end
@@ -74,12 +74,15 @@ module FacebookAds
74
74
  "hourly_stats_aggregated_by_audience_time_zone",
75
75
  "image_asset",
76
76
  "impression_device",
77
+ "is_conversion_id_modeled",
77
78
  "link_url_asset",
79
+ "mmm",
78
80
  "place_page_id",
79
81
  "platform_position",
80
82
  "product_id",
81
83
  "publisher_platform",
82
84
  "region",
85
+ "skan_campaign_id",
83
86
  "skan_conversion_id",
84
87
  "title_asset",
85
88
  "video_asset",
@@ -228,6 +231,7 @@ module FacebookAds
228
231
  field :social_spend, 'string'
229
232
  field :spend, 'string'
230
233
  field :total_postbacks, 'string'
234
+ field :total_postbacks_detailed, { list: 'AdsActionStats' }
231
235
  field :unique_actions, { list: 'AdsActionStats' }
232
236
  field :unique_clicks, 'string'
233
237
  field :unique_conversions, { list: 'AdsActionStats' }
@@ -102,7 +102,7 @@ module FacebookAds
102
102
  end
103
103
 
104
104
  has_edge :events do |edge|
105
- edge.post 'AdsPixel' do |api|
105
+ edge.post do |api|
106
106
  api.has_param :data, { list: 'string' }
107
107
  api.has_param :namespace_id, 'string'
108
108
  api.has_param :partner_agent, 'string'
@@ -115,6 +115,10 @@ module FacebookAds
115
115
  end
116
116
  end
117
117
 
118
+ has_edge :meapitocapiconsolidationhelper do |edge|
119
+ edge.post
120
+ end
121
+
118
122
  has_edge :shadowtraffichelper do |edge|
119
123
  edge.post
120
124
  end
@@ -124,6 +124,7 @@ module FacebookAds
124
124
  field :auto_event_mapping_android, { list: 'object' }
125
125
  field :auto_event_mapping_ios, { list: 'object' }
126
126
  field :auto_event_setup_enabled, 'bool'
127
+ field :business, 'Business'
127
128
  field :canvas_fluid_height, 'bool'
128
129
  field :canvas_fluid_width, 'int'
129
130
  field :canvas_url, 'string'
@@ -169,6 +170,7 @@ module FacebookAds
169
170
  field :name, 'string'
170
171
  field :namespace, 'string'
171
172
  field :object_store_urls, 'object'
173
+ field :owner_business, 'Business'
172
174
  field :page_tab_default_name, 'string'
173
175
  field :page_tab_url, 'string'
174
176
  field :photo_url, 'string'
@@ -233,6 +235,7 @@ module FacebookAds
233
235
  api.has_param :bundle_id, 'string'
234
236
  api.has_param :bundle_short_version, 'string'
235
237
  api.has_param :bundle_version, 'string'
238
+ api.has_param :campaign_ids, 'string'
236
239
  api.has_param :click_id, 'string'
237
240
  api.has_param :consider_views, 'bool'
238
241
  api.has_param :custom_events, { list: 'object' }
@@ -325,6 +328,7 @@ module FacebookAds
325
328
  edge.post do |api|
326
329
  api.has_param :app_id, 'int'
327
330
  api.has_param :is_aem_ready, 'bool'
331
+ api.has_param :is_aem_v2_ready, 'bool'
328
332
  api.has_param :is_skan_ready, 'bool'
329
333
  end
330
334
  end
@@ -494,6 +498,7 @@ module FacebookAds
494
498
  api.has_param :fb_click_time, 'int'
495
499
  api.has_param :fb_view_time, 'int'
496
500
  api.has_param :is_fb, 'bool'
501
+ api.has_param :used_install_referrer, 'bool'
497
502
  api.has_param :view_attr_window, 'int'
498
503
  end
499
504
  end
@@ -509,12 +514,17 @@ module FacebookAds
509
514
  end
510
515
 
511
516
  has_edge :monetized_digital_store_objects do |edge|
517
+ edge.get
512
518
  edge.post do |api|
513
519
  api.has_param :content_id, 'string'
514
520
  api.has_param :store, 'string'
515
521
  end
516
522
  end
517
523
 
524
+ has_edge :object_types do |edge|
525
+ edge.get 'NullNode'
526
+ end
527
+
518
528
  has_edge :occludespopups do |edge|
519
529
  edge.post do |api|
520
530
  api.has_param :flash, 'bool'